Module spring.data.mongodb

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

Class ArrayOperators.Filter

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ArrayOperators.Filter

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ArrayOperators

public static class ArrayOperators.Filter
extends Object
implements AggregationExpression

$filter AggregationExpression allows to select a subset of the array to return based on the specified condition.

Since:

1.10

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ArrayOperators.Filter.AsBuilder
static interface	ArrayOperators.Filter.ConditionBuilder
static interface	ArrayOperators.Filter.InputBuilder

Method Summary

Modifier and Type	Method	Description
static ArrayOperators.Filter.AsBuilder	filter(String field)	Set the field to apply the $filter to.
static ArrayOperators.Filter.AsBuilder	filter(List<?> values)	Set the values to apply the $filter to.
static ArrayOperators.Filter.AsBuilder	filter(AggregationExpression expression)	Set the AggregationExpression resolving to an array to apply the $filter to.
static ArrayOperators.Filter.AsBuilder	filter(Field field)	Set the field to apply the $filter to.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within 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.AggregationExpression

toDocument

Method Details

filter

public static ArrayOperators.Filter.AsBuilder filter(String field)

Set the field to apply the $filter to.

Parameters:

field - must not be null.

Returns:

never null.

filter

public static ArrayOperators.Filter.AsBuilder filter(Field field)

Set the field to apply the $filter to.

Parameters:

field - must not be null.

Returns:

never null.

filter

public static ArrayOperators.Filter.AsBuilder filter(AggregationExpression expression)

Set the AggregationExpression resolving to an array to apply the $filter to.

Parameters:

expression - must not be null.

Returns:

never null.

Since:

4.2

filter

public static ArrayOperators.Filter.AsBuilder filter(List<?> values)

Set the values to apply the $filter to.

Parameters:

values - must not be null.

Returns:

new instance of ArrayOperators.Filter.AsBuilder to create the ArrayOperators.Filter.

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.