Record Class EngineAggregates.Definition
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.EngineAggregates.Definition
- All Implemented Interfaces:
AggregationType
- Enclosing class:
EngineAggregates
public static record EngineAggregates.Definition(AggregateId id, String labelKey, @Nullable DataType outputType, ParameterSchema parameterSchema, boolean takesWindowFill, boolean counter, boolean oneSampleIsSample, AggregationType.EmptyWindowBound emptyWindowBound, boolean approximate)
extends Record
implements AggregationType
An engine-own or shared aggregate's definition: its id, label key, output type, parameters and
the predicates the pipeline reads. Reads a window's bound only when
emptyWindowBound
names one.-
Nested Class Summary
Nested classes/interfaces inherited from interface AggregationType
AggregationType.EmptyWindowBound -
Constructor Summary
ConstructorsConstructorDescriptionDefinition(AggregateId id, String labelKey, @Nullable DataType outputType, ParameterSchema parameterSchema, boolean takesWindowFill, boolean counter, boolean oneSampleIsSample, AggregationType.EmptyWindowBound emptyWindowBound, boolean approximate) Creates an instance of aDefinitionrecord class. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the value of theapproximaterecord component.The same definition marked an estimate.The same definition whose empty window answers the signal's value atside.booleancounter()Returns the value of thecounterrecord component.dataType()Returns the data type this aggregate produces regardless of its input.Returns the aggregate's description.Returns the value of theemptyWindowBoundrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.id()Returns the value of theidrecord component.labelKey()Returns the value of thelabelKeyrecord component.The same definition labelled fromkeyin the engine's bundle.name()Returns the aggregate's name.booleanReturns the value of theoneSampleIsSamplerecord component.@Nullable DataTypeReturns the value of theoutputTyperecord component.parameters(ParameterSchema schema) The same definition withparameterSchema.Returns the value of theparameterSchemarecord component.booleanReturns whether an empty window may take a constant.booleanReturns the value of thetakesWindowFillrecord component.final StringtoString()Returns a string representation of this record class.booleanReturns whether the aggregate reads the signal's values at its window edges.Methods inherited from interface AggregationType
acceptedInputTypes, applicableFillModes, applicableFills, entry, interpolations, interpolations, legacyFills, offeredInputTypes, resolveInterpolation
-
Constructor Details
-
Definition
public Definition(AggregateId id, String labelKey, @Nullable DataType outputType, ParameterSchema parameterSchema, boolean takesWindowFill, boolean counter, boolean oneSampleIsSample, AggregationType.EmptyWindowBound emptyWindowBound, boolean approximate) Creates an instance of aDefinitionrecord class.- Parameters:
id- the value for theidrecord componentlabelKey- the value for thelabelKeyrecord componentoutputType- the value for theoutputTyperecord componentparameterSchema- the value for theparameterSchemarecord componenttakesWindowFill- the value for thetakesWindowFillrecord componentcounter- the value for thecounterrecord componentoneSampleIsSample- the value for theoneSampleIsSamplerecord componentemptyWindowBound- the value for theemptyWindowBoundrecord componentapproximate- the value for theapproximaterecord component
-
-
Method Details
-
parameters
The same definition withparameterSchema. -
atBound
The same definition whose empty window answers the signal's value atside. -
approximated
The same definition marked an estimate. -
labelled
The same definition labelled fromkeyin the engine's bundle. -
name
Description copied from interface:AggregationTypeReturns the aggregate's name.- Specified by:
namein interfaceAggregationType- Returns:
- the name.
-
description
Description copied from interface:AggregationTypeReturns the aggregate's description.- Specified by:
descriptionin interfaceAggregationType- Returns:
- the description.
-
dataType
Description copied from interface:AggregationTypeReturns the data type this aggregate produces regardless of its input.- Specified by:
dataTypein interfaceAggregationType- Returns:
- the type, or empty when the result takes the type of the tag it was computed over.
-
usesBounds
public boolean usesBounds()Description copied from interface:AggregationTypeReturns whether the aggregate reads the signal's values at its window edges.- Specified by:
usesBoundsin interfaceAggregationType
-
takesConstant
public boolean takesConstant()Description copied from interface:AggregationTypeReturns whether an empty window may take a constant. OtherwiseAggregationType.takesWindowFill().- Specified by:
takesConstantin interfaceAggregationType
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
id
Returns the value of theidrecord component.- Specified by:
idin interfaceAggregationType- Returns:
- the value of the
idrecord component
-
labelKey
Returns the value of thelabelKeyrecord component.- Returns:
- the value of the
labelKeyrecord component
-
outputType
Returns the value of theoutputTyperecord component.- Returns:
- the value of the
outputTyperecord component
-
parameterSchema
Returns the value of theparameterSchemarecord component.- Specified by:
parameterSchemain interfaceAggregationType- Returns:
- the value of the
parameterSchemarecord component
-
takesWindowFill
public boolean takesWindowFill()Returns the value of thetakesWindowFillrecord component.- Specified by:
takesWindowFillin interfaceAggregationType- Returns:
- the value of the
takesWindowFillrecord component
-
counter
public boolean counter()Returns the value of thecounterrecord component.- Specified by:
counterin interfaceAggregationType- Returns:
- the value of the
counterrecord component
-
oneSampleIsSample
public boolean oneSampleIsSample()Returns the value of theoneSampleIsSamplerecord component.- Specified by:
oneSampleIsSamplein interfaceAggregationType- Returns:
- the value of the
oneSampleIsSamplerecord component
-
emptyWindowBound
Returns the value of theemptyWindowBoundrecord component.- Specified by:
emptyWindowBoundin interfaceAggregationType- Returns:
- the value of the
emptyWindowBoundrecord component
-
approximate
public boolean approximate()Returns the value of theapproximaterecord component.- Specified by:
approximatein interfaceAggregationType- Returns:
- the value of the
approximaterecord component
-