Class DocumentOperators.Shift
java.lang.Object
org.springframework.data.mongodb.core.aggregation.DocumentOperators.Shift
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- DocumentOperators
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 TypeMethodDescriptionappend
(Object value, org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList) Append the given key at the position in the underlyingLinkedHashMap
.Get the argument map.by
(int shiftBy) Shift the document position relative to the current.protected boolean
Check if the given key is available.Define the default value if the target document is out of range.defaultToValueOf
(AggregationExpression expression) Define theexpression
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 the value for a given key.protected String
protected boolean
static DocumentOperators.Shift
Specifies the field to evaluate and return.static DocumentOperators.Shift
shift
(AggregationExpression expression) Specifies theexpression
to evaluate and return.org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) 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
Specifies the field to evaluate and return.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
DocumentOperators.Shift
.
-
shift
Specifies theexpression
to evaluate and return.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DocumentOperators.Shift
.
-
by
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
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
Define theexpression
to evaluate if the target document is out of range.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DocumentOperators.Shift
.
-
getMongoMethod
-
toDocument
Description copied from interface:AggregationExpression
- Specified by:
toDocument
in interfaceAggregationExpression
- Parameters:
context
- must not be null.- Returns:
- the MongoDB native (
Document
) form of the expression.
-
toDocument
-
asFields
-
append
-
append
-
append
-
appendTo
-
remove
-
appendAt
Append the given key at the position in the underlyingLinkedHashMap
.- Parameters:
index
-key
-value
-- Returns:
- Since:
- 3.1
-
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
Get the value for a given key.- Type Parameters:
T
-- Parameters:
key
-- Returns:
- Since:
- 2.1
-
isArgumentMap
protected boolean isArgumentMap() -
argumentMap
Get the argument map.- Returns:
- Since:
- 2.1
-
contains
Check if the given key is available.- Parameters:
key
-- Returns:
- Since:
- 2.1
-