@NonNullApi

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

Support for the MongoDB aggregation framework.

See: Description

Interface Summary

Interface	Description
AggregationExpression	An AggregationExpression can be used with field expressions in aggregation pipeline stages like project and group.
AggregationOperation	Represents one single operation in an aggregation pipeline.
AggregationOperationContext	The context for an AggregationOperation.
ArrayOperators.ArrayOperatorFactory.ReduceInitialValueBuilder
ArrayOperators.Filter.AsBuilder
ArrayOperators.Filter.ConditionBuilder
ArrayOperators.Filter.InputBuilder
ArrayOperators.In.InBuilder
ArrayOperators.Reduce.InitialValueBuilder
ArrayOperators.Reduce.PropertyExpression.AsBuilder
ArrayOperators.Reduce.ReduceBuilder
ArrayOperators.Slice.SliceElementsBuilder
BucketAutoOperation.Granularity
ConditionalOperators.Cond.OtherwiseBuilder
ConditionalOperators.Cond.ThenBuilder
ConditionalOperators.Cond.WhenBuilder
ConditionalOperators.IfNull.IfNullBuilder
ConditionalOperators.IfNull.ThenBuilder
ConditionalOperators.Switch.CaseOperator.ThenBuilder
DateOperators.DateFromParts.DateFromPartsWithYear
DateOperators.DateParts<T extends DateOperators.DateParts<T>>
DateOperators.DateToString.FormatBuilder
DateOperators.IsoDateFromParts.IsoDateFromPartsWithYear
ExposedFields.FieldReference	A reference to an ExposedFields.ExposedField.
Field	Abstraction for a field.
FieldsExposingAggregationOperation	AggregationOperation that exposes ExposedFields that can be used for later aggregation pipeline AggregationOperations.
FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation	Marker interface for AggregationOperation that inherits fields from previous operations.
GraphLookupOperation.ConnectFromBuilder
GraphLookupOperation.ConnectToBuilder
GraphLookupOperation.FromBuilder
GraphLookupOperation.StartWithBuilder
LookupOperation.AsBuilder
LookupOperation.ForeignFieldBuilder
LookupOperation.FromBuilder
LookupOperation.LocalFieldBuilder
ReplaceRootOperation.Replacement	Replacement object that results in a replacement document or an expression that results in a document.
UnwindOperation.EmptyArraysBuilder
UnwindOperation.IndexBuilder
UnwindOperation.PathBuilder
VariableOperators.Let.LetBuilder
VariableOperators.Map.AsBuilder
VariableOperators.Map.FunctionBuilder

Class Summary

