Module spring.data.mongodb

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

Class DocumentOperators.Shift

java.lang.Object

org.springframework.data.mongodb.core.aggregation.DocumentOperators.Shift

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

DocumentOperators

public static class DocumentOperators.Shift
extends Object

Shift applies an expression to a document in a specified position relative to the current document.

Since:

3.3

Author:

Christoph Strobl

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)
DocumentOperators.Shift	by(int shiftBy)	Shift the document position relative to the current.
protected boolean	contains(Object key)	Check if the given key is available.
DocumentOperators.Shift	defaultTo(Object value)	Define the default value if the target document is out of range.
DocumentOperators.Shift	defaultToValueOf(AggregationExpression expression)	Define the expression to evaluate if the target document is out of range.
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()
protected Map<String,Object>	remove(String key)
static DocumentOperators.Shift	shift(String fieldReference)	Specifies the field to evaluate and return.
static DocumentOperators.Shift	shift(AggregationExpression expression)	Specifies the expression to evaluate and return.
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

shift

public static DocumentOperators.Shift shift(String fieldReference)

Specifies the field to evaluate and return.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DocumentOperators.Shift.

shift

public static DocumentOperators.Shift shift(AggregationExpression expression)

Specifies the expression to evaluate and return.

Parameters:

expression - must not be null.

Returns:

new instance of DocumentOperators.Shift.

by

public DocumentOperators.Shift by(int shiftBy)

Shift the document position relative to the current. Use a positive value for follow up documents (eg. 1 for the next) or a negative value for the predecessor documents (eg. -1 for the previous).

Parameters:

shiftBy - value to add to the current position.

Returns:

new instance of DocumentOperators.Shift.

defaultTo

public DocumentOperators.Shift defaultTo(Object value)

Define the default value if the target document is out of range.

Parameters:

value - must not be null.

Returns:

new instance of DocumentOperators.Shift.

defaultToValueOf

public DocumentOperators.Shift defaultToValueOf(AggregationExpression expression)

Define the expression to evaluate if the target document is out of range.

Parameters:

expression - must not be null.

Returns:

new instance of DocumentOperators.Shift.

getMongoMethod

protected String getMongoMethod()

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