Class DateOperators.TimezonedDateAggregationExpression
java.lang.Object
org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Direct Known Subclasses:
DateOperators.DateAdd
,DateOperators.DateDiff
,DateOperators.DateFromParts
,DateOperators.DateFromString
,DateOperators.DateSubtract
,DateOperators.DateToParts
,DateOperators.DateToString
,DateOperators.DateTrunc
,DateOperators.DayOfMonth
,DateOperators.DayOfWeek
,DateOperators.DayOfYear
,DateOperators.Hour
,DateOperators.IsoDateFromParts
,DateOperators.IsoDayOfWeek
,DateOperators.IsoWeek
,DateOperators.IsoWeekYear
,DateOperators.Millisecond
,DateOperators.Minute
,DateOperators.Month
,DateOperators.Second
,DateOperators.Week
,DateOperators.Year
- Enclosing class:
- DateOperators
AggregationExpression
capable of setting a given DateOperators.Timezone
.- Since:
- 2.1
- Author:
- Christoph Strobl
-
Constructor Summary
-
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
.appendTimezone
(Object source, DateOperators.Timezone timezone) Append thetimezone
to a given source.Get the argument map.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 abstract String
protected boolean
protected boolean
org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) values()
protected abstract DateOperators.TimezonedDateAggregationExpression
withTimezone
(DateOperators.Timezone timezone) Optionally set theDateOperators.Timezone
to use.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
-
Constructor Details
-
TimezonedDateAggregationExpression
-
-
Method Details
-
appendTimezone
Append thetimezone
to a given source. The source itself can be aMap
of already set properties or a single value. In case of single valuesource
the value will be added asdate
property.- Parameters:
source
- must not be null.timezone
- must not be null useDateOperators.Timezone.none()
instead.- Returns:
-
withTimezone
protected abstract DateOperators.TimezonedDateAggregationExpression withTimezone(DateOperators.Timezone timezone) Optionally set theDateOperators.Timezone
to use. If not specified UTC is used.
NOTE: Requires MongoDB 3.6 or later.- Parameters:
timezone
- must not be null. ConsiderDateOperators.Timezone.none()
instead.- Returns:
- new instance.
- Throws:
IllegalArgumentException
- if given timezone is null.
-
hasTimezone
protected boolean hasTimezone() -
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
-
getMongoMethod
-