Class SampleOperation
java.lang.Object
org.springframework.data.mongodb.core.aggregation.SampleOperation
- All Implemented Interfaces:
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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn the MongoDB operator that is used for thisAggregationOperation
.org.bson.Document
toDocument
(AggregationOperationContext context) 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
Description copied from interface:AggregationOperation
- Specified by:
toDocument
in interfaceAggregationOperation
- Parameters:
context
- theAggregationOperationContext
to operate within. Must not be null.- Returns:
- the Document
-
getOperator
Description copied from interface:AggregationOperation
Return the MongoDB operator that is used for thisAggregationOperation
. Aggregation operations should implement this method to avoid document rendering.- Specified by:
getOperator
in interfaceAggregationOperation
- Returns:
- the operator used for this
AggregationOperation
.
-