Class RootBrowsePublisher

java.lang.Object
com.inductiveautomation.historian.gateway.api.query.browsing.RootBrowsePublisher
All Implemented Interfaces:
BrowsePublisher

public class RootBrowsePublisher extends Object implements BrowsePublisher
A BrowsePublisher that publishes browse results beneath a root path.
  • Constructor Details

    • RootBrowsePublisher

      public RootBrowsePublisher(QualifiedPath rootPath)
  • Method Details

    • getResults

      public Results<Result> getResults()
    • isCanceled

      public boolean isCanceled()
      Description copied from interface: BrowsePublisher
      Returns whether the browse has been canceled.
      Specified by:
      isCanceled in interface BrowsePublisher
      Returns:
      true if it has.
    • cancel

      public void cancel()
    • getResultCount

      public int getResultCount()
      Description copied from interface: BrowsePublisher
      Returns the number of results added so far.
      Specified by:
      getResultCount in interface BrowsePublisher
      Returns:
      the result count.
    • setTotalResultsAvailable

      public void setTotalResultsAvailable(int totalResultsAvailable)
      Description copied from interface: BrowsePublisher
      Sets the total number of results in the complete result set, regardless of paging limits.
      Specified by:
      setTotalResultsAvailable in interface BrowsePublisher
      Parameters:
      totalResultsAvailable - the total result count.
    • setContinuationPoint

      public void setContinuationPoint(String continuationPoint)
      Description copied from interface: BrowsePublisher
      Sets the continuation point, an identifier for the current position that lets a later call resume the browse.
      Specified by:
      setContinuationPoint in interface BrowsePublisher
      Parameters:
      continuationPoint - the identifier of the current position.
    • addResult

      protected void addResult(BasicResult result)
    • newNode

      public BrowsePublisher.NodeBuilder newNode(String typeId, String name)
      Description copied from interface: BrowsePublisher
      Starts a node. Call BrowsePublisher.NodeBuilder.add() to publish it.
      Specified by:
      newNode in interface BrowsePublisher
      Parameters:
      typeId - the node's type id.
      name - the node's name.
      Returns:
      a builder for the node.
    • recurse

      public BrowsePublisher recurse()
      Description copied from interface: BrowsePublisher
      Returns a publisher for browsing deeper, for recursive browses.
      Specified by:
      recurse in interface BrowsePublisher
      Returns:
      the publisher for the next level.
    • recurse

      public BrowsePublisher recurse(QualifiedPath path)
      Description copied from interface: BrowsePublisher
      Returns a publisher for browsing deeper from a given path.
      Specified by:
      recurse in interface BrowsePublisher
      Parameters:
      path - the path to browse from.
      Returns:
      the publisher for the next level.