Class Accumulators


  • @Deprecated(since="2021-05-27")
    public final class Accumulators
    extends java.lang.Object
    Deprecated.
    Usage of this API is not supported in AEM as a Cloud Service.
    Builders for accumulators used in the group pipeline stage of an aggregation pipeline.
    Since:
    3.1
    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static <TExpression>
      BsonField
      addToSet​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing all unique values that results from applying the given expression to each document in a group of documents that share the same group by key.
      static <TExpression>
      BsonField
      avg​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing the average of the values of the given expression when applied to all members of the group.
      static <TExpression>
      BsonField
      first​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing the value of the given expression when applied to the first member of the group.
      static <TExpression>
      BsonField
      last​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing the value of the given expression when applied to the last member of the group.
      static <TExpression>
      BsonField
      max​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing the maximum of the values of the given expression when applied to all members of the group.
      static <TExpression>
      BsonField
      min​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing the minimum of the values of the given expression when applied to all members of the group.
      static <TExpression>
      BsonField
      push​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing an array of all values that results from applying an expression to each document in a group of documents that share the same group by key.
      static <TExpression>
      BsonField
      stdDevPop​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing the sample standard deviation of the values of the given expression when applied to all members of the group.
      static <TExpression>
      BsonField
      stdDevSamp​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing the sample standard deviation of the values of the given expression when applied to all members of the group.
      static <TExpression>
      BsonField
      sum​(java.lang.String fieldName, TExpression expression)
      Deprecated.
      Gets a field name for a $group operation representing the sum of the values of the given expression when applied to all members of the group.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • sum

        public static <TExpression> BsonField sum​(java.lang.String fieldName,
                                                  TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing the sum of the values of the given expression when applied to all members of the group.
        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
      • avg

        public static <TExpression> BsonField avg​(java.lang.String fieldName,
                                                  TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing the average of the values of the given expression when applied to all members of the group.
        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
      • first

        public static <TExpression> BsonField first​(java.lang.String fieldName,
                                                    TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing the value of the given expression when applied to the first member of the group.
        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
      • last

        public static <TExpression> BsonField last​(java.lang.String fieldName,
                                                   TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing the value of the given expression when applied to the last member of the group.
        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
      • max

        public static <TExpression> BsonField max​(java.lang.String fieldName,
                                                  TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing the maximum of the values of the given expression when applied to all members of the group.
        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
      • min

        public static <TExpression> BsonField min​(java.lang.String fieldName,
                                                  TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing the minimum of the values of the given expression when applied to all members of the group.
        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
      • push

        public static <TExpression> BsonField push​(java.lang.String fieldName,
                                                   TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing an array of all values that results from applying an expression to each document in a group of documents that share the same group by key.
        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
      • addToSet

        public static <TExpression> BsonField addToSet​(java.lang.String fieldName,
                                                       TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing all unique values that results from applying the given expression to each document in a group of documents that share the same group by key.
        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
      • stdDevPop

        public static <TExpression> BsonField stdDevPop​(java.lang.String fieldName,
                                                        TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing the sample standard deviation of the values of the given expression when applied to all members of the group.

        Use if the values encompass the entire population of data you want to represent and do not wish to generalize about a larger population.

        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
        Since:
        3.2
      • stdDevSamp

        public static <TExpression> BsonField stdDevSamp​(java.lang.String fieldName,
                                                         TExpression expression)
        Deprecated.
        Gets a field name for a $group operation representing the sample standard deviation of the values of the given expression when applied to all members of the group.

        Use if the values encompass a sample of a population of data from which to generalize about the population.

        Type Parameters:
        TExpression - the expression type
        Parameters:
        fieldName - the field name
        expression - the expression
        Returns:
        the field
        Since:
        3.2