org.springframework.data.mongodb.core.aggregation

Class DateOperators.TimezonedDateAggregationExpression

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression

Direct Known Subclasses:

DateOperators.DateFromParts, DateOperators.DateFromString, DateOperators.DateToParts, DateOperators.DateToString, DateOperators.DayOfMonth, DateOperators.DayOfWeek, DateOperators.DayOfYear, DateOperators.Hour, DateOperators.IsoDateFromParts, DateOperators.IsoDayOfWeek, DateOperators.IsoWeek, DateOperators.IsoWeekYear, DateOperators.Millisecond, DateOperators.Minute, DateOperators.Month, DateOperators.Second, DateOperators.Week, DateOperators.Year

Enclosing class:

DateOperators

public abstract static class DateOperators.TimezonedDateAggregationExpression
extends Object

AggregationExpression capable of setting a given DateOperators.Timezone.

Since:

2.1

Author:

Christoph Strobl

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimezonedDateAggregationExpression(Object value)

Method Summary

Modifier and Type	Method and Description
protected List<Object>	append(Object value)
protected Map<String,Object>	append(String key, Object value)
protected static Map<String,Object>	appendTimezone(Object source, DateOperators.Timezone timezone) Append the timezone to a given source.
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.
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 abstract String	getMongoMethod()
protected boolean	hasTimezone()
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()
protected abstract DateOperators.TimezonedDateAggregationExpression	withTimezone(DateOperators.Timezone timezone) Optionally set the DateOperators.Timezone to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimezonedDateAggregationExpression

protected TimezonedDateAggregationExpression(Object value)

Method Detail

appendTimezone

protected static Map<String,Object> appendTimezone(Object source,
                                                   DateOperators.Timezone timezone)

Append the timezone to a given source. The source itself can be a Map of already set properties or a single value. In case of single value source the value will be added as date property.

Parameters:

source - must not be null.

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

Returns:

withTimezone

protected abstract DateOperators.TimezonedDateAggregationExpression withTimezone(DateOperators.Timezone timezone)

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

Parameters:

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

Returns:

new instance.

Throws:

IllegalArgumentException - if given timezone is null.

hasTimezone

protected boolean hasTimezone()

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

getMongoMethod

protected abstract String getMongoMethod()