Class EngineAggregates
java.lang.Object
com.inductiveautomation.historian.gateway.api.query.EngineAggregates
Definitions two or more engines compute. An engine may bind them or ignore them; the catalog does
not know they exist. A definition fixes what the id means across engines; the engine keeps the
SQL, the columns it reduces and its required extension.
define(String, DataType, boolean, boolean, boolean) builds an engine's own
definition the same way.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordAn engine-own or shared aggregate's definition: its id, label key, output type, parameters and the predicates the pipeline reads. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final EngineAggregates.DefinitionBitwise reductions over an integer column.static final EngineAggregates.Definitionstatic final EngineAggregates.Definitionstatic final EngineAggregates.DefinitionThe number of distinct admitted values.static final EngineAggregates.DefinitionThe window's first admitted sample; an empty window takes the value at its start, as last value takes the value at its end.static final EngineAggregates.DefinitionThe geometric mean of the admitted values above zero; values at or below zero are excluded.static final EngineAggregates.DefinitionThe most frequent admitted value; a tie goes to the smallest value.static final ParameterSchemaThepparameter of a percentile estimate, 0 to 1.static final EngineAggregates.Definitionstatic final EngineAggregates.DefinitionThe admitted values in time order, joined by thedelimiterparameter.static final EngineAggregates.DefinitionThe distinct admitted values in time order, joined by thedelimiterparameter.static final EngineAggregates.Definition -
Method Summary
Modifier and TypeMethodDescriptionstatic EngineAggregates.Definitiondefine(String id, @Nullable DataType dataType, boolean takesWindowFill, boolean counter, boolean oneSampleIsSample) A definition underid, which must not be aStandardAggregatesid:dataTypethe output type (null keeps the tag's),takesWindowFillwhether an empty window may take its neighbours' values,counterwhether an empty window counts zero (a count of samples, changes or values; anything read between samples, such as a delta or a rate, has no value there and takes the fill),oneSampleIsSamplewhether a window holding one sample has that sample's value.
-
Field Details
-
FIRST
The window's first admitted sample; an empty window takes the value at its start, as last value takes the value at its end. -
COUNT_DISTINCT
The number of distinct admitted values. -
STANDARD_DEVIATION_POPULATION
-
VARIANCE_POPULATION
-
GEOMETRIC_MEAN
The geometric mean of the admitted values above zero; values at or below zero are excluded. -
MODE
The most frequent admitted value; a tie goes to the smallest value. -
BIT_AND
Bitwise reductions over an integer column. -
BIT_OR
-
BIT_XOR
-
STRING_AGG
The admitted values in time order, joined by thedelimiterparameter. -
STRING_DISTINCT_AGG
The distinct admitted values in time order, joined by thedelimiterparameter. -
PERCENTILE_PARAMS
Thepparameter of a percentile estimate, 0 to 1.
-
-
Method Details
-
define
public static EngineAggregates.Definition define(String id, @Nullable DataType dataType, boolean takesWindowFill, boolean counter, boolean oneSampleIsSample) A definition underid, which must not be aStandardAggregatesid:dataTypethe output type (null keeps the tag's),takesWindowFillwhether an empty window may take its neighbours' values,counterwhether an empty window counts zero (a count of samples, changes or values; anything read between samples, such as a delta or a rate, has no value there and takes the fill),oneSampleIsSamplewhether a window holding one sample has that sample's value.
-