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

Class RootBrowsePublisher.ResultBuilder

java.lang.Object

com.inductiveautomation.historian.gateway.api.query.browsing.RootBrowsePublisher.ResultBuilder

All Implemented Interfaces:

BrowsePublisher.NodeBuilder

Enclosing class:

RootBrowsePublisher

protected class RootBrowsePublisher.ResultBuilder
extends Object
implements BrowsePublisher.NodeBuilder

Constructor Summary

Constructors

Constructor	Description
ResultBuilder(QualifiedPath nodePath)

Method Summary

Modifier and Type	Method	Description
void	add()	Finalizes the configuration of a node being built and adds it to the browsing structure.
BrowsePublisher.NodeBuilder	creationTime(Instant creationTime)	Sets the creation time of the node being built.
BrowsePublisher.NodeBuilder	displayPath(Path displayPath)	Sets the display path for the node being built.
BrowsePublisher.NodeBuilder	hasChildren(boolean hasChildren)	Sets whether the node being built has child nodes.
BrowsePublisher.NodeBuilder	metadata(MetadataPoint metadata)	Sets the metadata for the node being built.
BrowsePublisher.NodeBuilder	retiredTime(Instant retiredTime)	Sets the retired time of the node being built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResultBuilder

public ResultBuilder(QualifiedPath nodePath)

Method Details

creationTime

public BrowsePublisher.NodeBuilder creationTime(Instant creationTime)

Description copied from interface: BrowsePublisher.NodeBuilder

Sets the creation time of the node being built. This value represents the point in time when the node was created.

Specified by:

creationTime in interface BrowsePublisher.NodeBuilder

Parameters:

creationTime - the creation time of the node as an Instant

Returns:

the BrowsePublisher.NodeBuilder instance for method chaining

retiredTime

public BrowsePublisher.NodeBuilder retiredTime(Instant retiredTime)

Description copied from interface: BrowsePublisher.NodeBuilder

Sets the retired time of the node being built. The retired time indicates the point in time when the node is no longer active or relevant.

Specified by:

retiredTime in interface BrowsePublisher.NodeBuilder

Parameters:

retiredTime - the time the node was retired as an Instant

Returns:

the BrowsePublisher.NodeBuilder instance for method chaining

metadata

public BrowsePublisher.NodeBuilder metadata(MetadataPoint metadata)

Description copied from interface: BrowsePublisher.NodeBuilder

Sets the metadata for the node being built. The metadata provides additional properties or attributes associated with the node, such as contextual, temporal, or descriptive information.

Specified by:

metadata in interface BrowsePublisher.NodeBuilder

Parameters:

metadata - the MetadataPoint containing metadata information such as value, quality, timestamp, and source

Returns:

the BrowsePublisher.NodeBuilder instance for method chaining

displayPath

public BrowsePublisher.NodeBuilder displayPath(Path displayPath)

Description copied from interface: BrowsePublisher.NodeBuilder

Sets the display path for the node being built. The display path represents a human-readable or logical path associated with the node for display or reference purposes.

Specified by:

displayPath in interface BrowsePublisher.NodeBuilder

Parameters:

displayPath - the Path representing the display path

Returns:

the BrowsePublisher.NodeBuilder instance for method chaining

hasChildren

public BrowsePublisher.NodeBuilder hasChildren(boolean hasChildren)

Description copied from interface: BrowsePublisher.NodeBuilder

Sets whether the node being built has child nodes.

Specified by:

hasChildren in interface BrowsePublisher.NodeBuilder

Parameters:

hasChildren - a boolean indicating if the node has child nodes; true if the node has children, false otherwise

Returns:

the BrowsePublisher.NodeBuilder instance for method chaining

add

public void add()

Description copied from interface: BrowsePublisher.NodeBuilder

Finalizes the configuration of a node being built and adds it to the browsing structure. This method creates the configured node with its associated metadata, path, display path, and child status, then appends it to the result list for further use or processing.

Specified by:

add in interface BrowsePublisher.NodeBuilder