org.springframework.data.mongodb.core.aggregation

Class StringOperators.Split

java.lang.Object

org.springframework.data.mongodb.core.aggregation.StringOperators.Split

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

StringOperators

public static class StringOperators.Split
extends Object

AggregationExpression for $split.

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAggregationExpression.Expand Expand a nested list of values to single entries or keep the list.

Method Summary

Modifier and Type	Method and Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, AbstractAggregationExpression.Expand expandList)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	appendAt(int index, String key, Object value) Append the given key at the position in the underlying LinkedHashMap.
protected Map<String,Object>	argumentMap() Get the argument map.
protected static List<Field>	asFields(String... fieldRefs)
protected boolean	contains(Object key) Check if the given key is available.
protected <T> T	get(int index) Get the value at a given index.
protected <T> T	get(Object key) Get the value for a given key.
protected String	getMongoMethod()
protected Map<String,Object>	remove(String key)
StringOperators.Split	split(AggregationExpression expression) Use value resulting from AggregationExpression as delimiter.
StringOperators.Split	split(Field fieldReference) Use value of referenced field as delimiter.
StringOperators.Split	split(String delimiter) Use given String as delimiter.
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationExpression into a Document within the given AggregationOperationContext.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
static StringOperators.Split	valueOf(AggregationExpression expression) Start creating a new StringOperators.Split.
static StringOperators.Split	valueOf(String fieldReference) Start creating a new StringOperators.Split.
protected List<Object>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationExpression

from, toDocument

Methods inherited from interface org.springframework.data.mongodb.MongoExpression

create, create

Method Detail

getMongoMethod

protected String getMongoMethod()

valueOf

public static StringOperators.Split valueOf(String fieldReference)

Start creating a new StringOperators.Split.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.Split.

valueOf

public static StringOperators.Split valueOf(AggregationExpression expression)

Start creating a new StringOperators.Split.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.Split.

split

public StringOperators.Split split(String delimiter)

Use given String as delimiter.

Parameters:

delimiter - must not be null.

Returns:

new instance of StringOperators.Split.

split

public StringOperators.Split split(Field fieldReference)

Use value of referenced field as delimiter.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.Split.

split

public StringOperators.Split split(AggregationExpression expression)

Use value resulting from AggregationExpression as delimiter.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.Split.

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationExpression

Turns the AggregationExpression into a Document within the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationExpression

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.

toDocument

public org.bson.Document toDocument(Object value,
                                    AggregationOperationContext context)

asFields

protected static List<Field> asFields(String... fieldRefs)

append

protected List<Object> append(Object value,
                              AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(String key,
                                    Object value)

remove

protected Map<String,Object> remove(String key)

appendAt

protected Map<String,Object> appendAt(int index,
                                      String key,
                                      Object value)

Append the given key at the position in the underlying LinkedHashMap.

Parameters:

index -

key -

value -

Returns:

Since:

3.1

values

protected List<Object> values()

get

protected <T> T get(int index)

Get the value at a given index.

Type Parameters:

T -

Parameters:

index -

Returns:

Since:

2.1

get

protected <T> T get(Object key)

Get the value for a given key.

Type Parameters:

T -

Parameters:

key -

Returns:

Since:

2.1

argumentMap

protected Map<String,Object> argumentMap()

Get the argument map.

Returns:

Since:

2.1

contains

protected boolean contains(Object key)

Check if the given key is available.

Parameters:

key -

Returns:

Since:

2.1