Class DateOperators.DateTrunc
java.lang.Object
org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression
org.springframework.data.mongodb.core.aggregation.DateOperators.DateTrunc
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- DateOperators
public static class DateOperators.DateTrunc
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.binSize
(int binSize) Define the numeric time value.Define the numeric time value.binSize
(AggregationExpression expression) Define the numeric time value via anAggregationExpression
.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
protected boolean
startOfWeek
(String day) Define the weeks starting day ifto(String)
resolves to week.startOfWeek
(DayOfWeek day) Define the weeks starting day ifto(String)
resolves to week.Define the unit of time.to
(AggregationExpression unit) Define the unit of time via anAggregationExpression
.org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) static DateOperators.DateTrunc
truncateValue
(Object value) Truncates the date value.static DateOperators.DateTrunc
truncateValueOf
(String fieldReference) Truncates the date value of the referenced field.static DateOperators.DateTrunc
truncateValueOf
(AggregationExpression expression) Truncates the date value of computed by the givenAggregationExpression
.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
-
truncateValueOf
Truncates the date value of computed by the givenAggregationExpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
truncateValueOf
Truncates the date value of the referenced field.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
truncateValue
Truncates the date value.- Parameters:
value
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
to
Define the unit of time.- Parameters:
unit
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
to
Define the unit of time via anAggregationExpression
.- Parameters:
unit
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
startOfWeek
Define the weeks starting day ifto(String)
resolves to week.- Parameters:
day
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
startOfWeek
Define the weeks starting day ifto(String)
resolves to week.- Parameters:
day
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
binSize
Define the numeric time value.- Parameters:
binSize
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
binSize
Define the numeric time value via anAggregationExpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
binSize
Define the numeric time value.- Parameters:
binSize
- must not be null.- Returns:
- new instance of
DateOperators.DateTrunc
.
-
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.DateTrunc
.
-
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
-