mongo4cats-kernel
API
Generated with
mongo4cats-kernel/mongo4cats/mongo4cats.operations/Accumulator

Accumulator

mongo4cats.operations.Accumulator
See theAccumulator companion class
object Accumulator extends Accumulator

Attributes

Companion
class
Graph
Supertypes
class Accumulator
trait AsJavaConverters
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Inherited methods

def addToSet[T](fieldName: String, expression: T): Accumulator

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.

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.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/addToSet/

Inherited from:
Accumulator
def asJava[K, V](m: Map[K, V]): ConcurrentMap[K, V]

Attributes

Inherited from:
AsJavaConverters
def asJava[K, V](m: Map[K, V]): Map[K, V]

Attributes

Inherited from:
AsJavaConverters
def asJava[K, V](m: Map[K, V]): Map[K, V]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](s: Set[A]): Set[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](s: Set[A]): Set[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](s: Seq[A]): List[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](s: Seq[A]): List[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](b: Buffer[A]): List[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](i: Iterable[A]): Iterable[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](i: Iterator[A]): Iterator[A]

Attributes

Inherited from:
AsJavaConverters
def asJavaCollection[A](i: Iterable[A]): Collection[A]

Attributes

Inherited from:
AsJavaConverters
def asJavaDictionary[K, V](m: Map[K, V]): Dictionary[K, V]

Attributes

Inherited from:
AsJavaConverters
def asJavaEnumeration[A](i: Iterator[A]): Enumeration[A]

Attributes

Inherited from:
AsJavaConverters
def avg[T](fieldName: String, expression: T): Accumulator

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.

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.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/avg/

Inherited from:
Accumulator
def combinedWith(anotherAccumulator: Accumulator): Accumulator

Merges 2 field accumulators together.

Merges 2 field accumulators together.

Value parameters

anotherAccumulator

the accumulator to be merged with

Attributes

Returns

the accumulator

Inherited from:
Accumulator
override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Accumulator -> Any
Inherited from:
Accumulator
def first[T](fieldName: String, expression: T): Accumulator

Gets a field name for a $group operation representing the value of the given expression when applied to the first member of the group.

Gets a field name for a $group operation representing the value of the given expression when applied to the first member of the group.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/first/

Inherited from:
Accumulator
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Accumulator -> Any
Inherited from:
Accumulator
def last[T](fieldName: String, expression: T): Accumulator

Gets a field name for a $group operation representing the value of the given expression when applied to the last member of the group.

Gets a field name for a $group operation representing the value of the given expression when applied to the last member of the group.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/last/

Inherited from:
Accumulator
def max[T](fieldName: String, expression: T): Accumulator

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.

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.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/max/

Inherited from:
Accumulator
def min[T](fieldName: String, expression: T): Accumulator

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.

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.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/min/

Inherited from:
Accumulator
def push[T](fieldName: String, expression: T): Accumulator

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.

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.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/push/

Inherited from:
Accumulator
def stdDevPop[T](fieldName: String, expression: T): Accumulator

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.

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.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/stdDevPop/

Since

3.2

Inherited from:
Accumulator
def stdDevSamp[T](fieldName: String, expression: T): Accumulator

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.

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.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/stdDevSamp/

Inherited from:
Accumulator
def sum[T](fieldName: String, expression: T): Accumulator

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.

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.

Value parameters

expression

the expression https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#std-label-aggregation-expressions

fieldName

the field name

Attributes

Returns

the accumulator https://docs.mongodb.com/manual/reference/operator/aggregation/sum/

Inherited from:
Accumulator
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Accumulator -> Any
Inherited from:
Accumulator
Generated with