Package com.inductiveautomation.historian.gateway.api.paths

Record Class StandardHistorianPathAdapter

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.paths.StandardHistorianPathAdapter
All Implemented Interfaces:
QualifiedPathAdapter
public record StandardHistorianPathAdapter(Supplier<String> systemNameSupplier) extends Record implements QualifiedPathAdapter
A concrete implementation of the QualifiedPathAdapter interface that normalizes qualified paths into a standardized system/provider/tag component structure.

The normalization process attempts to transform incoming paths from various formats (such as driver-based paths or mixed component paths) into a consistent structure with components in the following order:

  • sys - System component
  • prov - Provider component
  • tag - Tag component (and any remaining path components)

This adapter utilizes a Supplier to dynamically supply the system name during the normalization process when it cannot be determined from the path itself.

  • Constructor Details

    • StandardHistorianPathAdapter

      public StandardHistorianPathAdapter(Supplier<String> systemNameSupplier)
      Creates an instance of a StandardHistorianPathAdapter record class.
      Parameters:
      systemNameSupplier - the value for the systemNameSupplier record component

  • Method Details

    • of

      public static StandardHistorianPathAdapter of(Supplier<String> systemNameSupplier)
      Creates a new instance of StandardHistorianPathAdapter using the provided supplier to obtain the system name.
      Parameters:
      systemNameSupplier - a Supplier that provides the system name for the adapter
      Returns:
      a new instance of StandardHistorianPathAdapter

    • normalize

      public AdaptedQualifiedPath normalize(QualifiedPath path) throws InvalidQualifiedPathException
      Description copied from interface: QualifiedPathAdapter
      Normalizes the given QualifiedPath and returns an AdaptedQualifiedPath. The normalization process may involve validating or modifying the input path according to specific implementation rules.
      Specified by:
      normalize in interface QualifiedPathAdapter
      Parameters:
      path - the QualifiedPath to normalize
      Returns:
      the resulting AdaptedQualifiedPath after normalization
      Throws:
      InvalidQualifiedPathException - if the provided QualifiedPath is invalid

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      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 with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • systemNameSupplier

      public Supplier<String> systemNameSupplier()
      Returns the value of the systemNameSupplier record component.
      Returns:
      the value of the systemNameSupplier record component