Class SumAggregator

This is the base class for all aggregators. NOTE: The wildcard count aggregator significantly differs from the others and overloads parts of this class.

Hierarchy (View Summary)

AggregateEvaluator
- SumAggregator

Index

Constructors

constructor

new SumAggregator(
    evaluator: IExpressionEvaluator,
    distinct: boolean,
    dataFactory: ComunicaDataFactory,
    additionFunction: ITermFunction,
    subtractionFunction: ITermFunction,
    throwError?: boolean,
): SumAggregator
Parameters
- evaluator: IExpressionEvaluator
- distinct: boolean
- dataFactory: ComunicaDataFactory
- additionFunction: ITermFunction
- subtractionFunction: ITermFunction
- OptionalthrowError: boolean
Returns SumAggregator
Overrides AggregateEvaluator.constructor
- Defined in packages/actor-bindings-aggregator-factory-sum/lib/SumAggregator.ts:17

Properties

`Protected` `Readonly`distinct

distinct: boolean

`Protected` `Readonly`evaluator

evaluator: IExpressionEvaluator

`Protected` `Readonly`superTypeProvider

superTypeProvider: ISuperTypeProvider

`Protected` `Readonly`termTransformer

termTransformer: TermTransformer

Methods

emptyValue

emptyValue(): undefined | Term
The spec says to throw an error when a set function is called on an empty set (unless explicitly mentioned otherwise like COUNT). However, aggregate error handling says to not bind the result in case of an error. So to simplify logic in the caller, we return undefined by default.

Returns undefined | Term
Inherited from AggregateEvaluator.emptyValue
- Defined in packages/bus-bindings-aggregator-factory/lib/AggregateEvaluator.ts:43

emptyValueTerm

emptyValueTerm(): Term
Returns Term
Overrides AggregateEvaluator.emptyValueTerm
- Defined in packages/actor-bindings-aggregator-factory-sum/lib/SumAggregator.ts:28

putBindings

putBindings(bindings: Bindings): Promise<void>
Base implementation of putBindings, that evaluates to a term and then calls putTerm. The WildcardCountAggregator will completely discard this implementation.
Parameters
- bindings: Bindings
Returns Promise<void>
Inherited from AggregateEvaluator.putBindings
- Defined in packages/bus-bindings-aggregator-factory/lib/AggregateEvaluator.ts:56

`Protected`putTerm

putTerm(term: Term): void
Parameters
- term: Term
Returns void
Overrides AggregateEvaluator.putTerm
- Defined in packages/actor-bindings-aggregator-factory-sum/lib/SumAggregator.ts:32

`Protected`removeTerm

removeTerm(term: Term): void
Parameters
- term: Term
Returns void
Overrides AggregateEvaluator.removeTerm
- Defined in packages/actor-bindings-aggregator-factory-sum/lib/SumAggregator.ts:52

result

result(): undefined | null | Term
Base implementation of result, that calls termResult and caches the result.

Returns undefined | null | Term
The result term, or undefined if no new result is available, or null if an error occurred.
Inherited from AggregateEvaluator.result
- Defined in packages/bus-bindings-aggregator-factory/lib/AggregateEvaluator.ts:80

`Protected`termResult

termResult(): undefined | Term
Returns undefined | Term
Overrides AggregateEvaluator.termResult
- Defined in packages/actor-bindings-aggregator-factory-sum/lib/SumAggregator.ts:77

`Protected`termToNumericOrError

termToNumericOrError(term: Term): NumericLiteral
Parameters
- term: Term
Returns NumericLiteral
Inherited from AggregateEvaluator.termToNumericOrError
- Defined in packages/bus-bindings-aggregator-factory/lib/AggregateEvaluator.ts:104

Class SumAggregator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SumAggregator

Properties

`Protected` `Readonly`distinct

`Protected` `Readonly`evaluator

`Protected` `Readonly`superTypeProvider

`Protected` `Readonly`termTransformer

Methods

emptyValue

Returns undefined | Term

emptyValueTerm

Returns Term

putBindings

Parameters

Returns Promise<void>

`Protected`putTerm

Parameters

Returns void

`Protected`removeTerm

Parameters

Returns void

result

Returns undefined | null | Term

`Protected`termResult

Returns undefined | Term

`Protected`termToNumericOrError

Parameters

Returns NumericLiteral

Settings

On This Page

Class SumAggregator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SumAggregator

Properties

Protected Readonlydistinct

Protected Readonlyevaluator

Protected ReadonlysuperTypeProvider

Protected ReadonlytermTransformer

Methods

emptyValue

Returns undefined | Term

emptyValueTerm

Returns Term

putBindings

Parameters

Returns Promise<void>

ProtectedputTerm

Parameters

Returns void

ProtectedremoveTerm

Parameters

Returns void

result

Returns undefined | null | Term

ProtectedtermResult

Returns undefined | Term

ProtectedtermToNumericOrError

Parameters

Returns NumericLiteral

Settings

On This Page

`Protected` `Readonly`distinct

`Protected` `Readonly`evaluator

`Protected` `Readonly`superTypeProvider

`Protected` `Readonly`termTransformer

`Protected`putTerm

`Protected`removeTerm

`Protected`termResult

`Protected`termToNumericOrError