Record Class RowSchema
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.RowSchema
- Record Components:
columnNames- ordered column namescolumnTypes- ordered column types (parallel tocolumnNames)firstColumnIsTimestamp- whether column 0 is a timestamp columnsupportsQuality- whether this dataset carries a quality code per cell; unrelated to whether column 0 is a timestampaggregateColumnTypes- the type of each aggregate's cells where one value column carries several aggregates (the Calculation layout), so a pivot can type a column per aggregate; empty otherwise
public record RowSchema(List<String> columnNames, List<ColumnType> columnTypes, boolean firstColumnIsTimestamp, boolean supportsQuality, Map<AggregateId, ColumnType> aggregateColumnTypes)
extends Record
Describes the schema of rows emitted by a
QueryPipeline.
Emitted exactly once via RowSink.onSchema(RowSchema) before any rows. Columns are
positional; per-cell qualities on Row.Wide are indexed identically.
-
Constructor Summary
ConstructorsConstructorDescriptionRowSchema(List<String> columnNames, List<ColumnType> columnTypes, boolean firstColumnIsTimestamp, boolean supportsQuality) A schema with no per-aggregate column types.RowSchema(List<String> columnNames, List<ColumnType> columnTypes, boolean firstColumnIsTimestamp, boolean supportsQuality, Map<AggregateId, ColumnType> aggregateColumnTypes) Creates an instance of aRowSchemarecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of theaggregateColumnTypesrecord component.Returns the value of thecolumnNamesrecord component.Returns the value of thecolumnTypesrecord component.final booleanIndicates whether some other object is "equal to" this one.booleanReturns the value of thefirstColumnIsTimestamprecord component.final inthashCode()Returns a hash code value for this object.booleanReturns the value of thesupportsQualityrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
RowSchema
public RowSchema(List<String> columnNames, List<ColumnType> columnTypes, boolean firstColumnIsTimestamp, boolean supportsQuality, Map<AggregateId, ColumnType> aggregateColumnTypes) Creates an instance of aRowSchemarecord class.- Parameters:
columnNames- the value for thecolumnNamesrecord componentcolumnTypes- the value for thecolumnTypesrecord componentfirstColumnIsTimestamp- the value for thefirstColumnIsTimestamprecord componentsupportsQuality- the value for thesupportsQualityrecord componentaggregateColumnTypes- the value for theaggregateColumnTypesrecord component
-
RowSchema
public RowSchema(List<String> columnNames, List<ColumnType> columnTypes, boolean firstColumnIsTimestamp, boolean supportsQuality) A schema with no per-aggregate column types.
-
-
Method Details
-
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. -
columnNames
Returns the value of thecolumnNamesrecord component.- Returns:
- the value of the
columnNamesrecord component
-
columnTypes
Returns the value of thecolumnTypesrecord component.- Returns:
- the value of the
columnTypesrecord component
-
firstColumnIsTimestamp
public boolean firstColumnIsTimestamp()Returns the value of thefirstColumnIsTimestamprecord component.- Returns:
- the value of the
firstColumnIsTimestamprecord component
-
supportsQuality
public boolean supportsQuality()Returns the value of thesupportsQualityrecord component.- Returns:
- the value of the
supportsQualityrecord component
-
aggregateColumnTypes
Returns the value of theaggregateColumnTypesrecord component.- Returns:
- the value of the
aggregateColumnTypesrecord component
-