Module spring.data.mongodb

Package org.springframework.data.mongodb.core.aggregation

Class DateOperators

java.lang.Object

org.springframework.data.mongodb.core.aggregation.DateOperators

public class DateOperators
extends Object

Gateway to Date aggregation operations.

Since:

1.10

Author:

Christoph Strobl, Matt Morrissette

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DateOperators.DateAdd	AggregationExpression for $dateAdd. NOTE: Requires MongoDB 5.0 or later.
static class	DateOperators.DateDiff	AggregationExpression for $dateDiff. NOTE: Requires MongoDB 5.0 or later.
static class	DateOperators.DateFromParts	AggregationExpression for $dateFromParts. NOTE: Requires MongoDB 3.6 or later.
static class	DateOperators.DateFromPartsOperatorFactory
static class	DateOperators.DateFromString	AggregationExpression for $dateFromString. NOTE: Requires MongoDB 3.6 or later.
static class	DateOperators.DateOperatorFactory
static interface	DateOperators.DateParts<T extends DateOperators.DateParts<T>>
static class	DateOperators.DateSubtract	AggregationExpression for $dateSubtract. NOTE: Requires MongoDB 5.0 or later.
static class	DateOperators.DateToParts	AggregationExpression for $dateToParts. NOTE: Requires MongoDB 3.6 or later.
static class	DateOperators.DateToString	AggregationExpression for $dateToString.
static class	DateOperators.DateTrunc	AggregationExpression for $dateTrunc. NOTE: Requires MongoDB 5.0 or later.
static class	DateOperators.DayOfMonth	AggregationExpression for $dayOfMonth.
static class	DateOperators.DayOfWeek	AggregationExpression for $dayOfWeek.
static class	DateOperators.DayOfYear	AggregationExpression for $dayOfYear.
static class	DateOperators.Hour	AggregationExpression for $hour.
static class	DateOperators.IsoDateFromParts	AggregationExpression for $dateFromParts using ISO week date. NOTE: Requires MongoDB 3.6 or later.
static class	DateOperators.IsoDayOfWeek	AggregationExpression for $isoDayOfWeek.
static class	DateOperators.IsoWeek	AggregationExpression for $isoWeek.
static class	DateOperators.IsoWeekYear	AggregationExpression for $isoWeekYear.
static class	DateOperators.Millisecond	AggregationExpression for $millisecond.
static class	DateOperators.Minute	AggregationExpression for $minute.
static class	DateOperators.Month	AggregationExpression for $month.
static class	DateOperators.Second	AggregationExpression for $second.
static interface	DateOperators.TemporalUnit	Interface defining a temporal unit for date operators.
static class	DateOperators.Timezone	Timezone represents a MongoDB timezone abstraction which can be represented with a timezone ID or offset as a String.
static class	DateOperators.TimezonedDateAggregationExpression	AggregationExpression capable of setting a given DateOperators.Timezone.
static class	DateOperators.TsIncrement	AggregationExpression for $tsIncrement.
static class	DateOperators.TsSecond	AggregationExpression for $tsSecond.
static class	DateOperators.Week	AggregationExpression for $week.
static class	DateOperators.Year	AggregationExpression for $year.

Constructor Summary

Constructors

Constructor	Description
DateOperators()

Method Summary

Modifier and Type	Method	Description
static DateOperators.DateFromPartsOperatorFactory	dateFromParts()	Construct 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 date String. To use a field reference or AggregationExpression as source of the date string consider DateOperators.DateOperatorFactory.fromString() or DateOperators.DateFromString.fromStringOf(AggregationExpression). NOTE: Requires MongoDB 3.6 or later.
static DateOperators.DateOperatorFactory	dateOf(String fieldReference)	Take the date referenced by given fieldReference.
static DateOperators.DateOperatorFactory	dateOf(AggregationExpression expression)	Take the date resulting from the given AggregationExpression.
static DateOperators.DateOperatorFactory	dateValue(Object value)	Take the given value as date.
static DateOperators.DateOperatorFactory	zonedDateOf(String fieldReference, DateOperators.Timezone timezone)	Take the date referenced by given fieldReference.
static DateOperators.DateOperatorFactory	zonedDateOf(AggregationExpression expression, DateOperators.Timezone timezone)	Take the date resulting from the given AggregationExpression.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DateOperators

public DateOperators()

Method Details

dateOf

public static DateOperators.DateOperatorFactory dateOf(String fieldReference)

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

public static DateOperators.DateOperatorFactory dateOf(AggregationExpression expression)

Take the date resulting from the given AggregationExpression.

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 given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateOperatorFactory.

Since:

3.3

dateValue

public static DateOperators.DateOperatorFactory dateValue(Object value)

Take the given value as date.
This can be one of:

• Date
• Calendar
• Instant
• ZonedDateTime
• Long
• Field
• AggregationExpression

Parameters:

value - must not be null.

Returns:

new instance of DateOperators.DateOperatorFactory.

Since:

2.1

dateFromParts

public static DateOperators.DateFromPartsOperatorFactory 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

public static DateOperators.DateFromString dateFromString(String value)

Construct a Date object from the given date String.
To use a field reference or AggregationExpression as source of the date string consider DateOperators.DateOperatorFactory.fromString() or DateOperators.DateFromString.fromStringOf(AggregationExpression).
NOTE: Requires MongoDB 3.6 or later.

Returns:

new instance of DateOperators.DateFromPartsOperatorFactory.

Since:

2.1