Module spring.data.mongodb

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

Class DateOperators.DateOperatorFactory

java.lang.Object

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

Enclosing class:

DateOperators

public static class DateOperators.DateOperatorFactory
extends Object

Author:

Christoph Strobl, Matt Morrissette

Constructor Summary

Constructors

Constructor	Description
DateOperatorFactory(Object value)	Creates new DateOperators.DateOperatorFactory for given value that resolves to a Date.
DateOperatorFactory(String fieldReference)	Creates new DateOperators.DateOperatorFactory for given fieldReference.
DateOperatorFactory(AggregationExpression expression)	Creates new DateOperators.DateOperatorFactory for given AggregationExpression.

Method Summary

Modifier and Type	Method	Description
DateOperators.DateAdd	add(Object value, String unit)	Creates new AggregationExpression that adds the given value (in units).
DateOperators.DateAdd	add(Object value, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that adds the given value (in units).
DateOperators.DateAdd	addValueOf(String fieldReference, String unit)	Creates new AggregationExpression that adds the value stored at the given field (in units).
DateOperators.DateAdd	addValueOf(String fieldReference, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that adds the value stored at the given field (in units).
DateOperators.DateAdd	addValueOf(AggregationExpression expression, String unit)	Creates new AggregationExpression that adds the value of the given expression (in units).
DateOperators.DateAdd	addValueOf(AggregationExpression expression, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that adds the value of the given expression (in units).
DateOperators.DayOfMonth	dayOfMonth()	Creates new AggregationExpression that returns the day of the month for a date as a number between 1 and 31.
DateOperators.DayOfWeek	dayOfWeek()	Creates new AggregationExpression that returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).
DateOperators.DayOfYear	dayOfYear()	Creates new AggregationExpression that returns the day of the year for a date as a number between 1 and 366.
DateOperators.DateDiff	diff(Object value, String unit)	Creates new AggregationExpression that calculates the difference (in units) to the date given value.
DateOperators.DateDiff	diff(Object value, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that calculates the difference (in units) to the date given value.
DateOperators.DateDiff	diffValueOf(String fieldReference, String unit)	Creates new AggregationExpression that calculates the difference (in units) to the date stored at the given field.
DateOperators.DateDiff	diffValueOf(String fieldReference, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that calculates the difference (in units) to the date stored at the given field.
DateOperators.DateDiff	diffValueOf(AggregationExpression expression, String unit)	Creates new AggregationExpression that calculates the difference (in units) to the date computed by the given expression.
DateOperators.DateDiff	diffValueOf(AggregationExpression expression, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that calculates the difference (in units) to the date computed by the given expression.
DateOperators.DateFromString	fromString()	Creates new AggregationExpression that converts a date/time string to a date object. NOTE: Requires MongoDB 3.6 or later.
DateOperators.Hour	hour()	Creates new AggregationExpression that returns the hour portion of a date as a number between 0 and 23.
DateOperators.IsoDayOfWeek	isoDayOfWeek()	Creates new AggregationExpression that returns the weekday number in ISO 8601-2018 format, ranging from 1 (for Monday) to 7 (for Sunday).
DateOperators.IsoWeek	isoWeek()	Creates new AggregationExpression that returns the week number in ISO 8601-2018 format, ranging from 1 to 53.
DateOperators.IsoWeekYear	isoWeekYear()	Creates new AggregationExpression that returns the year number in ISO 8601-2018 format.
DateOperators.Millisecond	millisecond()	Creates new AggregationExpression that returns the millisecond portion of a date as an integer between 0 and 999.
DateOperators.Minute	minute()	Creates new AggregationExpression that returns the minute portion of a date as a number between 0 and 59.
DateOperators.Month	month()	Creates new AggregationExpression that returns the month of a date as a number between 1 and 12.
DateOperators.Second	second()	Creates new AggregationExpression that returns the second portion of a date as a number between 0 and 59, but can be 60 to account for leap seconds.
DateOperators.DateSubtract	subtract(Object value, String unit)	Creates new AggregationExpression that subtracts the given value (in units).
DateOperators.DateSubtract	subtract(Object value, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that subtracts the given value (in units).
DateOperators.DateSubtract	subtractValueOf(String fieldReference, String unit)	Creates new AggregationExpression that subtracts the value stored at the given field (in units).
DateOperators.DateSubtract	subtractValueOf(String fieldReference, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that subtracts the value stored at the given field (in units).
DateOperators.DateSubtract	subtractValueOf(AggregationExpression expression, String unit)	Creates new AggregationExpression that subtracts the value of the given expression (in units).
DateOperators.DateSubtract	subtractValueOf(AggregationExpression expression, DateOperators.TemporalUnit unit)	Creates new AggregationExpression that subtracts the value of the given expression (in units).
DateOperators.DateToParts	toParts()	Creates new AggregationExpression that returns a document containing the constituent parts of the date as individual properties. NOTE: Requires MongoDB 3.6 or later.
DateOperators.DateToString	toString(String format)	Creates new AggregationExpression that converts a date object to a string according to a user-specified format.
DateOperators.DateToString	toStringWithDefaultFormat()	Creates new AggregationExpression that converts a date object to a string according to the server default format.
DateOperators.DateTrunc	truncate(String unit)	Creates new AggregationExpression that truncates a date to the given unit.
DateOperators.DateTrunc	truncate(DateOperators.TemporalUnit unit)	Creates new AggregationExpression that truncates a date to the given unit.
DateOperators.TsIncrement	tsIncrement()	Creates new AggregationExpression that returns the incrementing ordinal from a timestamp.
DateOperators.TsSecond	tsSecond()	Creates new AggregationExpression that returns the seconds from a timestamp.
DateOperators.Week	week()	Creates new AggregationExpression that returns the week of the year for a date as a number between 0 and 53.
DateOperators.DateOperatorFactory	withTimezone(DateOperators.Timezone timezone)	Create a new DateOperators.DateOperatorFactory bound to a given DateOperators.Timezone. NOTE: Requires Mongo 3.6 or later.
DateOperators.Year	year()	Creates new AggregationExpression that returns the year portion of a date.

Methods inherited from class java.lang.Object

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

Constructor Details

DateOperatorFactory

public DateOperatorFactory(String fieldReference)

Creates new DateOperators.DateOperatorFactory for given fieldReference.

Parameters:

fieldReference - must not be null.

DateOperatorFactory

public DateOperatorFactory(AggregationExpression expression)

Creates new DateOperators.DateOperatorFactory for given AggregationExpression.

Parameters:

expression - must not be null.

DateOperatorFactory

public DateOperatorFactory(Object value)

Creates new DateOperators.DateOperatorFactory for given value that resolves to a Date.

• Date
• Calendar
• Instant
• ZonedDateTime
• Long

Parameters:

value - must not be null.

Since:

2.1

Method Details

withTimezone

public DateOperators.DateOperatorFactory withTimezone(DateOperators.Timezone timezone)

Create a new DateOperators.DateOperatorFactory bound to a given DateOperators.Timezone.
NOTE: Requires Mongo 3.6 or later.

Parameters:

timezone - must not be null. Use DateOperators.Timezone.none() instead.

Returns:

new instance of DateOperators.DateOperatorFactory.

Throws:

IllegalArgumentException - if given timezone is null.

Since:

2.1

addValueOf

public DateOperators.DateAdd addValueOf(AggregationExpression expression,
 String unit)

Creates new AggregationExpression that adds the value of the given expression (in units).

Parameters:

expression - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

addValueOf

public DateOperators.DateAdd addValueOf(AggregationExpression expression,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that adds the value of the given expression (in units).

Parameters:

expression - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

addValueOf

public DateOperators.DateAdd addValueOf(String fieldReference,
 String unit)

Creates new AggregationExpression that adds the value stored at the given field (in units).

Parameters:

fieldReference - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

addValueOf

public DateOperators.DateAdd addValueOf(String fieldReference,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that adds the value stored at the given field (in units).

Parameters:

fieldReference - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

add

public DateOperators.DateAdd add(Object value,
 String unit)

Creates new AggregationExpression that adds the given value (in units).

Parameters:

value - must not be null.

unit - the unit of measure. Must not be null.

Returns:

Since:

3.3 new instance of DateOperators.DateAdd.

add

public DateOperators.DateAdd add(Object value,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that adds the given value (in units).

Parameters:

value - must not be null.

unit - the unit of measure. Must not be null.

Returns:

Since:

3.3 new instance of DateOperators.DateAdd.

subtractValueOf

public DateOperators.DateSubtract subtractValueOf(AggregationExpression expression,
 String unit)

Creates new AggregationExpression that subtracts the value of the given expression (in units).

Parameters:

expression - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateSubtract.

Since:

4.0

subtractValueOf

public DateOperators.DateSubtract subtractValueOf(AggregationExpression expression,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that subtracts the value of the given expression (in units).

Parameters:

expression - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateSubtract.

Since:

4.0

subtractValueOf

public DateOperators.DateSubtract subtractValueOf(String fieldReference,
 String unit)

Creates new AggregationExpression that subtracts the value stored at the given field (in units).

Parameters:

fieldReference - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateSubtract.

Since:

4.0

subtractValueOf

public DateOperators.DateSubtract subtractValueOf(String fieldReference,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that subtracts the value stored at the given field (in units).

Parameters:

fieldReference - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateSubtract.

Since:

4.0

subtract

public DateOperators.DateSubtract subtract(Object value,
 String unit)

Creates new AggregationExpression that subtracts the given value (in units).

Parameters:

value - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateSubtract.

Since:

4.0

subtract

public DateOperators.DateSubtract subtract(Object value,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that subtracts the given value (in units).

Parameters:

value - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateSubtract.

Since:

4.0

truncate

public DateOperators.DateTrunc truncate(String unit)

Creates new AggregationExpression that truncates a date to the given unit.

Parameters:

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateTrunc.

Since:

4.0

truncate

public DateOperators.DateTrunc truncate(DateOperators.TemporalUnit unit)

Creates new AggregationExpression that truncates a date to the given unit.

Parameters:

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateTrunc.

Since:

4.0

dayOfYear

public DateOperators.DayOfYear dayOfYear()

Creates new AggregationExpression that returns the day of the year for a date as a number between 1 and 366.

Returns:

new instance of DateOperators.DayOfYear.

dayOfMonth

public DateOperators.DayOfMonth dayOfMonth()

Creates new AggregationExpression that returns the day of the month for a date as a number between 1 and 31.

Returns:

new instance of DateOperators.DayOfMonth.

dayOfWeek

public DateOperators.DayOfWeek dayOfWeek()

Creates new AggregationExpression that returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

Returns:

new instance of DateOperators.DayOfWeek.

diffValueOf

public DateOperators.DateDiff diffValueOf(AggregationExpression expression,
 String unit)

Creates new AggregationExpression that calculates the difference (in units) to the date computed by the given expression.

Parameters:

expression - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

diffValueOf

public DateOperators.DateDiff diffValueOf(AggregationExpression expression,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that calculates the difference (in units) to the date computed by the given expression.

Parameters:

expression - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

diffValueOf

public DateOperators.DateDiff diffValueOf(String fieldReference,
 String unit)

Creates new AggregationExpression that calculates the difference (in units) to the date stored at the given field.

Parameters:

fieldReference - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

diffValueOf

public DateOperators.DateDiff diffValueOf(String fieldReference,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that calculates the difference (in units) to the date stored at the given field.

Parameters:

fieldReference - must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

diff

public DateOperators.DateDiff diff(Object value,
 String unit)

Creates new AggregationExpression that calculates the difference (in units) to the date given value.

Parameters:

value - anything the resolves to a valid date. Must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

diff

public DateOperators.DateDiff diff(Object value,
 DateOperators.TemporalUnit unit)

Creates new AggregationExpression that calculates the difference (in units) to the date given value.

Parameters:

value - anything the resolves to a valid date. Must not be null.

unit - the unit of measure. Must not be null.

Returns:

new instance of DateOperators.DateAdd. @since 3.3

year

public DateOperators.Year year()

Creates new AggregationExpression that returns the year portion of a date.

Returns:

new instance of DateOperators.Year.

month

public DateOperators.Month month()

Creates new AggregationExpression that returns the month of a date as a number between 1 and 12.

Returns:

new instance of DateOperators.Month.

week

public DateOperators.Week week()

Creates new AggregationExpression that returns the week of the year for a date as a number between 0 and 53.

Returns:

new instance of DateOperators.Week.

hour

public DateOperators.Hour hour()

Creates new AggregationExpression that returns the hour portion of a date as a number between 0 and 23.

Returns:

new instance of DateOperators.Hour.

minute

public DateOperators.Minute minute()

Creates new AggregationExpression that returns the minute portion of a date as a number between 0 and 59.

Returns:

new instance of DateOperators.Minute.

second

public DateOperators.Second second()

Creates new AggregationExpression that returns the second portion of a date as a number between 0 and 59, but can be 60 to account for leap seconds.

Returns:

new instance of DateOperators.Second.

millisecond

public DateOperators.Millisecond millisecond()

Creates new AggregationExpression that returns the millisecond portion of a date as an integer between 0 and 999.

Returns:

new instance of DateOperators.Millisecond.

toString

public DateOperators.DateToString toString(String format)

Creates new AggregationExpression that converts a date object to a string according to a user-specified format.

Parameters:

format - must not be null.

Returns:

new instance of DateOperators.DateToString.

toStringWithDefaultFormat

public DateOperators.DateToString toStringWithDefaultFormat()

Creates new AggregationExpression that converts a date object to a string according to the server default format.

Returns:

new instance of DateOperators.DateToString.

Since:

2.1

isoDayOfWeek

public DateOperators.IsoDayOfWeek isoDayOfWeek()

Creates new AggregationExpression that returns the weekday number in ISO 8601-2018 format, ranging from 1 (for Monday) to 7 (for Sunday).

Returns:

new instance of DateOperators.IsoDayOfWeek.

isoWeek

public DateOperators.IsoWeek isoWeek()

Creates new AggregationExpression that returns the week number in ISO 8601-2018 format, ranging from 1 to 53.

Returns:

new instance of DateOperators.IsoWeek.

isoWeekYear

public DateOperators.IsoWeekYear isoWeekYear()

Creates new AggregationExpression that returns the year number in ISO 8601-2018 format.

Returns:

new instance of DateOperators.IsoWeekYear.

toParts

public DateOperators.DateToParts toParts()

Creates new AggregationExpression that returns a document containing the constituent parts of the date as individual properties.
NOTE: Requires MongoDB 3.6 or later.

Returns:

new instance of DateOperators.DateToParts.

Since:

2.1

fromString

public DateOperators.DateFromString fromString()

Creates new AggregationExpression that converts a date/time string to a date object.
NOTE: Requires MongoDB 3.6 or later.

Returns:

new instance of DateOperators.DateFromString.

Since:

2.1

tsIncrement

public DateOperators.TsIncrement tsIncrement()

Creates new AggregationExpression that returns the incrementing ordinal from a timestamp.

Returns:

new instance of DateOperators.TsIncrement.

Since:

4.0

tsSecond

public DateOperators.TsSecond tsSecond()

Creates new AggregationExpression that returns the seconds from a timestamp.

Returns:

new instance of DateOperators.TsIncrement.

Since:

4.0