Class DateOperators.DateToParts
java.lang.Object
org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression
org.springframework.data.mongodb.core.aggregation.DateOperators.DateToParts
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- DateOperators
public static class DateOperators.DateToParts
extends DateOperators.TimezonedDateAggregationExpression
- Since:
- 2.1
- Author:
- Matt Morrissette, Christoph Strobl
- See Also:
-
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.DateToParts
datePartsOf
(String fieldReference) Creates newDateOperators.DateToParts
.static DateOperators.DateToParts
datePartsOf
(AggregationExpression expression) Creates newDateOperators.DateToParts
.static DateOperators.DateToParts
dateToParts
(Object value) Creates newDateOperators.DateToParts
.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
iso8601()
Use ISO week date fields in the resulting document.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
-
dateToParts
Creates newDateOperators.DateToParts
.- Parameters:
value
- must not be null.- Returns:
- new instance of
DateOperators.DateToParts
. - Throws:
IllegalArgumentException
- if given value is null.
-
datePartsOf
Creates newDateOperators.DateToParts
.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
DateOperators.DateToParts
. - Throws:
IllegalArgumentException
- if given fieldReference is null.
-
datePartsOf
Creates newDateOperators.DateToParts
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DateOperators.DateToParts
. - Throws:
IllegalArgumentException
- if given expression is null.
-
iso8601
Use ISO week date fields in the resulting document.- Returns:
- new instance of
DateOperators.DateToParts
.
-
withTimezone
Optionally set theDateOperators.Timezone
to use. If not specified UTC is used.
NOTE: Requires MongoDB 3.6 or later.- Specified by:
withTimezone
in classDateOperators.TimezonedDateAggregationExpression
- Parameters:
timezone
- must not be null. ConsiderDateOperators.Timezone.none()
instead.- Returns:
- new instance of
DateOperators.DateFromParts
. - Throws:
IllegalArgumentException
- if given timezone is null.
-
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
-