Constructor Detail

• ProjectionOperationBuilder

  public ProjectionOperationBuilder(String name,
                                    ProjectionOperation operation,
                                    @Nullable
                                    org.springframework.data.mongodb.core.aggregation.ProjectionOperation.ProjectionOperationBuilder.OperationProjection previousProjection)

  Creates a new ProjectionOperation.ProjectionOperationBuilder for the field with the given name on top of the given ProjectionOperation.

  Parameters:

  name - must not be null or empty.

  operation - must not be null.

  previousProjection - the previous operation projection, may be null.

• ProjectionOperationBuilder

  protected ProjectionOperationBuilder(Object value,
                                       ProjectionOperation operation,
                                       @Nullable
                                       org.springframework.data.mongodb.core.aggregation.ProjectionOperation.ProjectionOperationBuilder.OperationProjection previousProjection)

  Creates a new ProjectionOperation.ProjectionOperationBuilder for the field with the given value on top of the given ProjectionOperation.

  Parameters:

  value -

  operation -

  previousProjection -

Method Detail

• previousOperation

  public ProjectionOperation previousOperation()

  Projects the result of the previous operation onto the current field. Will automatically add an exclusion for _id as what would be held in it by default will now go into the field just projected into.

  Returns:

• nested

  public ProjectionOperation nested(Fields fields)

  Defines a nested field binding for the current field.

  Parameters:

  fields - must not be null.

  Returns:

• as

  public ProjectionOperation as(String alias)

  Allows to specify an alias for the previous projection operation.

  Parameters:

  alias -

  Returns:

• applyCondition

  public ProjectionOperation applyCondition(ConditionalOperators.Cond cond)

  Apply a conditional projection using ConditionalOperators.Cond.

  Parameters:

  cond - must not be null.

  Returns:

  never null.

• applyCondition

  public ProjectionOperation applyCondition(ConditionalOperators.IfNull ifNull)

  Apply a conditional value replacement for null values using ConditionalOperators.IfNull.

  Parameters:

  ifNull - must not be null.

  Returns:

  never null.

• plus

  public ProjectionOperation.ProjectionOperationBuilder plus(Number number)

  Generates an $add expression that adds the given number to the previously mentioned field.

  Parameters:

  number -

  Returns:

• plus

  public ProjectionOperation.ProjectionOperationBuilder plus(String fieldReference)

  Generates an $add expression that adds the value of the given field to the previously mentioned field.

  Parameters:

  fieldReference -

  Returns:

• minus

  public ProjectionOperation.ProjectionOperationBuilder minus(Number number)

  Generates an $subtract expression that subtracts the given number to the previously mentioned field.

  Parameters:

  number -

  Returns:

• minus

  public ProjectionOperation.ProjectionOperationBuilder minus(String fieldReference)

  Generates an $subtract expression that subtracts the value of the given field to the previously mentioned field.

  Parameters:

  fieldReference -

  Returns:

• minus

  public ProjectionOperation.ProjectionOperationBuilder minus(AggregationExpression expression)

  Generates an $subtract expression that subtracts the result of the given AggregationExpression from the previously mentioned field.

  Parameters:

  expression - must not be null.

  Returns:

  Since:

  1.10

• multiply

  public ProjectionOperation.ProjectionOperationBuilder multiply(Number number)

  Generates an $multiply expression that multiplies the given number with the previously mentioned field.

  Parameters:

  number -

  Returns:

• multiply

  public ProjectionOperation.ProjectionOperationBuilder multiply(String fieldReference)

  Generates an $multiply expression that multiplies the value of the given field with the previously mentioned field.

  Parameters:

  fieldReference -

  Returns:

• multiply

  public ProjectionOperation.ProjectionOperationBuilder multiply(AggregationExpression expression)

  Generates an $multiply expression that multiplies the previously with the result of the AggregationExpression. mentioned field.

  Parameters:

  expression - must not be null.

  Returns:

  Since:

  1.10

• divide

  public ProjectionOperation.ProjectionOperationBuilder divide(Number number)

  Generates an $divide expression that divides the previously mentioned field by the given number.

  Parameters:

  number -

  Returns:

• divide

  public ProjectionOperation.ProjectionOperationBuilder divide(String fieldReference)

  Generates an $divide expression that divides the value of the given field by the previously mentioned field.

  Parameters:

  fieldReference -

  Returns:

