Module spring.data.mongodb

Package org.springframework.data.mongodb.core.aggregation

Class ArrayOperators.Slice

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ArrayOperators

public static class ArrayOperators.Slice
extends Object

AggregationExpression for $slice.

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ArrayOperators.Slice.SliceElementsBuilder

Method Summary

Modifier and Type	Method	Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, org.springframework.data.mongodb.core.aggregation.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>	appendTo(String key, Object value)
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 boolean	isArgumentMap()
ArrayOperators.Slice	itemCount(int count)	Slice the number of elements.
ArrayOperators.Slice	itemCount(AggregationExpression count)	Slice the number of elements.
ArrayOperators.Slice.SliceElementsBuilder	offset(int position)	Slice using offset and count.
ArrayOperators.Slice.SliceElementsBuilder	offset(AggregationExpression position)	Slice using offset and count.
protected Map<String,Object>	remove(String key)
static ArrayOperators.Slice	sliceArrayOf(String fieldReference)	Creates new ArrayOperators.Slice.
static ArrayOperators.Slice	sliceArrayOf(Collection<?> values)	Creates new ArrayOperators.Slice.
static ArrayOperators.Slice	sliceArrayOf(AggregationExpression expression)	Creates new ArrayOperators.Slice.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
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

toDocument

Method Details

getMongoMethod

protected String getMongoMethod()

sliceArrayOf

public static ArrayOperators.Slice sliceArrayOf(String fieldReference)

Creates new ArrayOperators.Slice.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ArrayOperators.Slice.

sliceArrayOf

public static ArrayOperators.Slice sliceArrayOf(AggregationExpression expression)

Creates new ArrayOperators.Slice.

Parameters:

expression - must not be null.

Returns:

new instance of ArrayOperators.Slice.

sliceArrayOf

public static ArrayOperators.Slice sliceArrayOf(Collection<?> values)

Creates new ArrayOperators.Slice.

Parameters:

values - must not be null.

Returns:

new instance of ArrayOperators.Slice.

Since:

2.2

itemCount

public ArrayOperators.Slice itemCount(int count)

Slice the number of elements.

Parameters:

count - number of elements to slice.

Returns:

new instance of ArrayOperators.Slice.

itemCount

public ArrayOperators.Slice itemCount(AggregationExpression count)

Slice the number of elements.

Parameters:

count - an AggregationExpression that evaluates to a numeric value used as number of elements to slice.

Returns:

new instance of ArrayOperators.Slice.

Since:

4.5

offset

public ArrayOperators.Slice.SliceElementsBuilder offset(int position)

Slice using offset and count.

Parameters:

position - the start position

Returns:

new instance of ArrayOperators.Slice.SliceElementsBuilder to create ArrayOperators.Slice.

offset

public ArrayOperators.Slice.SliceElementsBuilder offset(AggregationExpression position)

Slice using offset and count.

Parameters:

position - the start position

Returns:

new instance of ArrayOperators.Slice.SliceElementsBuilder to create ArrayOperators.Slice.

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,
 org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

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

appendTo

protected Map<String,Object> appendTo(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

isArgumentMap

protected boolean isArgumentMap()

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