Class RawQueryOptions
java.lang.Object
com.inductiveautomation.historian.common.model.options.AbstractQueryOptions<RawQueryKey, DataPointType>
com.inductiveautomation.historian.common.model.options.DataPointQueryOptions<RawQueryKey>
com.inductiveautomation.historian.common.model.options.RawQueryOptions
- All Implemented Interfaces:
QueryOptions<RawQueryKey, DataPointType>
Options for a raw query; the query key is a
RawQueryKey.-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class DataPointQueryOptions
DataPointQueryOptions.DataQueryBuilder<K,B> Nested classes/interfaces inherited from class AbstractQueryOptions
AbstractQueryOptions.BaseBuilder<K,T, B> -
Field Summary
Fields inherited from class AbstractQueryOptions
extendedProperties, queryKeys, returnSize, timeRange -
Method Summary
Modifier and TypeMethodDescriptionstatic RawQueryOptions.Builderbuilder()Returns a new builder.static RawQueryOptions.Builderbuilder(RawQueryOptions options) Returns a builder initialized fromoptions.Returns how a Wide cell that no sample reached is answered.ReturnsStandardDataPointType.ATOMIC.booleanReturns whether a tag history call asks for the classic tag history read: the wide carry plus the historian's realtime value at the end of the range.toString()Methods inherited from class DataPointQueryOptions
areObservationsExcluded, getBounding, getQualityLevelFilter, getRequestedBounding, getRequestedQualityLevelFilterMethods inherited from class AbstractQueryOptions
getExtendedProperties, getExtendedPropertyValue, getQueryKeys, getReturnSize, getTimeRange
-
Method Details
-
getFillMode
Returns how a Wide cell that no sample reached is answered.FillMode.PREVIOUSrepeats the column's last sample, as does every fill under the classic read.FillMode.AUTO(the default) repeats it on a legacy compatible historian and leaves the cell empty elsewhere. Any other fill leaves it empty. Typed surfaces accept onlyAUTOandPREVIOUS. Tall results never fill.- Returns:
- the fill mode; never
null
-
isLegacyCompatible
public boolean isLegacyCompatible()Returns whether a tag history call asks for the classic tag history read: the wide carry plus the historian's realtime value at the end of the range. Defaultfalse. -
getPointType
ReturnsStandardDataPointType.ATOMIC. -
toString
- Overrides:
toStringin classDataPointQueryOptions<RawQueryKey>
-
builder
Returns a new builder. -
builder
Returns a builder initialized fromoptions.- Parameters:
options- the options to copy
-