Module spring.data.mongodb

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

Class DateOperators.DateToString

java.lang.Object

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

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

DateOperators

public static class DateOperators.DateToString
extends DateOperators.TimezonedDateAggregationExpression

AggregationExpression for $dateToString.

Author:

Christoph Strobl, Matt Morrissette

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DateOperators.DateToString.FormatBuilder

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.DateToString.FormatBuilder	dateOf(String fieldReference)	Creates new DateOperators.DateToString.FormatBuilder allowing to define the date format to apply.
static DateOperators.DateToString.FormatBuilder	dateOf(AggregationExpression expression)	Creates new DateOperators.DateToString.FormatBuilder allowing to define the date format to apply.
static DateOperators.DateToString.FormatBuilder	dateToString(Object value)	Creates new DateOperators.DateToString.FormatBuilder.
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()
protected boolean	isArgumentMap()
DateOperators.DateToString	onNullReturn(Object value)	Optionally specify the value to return when the date is null or missing.
DateOperators.DateToString	onNullReturnValueOf(String fieldReference)	Optionally specify the field holding the value to return when the date is null or missing.
DateOperators.DateToString	onNullReturnValueOf(AggregationExpression expression)	Optionally specify the expression to evaluate and return when the date is null or missing.
protected Map<String,Object>	remove(String key)
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.DateToString	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

Method Details

dateToString

public static DateOperators.DateToString.FormatBuilder dateToString(Object value)

Creates new DateOperators.DateToString.FormatBuilder.

Parameters:

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

Returns:

new instance of DateOperators.DateToString.FormatBuilder.

Throws:

IllegalArgumentException - if given value is null.

Since:

2.1

dateOf

public static DateOperators.DateToString.FormatBuilder dateOf(String fieldReference)

Creates new DateOperators.DateToString.FormatBuilder allowing to define the date format to apply.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.DateToString.FormatBuilder to crate DateOperators.DateToString.

dateOf

public static DateOperators.DateToString.FormatBuilder dateOf(AggregationExpression expression)

Creates new DateOperators.DateToString.FormatBuilder allowing to define the date format to apply.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateToString.FormatBuilder to crate DateOperators.DateToString.

withTimezone

public DateOperators.DateToString 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.Millisecond.

Throws:

IllegalArgumentException - if given timezone is null.

Since:

2.1

onNullReturn

public DateOperators.DateToString onNullReturn(Object value)

Optionally specify the value to return when the date is null or missing.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

value - must not be null.

Returns:

new instance of DateOperators.DateToString.

Since:

2.1

onNullReturnValueOf

public DateOperators.DateToString onNullReturnValueOf(String fieldReference)

Optionally specify the field holding the value to return when the date is null or missing.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.DateToString.

Since:

2.1

onNullReturnValueOf

public DateOperators.DateToString onNullReturnValueOf(AggregationExpression expression)

Optionally specify the expression to evaluate and return when the date is null or missing.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateToString.

Since:

2.1

getMongoMethod

protected String getMongoMethod()

append

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

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)

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