Module spring.data.mongodb

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

Class DateOperators.DateFromParts

java.lang.Object

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

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

All Implemented Interfaces:

AggregationExpression, DateOperators.DateParts<DateOperators.DateFromParts>, MongoExpression

Enclosing class:

DateOperators

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

AggregationExpression for $dateFromParts.
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	Description
static interface	DateOperators.DateFromParts.DateFromPartsWithYear

Method Summary

Modifier and Type	Method	Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	appendAt(int index, String key, Object value)	Append the given key at the position in the underlying LinkedHashMap.
protected Map<String,Object>	appendTo(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.DateFromParts.DateFromPartsWithYear	dateFromParts()	Creates new DateOperators.DateFromParts.DateFromPartsWithYear.
DateOperators.DateFromParts	day(Object day)	Set the day to the given value which must resolve to a calendar day in range 1 - 31.
DateOperators.DateFromParts	dayOf(String fieldReference)	Set the day to the value resolved by following the given field reference.
DateOperators.DateFromParts	dayOf(AggregationExpression expression)	Set the day to the result of the given expression.
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.DateFromParts	hour(Object hour)	Set the hour to the given value which must resolve to a value in range of 0 - 23.
protected boolean	isArgumentMap()
DateOperators.DateFromParts	millisecond(Object millisecond)	Set the millisecond to the given value which must resolve to a value in range 0 - 999.
DateOperators.DateFromParts	minute(Object minute)	Set the minute to the given value which must resolve to a value in range 0 - 59.
DateOperators.DateFromParts	month(Object month)	Set the month to the given value which must resolve to a calendar month in range 1 - 12.
DateOperators.DateFromParts	monthOf(String fieldReference)	Set the month to the value resolved by following the given field reference.
DateOperators.DateFromParts	monthOf(AggregationExpression expression)	Set the month to the result of the given expression.
protected Map<String,Object>	remove(String key)
DateOperators.DateFromParts	second(Object second)	Set the second to the given value which must resolve to a value in range 0 - 59.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
protected List<Object>	values()
DateOperators.DateFromParts	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.AggregationExpression

toDocument

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.DateOperators.DateParts

hourOf, hourOf, millisecondOf, millisecondOf, minuteOf, minuteOf, secondOf, secondOf

Method Details

dateFromParts

public static DateOperators.DateFromParts.DateFromPartsWithYear dateFromParts()

Creates new DateOperators.DateFromParts.DateFromPartsWithYear.

Returns:

new instance of DateOperators.DateFromParts.DateFromPartsWithYear.

Since:

2.1

month

public DateOperators.DateFromParts month(Object month)

Set the month to the given value which must resolve to a calendar month in range 1 - 12. Can be a simple value, field reference or expression.

Parameters:

month - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given month is null.

monthOf

public DateOperators.DateFromParts monthOf(String fieldReference)

Set the month 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.

monthOf

public DateOperators.DateFromParts monthOf(AggregationExpression expression)

Set the month to the result of the given expression.

Parameters:

expression - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given expression is null.

day

public DateOperators.DateFromParts day(Object day)

Set the day to the given value which must resolve to a calendar day in range 1 - 31. Can be a simple value, field reference or expression.

Parameters:

day - must not be null.

Returns:

new instance.

Throws:

IllegalArgumentException - if given day is null.

dayOf

public DateOperators.DateFromParts dayOf(String fieldReference)

Set the day 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.

dayOf

public DateOperators.DateFromParts dayOf(AggregationExpression expression)

Set the day 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.DateFromParts 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.DateFromParts>

Parameters:

hour - must not be null.

Returns:

new instance.

minute

public DateOperators.DateFromParts 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.DateFromParts>

Parameters:

minute - must not be null.

Returns:

new instance.

second

public DateOperators.DateFromParts 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.DateFromParts>

Parameters:

second - must not be null.

Returns:

new instance.

millisecond

public DateOperators.DateFromParts millisecond(Object millisecond)

Description copied from interface: DateOperators.DateParts

Set the millisecond 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:

millisecond in interface DateOperators.DateParts<DateOperators.DateFromParts>

Parameters:

millisecond - must not be null.

Returns:

new instance.

withTimezone

public DateOperators.DateFromParts 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.DateFromParts.

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

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.

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,
 org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

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

appendTo

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

remove

protected Map<String,Object> remove(String key)

appendAt

protected Map<String,Object> appendAt(int index,
 String key,
 Object value)

Append the given key at the position in the underlying LinkedHashMap.

Parameters:

index -

key -

value -

Returns:

Since:

3.1

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

isArgumentMap

protected boolean isArgumentMap()

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