Class SetWindowFieldsOperation.SetWindowFieldsOperationBuilder

java.lang.Object

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

Enclosing class:

SetWindowFieldsOperation

public static class SetWindowFieldsOperation.SetWindowFieldsOperationBuilder
extends Object

A fluent builder to create a SetWindowFieldsOperation.

Since:

3.3

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetWindowFieldsOperation.SetWindowFieldsOperationBuilder.As	Interface to capture field name used to capture the computation result.
static interface	SetWindowFieldsOperation.SetWindowFieldsOperationBuilder.WindowChoice	Interface to capture an optional SetWindowFieldsOperation.Window applicable to the field computation.

Constructor Summary

Constructors

Constructor	Description
SetWindowFieldsOperationBuilder()

Method Summary

Modifier and Type	Method	Description
SetWindowFieldsOperation	build()	Obtain a new instance of SetWindowFieldsOperation with previously set arguments.
SetWindowFieldsOperation.SetWindowFieldsOperationBuilder.WindowChoice	output(AggregationExpression expression)	Add a field capturing the result of the given expression to the output.
SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	output(SetWindowFieldsOperation.WindowOutput output)	Define the actual output computation.
SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	partitionBy(Object value)	Partition by a value that translates to a valid mongodb expression.
SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	partitionByExpression(AggregationExpression expression)	Specify the expression to group by.
SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	partitionByField(String fieldName)	Specify the field to group by.
SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	sortBy(String... fields)	Sort ascending by the given fields.
SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	sortBy(Sort sort)	Set the sort order.
SetWindowFieldsOperation.SetWindowFieldsOperationBuilder	sortBy(SortOperation sort)	Set the SortOperation to use.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SetWindowFieldsOperationBuilder

public SetWindowFieldsOperationBuilder()

Method Details

partitionByField

@Contract("_ -> this")
public SetWindowFieldsOperation.SetWindowFieldsOperationBuilder partitionByField(String fieldName)

Specify the field to group by.

Parameters:

fieldName - must not be null or null.

Returns:

this.

partitionByExpression

@Contract("_ -> this")
public SetWindowFieldsOperation.SetWindowFieldsOperationBuilder partitionByExpression(AggregationExpression expression)

Specify the expression to group by.

Parameters:

expression - must not be null.

Returns:

this.

sortBy

@Contract("_ -> this")
public SetWindowFieldsOperation.SetWindowFieldsOperationBuilder sortBy(String... fields)

Sort ascending by the given fields.

Parameters:

fields - must not be null.

Returns:

this.

sortBy

@Contract("_ -> this")
public SetWindowFieldsOperation.SetWindowFieldsOperationBuilder sortBy(Sort sort)

Set the sort order.

Parameters:

sort - must not be null.

Returns:

this.

sortBy

@Contract("_ -> this")
public SetWindowFieldsOperation.SetWindowFieldsOperationBuilder sortBy(SortOperation sort)

Set the SortOperation to use.

Parameters:

sort - must not be null.

Returns:

this.

output

@Contract("_ -> this")
public SetWindowFieldsOperation.SetWindowFieldsOperationBuilder output(SetWindowFieldsOperation.WindowOutput output)

Define the actual output computation.

Parameters:

output - must not be null.

Returns:

this.

output

@Contract("_ -> new")
public SetWindowFieldsOperation.SetWindowFieldsOperationBuilder.WindowChoice output(AggregationExpression expression)

Add a field capturing the result of the given expression to the output.

Parameters:

expression - must not be null.

Returns:

new instance of SetWindowFieldsOperation.SetWindowFieldsOperationBuilder.WindowChoice.

partitionBy

@Contract("_ -> this")
public SetWindowFieldsOperation.SetWindowFieldsOperationBuilder partitionBy(Object value)

Partition by a value that translates to a valid mongodb expression.

Parameters:

value - must not be null.

Returns:

this.

build

@Contract("-> new")
public SetWindowFieldsOperation build()

Obtain a new instance of SetWindowFieldsOperation with previously set arguments.

Returns:

new instance of SetWindowFieldsOperation.