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

Class RootBrowsePublisher

java.lang.Object
com.inductiveautomation.historian.gateway.api.query.browsing.RootBrowsePublisher
All Implemented Interfaces:
BrowsePublisher
public class RootBrowsePublisher extends Object implements BrowsePublisher
The RootBrowsePublisher class is responsible for publishing browsing results starting from a specified root path. It implements the BrowsePublisher interface and provides capability for managing results and handling nodes in the browsing hierarchy.

  • Constructor Details

    • RootBrowsePublisher

      public RootBrowsePublisher(QualifiedPath rootPath)

  • Method Details

    • getResults

      public Results<Result> getResults()

    • isCanceled

      public boolean isCanceled()
      Description copied from interface: BrowsePublisher
      Determines whether the browsing operation has been canceled.
      Specified by:
      isCanceled in interface BrowsePublisher
      Returns:
      true if the browsing operation has been canceled, false otherwise.

    • cancel

      public void cancel()

    • getResultCount

      public int getResultCount()
      Description copied from interface: BrowsePublisher
      Retrieves the current count of results that have been added.
      Specified by:
      getResultCount in interface BrowsePublisher
      Returns:
      the total number of results currently stored.

    • setTotalResultsAvailable

      public void setTotalResultsAvailable(int totalResultsAvailable)
      Description copied from interface: BrowsePublisher
      Sets the total number of results that should be available for browsing. This value is primarily used for pagination when implementing result size limits and managing continuation points.
      Specified by:
      setTotalResultsAvailable in interface BrowsePublisher
      Parameters:
      totalResultsAvailable - The total count of results that exist in the complete result set regardless of any pagination constraints

    • setContinuationPoint

      public void setContinuationPoint(String continuationPoint)
      Description copied from interface: BrowsePublisher
      Updates the continuation point for the browsing operation. The continuation point is used to track the current position within a paginated or hierarchical browsing structure, enabling continuation or resumption of browsing from a specific state.
      Specified by:
      setContinuationPoint in interface BrowsePublisher
      Parameters:
      continuationPoint - the new continuation point to set, typically a string identifier representing the current position or state.

    • addResult

      protected void addResult(BasicResult result)

    • newNode

      public BrowsePublisher.NodeBuilder newNode(String typeId, String name)
      Description copied from interface: BrowsePublisher
      Creates a new node builder with the specified type ID and name. The resulting BrowsePublisher.NodeBuilder can be used to define various properties for the node before adding it to the browsing structure.
      Specified by:
      newNode in interface BrowsePublisher
      Parameters:
      typeId - the type identifier for the new node
      name - the name of the new node
      Returns:
      a BrowsePublisher.NodeBuilder instance to configure and add the new node

    • recurse

      public BrowsePublisher recurse()
      Description copied from interface: BrowsePublisher
      Creates and returns a new BrowsePublisher instance to continue browsing deeper into the hierarchical structure. This is typically used when recursive browsing is required, starting from the current state or node.
      Specified by:
      recurse in interface BrowsePublisher
      Returns:
      a BrowsePublisher for recursive browsing at a deeper level of the hierarchy