• divide

  public ProjectionOperation.ProjectionOperationBuilder divide(AggregationExpression expression)

  Generates an $divide expression that divides the value of the previously mentioned by the result of the AggregationExpression.

  Parameters:

  expression - must not be null.

  Returns:

  Since:

  1.10

• mod

  public ProjectionOperation.ProjectionOperationBuilder mod(Number number)

  Generates an $mod expression that divides the previously mentioned field by the given number and returns the remainder.

  Parameters:

  number -

  Returns:

• mod

  public ProjectionOperation.ProjectionOperationBuilder mod(String fieldReference)

  Generates an $mod expression that divides the value of the given field by the previously mentioned field and returns the remainder.

  Parameters:

  fieldReference -

  Returns:

• mod

  public ProjectionOperation.ProjectionOperationBuilder mod(AggregationExpression expression)

  Generates an $mod expression that divides the value of the previously mentioned field by the result of the AggregationExpression.

  Parameters:

  expression - must not be null.

  Returns:

  Since:

  1.10

• size

  public ProjectionOperation.ProjectionOperationBuilder size()

  Generates a $size expression that returns the size of the array held by the given field.
  

  Returns:

  never null.

  Since:

  1.7

• cmp

  public ProjectionOperation.ProjectionOperationBuilder cmp(Object compareValue)

  Generates a $cmp expression (compare to) that compares the value of the field to a given value or field.

  Parameters:

  compareValue - compare value or a Field object.

  Returns:

  never null.

  Since:

  1.10

• eq

  public ProjectionOperation.ProjectionOperationBuilder eq(Object compareValue)

  Generates a $eq expression (equal) that compares the value of the field to a given value or field.

  Parameters:

  compareValue - compare value or a Field object.

  Returns:

  never null.

  Since:

  1.10

• gt

  public ProjectionOperation.ProjectionOperationBuilder gt(Object compareValue)

  Generates a $gt expression (greater than) that compares the value of the field to a given value or field.

  Parameters:

  compareValue - compare value or a Field object.

  Returns:

  never null.

  Since:

  1.10

• gte

  public ProjectionOperation.ProjectionOperationBuilder gte(Object compareValue)

  Generates a $gte expression (greater than equal) that compares the value of the field to a given value or field.

  Parameters:

  compareValue - compare value or a Field object.

  Returns:

  never null.

  Since:

  1.10

• lt

  public ProjectionOperation.ProjectionOperationBuilder lt(Object compareValue)

  Generates a $lt expression (less than) that compares the value of the field to a given value or field.

  Parameters:

  compareValue - compare value or a Field object.

  Returns:

  never null.

  Since:

  1.10

• lte

  public ProjectionOperation.ProjectionOperationBuilder lte(Object compareValue)

  Generates a $lte expression (less than equal) that compares the value of the field to a given value or field.

  Parameters:

  compareValue - the compare value or a Field object.

  Returns:

  never null.

  Since:

  1.10

• ne

  public ProjectionOperation.ProjectionOperationBuilder ne(Object compareValue)

  Generates a $ne expression (not equal) that compares the value of the field to a given value or field.

  Parameters:

  compareValue - compare value or a Field object.

  Returns:

  never null.

  Since:

  1.10

• slice

  public ProjectionOperation.ProjectionOperationBuilder slice(int count)

  Generates a $slice expression that returns a subset of the array held by the given field.
  If n is positive, $slice returns up to the first n elements in the array.
  If n is negative, $slice returns up to the last n elements in the array.

  Parameters:

  count - max number of elements.

  Returns:

  never null.

  Since:

  1.10

• slice

  public ProjectionOperation.ProjectionOperationBuilder slice(int count,
                                                              int offset)

  Generates a $slice expression that returns a subset of the array held by the given field.
  

  Parameters:

  count - max number of elements. Must not be negative.

  offset - the offset within the array to start from.

  Returns:

  never null.

  Since:

  1.10

• filter

  public ProjectionOperation.ProjectionOperationBuilder filter(String as,
                                                               AggregationExpression condition)

  Generates a $filter expression that returns a subset of the array held by the given field.

  Parameters:

  as - The variable name for the element in the input array. Must not be null.

  condition - The AggregationExpression that determines whether to include the element in the resulting array. Must not be null.

  Returns:

  never null.

  Since:

  1.10

