Module spring.data.mongodb

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

Class TypedAggregation<I>

java.lang.Object

org.springframework.data.mongodb.core.aggregation.Aggregation

org.springframework.data.mongodb.core.aggregation.TypedAggregation<I>

public class TypedAggregation<I>
extends Aggregation

A TypedAggregation is a special Aggregation that holds information of the input aggregation type.

Author:

Thomas Darimont, Oliver Gierke

Field Summary

Fields inherited from class org.springframework.data.mongodb.core.aggregation.Aggregation

CURRENT, DEFAULT_CONTEXT, DEFAULT_OPTIONS, pipeline, REMOVE, ROOT

Constructor Summary

Constructors

Constructor	Description
TypedAggregation(Class<I> inputType, List<AggregationOperation> operations)	Creates a new TypedAggregation from the given AggregationOperations.
TypedAggregation(Class<I> inputType, List<AggregationOperation> operations, AggregationOptions options)	Creates a new TypedAggregation from the given AggregationOperations and the given AggregationOptions.
TypedAggregation(Class<I> inputType, AggregationOperation... operations)	Creates a new TypedAggregation from the given AggregationOperations.

Method Summary

Modifier and Type	Method	Description
Class<I>	getInputType()	Returns the input type for the Aggregation.
TypedAggregation<I>	withOptions(AggregationOptions options)	Returns a copy of this Aggregation with the given AggregationOptions set.

Methods inherited from class org.springframework.data.mongodb.core.aggregation.Aggregation

addFields, asAggregationList, bind, bucket, bucket, bucketAuto, bucketAuto, count, facet, facet, fields, geoNear, getOptions, getPipeline, graphLookup, group, group, limit, lookup, lookup, lookup, match, match, match, merge, newAggregation, newAggregation, newAggregation, newAggregation, newAggregationOptions, newUpdate, out, previousOperation, project, project, project, redact, replaceRoot, replaceRoot, replaceRoot, sample, skip, sort, sort, sortByCount, sortByCount, stage, stage, toDocument, toPipeline, toString, unwind, unwind, unwind, unwind, vectorSearch

Methods inherited from class java.lang.Object

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

Constructor Details

TypedAggregation

public TypedAggregation(Class<I> inputType,
 AggregationOperation... operations)

Creates a new TypedAggregation from the given AggregationOperations.

Parameters:

inputType - must not be null.

operations - must not be null or empty.

TypedAggregation

public TypedAggregation(Class<I> inputType,
 List<AggregationOperation> operations)

Creates a new TypedAggregation from the given AggregationOperations.

Parameters:

inputType - must not be null.

operations - must not be null or empty.

TypedAggregation

public TypedAggregation(Class<I> inputType,
 List<AggregationOperation> operations,
 AggregationOptions options)

Creates a new TypedAggregation from the given AggregationOperations and the given AggregationOptions.

Parameters:

inputType - must not be null.

operations - must not be null or empty.

options - must not be null.

Method Details

getInputType

public Class<I> getInputType()

Returns the input type for the Aggregation.

Returns:

the inputType will never be null.

withOptions

public TypedAggregation<I> withOptions(AggregationOptions options)

Description copied from class: Aggregation

Returns a copy of this Aggregation with the given AggregationOptions set. Note that options are supported in MongoDB version 2.6+.

Overrides:

withOptions in class Aggregation

Parameters:

options - must not be null.

Returns:

new instance of Aggregation.