Class HistorianProperties

java.lang.Object
com.inductiveautomation.historian.common.model.HistorianProperties

public final class HistorianProperties extends Object
  • Field Details

  • Constructor Details

    • HistorianProperties

      public HistorianProperties()
  • Method Details

    • getMatchingLegacyFlag

      public static Optional<Integer> getMatchingLegacyFlag(String propertyName)
    • getMatchingPropertyFromLegacyFlag

      public static <T> Optional<Property<T>> getMatchingPropertyFromLegacyFlag(int legacyFlag)
    • applyToOptions

      public static <K extends DataPointQueryKey, B extends DataPointQueryOptions.DataQueryBuilder<K,B>> void applyToOptions(B builder, @Nullable PropertySet props)
      Moves the tag history query hints carried on a query's extendedProperties into the typed bounding field of builder. system.historian.* accepts the same flag vocabulary as TagHistoryQueryFlags, as Property entries rather than bits. Typed builder calls made afterwards supersede the properties.

      Only BoundingMode becomes a typed field; NATIVE_AGGREGATES_ONLY, NO_PREPROCESSED_DATA, NO_SCE_VALIDATION and NO_INTERPOLATION stay on extendedProperties for the pipeline to read at dispatch.

      A null or empty props does nothing.

      Type Parameters:
      K - the builder's query-key type
      B - the concrete builder type, preserving the fluent return type
      Parameters:
      builder - the builder to mutate; not null
      props - the extended properties; may be null or empty