Class DateOperators
java.lang.Object
org.springframework.data.mongodb.core.aggregation.DateOperators
Gateway to Date aggregation operations.
- Since:
- 1.10
- Author:
- Christoph Strobl, Matt Morrissette
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static interface
DateOperators.DateParts<T extends DateOperators.DateParts<T>>
static class
static class
static class
AggregationExpression
for$dateToString
.static class
static class
AggregationExpression
for$dayOfMonth
.static class
AggregationExpression
for$dayOfWeek
.static class
AggregationExpression
for$dayOfYear
.static class
AggregationExpression
for$hour
.static class
static class
AggregationExpression
for$isoDayOfWeek
.static class
AggregationExpression
for$isoWeek
.static class
AggregationExpression
for$isoWeekYear
.static class
AggregationExpression
for$millisecond
.static class
AggregationExpression
for$minute
.static class
AggregationExpression
for$month
.static class
AggregationExpression
for$second
.static interface
Interface defining a temporal unit for date operators.static class
Timezone represents a MongoDB timezone abstraction which can be represented with a timezone ID or offset as aString
.static class
AggregationExpression
capable of setting a givenDateOperators.Timezone
.static class
AggregationExpression
for$tsIncrement
.static class
AggregationExpression
for$tsSecond
.static class
AggregationExpression
for$week
.static class
AggregationExpression
for$year
. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionConstruct a Date object by providing the date’s constituent properties.
NOTE: Requires MongoDB 3.6 or later.static DateOperators.DateFromString
dateFromString
(String value) Construct a Date object from the given dateString
.
To use afield reference
orAggregationExpression
as source of the date string considerDateOperators.DateOperatorFactory.fromString()
orDateOperators.DateFromString.fromStringOf(AggregationExpression)
.
NOTE: Requires MongoDB 3.6 or later.Take the date referenced by given fieldReference.dateOf
(AggregationExpression expression) Take the date resulting from the givenAggregationExpression
.Take the given value as date.zonedDateOf
(String fieldReference, DateOperators.Timezone timezone) Take the date referenced by given fieldReference.zonedDateOf
(AggregationExpression expression, DateOperators.Timezone timezone) Take the date resulting from the givenAggregationExpression
.
-
Constructor Details
-
DateOperators
public DateOperators()
-
-
Method Details
-
dateOf
Take the date referenced by given fieldReference.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
DateOperators.DateOperatorFactory
.
-
zonedDateOf
public static DateOperators.DateOperatorFactory zonedDateOf(String fieldReference, DateOperators.Timezone timezone) Take the date referenced by given fieldReference.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
DateOperators.DateOperatorFactory
. - Since:
- 3.3
-
dateOf
Take the date resulting from the givenAggregationExpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DateOperators.DateOperatorFactory
.
-
zonedDateOf
public static DateOperators.DateOperatorFactory zonedDateOf(AggregationExpression expression, DateOperators.Timezone timezone) Take the date resulting from the givenAggregationExpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DateOperators.DateOperatorFactory
. - Since:
- 3.3
-
dateValue
Take the given value as date.
This can be one of:- Parameters:
value
- must not be null.- Returns:
- new instance of
DateOperators.DateOperatorFactory
. - Since:
- 2.1
-
dateFromParts
Construct a Date object by providing the date’s constituent properties.
NOTE: Requires MongoDB 3.6 or later.- Returns:
- new instance of
DateOperators.DateFromPartsOperatorFactory
. - Since:
- 2.1
-
dateFromString
Construct a Date object from the given dateString
.
To use afield reference
orAggregationExpression
as source of the date string considerDateOperators.DateOperatorFactory.fromString()
orDateOperators.DateFromString.fromStringOf(AggregationExpression)
.
NOTE: Requires MongoDB 3.6 or later.- Returns:
- new instance of
DateOperators.DateFromPartsOperatorFactory
. - Since:
- 2.1
-