Class DateOperators.DateSubtract
java.lang.Object
org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression
org.springframework.data.mongodb.core.aggregation.DateOperators.DateSubtract
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- DateOperators
public static class DateOperators.DateSubtract
extends DateOperators.TimezonedDateAggregationExpression
- Since:
- 4.0
- 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.protected boolean
Check if the given key is available.Define the start date, in UTC, for the subtraction operation.fromDateOf
(String fieldReference) Define the start date, in UTC, for the subtraction operation.fromDateOf
(AggregationExpression expression) Define the start date, in UTC, for the subtraction operation.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 DateOperators.DateSubtract
subtractValue
(Object value, String unit) Subtract the number of units from astart date
.static DateOperators.DateSubtract
subtractValueOf
(String fieldReference, String unit) Subtract the number of units from a field from astart date
.static DateOperators.DateSubtract
subtractValueOf
(AggregationExpression expression, String unit) Subtract the number of units of the result of the givenexpression
from astart date
.org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) values()
withTimezone
(DateOperators.Timezone timezone) Optionally set theDateOperators.Timezone
to use.Methods inherited from class org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression
appendTimezone, hasTimezone
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
-
subtractValueOf
public static DateOperators.DateSubtract subtractValueOf(AggregationExpression expression, String unit) Subtract the number of units of the result of the givenexpression
from astart date
.- Parameters:
expression
- must not be null.unit
- must not be null.- Returns:
- new instance of
DateOperators.DateSubtract
.
-
subtractValueOf
Subtract the number of units from a field from astart date
.- Parameters:
fieldReference
- must not be null.unit
- must not be null.- Returns:
- new instance of
DateOperators.DateSubtract
.
-
subtractValue
Subtract the number of units from astart date
.- Parameters:
value
- must not be null.unit
- must not be null.- Returns:
- new instance of
DateOperators.DateSubtract
.
-
fromDateOf
Define the start date, in UTC, for the subtraction operation.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DateOperators.DateSubtract
.
-
fromDateOf
Define the start date, in UTC, for the subtraction operation.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
DateOperators.DateSubtract
.
-
fromDate
Define the start date, in UTC, for the subtraction operation.- Parameters:
dateExpression
- anything that evaluates to a valid date. Must not be null.- Returns:
- new instance of
DateOperators.DateSubtract
.
-
withTimezone
Optionally set theDateOperators.Timezone
to use. If not specified UTC is used.- Specified by:
withTimezone
in classDateOperators.TimezonedDateAggregationExpression
- Parameters:
timezone
- must not be null. ConsiderDateOperators.Timezone.none()
instead.- Returns:
- new instance of
DateOperators.DateSubtract
.
-
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
-