Package com.inductiveautomation.historian.gateway.api.query

Interface HistoricalNode

All Known Implementing Classes:
QuestHistoricalNode, SqliteHistoricalNode
public interface HistoricalNode
The HistoricalNode interface represents a versioned node in a historical data system. Each node is uniquely identified and provides metadata about its creation, data type, and optional retirement status.

This interface is typically implemented by classes that represent historical entities such as database nodes or other structured entities that track changes over time.

  • Method Summary

    Modifier and Type
    Method
    Description
    Instant
    createdTime()
    Retrieves the creation timestamp of this historical node.
    Optional<DataType>
    dataType()
    Retrieves the data type associated with this historical node, if available.
    UUID
    nodeId()
    Returns the unique identifier of the historical node.
    Optional<Instant>
    retiredTime()
    Retrieves the retirement timestamp of this historical node, if available.
    QualifiedPath
    source()
    Returns the qualified path that identifies the source of the historical node.

  • Method Details

    • nodeId

      UUID nodeId()
      Returns the unique identifier of the historical node.
      Returns:
      a UUID representing the unique identifier of this node.

    • source

      QualifiedPath source()
      Returns the qualified path that identifies the source of the historical node.
      Returns:
      a QualifiedPath representing the source of this node.

    • dataType

      Optional<DataType> dataType()
      Retrieves the data type associated with this historical node, if available.
      Returns:
      an Optional describing the data type of the node, or an empty Optional if no data type is associated.

    • createdTime

      Instant createdTime()
      Retrieves the creation timestamp of this historical node.
      Returns:
      an Instant representing the point in time when this node was created.

    • retiredTime

      Optional<Instant> retiredTime()
      Retrieves the retirement timestamp of this historical node, if available. A retirement timestamp indicates the point in time when the node was marked as retired.
      Returns:
      an Optional containing the retirement timestamp of the node, or an empty Optional if the node hasn't been marked as retired.