org.springframework.data.mongodb.core.aggregation

Class DateOperators.IsoDateFromParts

java.lang.Object

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

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

All Implemented Interfaces:

AggregationExpression, DateOperators.DateParts<DateOperators.IsoDateFromParts>

Enclosing class:

DateOperators

public static class DateOperators.IsoDateFromParts
extends DateOperators.TimezonedDateAggregationExpression
implements DateOperators.DateParts<DateOperators.IsoDateFromParts>

AggregationExpression for $dateFromParts using ISO week date.
NOTE: Requires MongoDB 3.6 or later.

Since:

2.1

Author:

Matt Morrissette, Christoph Strobl

See Also:

https://docs.mongodb.com/manual/reference/operator/aggregation/dateFromParts/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DateOperators.IsoDateFromParts.IsoDateFromPartsWithYear

Method Summary

Modifier and Type	Method and Description
protected List<Object>	append(Object value)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	argumentMap() Get the argument map.
protected static List<Field>	asFields(String... fieldRefs)
protected boolean	contains(Object key) Check if the given key is available.
static DateOperators.IsoDateFromParts.IsoDateFromPartsWithYear	dateFromParts() Creates new DateOperators.IsoDateFromParts.IsoDateFromPartsWithYear.
protected <T> T	get(int index) Get the value at a given index.
protected <T> T	get(Object key) Get the value for a given key.
protected String	getMongoMethod()
DateOperators.IsoDateFromParts	hour(Object hour) Set the hour to the given value which must resolve to a value in range of 0 - 23.
DateOperators.IsoDateFromParts	isoDayOfWeek(Object day) Set the day of week to the given value which must resolve to a weekday in range 1 - 7.
DateOperators.IsoDateFromParts	isoDayOfWeekOf(AggregationExpression expression) Set the day of week to the result of the given expression.
DateOperators.IsoDateFromParts	isoDayOfWeekOf(String fieldReference) Set the day of week to the value resolved by following the given field reference.
DateOperators.IsoDateFromParts	isoWeek(Object isoWeek) Set the week of year to the given value which must resolve to a calendar week in range 1 - 53.
DateOperators.IsoDateFromParts	isoWeekOf(AggregationExpression expression) Set the week of year to the result of the given expression.
DateOperators.IsoDateFromParts	isoWeekOf(String fieldReference) Set the week of year to the value resolved by following the given field reference.
DateOperators.IsoDateFromParts	milliseconds(Object milliseconds) Set the milliseconds to the given value which must resolve to a value in range 0 - 999.
DateOperators.IsoDateFromParts	minute(Object minute) Set the minute to the given value which must resolve to a value in range 0 - 59.
DateOperators.IsoDateFromParts	second(Object second) Set the second to the given value which must resolve to a value in range 0 - 59.
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationExpression into a Document within the given AggregationOperationContext.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
protected List<Object>	values()
DateOperators.IsoDateFromParts	withTimezone(DateOperators.Timezone timezone) Optionally set the DateOperators.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.DateOperators.DateParts

hourOf, hourOf, millisecondsOf, millisecondsOf, minuteOf, minuteOf, secondOf, secondOf

Method Detail

dateFromParts

public static DateOperators.IsoDateFromParts.IsoDateFromPartsWithYear dateFromParts()

Creates new DateOperators.IsoDateFromParts.IsoDateFromPartsWithYear.

Returns:

new instance of DateOperators.IsoDateFromParts.IsoDateFromPartsWithYear.

Since:

2.1

isoWeek

public DateOperators.IsoDateFromParts isoWeek(Object isoWeek)

Set the week of year to the given value which must resolve to a calendar week in range 1 - 53. Can be a simple value, field reference or expression.

Parameters:

isoWeek - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given isoWeek is null.

isoWeekOf

public DateOperators.IsoDateFromParts isoWeekOf(String fieldReference)

Set the week of year to the value resolved by following the given field reference.

Parameters:

fieldReference - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given fieldReference is null.

isoWeekOf

public DateOperators.IsoDateFromParts isoWeekOf(AggregationExpression expression)

Set the week of year to the result of the given expression.

Parameters:

expression - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given expression is null.

isoDayOfWeek

public DateOperators.IsoDateFromParts isoDayOfWeek(Object day)

Set the day of week to the given value which must resolve to a weekday in range 1 - 7. Can be a simple value, field reference or expression.

Parameters:

day - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given isoWeek is null.

isoDayOfWeekOf

public DateOperators.IsoDateFromParts isoDayOfWeekOf(String fieldReference)

Set the day of week to the value resolved by following the given field reference.

Parameters:

fieldReference - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given fieldReference is null.

isoDayOfWeekOf

public DateOperators.IsoDateFromParts isoDayOfWeekOf(AggregationExpression expression)

Set the day of week to the result of the given expression.

Parameters:

expression - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given expression is null.

hour

public DateOperators.IsoDateFromParts hour(Object hour)

Description copied from interface: DateOperators.DateParts

Set the hour to the given value which must resolve to a value in range of 0 - 23. Can be a simple value, field reference or expression.

Specified by:

hour in interface DateOperators.DateParts<DateOperators.IsoDateFromParts>

Parameters:

hour - must not be null.

Returns:

new instance.

minute

public DateOperators.IsoDateFromParts minute(Object minute)

Description copied from interface: DateOperators.DateParts

Set the minute to the given value which must resolve to a value in range 0 - 59. Can be a simple value, field reference or expression.

Specified by:

minute in interface DateOperators.DateParts<DateOperators.IsoDateFromParts>

Parameters:

minute - must not be null.

Returns:

new instance.

second

public DateOperators.IsoDateFromParts second(Object second)

Description copied from interface: DateOperators.DateParts

Set the second to the given value which must resolve to a value in range 0 - 59. Can be a simple value, field reference or expression.

Specified by:

second in interface DateOperators.DateParts<DateOperators.IsoDateFromParts>

Parameters:

second - must not be null.

Returns:

new instance.

milliseconds

public DateOperators.IsoDateFromParts milliseconds(Object milliseconds)

Description copied from interface: DateOperators.DateParts

Set the milliseconds to the given value which must resolve to a value in range 0 - 999. Can be a simple value, field reference or expression.

Specified by:

milliseconds in interface DateOperators.DateParts<DateOperators.IsoDateFromParts>

Parameters:

milliseconds - must not be null.

Returns:

new instance.

withTimezone

public DateOperators.IsoDateFromParts withTimezone(DateOperators.Timezone timezone)

Optionally set the DateOperators.Timezone to use. If not specified UTC is used.
NOTE: Requires MongoDB 3.6 or later.

Specified by:

withTimezone in class DateOperators.TimezonedDateAggregationExpression

Parameters:

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

Returns:

new instance of DateOperators.IsoDateFromParts.

Throws:

IllegalArgumentException - if given timezone is null.

getMongoMethod

protected String getMongoMethod()

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationExpression

Turns the AggregationExpression into a Document within the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationExpression

Returns:

toDocument

public org.bson.Document toDocument(Object value,
                                    AggregationOperationContext context)

asFields

protected static List<Field> asFields(String... fieldRefs)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(String key,
                                    Object value)

values

protected List<Object> 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

protected <T> T get(Object key)

Get the value for a given key.

Type Parameters:

T -

Parameters:

key -

Returns:

Since:

2.1

argumentMap

protected Map<String,Object> argumentMap()

Get the argument map.

Returns:

Since:

2.1

contains

protected boolean contains(Object key)

Check if the given key is available.

Parameters:

key -

Returns:

Since:

2.1