• equalsArrays

  public ProjectionOperation.ProjectionOperationBuilder equalsArrays(String... arrays)

  Generates a $setEquals expression that compares the previously mentioned field to one or more arrays and returns true if they have the same distinct elements and false otherwise.

  Parameters:

  arrays - must not be null.

  Returns:

  never null.

  Since:

  1.10

• intersectsArrays

  public ProjectionOperation.ProjectionOperationBuilder intersectsArrays(String... arrays)

  Generates a $setIntersection expression that takes array of the previously mentioned field and one or more arrays and returns an array that contains the elements that appear in every of those.

  Parameters:

  arrays - must not be null.

  Returns:

  never null.

  Since:

  1.10

• unionArrays

  public ProjectionOperation.ProjectionOperationBuilder unionArrays(String... arrays)

  Generates a $setUnion expression that takes array of the previously mentioned field and one or more arrays and returns an array that contains the elements that appear in any of those.

  Parameters:

  arrays - must not be null.

  Returns:

  never null.

  Since:

  1.10

• differenceToArray

  public ProjectionOperation.ProjectionOperationBuilder differenceToArray(String array)

  Generates a $setDifference expression that takes array of the previously mentioned field and returns an array containing the elements that do not exist in the given array.

  Parameters:

  array - must not be null.

  Returns:

  never null.

  Since:

  1.10

• subsetOfArray

  public ProjectionOperation.ProjectionOperationBuilder subsetOfArray(String array)

  Generates a $setIsSubset expression that takes array of the previously mentioned field and returns true if it is a subset of the given array.

  Parameters:

  array - must not be null.

  Returns:

  never null.

  Since:

  1.10

• anyElementInArrayTrue

  public ProjectionOperation.ProjectionOperationBuilder anyElementInArrayTrue()

  Generates an $anyElementTrue expression that Takes array of the previously mentioned field and returns true if any of the elements are true and false otherwise.

  Returns:

  never null.

  Since:

  1.10

• allElementsInArrayTrue

  public ProjectionOperation.ProjectionOperationBuilder allElementsInArrayTrue()

  Generates an $allElementsTrue expression that takes array of the previously mentioned field and returns true if no elements is false.

  Returns:

  never null.

  Since:

  1.10

• absoluteValue

  public ProjectionOperation.ProjectionOperationBuilder absoluteValue()

  Generates a $abs expression that takes the number of the previously mentioned field and returns the absolute value of it.

  Returns:

  never null.

  Since:

  1.10

• ceil

  public ProjectionOperation.ProjectionOperationBuilder ceil()

  Generates a $ceil expression that takes the number of the previously mentioned field and returns the smallest integer greater than or equal to the specified number.

  Returns:

  never null.

  Since:

  1.10

• exp

  public ProjectionOperation.ProjectionOperationBuilder exp()

  Generates a $exp expression that takes the number of the previously mentioned field and raises Euler’s number (i.e. e ) on it.

  Returns:

  never null.

  Since:

  1.10

• floor

  public ProjectionOperation.ProjectionOperationBuilder floor()

  Generates a $floor expression that takes the number of the previously mentioned field and returns the largest integer less than or equal to it.

  Returns:

  never null.

  Since:

  1.10

• ln

  public ProjectionOperation.ProjectionOperationBuilder ln()

  Generates a $ln expression that takes the number of the previously mentioned field and calculates the natural logarithm ln (i.e loge) of it.

  Returns:

  never null.

  Since:

  1.10

• log

  public ProjectionOperation.ProjectionOperationBuilder log(String baseFieldRef)

  Generates a $log expression that takes the number of the previously mentioned field and calculates the log of the associated number in the specified base.

  Parameters:

  baseFieldRef - must not be null.

  Returns:

  never null.

  Since:

  1.10

• log

  public ProjectionOperation.ProjectionOperationBuilder log(Number base)

  Generates a $log expression that takes the number of the previously mentioned field and calculates the log of the associated number in the specified base.

  Parameters:

  base - must not be null.

  Returns:

  never null.

  Since:

  1.10

