org.springframework.data.mongodb.core.aggregation

Class ArrayOperators.ArrayOperatorFactory

java.lang.Object

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

Enclosing class:

ArrayOperators

public static class ArrayOperators.ArrayOperatorFactory
extends Object

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder

Constructor Summary

Constructors

Constructor and Description
ArrayOperatorFactory(AggregationExpression expression) Creates new ArrayOperators.ArrayOperatorFactory for given AggregationExpression.
ArrayOperatorFactory(String fieldReference) Creates new ArrayOperators.ArrayOperatorFactory for given fieldReference.

Method Summary

Modifier and Type	Method and Description
ArrayOperators.ConcatArrays	concat(AggregationExpression expression) Creates new AggregationExpression that takes the associated array and concats the array resulting form the given expression to it.
ArrayOperators.ConcatArrays	concat(String arrayFieldReference) Creates new AggregationExpression that takes the associated array and concats the given arrayFieldReference to it.
ArrayOperators.In	containsValue(Object value) Creates new AggregationExpression that returns a boolean indicating whether a specified value is in the associated array.
ArrayOperators.ArrayElemAt	elementAt(AggregationExpression expression) Creates new AggregationExpression that takes the associated array and returns the element at the position resulting form the given expression.
ArrayOperators.ArrayElemAt	elementAt(int position) Creates new AggregationExpression that takes the associated array and returns the element at the specified array position.
ArrayOperators.ArrayElemAt	elementAt(String fieldReference) Creates new AggregationExpression that takes the associated array and returns the element at the position defined by the referenced field.
ArrayOperators.Filter.AsBuilder	filter() Creates new AggregationExpression that takes the associated array and selects a subset of the array to return based on the specified condition.
ArrayOperators.IndexOfArray	indexOf(Object value) Creates new AggregationExpression that searches the associated array for an occurrence of a specified value and returns the array index (zero-based) of the first occurrence.
ArrayOperators.IsArray	isArray() Creates new AggregationExpression that takes the associated array and an check if its an array.
ArrayOperators.Size	length() Creates new AggregationExpression that takes the associated array and retrieves its length.
ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder	reduce(AggregationExpression expression) Start creating new AggregationExpression that applies an AggregationExpression to each element in an array and combines them into a single value.
ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder	reduce(ArrayOperators.Reduce.PropertyExpression... expressions) Start creating new AggregationExpression that applies an AggregationExpression to each element in an array and combines them into a single value.
ArrayOperators.ReverseArray	reverse() Creates new AggregationExpression that returns an array with the elements in reverse order.
ArrayOperators.Slice	slice() Creates new AggregationExpression that takes the associated array and selects a subset from it.
ArrayOperators.Zip	zipWith(Object... arrays) Creates new AggregationExpression that transposes an array of input arrays so that the first element of the output array would be an array containing, the first element of the first input array, the first element of the second input array, etc.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayOperatorFactory

public ArrayOperatorFactory(String fieldReference)

Creates new ArrayOperators.ArrayOperatorFactory for given fieldReference.

Parameters:

fieldReference - must not be null.

ArrayOperatorFactory

public ArrayOperatorFactory(AggregationExpression expression)

Creates new ArrayOperators.ArrayOperatorFactory for given AggregationExpression.

Parameters:

expression - must not be null.

Method Detail

elementAt

public ArrayOperators.ArrayElemAt elementAt(int position)

Creates new AggregationExpression that takes the associated array and returns the element at the specified array position.

Parameters:

position -

Returns:

elementAt

public ArrayOperators.ArrayElemAt elementAt(AggregationExpression expression)

Creates new AggregationExpression that takes the associated array and returns the element at the position resulting form the given expression.

Parameters:

expression - must not be null.

Returns:

elementAt

public ArrayOperators.ArrayElemAt elementAt(String fieldReference)

Creates new AggregationExpression that takes the associated array and returns the element at the position defined by the referenced field.

Parameters:

fieldReference - must not be null.

Returns:

concat

public ArrayOperators.ConcatArrays concat(String arrayFieldReference)

Creates new AggregationExpression that takes the associated array and concats the given arrayFieldReference to it.

Parameters:

arrayFieldReference - must not be null.

Returns:

concat

public ArrayOperators.ConcatArrays concat(AggregationExpression expression)

Creates new AggregationExpression that takes the associated array and concats the array resulting form the given expression to it.

Parameters:

expression - must not be null.

Returns:

filter

public ArrayOperators.Filter.AsBuilder filter()

Creates new AggregationExpression that takes the associated array and selects a subset of the array to return based on the specified condition.

Returns:

isArray

public ArrayOperators.IsArray isArray()

Creates new AggregationExpression that takes the associated array and an check if its an array.

Returns:

length

public ArrayOperators.Size length()

Creates new AggregationExpression that takes the associated array and retrieves its length.

Returns:

slice

public ArrayOperators.Slice slice()

Creates new AggregationExpression that takes the associated array and selects a subset from it.

Returns:

indexOf

public ArrayOperators.IndexOfArray indexOf(Object value)

Creates new AggregationExpression that searches the associated array for an occurrence of a specified value and returns the array index (zero-based) of the first occurrence.

Parameters:

value - must not be null.

Returns:

reverse

public ArrayOperators.ReverseArray reverse()

Creates new AggregationExpression that returns an array with the elements in reverse order.

Returns:

reduce

public ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder reduce(AggregationExpression expression)

Start creating new AggregationExpression that applies an AggregationExpression to each element in an array and combines them into a single value.

Parameters:

expression - must not be null.

Returns:

reduce

public ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder reduce(ArrayOperators.Reduce.PropertyExpression... expressions)

Start creating new AggregationExpression that applies an AggregationExpression to each element in an array and combines them into a single value.

Parameters:

expressions -

Returns:

zipWith

public ArrayOperators.Zip zipWith(Object... arrays)

Creates new AggregationExpression that transposes an array of input arrays so that the first element of the output array would be an array containing, the first element of the first input array, the first element of the second input array, etc.

Parameters:

arrays - must not be null.

Returns:

containsValue

public ArrayOperators.In containsValue(Object value)

Creates new AggregationExpression that returns a boolean indicating whether a specified value is in the associated array.

Parameters:

value - must not be null.

Returns: