@incremunica/bus-bindings-aggregator-factory/lib/AggregateEvaluator.d.ts

An Incremunica bus for bindings aggregator factories.

import type { IExpressionEvaluator, ISuperTypeProvider } from '@comunica/types';
import type { Bindings } from '@comunica/utils-bindings-factory';
import * as Eval from '@comunica/utils-expression-evaluator';
import type * as RDF from '@rdfjs/types';
/**
 * This is the base class for all aggregators.
 * NOTE: The wildcard count aggregator significantly differs from the others and overloads parts of this class.
 */
export declare abstract class AggregateEvaluator {
    protected readonly evaluator: IExpressionEvaluator;
    protected readonly distinct: boolean;
    private readonly throwError;
    private errorOccurred;
    private lastResult;
    protected readonly superTypeProvider: ISuperTypeProvider;
    protected readonly termTransformer: Eval.TermTransformer;
    protected constructor(evaluator: IExpressionEvaluator, distinct: boolean, throwError?: boolean);
    protected abstract putTerm(term: RDF.Term): void;
    protected abstract removeTerm(term: RDF.Term): void;
    protected abstract termResult(): RDF.Term | undefined;
    emptyValueTerm(): RDF.Term | undefined;
    /**
     * 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.
     */
    emptyValue(): RDF.Term | undefined;
    /**
     * Base implementation of putBindings, that evaluates to a term and then calls putTerm.
     * The WildcardCountAggregator will completely discard this implementation.
     * @param bindings
     */
    putBindings(bindings: Bindings): Promise<void>;
    /**
     * Base implementation of result, that calls termResult and caches the result.
     * @returns {RDF.Term | undefined | null}
     * The result term, or undefined if no new result is available, or null if an error occurred.
     */
    result(): RDF.Term | undefined | null;
    private safeThrow;
    protected termToNumericOrError(term: RDF.Term): Eval.NumericLiteral;
}