Module spring.data.mongodb

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

Class SetWindowFieldsOperation

java.lang.Object

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

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

public class SetWindowFieldsOperation
extends Object
implements AggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Encapsulates the setWindowFields-operation.

Since:

3.3

Author:

Christoph Strobl

See Also:

• https://docs.mongodb.com/manual/reference/operator/aggregation/setWindowFields/

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetWindowFieldsOperation.ComputedField	A Field that the result of a computation done via an AggregationExpression.
static class	SetWindowFieldsOperation.DocumentWindow	SetWindowFieldsOperation.Window implementation based on the current document.
static class	SetWindowFieldsOperation.DocumentWindowBuilder	Builder API for a SetWindowFieldsOperation.RangeWindow.
static class	SetWindowFieldsOperation.RangeWindow	SetWindowFieldsOperation.Window implementation based on the sort fields.
static class	SetWindowFieldsOperation.RangeWindowBuilder	Builder API for a SetWindowFieldsOperation.RangeWindow.
static class	SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	A fluent builder to create a SetWindowFieldsOperation.
static interface	SetWindowFieldsOperation.Window	A SetWindowFieldsOperation.Window to be used for ComputedField.
static class	SetWindowFieldsOperation.WindowOutput	SetWindowFieldsOperation.WindowOutput defines output of $setWindowFields stage by defining the field(s) to append to the documents in the output.
static interface	SetWindowFieldsOperation.Windows	Quick access to documents and RangeWindow range windows.
static interface	SetWindowFieldsOperation.WindowUnit	The actual time unit to apply to a SetWindowFieldsOperation.Window.
static enum	SetWindowFieldsOperation.WindowUnits	Quick access to available units.

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SetWindowFieldsOperation(Object partitionBy, AggregationOperation sortBy, SetWindowFieldsOperation.WindowOutput output)	Create a new SetWindowFieldsOperation with given args.

Method Summary

Modifier and Type	Method	Description
static SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	builder()	Obtain a builder to create a SetWindowFieldsOperation.
ExposedFields	getFields()	Returns the fields exposed by the AggregationOperation.
String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

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

toPipelineStages

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

inheritsFields

Constructor Details

SetWindowFieldsOperation

protected SetWindowFieldsOperation(@Nullable
 Object partitionBy,
 @Nullable
 AggregationOperation sortBy,
 SetWindowFieldsOperation.WindowOutput output)

Create a new SetWindowFieldsOperation with given args.

Parameters:

partitionBy - The field or AggregationExpression to group by.

sortBy - the operation to sort the documents by in the partition.

output - the SetWindowFieldsOperation.WindowOutput containing the fields to add and the rules to calculate their respective values.

Method Details

builder

public static SetWindowFieldsOperation.SetWindowFieldsOperationBuilder builder()

Obtain a builder to create a SetWindowFieldsOperation.

Returns:

new instance of SetWindowFieldsOperation.SetWindowFieldsOperationBuilder.

getFields

public ExposedFields getFields()

Description copied from interface: FieldsExposingAggregationOperation

Returns the fields exposed by the AggregationOperation.

Specified by:

getFields in interface FieldsExposingAggregationOperation

Returns:

will never be null.

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

Return the MongoDB operator that is used for this AggregationOperation. Aggregation operations should implement this method to avoid document rendering.

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.