Class SelectionOperators.Bottom
java.lang.Object
org.springframework.data.mongodb.core.aggregation.SelectionOperators.Bottom
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- SelectionOperators
AbstractAggregationExpression
to return the bottom element according to the specified order
.-
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.static SelectionOperators.Bottom
bottom()
static SelectionOperators.Bottom
bottom
(int numberOfResults) protected boolean
Check if the given key is available.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
In case a limit value (n) is present $bottomN is used instead of $bottom.protected boolean
limit
(int numberOfResults) Limits the number of returned elements to the given value.limit
(AggregationExpression expression) Limits the number of returned elements to the value defined by the givenexpression
.Define fields included in the output for each element.output
(AggregationExpression... out) Define expressions building the value included in the output for each element.Define result ordering.Define result ordering.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
-
getMongoMethod
In case a limit value (n) is present $bottomN is used instead of $bottom.- Returns:
-
bottom
- Returns:
- new instance of
SelectionOperators.Bottom
.
-
bottom
- Parameters:
numberOfResults
- Limits the number of returned elements to the given value.- Returns:
- new instance of
SelectionOperators.Bottom
.
-
limit
Limits the number of returned elements to the given value.- Parameters:
numberOfResults
-- Returns:
- new instance of
SelectionOperators.Bottom
.
-
limit
Limits the number of returned elements to the value defined by the givenexpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
SelectionOperators.Bottom
.
-
sortBy
Define result ordering.- Parameters:
sort
- must not be null.- Returns:
- new instance of
SelectionOperators.Bottom
.
-
output
Define result ordering.- Parameters:
out
- must not be null.- Returns:
- new instance of
SelectionOperators.Bottom
.
-
output
Define fields included in the output for each element.- Parameters:
fieldNames
- must not be null.- Returns:
- new instance of
SelectionOperators.Bottom
. - See Also:
-
output
Define expressions building the value included in the output for each element.- Parameters:
out
- must not be null.- Returns:
- new instance of
SelectionOperators.Bottom
. - See Also:
-
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
-