Package 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	Description
static interface	ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder

Constructor Summary

Constructors

Constructor	Description
ArrayOperatorFactory(String fieldReference)	Creates new ArrayOperators.ArrayOperatorFactory for given fieldReference.
ArrayOperatorFactory(Collection<?> values)	Creates new ArrayOperators.ArrayOperatorFactory for given values.
ArrayOperatorFactory(AggregationExpression expression)	Creates new ArrayOperators.ArrayOperatorFactory for given AggregationExpression.

Method Summary

Modifier and Type	Method	Description
ArrayOperators.ConcatArrays	concat(String arrayFieldReference)	Creates new AggregationExpression that takes the associated array and concats the given arrayFieldReference to it.
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.In	containsValue(Object value)	Creates new AggregationExpression that returns a boolean indicating whether a specified value is in the associated array.
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.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.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.First	first()	Creates new AggregationExpression that return the first element in the associated array.
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.Last	last()	Creates new AggregationExpression that return the last element in the given 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.SortArray	sort(Sort sort)	Creates new AggregationExpression that takes the associated array and sorts it by the given order.
ArrayOperators.ArrayToObject	toObject()	Creates new AggregationExpression that converts the associated expression into an object.
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 Details

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.

ArrayOperatorFactory

public ArrayOperatorFactory(Collection<?> values)

Creates new ArrayOperators.ArrayOperatorFactory for given values.

Parameters:

values - must not be null.

Since:

2.2

Method Details

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 - the element index.

Returns:

new instance of ArrayOperators.ArrayElemAt.

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:

new instance of ArrayOperators.ArrayElemAt.

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:

new instance of ArrayOperators.ArrayElemAt.

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:

new instance of ArrayOperators.ConcatArrays.

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:

new instance of ArrayOperators.ConcatArrays.

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:

new instance of ArrayOperators.Filter.AsBuilder to create a ArrayOperators.Filter.

isArray

public ArrayOperators.IsArray isArray()

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

Returns:

new instance of ArrayOperators.IsArray.

length

public ArrayOperators.Size length()

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

Returns:

new instance of ArrayOperators.Size.

slice

public ArrayOperators.Slice slice()

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

Returns:

new instance of ArrayOperators.Slice.

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:

new instance of ArrayOperators.IndexOfArray.

reverse

public ArrayOperators.ReverseArray reverse()

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

Returns:

new instance of ArrayOperators.ReverseArray.

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:

new instance of ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder to create ArrayOperators.Reduce.

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 - must not be null.

Returns:

new instance of ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder to create ArrayOperators.Reduce.

sort

public ArrayOperators.SortArray sort(Sort sort)

Creates new AggregationExpression that takes the associated array and sorts it by the given order.

Returns:

new instance of ArrayOperators.SortArray.

Since:

4.0

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:

new instance of ArrayOperators.Zip.

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:

new instance of ArrayOperators.In.

toObject

public ArrayOperators.ArrayToObject toObject()

Creates new AggregationExpression that converts the associated expression into an object. NOTE: Requires MongoDB 3.6 or later.

Returns:

new instance of ArrayOperators.ArrayToObject.

Since:

2.1

first

public ArrayOperators.First first()

Creates new AggregationExpression that return the first element in the associated array. NOTE: Requires MongoDB 4.4 or later.

Returns:

new instance of ArrayOperators.First.

Since:

3.4

last

public ArrayOperators.Last last()

Creates new AggregationExpression that return the last element in the given array. NOTE: Requires MongoDB 4.4 or later.

Returns:

new instance of ArrayOperators.Last.

Since:

3.4