org.springframework.data.mongodb.core.aggregation

Class DateOperators.IsoWeek

java.lang.Object

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

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

All Implemented Interfaces:

AggregationExpression

Enclosing class:

DateOperators

public static class DateOperators.IsoWeek
extends DateOperators.TimezonedDateAggregationExpression

AggregationExpression for $isoWeek.

Author:

Christoph Strobl, Matt Morrissette

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAggregationExpression.Expand Expand a nested list of values to single entries or keep the list.

Method Summary

Modifier and Type	Method and Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, 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>	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.IsoWeek	isoWeek(Object value) Creates new DateOperators.IsoWeek.
static DateOperators.IsoWeek	isoWeekOf(AggregationExpression expression) Creates new DateOperators.IsoWeek.
static DateOperators.IsoWeek	isoWeekOf(String fieldReference) Creates new DateOperators.IsoWeek.
protected Map<String,Object>	remove(String key)
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.IsoWeek	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

isoWeek

public static DateOperators.IsoWeek isoWeek(Object value)

Creates new DateOperators.IsoWeek.

Parameters:

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

Returns:

new instance of DateOperators.IsoWeek.

Throws:

IllegalArgumentException - if given value is null.

Since:

2.1

isoWeekOf

public static DateOperators.IsoWeek isoWeekOf(String fieldReference)

Creates new DateOperators.IsoWeek.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.IsoWeek.

isoWeekOf

public static DateOperators.IsoWeek isoWeekOf(AggregationExpression expression)

Creates new DateOperators.IsoWeek.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.IsoWeek.

withTimezone

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

Throws:

IllegalArgumentException - if given timezone is null.

Since:

2.1

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,
                              AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(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

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