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

Class SampleOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.SampleOperation

All Implemented Interfaces:

AggregationOperation

public class SampleOperation
extends Object
implements AggregationOperation

Encapsulates the $sample-operation.

We recommend to use the static factory method Aggregation.sample(long) instead of creating instances of this class directly.

Since:

2.0

Author:

Gustavo de Geus

See Also:

• MongoDB Aggregation Framework: $sample

Constructor Summary

Constructors

Constructor	Description
SampleOperation(long sampleSize)

Method Summary

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

SampleOperation

public SampleOperation(long sampleSize)

Parameters:

sampleSize - number of documents to be randomly selected from its input.

Method Details

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.