• log

  public ProjectionOperation.ProjectionOperationBuilder log(AggregationExpression base)

  Generates a $log expression that takes the number of the previously mentioned field and calculates the log of the associated number in the specified base.

  Parameters:

  base - must not be null.

  Returns:

  never null.

  Since:

  1.10

• log10

  public ProjectionOperation.ProjectionOperationBuilder log10()

  Generates a $log10 expression that takes the number of the previously mentioned field and calculates the log base 10.

  Returns:

  never null.

  Since:

  1.10

• pow

  public ProjectionOperation.ProjectionOperationBuilder pow(String exponentFieldRef)

  Generates a $pow expression that takes the number of the previously mentioned field and raises it by the specified exponent.

  Parameters:

  exponentFieldRef - must not be null.

  Returns:

  never null.

  Since:

  1.10

• pow

  public ProjectionOperation.ProjectionOperationBuilder pow(Number exponent)

  Generates a $pow expression that takes the number of the previously mentioned field and raises it by the specified exponent.

  Parameters:

  exponent - must not be null.

  Returns:

  never null.

  Since:

  1.10

• pow

  public ProjectionOperation.ProjectionOperationBuilder pow(AggregationExpression exponentExpression)

  Generates a $pow expression that Takes the number of the previously mentioned field and raises it by the specified exponent.

  Parameters:

  exponentExpression - must not be null.

  Returns:

  never null.

  Since:

  1.10

• sqrt

  public ProjectionOperation.ProjectionOperationBuilder sqrt()

  Generates a $sqrt expression that takes the number of the previously mentioned field and calculates the square root.

  Returns:

  never null.

  Since:

  1.10

• trunc

  public ProjectionOperation.ProjectionOperationBuilder trunc()

  Takes the number of the previously mentioned field and truncates it to its integer value.

  Returns:

  never null.

  Since:

  1.10

• concat

  public ProjectionOperation.ProjectionOperationBuilder concat(Object... values)

  Generates a $concat expression that takes the string representation of the previously mentioned field and concats given values to it.

  Returns:

  never null.

  Since:

  1.10

• substring

  public ProjectionOperation.ProjectionOperationBuilder substring(int start)

  Generates a $substr expression that Takes the string representation of the previously mentioned field and returns a substring starting at a specified index position.

  Parameters:

  start -

  Returns:

  Since:

  1.10

• substring

  public ProjectionOperation.ProjectionOperationBuilder substring(int start,
                                                                  int nrOfChars)

  Generates a $substr expression that takes the string representation of the previously mentioned field and returns a substring starting at a specified index position including the specified number of characters.

  Parameters:

  start -

  nrOfChars -

  Returns:

  Since:

  1.10

• toLower

  public ProjectionOperation.ProjectionOperationBuilder toLower()

  Generates a $toLower expression that takes the string representation of the previously mentioned field and lowers it.

  Returns:

  Since:

  1.10

• toUpper

  public ProjectionOperation.ProjectionOperationBuilder toUpper()

  Generates a $toUpper expression that takes the string representation of the previously mentioned field and uppers it.

  Returns:

  Since:

  1.10

• strCaseCmp

  public ProjectionOperation.ProjectionOperationBuilder strCaseCmp(String value)

  Generates a $strcasecmp expression that takes the string representation of the previously mentioned field and performs case-insensitive comparison to the given value.

  Parameters:

  value - must not be null.

  Returns:

  Since:

  1.10

• strCaseCmpValueOf

  public ProjectionOperation.ProjectionOperationBuilder strCaseCmpValueOf(String fieldRef)

  Generates a $strcasecmp expression that takes the string representation of the previously mentioned field and performs case-insensitive comparison to the referenced fieldRef.

  Parameters:

  fieldRef - must not be null.

  Returns:

  Since:

  1.10

• strCaseCmp

  public ProjectionOperation.ProjectionOperationBuilder strCaseCmp(AggregationExpression expression)

  Generates a $strcasecmp expression that takes the string representation of the previously mentioned field and performs case-insensitive comparison to the result of the given AggregationExpression.

  Parameters:

  expression - must not be null.

  Returns:

  Since:

  1.10