Class	Description
AccumulatorOperators	Gateway to accumulator aggregation operations.
AccumulatorOperators.AccumulatorOperatorFactory
AccumulatorOperators.Avg	AggregationExpression for $avg.
AccumulatorOperators.Max	AggregationExpression for $max.
AccumulatorOperators.Min	AggregationExpression for $min.
AccumulatorOperators.StdDevPop	AggregationExpression for $stdDevPop.
AccumulatorOperators.StdDevSamp	AggregationExpression for $stdDevSamp.
AccumulatorOperators.Sum	AggregationExpression for $sum.
Aggregation	An Aggregation is a representation of a list of aggregation steps to be performed by the MongoDB Aggregation Framework.
AggregationOptions	Holds a set of configurable aggregation options that can be used within an aggregation pipeline.
AggregationOptions.Builder	A Builder for AggregationOptions.
AggregationResults<T>	Collects the results of executing an aggregation operation.
AggregationSpELExpression	An AggregationExpression that renders a MongoDB Aggregation Framework expression from the AST of a SpEL expression.
ArithmeticOperators	Gateway to Arithmetic aggregation operations that perform math operations on numbers.
ArithmeticOperators.Abs	AggregationExpression for $abs.
ArithmeticOperators.Add	AggregationExpression for $add.
ArithmeticOperators.ArithmeticOperatorFactory
ArithmeticOperators.Ceil	AggregationExpression for $ceil.
ArithmeticOperators.Divide	AggregationExpression for $divide.
ArithmeticOperators.Exp	AggregationExpression for $exp.
ArithmeticOperators.Floor	AggregationExpression for $floor.
ArithmeticOperators.Ln	AggregationExpression for $ln.
ArithmeticOperators.Log	AggregationExpression for $log.
ArithmeticOperators.Log10	AggregationExpression for $log10.
ArithmeticOperators.Mod	AggregationExpression for $mod.
ArithmeticOperators.Multiply	AggregationExpression for $multiply.
ArithmeticOperators.Pow	AggregationExpression for $pow.
ArithmeticOperators.Sqrt	AggregationExpression for $sqrt.
ArithmeticOperators.Subtract	AggregationExpression for $subtract.
ArithmeticOperators.Trunc	AggregationExpression for $trunc.
ArrayOperators	Gateway to array aggregation operations.
ArrayOperators.ArrayElemAt	AggregationExpression for $arrayElementAt.
ArrayOperators.ArrayOperatorFactory
ArrayOperators.ArrayToObject	AggregationExpression for $arrayToObject that transforms an array into a single document.
ArrayOperators.ConcatArrays	AggregationExpression for $concatArrays.
ArrayOperators.Filter	$filter AggregationExpression allows to select a subset of the array to return based on the specified condition.
ArrayOperators.In	AggregationExpression for $in.
ArrayOperators.IndexOfArray	AggregationExpression for $indexOfArray.
ArrayOperators.IndexOfArray.IndexOfArrayBuilder
ArrayOperators.IsArray	AggregationExpression for $isArray.
ArrayOperators.RangeOperator	AggregationExpression for $range.
ArrayOperators.RangeOperator.RangeOperatorBuilder
ArrayOperators.Reduce	AggregationExpression for $reduce.
ArrayOperators.Reduce.PropertyExpression
ArrayOperators.ReverseArray	AggregationExpression for $reverseArray.
ArrayOperators.Size	AggregationExpression for $size.
ArrayOperators.Slice	AggregationExpression for $slice.
ArrayOperators.Zip	AggregationExpression for $zip.
ArrayOperators.Zip.ZipBuilder
BooleanOperators	Gateway to boolean expressions that evaluate their argument expressions as booleans and return a boolean as the result.
BooleanOperators.And	AggregationExpression for $and.
BooleanOperators.BooleanOperatorFactory
BooleanOperators.Not	AggregationExpression for $not.
BooleanOperators.Or	AggregationExpression for $or.
BucketAutoOperation	Encapsulates the aggregation framework $bucketAuto-operation.
BucketAutoOperation.BucketAutoOperationOutputBuilder	BucketOperationSupport.OutputBuilder implementation for BucketAutoOperation.
BucketAutoOperation.ExpressionBucketAutoOperationBuilder	ExpressionBucketOperationBuilderSupport implementation for BucketAutoOperation using SpEL expression based Output.
BucketOperation	Encapsulates the aggregation framework $bucket-operation.
BucketOperation.BucketOperationOutputBuilder	OutputBuilder implementation for BucketOperation.
BucketOperation.ExpressionBucketOperationBuilder	ExpressionBucketOperationBuilderSupport implementation for BucketOperation using SpEL expression based Output.
BucketOperationSupport<T extends BucketOperationSupport<T,B>,B extends BucketOperationSupport.OutputBuilder<B,T>>	Base class for bucket operations that support output expressions the aggregation framework.
BucketOperationSupport.ExpressionBucketOperationBuilderSupport<B extends BucketOperationSupport.OutputBuilder<B,T>,T extends BucketOperationSupport<T,B>>	Builder for SpEL expression-based BucketOperationSupport.Output.
BucketOperationSupport.OperationOutput	Output field that uses a Mongo operation (expression object) to generate an output field value.
BucketOperationSupport.Output	Encapsulates an output field in a bucket aggregation stage.
BucketOperationSupport.OutputBuilder<B extends BucketOperationSupport.OutputBuilder<B,T>,T extends BucketOperationSupport<T,B>>	Base class for BucketOperationSupport.Output builders that result in a BucketOperationSupport providing the built BucketOperationSupport.Output.
BucketOperationSupport.Outputs	Encapsulates BucketOperationSupport.Outputs.
ComparisonOperators	Gateway to comparison expressions.
ComparisonOperators.Cmp	AggregationExpression for $cmp.
ComparisonOperators.ComparisonOperatorFactory
ComparisonOperators.Eq	AggregationExpression for $eq.
ComparisonOperators.Gt	AggregationExpression for $gt.
ComparisonOperators.Gte	AggregationExpression for $gte.
ComparisonOperators.Lt	AggregationExpression for $lt.
ComparisonOperators.Lte	AggregationExpression for $lte.
ComparisonOperators.Ne	AggregationExpression for $ne.
ConditionalOperators	Gateway to conditional expressions that evaluate their argument expressions as booleans to a value.
ConditionalOperators.Cond	Encapsulates the aggregation framework $cond operator.
ConditionalOperators.ConditionalOperatorFactory
ConditionalOperators.IfNull	Encapsulates the aggregation framework $ifNull operator.
ConditionalOperators.Switch	AggregationExpression for $switch.
ConditionalOperators.Switch.CaseOperator	Encapsulates the aggregation framework case document inside a $switch-operation.
ConvertOperators	Gateway to convert aggregation operations.
ConvertOperators.Convert	AggregationExpression for $convert that converts a value to a specified type.
ConvertOperators.ConvertOperatorFactory
ConvertOperators.ToBool	AggregationExpression for $toBool that converts a value to boolean.
ConvertOperators.ToDate	AggregationExpression for $toDate that converts a value to date.
ConvertOperators.ToDecimal	AggregationExpression for $toDecimal that converts a value to decimal.
ConvertOperators.ToDouble	AggregationExpression for $toDouble that converts a value to double.
ConvertOperators.ToInt	AggregationExpression for $toInt that converts a value to integer.
ConvertOperators.ToLong	AggregationExpression for $toLong that converts a value to long.
ConvertOperators.ToObjectId	AggregationExpression for $toObjectId that converts a value to objectId.
ConvertOperators.ToString	AggregationExpression for $toString that converts a value to string.
CountOperation	Encapsulates the aggregation framework $count-operation.
CountOperation.CountOperationBuilder	Builder for CountOperation.
DataTypeOperators	Gateway to data type expressions.
DataTypeOperators.Type	AggregationExpression for $type.
DateOperators	Gateway to Date aggregation operations.
DateOperators.DateFromParts	AggregationExpression for $dateFromParts.
DateOperators.DateFromPartsOperatorFactory
DateOperators.DateFromString	AggregationExpression for $dateFromString.
DateOperators.DateOperatorFactory
DateOperators.DateToParts	AggregationExpression for $dateToParts.
DateOperators.DateToString	AggregationExpression for $dateToString.
DateOperators.DayOfMonth	AggregationExpression for $dayOfMonth.
DateOperators.DayOfWeek	AggregationExpression for $dayOfWeek.
DateOperators.DayOfYear	AggregationExpression for $dayOfYear.
DateOperators.Hour	AggregationExpression for $hour.
DateOperators.IsoDateFromParts	AggregationExpression for $dateFromParts using ISO week date.
DateOperators.IsoDayOfWeek	AggregationExpression for $isoDayOfWeek.
DateOperators.IsoWeek	AggregationExpression for $isoWeek.
DateOperators.IsoWeekYear	AggregationExpression for $isoWeekYear.
DateOperators.Millisecond	AggregationExpression for $millisecond.
DateOperators.Minute	AggregationExpression for $minute.
DateOperators.Month	AggregationExpression for $month.
DateOperators.Second	AggregationExpression for $second.
DateOperators.Timezone	Timezone represents a MongoDB timezone abstraction which can be represented with a timezone ID or offset as a String.
DateOperators.TimezonedDateAggregationExpression	AggregationExpression capable of setting a given DateOperators.Timezone.
DateOperators.Week	AggregationExpression for $week.
DateOperators.Year	AggregationExpression for $year.
ExposedFields	Value object to capture the fields exposed by an AggregationOperation.
FacetOperation	Encapsulates the aggregation framework $facet-operation.
FacetOperation.FacetOperationBuilder	Builder for FacetOperation by adding existing and the new pipeline of AggregationOperation to the new FacetOperation.
Fields	Value object to capture a list of Field instances.
GeoNearOperation	Represents a geoNear aggregation operation.
GraphLookupOperation	Encapsulates the aggregation framework $graphLookup-operation.
GraphLookupOperation.GraphLookupOperationBuilder
GroupOperation	Encapsulates the aggregation framework $group-operation.
GroupOperation.GroupOperationBuilder	Builder for GroupOperations on a field.
LimitOperation	Encapsulates the $limit-operation.
LiteralOperators	Gateway to literal aggregation operations.
LiteralOperators.Literal	AggregationExpression for $literal.
LiteralOperators.LiteralOperatorFactory
LookupOperation	Encapsulates the aggregation framework $lookup-operation.
LookupOperation.LookupOperationBuilder	Builder for fluent LookupOperation creation.
MatchOperation	Encapsulates the $match-operation.
ObjectOperators	Gateway for object expression operators.
ObjectOperators.MergeObjects	AggregationExpression for $mergeObjects that combines multiple documents into a single document.
ObjectOperators.ObjectOperatorFactory
ObjectOperators.ObjectToArray	AggregationExpression for $objectToArray that converts a document to an array of documents that each contains two fields k and v.
OutOperation	Encapsulates the $out-operation.
PrefixingDelegatingAggregationOperationContext	AggregationOperationContext implementation prefixing non-command keys on root level with the given prefix.
ProjectionOperation	Encapsulates the aggregation framework $project-operation.
ProjectionOperation.ArrayProjectionOperationBuilder	Builder for array projections.
ProjectionOperation.ExpressionProjectionOperationBuilder	An ProjectionOperation.ProjectionOperationBuilder that is used for SpEL expression based projections.
ProjectionOperation.ProjectionOperationBuilder	Builder for ProjectionOperations on a field.
ReplaceRootOperation	Encapsulates the aggregation framework $replaceRoot-operation.
ReplaceRootOperation.ReplaceRootDocumentOperationBuilder	Builder for ReplaceRootDocumentOperation to populate ReplacementDocument
ReplaceRootOperation.ReplaceRootOperationBuilder	Builder for ReplaceRootOperation.
SampleOperation	Encapsulates the $sample-operation.
SetOperators	Gateway to Set expressions which perform set operation on arrays, treating arrays as sets.
SetOperators.AllElementsTrue	AggregationExpression for $allElementsTrue.
SetOperators.AnyElementTrue	AggregationExpression for $anyElementTrue.
SetOperators.SetDifference	AggregationExpression for $setDifference.
SetOperators.SetEquals	AggregationExpression for $setEquals.
SetOperators.SetIntersection	AggregationExpression for $setIntersection.
SetOperators.SetIsSubset	AggregationExpression for $setIsSubset.
SetOperators.SetOperatorFactory
SetOperators.SetUnion	AggregationExpression for $setUnion.
SkipOperation	Encapsulates the aggregation framework $skip-operation.
SortByCountOperation	Encapsulates the aggregation framework $sortByCount-operation.
SortOperation	Encapsulates the aggregation framework $sort-operation.
StringOperators	Gateway to String aggregation operations.
StringOperators.Concat	AggregationExpression for $concat.
StringOperators.IndexOfBytes	AggregationExpression for $indexOfBytes.
StringOperators.IndexOfBytes.SubstringBuilder
StringOperators.IndexOfCP	AggregationExpression for $indexOfCP.
StringOperators.IndexOfCP.SubstringBuilder
StringOperators.LTrim	AggregationExpression for $ltrim which removes whitespace or the specified characters from the beginning of a string.
StringOperators.RTrim	AggregationExpression for $rtrim which removes whitespace or the specified characters from the end of a string.
StringOperators.Split	AggregationExpression for $split.
StringOperators.StrCaseCmp	AggregationExpression for $strcasecmp.
StringOperators.StringOperatorFactory
StringOperators.StrLenBytes	AggregationExpression for $strLenBytes.
StringOperators.StrLenCP	AggregationExpression for $strLenCP.
StringOperators.Substr	AggregationExpression for $substr.
StringOperators.SubstrCP	AggregationExpression for $substrCP.
StringOperators.ToLower	AggregationExpression for $toLower.
StringOperators.ToUpper	AggregationExpression for $toUpper.
StringOperators.Trim	AggregationExpression for $trim which removes whitespace or the specified characters from the beginning and end of a string.
TypeBasedAggregationOperationContext	AggregationOperationContext aware of a particular type and a MappingContext to potentially translate property references into document field names.
TypedAggregation<I>	A TypedAggregation is a special Aggregation that holds information of the input aggregation type.
UnwindOperation	Encapsulates the aggregation framework $unwind-operation.
UnwindOperation.UnwindOperationBuilder	Builder for fluent UnwindOperation creation.
VariableOperators	Gateway to variable aggregation operations.
VariableOperators.Let	AggregationExpression for $let that binds AggregationExpression to variables for use in the specified in expression, and returns the result of the expression.
VariableOperators.Let.ExpressionVariable
VariableOperators.Map	AggregationExpression for $map.

Enum Summary

Enum	Description
AggregationFunctionExpressions	Deprecated since 1.10.
ArrayOperators.Reduce.Variable
BucketAutoOperation.Granularities	Supported MongoDB granularities.
OutOperation.OutMode	The mode for merging the aggregation pipeline output.

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

Support for the MongoDB aggregation framework.

Since:

1.3