Module spring.data.mongodb

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

Class DateOperators.DateSubtract

java.lang.Object

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

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

DateOperators

public static class DateOperators.DateSubtract
extends DateOperators.TimezonedDateAggregationExpression

AggregationExpression for $dateSubtract.
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)
protected boolean	contains(Object key)	Check if the given key is available.
DateOperators.DateSubtract	fromDate(Object dateExpression)	Define the start date, in UTC, for the subtraction operation.
DateOperators.DateSubtract	fromDateOf(String fieldReference)	Define the start date, in UTC, for the subtraction operation.
DateOperators.DateSubtract	fromDateOf(AggregationExpression expression)	Define the start date, in UTC, for the subtraction operation.
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)
static DateOperators.DateSubtract	subtractValue(Object value, String unit)	Subtract the number of units from a start date.
static DateOperators.DateSubtract	subtractValueOf(String fieldReference, String unit)	Subtract the number of units from a field from a start date.
static DateOperators.DateSubtract	subtractValueOf(AggregationExpression expression, String unit)	Subtract the number of units of the result of the given expression from a start date.
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.DateSubtract	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

subtractValueOf

public static DateOperators.DateSubtract subtractValueOf(AggregationExpression expression,
 String unit)

Subtract the number of units of the result of the given expression from a start date.

Parameters:

expression - must not be null.

unit - must not be null.

Returns:

new instance of DateOperators.DateSubtract.

subtractValueOf

public static DateOperators.DateSubtract subtractValueOf(String fieldReference,
 String unit)

Subtract the number of units from a field from a start date.

Parameters:

fieldReference - must not be null.

unit - must not be null.

Returns:

new instance of DateOperators.DateSubtract.

subtractValue

public static DateOperators.DateSubtract subtractValue(Object value,
 String unit)

Subtract the number of units from a start date.

Parameters:

value - must not be null.

unit - must not be null.

Returns:

new instance of DateOperators.DateSubtract.

fromDateOf

public DateOperators.DateSubtract fromDateOf(AggregationExpression expression)

Define the start date, in UTC, for the subtraction operation.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateSubtract.

fromDateOf

public DateOperators.DateSubtract fromDateOf(String fieldReference)

Define the start date, in UTC, for the subtraction operation.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.DateSubtract.

fromDate

public DateOperators.DateSubtract fromDate(Object dateExpression)

Define the start date, in UTC, for the subtraction operation.

Parameters:

dateExpression - anything that evaluates to a valid date. Must not be null.

Returns:

new instance of DateOperators.DateSubtract.

withTimezone

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

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