Record Class AggregatedQueryKey
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.AggregatedQueryKey
- Record Components:
source- the path of the data pointaggregate- the aggregate's identity and parametersfillMode- what a window the calculation left without a value gets; seeFillModeinterpolation- how this key reads the signal and whether its windows take edge values;nullorInterpolation.AUTOtakes the query's defaultAggregatedQueryOptions.getInterpolation()fillValue- the value every empty window takes underFillMode.CONSTANT; ignored under any other fill
- All Implemented Interfaces:
DataPointQueryKey, QueryKey<DataPointType>
public record AggregatedQueryKey(QualifiedPath source, AggregateSpec aggregate, FillMode fillMode, @Nullable Interpolation interpolation, @Nullable Double fillValue)
extends Record
implements DataPointQueryKey
Query key for an aggregated query: a source path, an
AggregateSpec, a fill mode, an
interpolation and a constant. of(QualifiedPath, AggregationType) builds an
unparameterized spec; read aggregate().type() for the underlying AggregationType.-
Constructor Summary
ConstructorsConstructorDescriptionAggregatedQueryKey(QualifiedPath source, AggregateSpec aggregate, FillMode fillMode) A key under the query's interpolation with no constant.AggregatedQueryKey(QualifiedPath source, AggregateSpec aggregate, FillMode fillMode, @Nullable Interpolation interpolation, @Nullable Double fillValue) Creates an instance of aAggregatedQueryKeyrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of theaggregaterecord component.final booleanIndicates whether some other object is "equal to" this one.fillMode()Returns the value of thefillModerecord component.@Nullable DoubleReturns the value of thefillValuerecord component.final inthashCode()Returns a hash code value for this object.@Nullable InterpolationReturns the value of theinterpolationrecord component.static AggregatedQueryKeyof(QualifiedPath source, AggregationType aggregationType) Creates a key for an unparameterized aggregate withFillMode.AUTO.static AggregatedQueryKeyof(QualifiedPath source, AggregationType aggregationType, FillMode fillMode) Creates a key for an unparameterized aggregate with the given fill mode.static AggregatedQueryKeyof(QualifiedPath source, AggregateSpec aggregate) Creates a key for a possibly parameterized aggregate withFillMode.AUTO.ReturnsStandardDataPointType.AGGREGATED.source()Returns the value of thesourcerecord component.final StringtoString()Returns a string representation of this record class.withFillMode(FillMode fillMode) Returns this key withfillMode, everything else unchanged.withInterpolation(@Nullable Interpolation interpolation) Returns this key withinterpolation, everything else unchanged.
-
Constructor Details
-
AggregatedQueryKey
A key under the query's interpolation with no constant. -
AggregatedQueryKey
public AggregatedQueryKey(QualifiedPath source, AggregateSpec aggregate, FillMode fillMode, @Nullable Interpolation interpolation, @Nullable Double fillValue) Creates an instance of aAggregatedQueryKeyrecord class.- Parameters:
source- the value for thesourcerecord componentaggregate- the value for theaggregaterecord componentfillMode- the value for thefillModerecord componentinterpolation- the value for theinterpolationrecord componentfillValue- the value for thefillValuerecord component
-
-
Method Details
-
withFillMode
Returns this key withfillMode, everything else unchanged. -
withInterpolation
Returns this key withinterpolation, everything else unchanged. -
pointType
ReturnsStandardDataPointType.AGGREGATED.- Specified by:
pointTypein interfaceQueryKey<DataPointType>- Returns:
- the point type.
-
of
Creates a key for an unparameterized aggregate withFillMode.AUTO.- Parameters:
source- the path of the data pointaggregationType- the aggregate- Returns:
- the key
-
of
public static AggregatedQueryKey of(QualifiedPath source, AggregationType aggregationType, FillMode fillMode) Creates a key for an unparameterized aggregate with the given fill mode.- Parameters:
source- the path of the data pointaggregationType- the aggregatefillMode- what a window with no samples gets- Returns:
- the key
-
of
Creates a key for a possibly parameterized aggregate withFillMode.AUTO.- Parameters:
source- the path of the data pointaggregate- the aggregate's identity and parameters- Returns:
- the key
-
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. All components in this record class are compared withObjects::equals(Object,Object). -
source
Returns the value of thesourcerecord component.- Specified by:
sourcein interfaceDataPointQueryKey- Returns:
- the value of the
sourcerecord component
-
aggregate
-
fillMode
-
interpolation
Returns the value of theinterpolationrecord component.- Returns:
- the value of the
interpolationrecord component
-
fillValue
-