Class MaxAggregator

Instances of this interface perform a specific aggregation of bindings. You can put bindings and when all bindings have been put, request the result.

Hierarchy (View Summary)

AggregateEvaluator
- MaxAggregator

Implements

IBindingsAggregator

Index

Constructors

Properties

distinct evaluator superTypeProvider termTransformer

Methods

emptyValue emptyValueTerm putBindings putTerm removeTerm result termResult termToNumericOrError

Constructors

constructor

new MaxAggregator(
    evaluator: IExpressionEvaluator,
    distinct: boolean,
    orderByEvaluator: ITermComparator,
    throwError?: boolean,
): MaxAggregator
Parameters
- evaluator: IExpressionEvaluator
- distinct: boolean
- orderByEvaluator: ITermComparator
- OptionalthrowError: boolean
Returns MaxAggregator
Overrides AggregateEvaluator.constructor
- Defined in packages/actor-bindings-aggregator-factory-max/lib/MaxAggregator.ts:14

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(): undefined | Term
Returns undefined | Term
Inherited from AggregateEvaluator.emptyValueTerm
- Defined in packages/bus-bindings-aggregator-factory/lib/AggregateEvaluator.ts:33

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>
Implementation of IBindingsAggregator.putBindings
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-max/lib/MaxAggregator.ts:23

`Protected`removeTerm

removeTerm(term: Term): void
Parameters
- term: Term
Returns void
Overrides AggregateEvaluator.removeTerm
- Defined in packages/actor-bindings-aggregator-factory-max/lib/MaxAggregator.ts:33

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.
Implementation of IBindingsAggregator.result
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-max/lib/MaxAggregator.ts:42

`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