• arrayElementAt

  public ProjectionOperation.ProjectionOperationBuilder arrayElementAt(int position)

  Generates a $arrayElemAt expression that takes the string representation of the previously mentioned field and returns the element at the specified array position.

  Parameters:

  position -

  Returns:

  Since:

  1.10

• concatArrays

  public ProjectionOperation.ProjectionOperationBuilder concatArrays(String... fields)

  Generates a $concatArrays expression that takes the string representation of the previously mentioned field and concats it with the arrays from the referenced fields.

  Parameters:

  fields - must not be null.

  Returns:

  Since:

  1.10

• isArray

  public ProjectionOperation.ProjectionOperationBuilder isArray()

  Generates a $isArray expression that takes the string representation of the previously mentioned field and checks if its an array.

  Returns:

  Since:

  1.10

• asLiteral

  public ProjectionOperation.ProjectionOperationBuilder asLiteral()

  Generates a $literal expression that Takes the value previously and uses it as literal.

  Returns:

  Since:

  1.10

• dateAsFormattedString

  public ProjectionOperation.ProjectionOperationBuilder dateAsFormattedString(String format)

  Generates a $dateToString expression that takes the date representation of the previously mentioned field and applies given format to it.

  Parameters:

  format - must not be null.

  Returns:

  Since:

  1.10

• dateAsFormattedString

  public ProjectionOperation.ProjectionOperationBuilder dateAsFormattedString()

  Generates a $dateToString expression that takes the date representation of the previously mentioned field using the server default format.
  NOTE: Requires MongoDB 4.0 or later.

  Returns:

  Since:

  2.1

• let

  public ProjectionOperation.ProjectionOperationBuilder let(AggregationExpression valueExpression,
                                                            String variableName,
                                                            AggregationExpression in)

  Generates a $let expression that binds variables for use in the specified expression, and returns the result of the expression.

  Parameters:

  valueExpression - The AggregationExpression bound to variableName.

  variableName - The variable name to be used in the in AggregationExpression.

  in - The AggregationExpression to evaluate.

  Returns:

  never null.

  Since:

  1.10

• let

  public ProjectionOperation.ProjectionOperationBuilder let(Collection<VariableOperators.Let.ExpressionVariable> variables,
                                                            AggregationExpression in)

  Generates a $let expression that binds variables for use in the specified expression, and returns the result of the expression.

  Parameters:

  variables - The bound VariableOperators.Let.ExpressionVariables.

  in - The AggregationExpression to evaluate.

  Returns:

  never null.

  Since:

  1.10

• 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

  Returns:

  the Document

• project

  public ProjectionOperation.ProjectionOperationBuilder project(String operation,
                                                                Object... values)

  Adds a generic projection for the current field.

  Parameters:

  operation - the operation key, e.g. $add.

  values - the values to be set for the projection operation.

  Returns:

• extractMinute

  public ProjectionOperation.ProjectionOperationBuilder extractMinute()

  Extracts the minute from a date expression.

  Returns:

• extractHour

  public ProjectionOperation.ProjectionOperationBuilder extractHour()

  Extracts the hour from a date expression.

  Returns:

• extractSecond

  public ProjectionOperation.ProjectionOperationBuilder extractSecond()

  Extracts the second from a date expression.

  Returns:

• extractMillisecond

  public ProjectionOperation.ProjectionOperationBuilder extractMillisecond()

  Extracts the millisecond from a date expression.

  Returns:

• extractYear

  public ProjectionOperation.ProjectionOperationBuilder extractYear()

  Extracts the year from a date expression.

  Returns:

• extractMonth

  public ProjectionOperation.ProjectionOperationBuilder extractMonth()

  Extracts the month from a date expression.

  Returns:

• extractWeek

  public ProjectionOperation.ProjectionOperationBuilder extractWeek()

  Extracts the week from a date expression.

  Returns:

• extractDayOfYear

  public ProjectionOperation.ProjectionOperationBuilder extractDayOfYear()

  Extracts the dayOfYear from a date expression.

  Returns:

• extractDayOfMonth

  public ProjectionOperation.ProjectionOperationBuilder extractDayOfMonth()

  Extracts the dayOfMonth from a date expression.

  Returns:

• extractDayOfWeek

  public ProjectionOperation.ProjectionOperationBuilder extractDayOfWeek()

  Extracts the dayOfWeek from a date expression.

  Returns: