Module spring.data.mongodb

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

Class SetWindowFieldsOperation.ComputedField

java.lang.Object

org.springframework.data.mongodb.core.aggregation.SetWindowFieldsOperation.ComputedField

All Implemented Interfaces:

Field

Enclosing class:

SetWindowFieldsOperation

public static class SetWindowFieldsOperation.ComputedField
extends Object
implements Field

A Field that the result of a computation done via an AggregationExpression.

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
ComputedField(String name, AggregationExpression windowOperator)	Create a new SetWindowFieldsOperation.ComputedField.
ComputedField(String name, AggregationExpression windowOperator, SetWindowFieldsOperation.Window window)	Create a new SetWindowFieldsOperation.ComputedField.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of the field.
String	getTarget()	Returns the target of the field.
SetWindowFieldsOperation.Window	getWindow()
AggregationExpression	getWindowOperator()
boolean	isAliased()	Returns whether the Field is aliased, which means it has a name set different from the target.

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.Field

isInternal

Constructor Details

ComputedField

public ComputedField(String name,
 AggregationExpression windowOperator)

Create a new SetWindowFieldsOperation.ComputedField.

Parameters:

name - the target field name.

windowOperator - the expression to calculate the field value.

ComputedField

public ComputedField(String name,
 AggregationExpression windowOperator,
 @Nullable
 SetWindowFieldsOperation.Window window)

Create a new SetWindowFieldsOperation.ComputedField.

Parameters:

name - the target field name.

windowOperator - the expression to calculate the field value.

window - the boundaries to operate within. Can be null.

Method Details

getName

public String getName()

Description copied from interface: Field

Returns the name of the field.

Specified by:

getName in interface Field

Returns:

must not be null.

getTarget

public String getTarget()

Description copied from interface: Field

Returns the target of the field. In case no explicit target is available Field.getName() should be returned.

Specified by:

getTarget in interface Field

Returns:

must not be null.

isAliased

public boolean isAliased()

Description copied from interface: Field

Returns whether the Field is aliased, which means it has a name set different from the target.

Specified by:

isAliased in interface Field

Returns:

getWindowOperator

public AggregationExpression getWindowOperator()

getWindow

public SetWindowFieldsOperation.Window getWindow()