org.springframework.data.mongodb.core.aggregation

Class MatchOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.MatchOperation

All Implemented Interfaces:

AggregationOperation

public class MatchOperation
extends Object
implements AggregationOperation

Encapsulates the $match-operation.

We recommend to use the static factory method Aggregation.match(org.springframework.data.mongodb.core.query.Criteria) instead of creating instances of this class directly.

Since:

1.3

Author:

Sebastian Herold, Thomas Darimont, Oliver Gierke, Divya Srivastava

See Also:

MongoDB Aggregation Framework: $match

Constructor Summary

Constructors

Constructor and Description
MatchOperation(AggregationExpression expression) Creates a new MatchOperation for the given AggregationExpression.
MatchOperation(CriteriaDefinition criteriaDefinition) Creates a new MatchOperation for the given CriteriaDefinition.

Method Summary

Modifier and Type	Method and Description
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

Constructor Detail

MatchOperation

public MatchOperation(CriteriaDefinition criteriaDefinition)

Creates a new MatchOperation for the given CriteriaDefinition.

Parameters:

criteriaDefinition - must not be null.

MatchOperation

public MatchOperation(AggregationExpression expression)

Creates a new MatchOperation for the given AggregationExpression.

Parameters:

expression - must not be null.

Since:

3.3

Method Detail

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.