org.springframework.data.mongodb.core.aggregation

Class DateOperators.IsoDayOfWeek

java.lang.Object

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

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

All Implemented Interfaces:

AggregationExpression

Enclosing class:

DateOperators

public static class DateOperators.IsoDayOfWeek
extends DateOperators.TimezonedDateAggregationExpression

AggregationExpression for $isoDayOfWeek.

Author:

Christoph Strobl, Matt Morrissette

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.
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()
static DateOperators.IsoDayOfWeek	isoDayOfWeek(AggregationExpression expression) Creates new DateOperators.IsoDayOfWeek.
static DateOperators.IsoDayOfWeek	isoDayOfWeek(String fieldReference) Creates new DateOperators.IsoDayOfWeek.
static DateOperators.IsoDayOfWeek	isoDayWeek(Object value) Creates new DateOperators.IsoDayOfWeek.
com.mongodb.DBObject	toDbObject(AggregationOperationContext context) Turns the AggregationExpression into a DBObject within the given AggregationOperationContext.
com.mongodb.DBObject	toDbObject(Object value, AggregationOperationContext context)
protected List<Object>	values()
DateOperators.IsoDayOfWeek	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

Method Detail

isoDayWeek

public static DateOperators.IsoDayOfWeek isoDayWeek(Object value)

Creates new DateOperators.IsoDayOfWeek.

Parameters:

value - must not be null and resolve to field, expression or object that represents a date.

Returns:

new instance of DateOperators.IsoDayOfWeek.

Throws:

IllegalArgumentException - if given value is null.

Since:

2.1

isoDayOfWeek

public static DateOperators.IsoDayOfWeek isoDayOfWeek(String fieldReference)

Creates new DateOperators.IsoDayOfWeek.

Parameters:

fieldReference - must not be null.

Returns:

isoDayOfWeek

public static DateOperators.IsoDayOfWeek isoDayOfWeek(AggregationExpression expression)

Creates new DateOperators.IsoDayOfWeek.

Parameters:

expression - must not be null.

Returns:

withTimezone

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

Throws:

IllegalArgumentException - if given timezone is null.

Since:

2.1

getMongoMethod

protected String getMongoMethod()

toDbObject

public com.mongodb.DBObject toDbObject(AggregationOperationContext context)

Description copied from interface: AggregationExpression

Turns the AggregationExpression into a DBObject within the given AggregationOperationContext.

Specified by:

toDbObject in interface AggregationExpression

Returns:

toDbObject

public com.mongodb.DBObject toDbObject(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