Class DateOperators.DateDiff
java.lang.Object
org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression
org.springframework.data.mongodb.core.aggregation.DateOperators.DateDiff
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- DateOperators
- 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.protected boolean
Check if the given key is available.static DateOperators.DateDiff
Add the number of units to astart date
.static DateOperators.DateDiff
diffValueOf
(String fieldReference, String unit) Add the number of units from a field to astart date
.static DateOperators.DateDiff
diffValueOf
(AggregationExpression expression, String unit) Add the number of units of the result of the givenexpression
to astart date
.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
startOfWeek
(Object day) Set the start day of the week if the unit if measure is set to week.Define the start date, in UTC, for the addition operation.Define the start date, in UTC, for the addition operation.toDateOf
(AggregationExpression expression) Define the start date, in UTC, for the addition operation.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
-
diffValueOf
Add the number of units of the result of the givenexpression
to astart date
.- Parameters:
expression
- must not be null.unit
- must not be null.- Returns:
- new instance of
DateOperators.DateAdd
.
-
diffValueOf
Add the number of units from a field to astart date
.- Parameters:
fieldReference
- must not be null.unit
- must not be null.- Returns:
- new instance of
DateOperators.DateAdd
.
-
diffValue
Add the number of units to astart date
.- Parameters:
value
- must not be null.unit
- must not be null.- Returns:
- new instance of
DateOperators.DateAdd
.
-
toDateOf
Define the start date, in UTC, for the addition operation.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DateOperators.DateAdd
.
-
toDateOf
Define the start date, in UTC, for the addition operation.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
DateOperators.DateAdd
.
-
toDate
Define the start date, in UTC, for the addition operation.- Parameters:
dateExpression
- anything that evaluates to a valid date. Must not be null.- Returns:
- new instance of
DateOperators.DateAdd
.
-
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.DateAdd
.
-
startOfWeek
Set the start day of the week if the unit if measure is set to week. Uses Sunday by default.- Parameters:
day
- must not be null.- Returns:
- new instance of
DateOperators.DateDiff
.
-
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
-