Class RootBrowsePublisher.RecursiveBrowsePublisher
java.lang.Object
com.inductiveautomation.historian.gateway.api.query.browsing.RootBrowsePublisher.RecursiveBrowsePublisher
- All Implemented Interfaces:
BrowsePublisher
- Enclosing class:
RootBrowsePublisher
protected static class RootBrowsePublisher.RecursiveBrowsePublisher
extends Object
implements BrowsePublisher
-
Nested Class Summary
Nested classes/interfaces inherited from interface BrowsePublisher
BrowsePublisher.NodeBuilder -
Constructor Summary
ConstructorsConstructorDescriptionRecursiveBrowsePublisher(RootBrowsePublisher root, QualifiedPath thisNodeRoot) -
Method Summary
Modifier and TypeMethodDescriptionintReturns the number of results added so far.booleanReturns whether the browse has been canceled.Starts a node.recurse()Returns a publisher for browsing deeper, for recursive browses.recurse(QualifiedPath path) Returns a publisher for browsing deeper from a given path.voidsetContinuationPoint(String continuationPoint) Sets the continuation point, an identifier for the current position that lets a later call resume the browse.voidsetTotalResultsAvailable(int totalResultsAvailable) Sets the total number of results in the complete result set, regardless of paging limits.
-
Constructor Details
-
RecursiveBrowsePublisher
-
-
Method Details
-
setTotalResultsAvailable
public void setTotalResultsAvailable(int totalResultsAvailable) Description copied from interface:BrowsePublisherSets the total number of results in the complete result set, regardless of paging limits.- Specified by:
setTotalResultsAvailablein interfaceBrowsePublisher- Parameters:
totalResultsAvailable- the total result count.
-
isCanceled
public boolean isCanceled()Description copied from interface:BrowsePublisherReturns whether the browse has been canceled.- Specified by:
isCanceledin interfaceBrowsePublisher- Returns:
trueif it has.
-
getResultCount
public int getResultCount()Description copied from interface:BrowsePublisherReturns the number of results added so far.- Specified by:
getResultCountin interfaceBrowsePublisher- Returns:
- the result count.
-
setContinuationPoint
Description copied from interface:BrowsePublisherSets the continuation point, an identifier for the current position that lets a later call resume the browse.- Specified by:
setContinuationPointin interfaceBrowsePublisher- Parameters:
continuationPoint- the identifier of the current position.
-
newNode
Description copied from interface:BrowsePublisherStarts a node. CallBrowsePublisher.NodeBuilder.add()to publish it.- Specified by:
newNodein interfaceBrowsePublisher- Parameters:
typeId- the node's type id.name- the node's name.- Returns:
- a builder for the node.
-
recurse
Description copied from interface:BrowsePublisherReturns a publisher for browsing deeper, for recursive browses.- Specified by:
recursein interfaceBrowsePublisher- Returns:
- the publisher for the next level.
-
recurse
Description copied from interface:BrowsePublisherReturns a publisher for browsing deeper from a given path.- Specified by:
recursein interfaceBrowsePublisher- Parameters:
path- the path to browse from.- Returns:
- the publisher for the next level.
-