Module spring.data.mongodb

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

Class DateOperators.DateTrunc

java.lang.Object

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

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

DateOperators

public static class DateOperators.DateTrunc
extends DateOperators.TimezonedDateAggregationExpression

AggregationExpression for $dateTrunc.
NOTE: Requires MongoDB 5.0 or later.

Since:

4.0

Author:

Christoph Strobl

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)
DateOperators.DateTrunc	binSize(int binSize)	Define the numeric time value.
DateOperators.DateTrunc	binSize(Object binSize)	Define the numeric time value.
DateOperators.DateTrunc	binSize(AggregationExpression expression)	Define the numeric time value via an AggregationExpression.
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()
protected boolean	isArgumentMap()
protected Map<String,Object>	remove(String key)
DateOperators.DateTrunc	startOfWeek(String day)	Define the weeks starting day if to(String) resolves to week.
DateOperators.DateTrunc	startOfWeek(DayOfWeek day)	Define the weeks starting day if to(String) resolves to week.
DateOperators.DateTrunc	to(String unit)	Define the unit of time.
DateOperators.DateTrunc	to(AggregationExpression unit)	Define the unit of time via an AggregationExpression.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
static DateOperators.DateTrunc	truncateValue(Object value)	Truncates the date value.
static DateOperators.DateTrunc	truncateValueOf(String fieldReference)	Truncates the date value of the referenced field.
static DateOperators.DateTrunc	truncateValueOf(AggregationExpression expression)	Truncates the date value of computed by the given AggregationExpression.
protected List<Object>	values()
DateOperators.DateTrunc	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

truncateValueOf

public static DateOperators.DateTrunc truncateValueOf(AggregationExpression expression)

Truncates the date value of computed by the given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

truncateValueOf

public static DateOperators.DateTrunc truncateValueOf(String fieldReference)

Truncates the date value of the referenced field.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

truncateValue

public static DateOperators.DateTrunc truncateValue(Object value)

Truncates the date value.

Parameters:

value - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

to

public DateOperators.DateTrunc to(String unit)

Define the unit of time.

Parameters:

unit - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

to

public DateOperators.DateTrunc to(AggregationExpression unit)

Define the unit of time via an AggregationExpression.

Parameters:

unit - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

startOfWeek

public DateOperators.DateTrunc startOfWeek(DayOfWeek day)

Define the weeks starting day if to(String) resolves to week.

Parameters:

day - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

startOfWeek

public DateOperators.DateTrunc startOfWeek(String day)

Define the weeks starting day if to(String) resolves to week.

Parameters:

day - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

binSize

public DateOperators.DateTrunc binSize(int binSize)

Define the numeric time value.

Parameters:

binSize - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

binSize

public DateOperators.DateTrunc binSize(AggregationExpression expression)

Define the numeric time value via an AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

binSize

public DateOperators.DateTrunc binSize(Object binSize)

Define the numeric time value.

Parameters:

binSize - must not be null.

Returns:

new instance of DateOperators.DateTrunc.

withTimezone

public DateOperators.DateTrunc withTimezone(DateOperators.Timezone timezone)

Optionally set the DateOperators.Timezone to use. If not specified UTC is used.

Specified by:

withTimezone in class DateOperators.TimezonedDateAggregationExpression

Parameters:

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

Returns:

new instance of DateOperators.DateTrunc.

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,
 org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

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