public static class DateOperators.DateOperatorFactory extends Object
Constructor and Description |
---|
DateOperatorFactory(AggregationExpression expression)
Creates new
DateOperators.DateOperatorFactory for given AggregationExpression . |
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. |
Modifier and Type | Method and Description |
---|---|
DateOperators.DateAdd |
add(Object value,
DateOperators.TemporalUnit unit)
Creates new
AggregationExpression that adds the given value (in units). |
DateOperators.DateAdd |
add(Object value,
String unit)
Creates new
AggregationExpression that adds the given value (in units). |
DateOperators.DateAdd |
addValueOf(AggregationExpression expression,
DateOperators.TemporalUnit unit)
Creates new
AggregationExpression that adds the value of the given expression (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(String fieldReference,
DateOperators.TemporalUnit unit)
Creates new
AggregationExpression that adds the value stored at the given field (in
units). |
DateOperators.DateAdd |
addValueOf(String fieldReference,
String unit)
Creates new
AggregationExpression that adds the value stored at the given field (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,
DateOperators.TemporalUnit unit)
Creates new
AggregationExpression that calculates the difference (in units) to the date given
value. |
DateOperators.DateDiff |
diff(Object value,
String unit)
Creates new
AggregationExpression that calculates the difference (in units) to the date given
value. |
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.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(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(String fieldReference,
String unit)
Creates new
AggregationExpression that calculates the difference (in units) to the date stored
at the given field. |
DateOperators.DateFromString |
fromString()
Creates new
AggregationExpression that converts a date/time string to a date object. |
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.DateToParts |
toParts()
Creates new
AggregationExpression that returns a document containing the constituent parts of the date as
individual properties. |
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.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 . |
DateOperators.Year |
year()
Creates new
AggregationExpression that returns the year portion of a date. |
public DateOperatorFactory(String fieldReference)
DateOperators.DateOperatorFactory
for given fieldReference.fieldReference
- must not be null.public DateOperatorFactory(AggregationExpression expression)
DateOperators.DateOperatorFactory
for given AggregationExpression
.expression
- must not be null.public DateOperatorFactory(Object value)
value
- must not be null.public DateOperators.DateOperatorFactory withTimezone(DateOperators.Timezone timezone)
DateOperators.DateOperatorFactory
bound to a given DateOperators.Timezone
.timezone
- must not be null. Use DateOperators.Timezone.none()
instead.DateOperators.DateOperatorFactory
.IllegalArgumentException
- if given timezone is null.public DateOperators.DateAdd addValueOf(AggregationExpression expression, String unit)
AggregationExpression
that adds the value of the given expression
(in units).expression
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateAdd addValueOf(AggregationExpression expression, DateOperators.TemporalUnit unit)
AggregationExpression
that adds the value of the given expression
(in units).expression
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateAdd addValueOf(String fieldReference, String unit)
AggregationExpression
that adds the value stored at the given field (in
units).fieldReference
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateAdd addValueOf(String fieldReference, DateOperators.TemporalUnit unit)
AggregationExpression
that adds the value stored at the given field (in
units).fieldReference
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateAdd add(Object value, String unit)
AggregationExpression
that adds the given value (in units).value
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
.public DateOperators.DateAdd add(Object value, DateOperators.TemporalUnit unit)
AggregationExpression
that adds the given value (in units).value
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
.public DateOperators.DayOfYear dayOfYear()
AggregationExpression
that returns the day of the year for a date as a number between 1 and
366.DateOperators.DayOfYear
.public DateOperators.DayOfMonth dayOfMonth()
AggregationExpression
that returns the day of the month for a date as a number between 1 and
31.DateOperators.DayOfMonth
.public DateOperators.DayOfWeek dayOfWeek()
AggregationExpression
that returns the day of the week for a date as a number between 1
(Sunday) and 7 (Saturday).DateOperators.DayOfWeek
.public DateOperators.DateDiff diffValueOf(AggregationExpression expression, String unit)
AggregationExpression
that calculates the difference (in units) to the date
computed by the given expression
.expression
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateDiff diffValueOf(AggregationExpression expression, DateOperators.TemporalUnit unit)
AggregationExpression
that calculates the difference (in units) to the date
computed by the given expression
.expression
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateDiff diffValueOf(String fieldReference, String unit)
AggregationExpression
that calculates the difference (in units) to the date stored
at the given field.fieldReference
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateDiff diffValueOf(String fieldReference, DateOperators.TemporalUnit unit)
AggregationExpression
that calculates the difference (in units) to the date stored
at the given field.fieldReference
- must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateDiff diff(Object value, String unit)
AggregationExpression
that calculates the difference (in units) to the date given
value.value
- anything the resolves to a valid date. Must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.DateDiff diff(Object value, DateOperators.TemporalUnit unit)
AggregationExpression
that calculates the difference (in units) to the date given
value.value
- anything the resolves to a valid date. Must not be null.unit
- the unit of measure. Must not be null.DateOperators.DateAdd
. @since 3.3public DateOperators.Year year()
AggregationExpression
that returns the year portion of a date.DateOperators.Year
.public DateOperators.Month month()
AggregationExpression
that returns the month of a date as a number between 1 and 12.DateOperators.Month
.public DateOperators.Week week()
AggregationExpression
that returns the week of the year for a date as a number between 0 and
53.DateOperators.Week
.public DateOperators.Hour hour()
AggregationExpression
that returns the hour portion of a date as a number between 0 and 23.DateOperators.Hour
.public DateOperators.Minute minute()
AggregationExpression
that returns the minute portion of a date as a number between 0 and 59.DateOperators.Minute
.public DateOperators.Second second()
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.Second
.public DateOperators.Millisecond millisecond()
AggregationExpression
that returns the millisecond portion of a date as an integer between 0
and 999.DateOperators.Millisecond
.public DateOperators.DateToString toString(String format)
AggregationExpression
that converts a date object to a string according to a user-specified
format.format
- must not be null.DateOperators.DateToString
.public DateOperators.DateToString toStringWithDefaultFormat()
AggregationExpression
that converts a date object to a string according to the server default
format.DateOperators.DateToString
.public DateOperators.IsoDayOfWeek isoDayOfWeek()
AggregationExpression
that returns the weekday number in ISO 8601-2018 format, ranging from 1
(for Monday) to 7 (for Sunday).DateOperators.IsoDayOfWeek
.public DateOperators.IsoWeek isoWeek()
AggregationExpression
that returns the week number in ISO 8601-2018 format, ranging from 1 to
53.DateOperators.IsoWeek
.public DateOperators.IsoWeekYear isoWeekYear()
AggregationExpression
that returns the year number in ISO 8601-2018 format.DateOperators.IsoWeekYear
.public DateOperators.DateToParts toParts()
AggregationExpression
that returns a document containing the constituent parts of the date as
individual properties.DateOperators.DateToParts
.public DateOperators.DateFromString fromString()
AggregationExpression
that converts a date/time string to a date object.DateOperators.DateFromString
.Copyright © 2011–2022 Pivotal Software, Inc.. All rights reserved.