org.springframework.data.mongodb.core.aggregation

Class ArrayOperators.ArrayElemAt

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ArrayOperators.ArrayElemAt

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ArrayOperators

public static class ArrayOperators.ArrayElemAt
extends Object

AggregationExpression for $arrayElementAt.

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.
static ArrayOperators.ArrayElemAt	arrayOf(AggregationExpression expression) Creates new ArrayOperators.ArrayElemAt.
static ArrayOperators.ArrayElemAt	arrayOf(Collection<?> values) Creates new ArrayOperators.ArrayElemAt.
static ArrayOperators.ArrayElemAt	arrayOf(String fieldReference) Creates new ArrayOperators.ArrayElemAt.
protected static List<Field>	asFields(String... fieldRefs)
protected boolean	contains(Object key) Check if the given key is available.
ArrayOperators.ArrayElemAt	elementAt(AggregationExpression expression) Use the element at the index number evaluated from the given AggregationExpression.
ArrayOperators.ArrayElemAt	elementAt(int index) Use the element with given index number.
ArrayOperators.ArrayElemAt	elementAt(String arrayFieldReference) Use the element at the index number traken from the given field.
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)
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationExpression into a Document within the given AggregationOperationContext.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
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()

arrayOf

public static ArrayOperators.ArrayElemAt arrayOf(String fieldReference)

Creates new ArrayOperators.ArrayElemAt.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ArrayOperators.ArrayElemAt.

arrayOf

public static ArrayOperators.ArrayElemAt arrayOf(AggregationExpression expression)

Creates new ArrayOperators.ArrayElemAt.

Parameters:

expression - must not be null.

Returns:

new instance of ArrayOperators.ArrayElemAt.

arrayOf

public static ArrayOperators.ArrayElemAt arrayOf(Collection<?> values)

Creates new ArrayOperators.ArrayElemAt.

Parameters:

values - The array members. Must not be null.

Returns:

new instance of ArrayOperators.ArrayElemAt.

Since:

2.2

elementAt

public ArrayOperators.ArrayElemAt elementAt(int index)

Use the element with given index number.

Parameters:

index - the index number

Returns:

new instance of ArrayOperators.ArrayElemAt.

elementAt

public ArrayOperators.ArrayElemAt elementAt(AggregationExpression expression)

Use the element at the index number evaluated from the given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of ArrayOperators.ArrayElemAt.

elementAt

public ArrayOperators.ArrayElemAt elementAt(String arrayFieldReference)

Use the element at the index number traken from the given field.

Parameters:

arrayFieldReference - the field name.

Returns:

new instance of ArrayOperators.ArrayElemAt.

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