Module spring.data.mongodb

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

Class DateOperators.DateFromPartsOperatorFactory

java.lang.Object

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

Enclosing class:

DateOperators

public static class DateOperators.DateFromPartsOperatorFactory
extends Object

Since:

2.1

Author:

Matt Morrissette, Christoph Strobl

Method Summary

Modifier and Type	Method	Description
DateOperators.IsoDateFromParts	isoWeekYear(Object isoWeekYear)	Set the week date year to the given value which must resolve to a weekday in range 0 - 9999.
DateOperators.IsoDateFromParts	isoWeekYearOf(String fieldReference)	Set the week date year to the value resolved by following the given field reference.
DateOperators.IsoDateFromParts	isoWeekYearOf(AggregationExpression expression)	Set the week date year to the result of the given expression.
DateOperators.DateFromPartsOperatorFactory	withTimezone(DateOperators.Timezone timezone)	Create a new DateOperators.DateFromPartsOperatorFactory bound to a given DateOperators.Timezone.
DateOperators.DateFromParts	year(Object year)	Set the year to the given value which must resolve to a calendar year.
DateOperators.DateFromParts	yearOf(String fieldReference)	Set the year to the value resolved by following the given field reference.
DateOperators.DateFromParts	yearOf(AggregationExpression expression)	Set the year to the result of the given expression.

Methods inherited from class java.lang.Object

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

Method Details

isoWeekYear

public DateOperators.IsoDateFromParts isoWeekYear(Object isoWeekYear)

Set the week date year to the given value which must resolve to a weekday in range 0 - 9999. Can be a simple value, field reference or expression.

Parameters:

isoWeekYear - must not be null.

Returns:

new instance of DateOperators.IsoDateFromParts with DateOperators.Timezone if set.

Throws:

IllegalArgumentException - if given isoWeekYear is null.

isoWeekYearOf

public DateOperators.IsoDateFromParts isoWeekYearOf(String fieldReference)

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

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.IsoDateFromParts with DateOperators.Timezone if set.

Throws:

IllegalArgumentException - if given fieldReference is null.

isoWeekYearOf

public DateOperators.IsoDateFromParts isoWeekYearOf(AggregationExpression expression)

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

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.IsoDateFromParts with DateOperators.Timezone if set.

Throws:

IllegalArgumentException - if given expression is null.

year

public DateOperators.DateFromParts year(Object year)

Set the year to the given value which must resolve to a calendar year. Can be a simple value, field reference or expression.

Parameters:

year - must not be null.

Returns:

new instance of DateOperators.DateFromParts with DateOperators.Timezone if set.

Throws:

IllegalArgumentException - if given year is null

yearOf

public DateOperators.DateFromParts yearOf(String fieldReference)

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

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.DateFromParts with DateOperators.Timezone if set.

Throws:

IllegalArgumentException - if given fieldReference is null.

yearOf

public DateOperators.DateFromParts yearOf(AggregationExpression expression)

Set the year to the result of the given expression.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateFromParts with DateOperators.Timezone if set.

Throws:

IllegalArgumentException - if given expression is null.

withTimezone

public DateOperators.DateFromPartsOperatorFactory withTimezone(DateOperators.Timezone timezone)

Create a new DateOperators.DateFromPartsOperatorFactory bound to a given DateOperators.Timezone.

Parameters:

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

Returns:

new instance of DateOperators.DateFromPartsOperatorFactory.

Throws:

IllegalArgumentException - if given timezone is null.