Record Class HistorianQueryEntry.AggregatedEntry
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.binding.HistorianQueryEntry.AggregatedEntry
- All Implemented Interfaces:
HistorianQueryEntry
- Enclosing interface:
HistorianQueryEntry
public static record HistorianQueryEntry.AggregatedEntry(String alias, QualifiedPath source, @Nullable List<AggregateId> aggregateIds, Map<String,Object> parameters, @Nullable FillMode fillMode, boolean appendOnly, @Nullable Interpolation interpolation, @Nullable Double fillValue)
extends Record
implements HistorianQueryEntry
Aggregated data-point entry: the aggregate identity, optional aggregate parameters, fill,
interpolation and constant.
parameters holds aggregate parameters (for example {"percentile": 0.95}) as
a plain map so the config round-trips without the aggregate catalog; they are typed at query
time through ParameterSchema.fromMap(...). Pass Map.of() for an aggregate with
none.
A null aggregateIds inherits the binding-level defaultAggregateId,
falling back to AVERAGE; a null fillMode inherits
defaultFillMode, falling back to FillMode.AUTO; a null interpolation
takes the binding-level interpolation. fillValue is the constant a FillMode.CONSTANT fill gives an empty window. ofInheriting(String, QualifiedPath)
builds an entry that inherits everything.
-
Nested Class Summary
Nested classes/interfaces inherited from interface HistorianQueryEntry
HistorianQueryEntry.AggregatedEntry, HistorianQueryEntry.AnnotationEntry, HistorianQueryEntry.MetadataEntry, HistorianQueryEntry.RawEntry -
Constructor Summary
ConstructorsConstructorDescriptionAggregatedEntry(String alias, QualifiedPath source, @Nullable List<AggregateId> aggregateIds, Map<String, Object> parameters, @Nullable FillMode fillMode, boolean appendOnly) An entry under the binding's interpolation with no constant.AggregatedEntry(String alias, QualifiedPath source, @Nullable List<AggregateId> aggregateIds, Map<String, Object> parameters, @Nullable FillMode fillMode, boolean appendOnly, @Nullable Interpolation interpolation, @Nullable Double fillValue) Creates an instance of aAggregatedEntryrecord class. -
Method Summary
Modifier and TypeMethodDescription@Nullable AggregateIdReturns the first aggregate id, ornullwhen the entry inherits the binding-level default.@Nullable List<AggregateId> Returns the value of theaggregateIdsrecord component.alias()Returns the value of thealiasrecord component.booleanReturns the value of theappendOnlyrecord component.final booleanIndicates whether some other object is "equal to" this one.@Nullable FillModefillMode()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.of(String alias, QualifiedPath source) Creates an entry with the average aggregate, no parameters,FillMode.AUTO, and append-only off.ofInheriting(String alias, QualifiedPath source) Creates an entry that inherits the binding-level aggregate and fill mode, with no parameters and append-only off.Returns the value of theparametersrecord component.source()Returns the value of thesourcerecord component.final StringtoString()Returns a string representation of this record class.withAggregateIds(@Nullable List<AggregateId> newAggregateIds) withAppendOnly(boolean newAppendOnly) withFillMode(@Nullable FillMode newFillMode) withFillValue(@Nullable Double newFillValue) withInterpolation(@Nullable Interpolation newInterpolation) withParameters(Map<String, Object> newParameters) withSource(QualifiedPath newSource)
-
Constructor Details
-
AggregatedEntry
public AggregatedEntry(String alias, QualifiedPath source, @Nullable @Nullable List<AggregateId> aggregateIds, Map<String, Object> parameters, @Nullable @Nullable FillMode fillMode, boolean appendOnly) An entry under the binding's interpolation with no constant. -
AggregatedEntry
public AggregatedEntry(String alias, QualifiedPath source, @Nullable @Nullable List<AggregateId> aggregateIds, Map<String, Object> parameters, @Nullable @Nullable FillMode fillMode, boolean appendOnly, @Nullable @Nullable Interpolation interpolation, @Nullable @Nullable Double fillValue) Creates an instance of aAggregatedEntryrecord class.- Parameters:
alias- the value for thealiasrecord componentsource- the value for thesourcerecord componentaggregateIds- the value for theaggregateIdsrecord componentparameters- the value for theparametersrecord componentfillMode- the value for thefillModerecord componentappendOnly- the value for theappendOnlyrecord componentinterpolation- the value for theinterpolationrecord componentfillValue- the value for thefillValuerecord component
-
-
Method Details
-
aggregateId
Returns the first aggregate id, ornullwhen the entry inherits the binding-level default. Wide and Tall entries have exactly one; for Calculations entries useaggregateIds()for the full set. -
withAlias
-
withSource
-
withFillMode
-
withInterpolation
public HistorianQueryEntry.AggregatedEntry withInterpolation(@Nullable @Nullable Interpolation newInterpolation) -
withFillValue
-
withAppendOnly
-
withAggregateIds
public HistorianQueryEntry.AggregatedEntry withAggregateIds(@Nullable @Nullable List<AggregateId> newAggregateIds) -
withParameters
-
of
Creates an entry with the average aggregate, no parameters,FillMode.AUTO, and append-only off. -
ofInheriting
Creates an entry that inherits the binding-level aggregate and fill mode, with no parameters and append-only off. -
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. -
alias
Returns the value of thealiasrecord component.- Specified by:
aliasin interfaceHistorianQueryEntry- Returns:
- the value of the
aliasrecord component
-
source
Returns the value of thesourcerecord component.- Specified by:
sourcein interfaceHistorianQueryEntry- Returns:
- the value of the
sourcerecord component
-
aggregateIds
Returns the value of theaggregateIdsrecord component.- Returns:
- the value of the
aggregateIdsrecord component
-
parameters
-
fillMode
Returns the value of thefillModerecord component.- Returns:
- the value of the
fillModerecord component
-
appendOnly
public boolean appendOnly()Returns the value of theappendOnlyrecord component.- Specified by:
appendOnlyin interfaceHistorianQueryEntry- Returns:
- the value of the
appendOnlyrecord component
-
interpolation
Returns the value of theinterpolationrecord component.- Returns:
- the value of the
interpolationrecord component
-
fillValue
Returns the value of thefillValuerecord component.- Returns:
- the value of the
fillValuerecord component
-