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

Class HistoricalNodeTree<N extends HistoricalNode>

java.lang.Object

com.inductiveautomation.ignition.common.PathTree<QualifiedPath,N>

com.inductiveautomation.historian.gateway.api.query.HistoricalNodeTree<N>

Type Parameters:

N - the type of nodes extending HistoricalNode that this tree will manage

All Implemented Interfaces:

Serializable

public class HistoricalNodeTree<N extends HistoricalNode>
extends PathTree<QualifiedPath,N>

Represents a specialized tree structure built on top of PathTree, where nodes are of a type extending HistoricalNode. This class provides capability for creating and managing nodes based on customized paths and allows for recursive removal of nodes along with their parent nodes if certain conditions are met.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.PathTree

PathTree.TreeNode

Field Summary

Fields

Modifier and Type	Field	Description
protected final ReadWriteLockExecutor	rwLockExecutor

Constructor Summary

Constructors

Constructor	Description
HistoricalNodeTree(Function<QualifiedPath,N> nodeFactory)

Method Summary

Modifier and Type	Method	Description
final List<N>	browse(QualifiedPath path)	Essentially an alias for getChildren(path), though wraps the results in a list.
final void	clear()	Clears the entire tree.
final N	computeIfAbsent(QualifiedPath path, Function<QualifiedPath,N> supplier)
protected final PathTree<QualifiedPath,N>.TreeNode	findNode(QualifiedPath path, boolean create)	Locates the node at the given path.
protected final PathTree<QualifiedPath,N>.TreeNode	findNode(QualifiedPath path, boolean create, Object[] valueArray)
final N	get(QualifiedPath path)	Returns the value at the given path.
final <R extends N> Collection<R>	getAllNestedChildren(QualifiedPath path)	Returns all nested children under a given path using breadth-first search.
final List<String>	getBranches(QualifiedPath path)	Returns the keys for the branches beneath the given point.
final List<String>	getBranches(QualifiedPath path, boolean foldersOnly)	Returns the keys for the branches beneath the given point.
final <R extends N> Collection<R>	getChildren(QualifiedPath path)	Returns the children under a given path.
protected final @NotNull PathTree<QualifiedPath,N>.TreeNode	getRoot()
final Object[]	getValuesOfPath(QualifiedPath path)	Returns all of the node values from the tree nodes along the specified path.
protected final PathTree<QualifiedPath,N>.TreeNode	instantiateNode(PathTree<QualifiedPath,N>.TreeNode parent, QualifiedPath path, int pos)	Instantiates a TreeNode under the parent, for the given path position of the path.
final boolean	put(QualifiedPath path, N value)	Inserts the value at the given path.
void	recursiveRemoveWithParent(QualifiedPath path)
final N	remove(QualifiedPath path)	Removes the given path, and returns the value that was associated with the path, if applicable.
final N	removeIfEmpty(QualifiedPath path)	Removes and returns the value, and if there are no children, removes the node from the tree.
final int	size()	Calculates the size of this tag tree.
<E extends Exception> void	withReadLock(CheckedRunnable<E> action)
<T, E extends Exception> T	withReadLock(CheckedSupplier<T,E> action)
<E extends Exception> void	withWriteLock(CheckedRunnable<E> action)
<T, E extends Exception> T	withWriteLock(CheckedSupplier<T,E> action)

Methods inherited from class com.inductiveautomation.ignition.common.PathTree

initializeRoot, isCaseSensitive, setCaseSensitive

Methods inherited from class java.lang.Object

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

Field Details

rwLockExecutor

protected final ReadWriteLockExecutor rwLockExecutor

Constructor Details

HistoricalNodeTree

public HistoricalNodeTree(Function<QualifiedPath,N> nodeFactory)

Method Details

recursiveRemoveWithParent

public void recursiveRemoveWithParent(QualifiedPath path)

findNode

protected final PathTree<QualifiedPath,N>.TreeNode findNode(QualifiedPath path,
 boolean create)

Description copied from class: PathTree

Locates the node at the given path. Will insert nodes as necessary, if create is true. Otherwise will return null if the path doesn't exist.

Overrides:

findNode in class PathTree<QualifiedPath,N extends HistoricalNode>

findNode

protected final PathTree<QualifiedPath,N>.TreeNode findNode(QualifiedPath path,
 boolean create,
 Object[] valueArray)

Overrides:

findNode in class PathTree<QualifiedPath,N extends HistoricalNode>

getValuesOfPath

public final Object[] getValuesOfPath(QualifiedPath path)

Description copied from class: PathTree

Returns all of the node values from the tree nodes along the specified path. The return length will be the path length + 1 (the root/null value), even if the node doesn't exist. Any tree node that doesn't exist or doesn't have a value will have a null entry.

Overrides:

getValuesOfPath in class PathTree<QualifiedPath,N extends HistoricalNode>

Parameters:

path - the path to locate

Returns:

an array whose bounds are equal to path.getPathLength()+1. Index 0 is the null/root value. Each array element represents the value at a given location in the tree, and will be null if the node does not exist.

clear

public final void clear()

Description copied from class: PathTree

Clears the entire tree.

Overrides:

clear in class PathTree<QualifiedPath,N extends HistoricalNode>

removeIfEmpty

@Nullable
public final N removeIfEmpty(QualifiedPath path)

Description copied from class: PathTree

Removes and returns the value, and if there are no children, removes the node from the tree.

Overrides:

removeIfEmpty in class PathTree<QualifiedPath,N extends HistoricalNode>

remove

public final N remove(QualifiedPath path)

Description copied from class: PathTree

Removes the given path, and returns the value that was associated with the path, if applicable.

Overrides:

remove in class PathTree<QualifiedPath,N extends HistoricalNode>

computeIfAbsent

public final N computeIfAbsent(QualifiedPath path,
 Function<QualifiedPath,N> supplier)

Overrides:

computeIfAbsent in class PathTree<QualifiedPath,N extends HistoricalNode>

get

public final N get(QualifiedPath path)

Description copied from class: PathTree

Returns the value at the given path. If the path is null, the root value is returned.

Overrides:

get in class PathTree<QualifiedPath,N extends HistoricalNode>

put

public final boolean put(QualifiedPath path,
 N value)

Description copied from class: PathTree

Inserts the value at the given path. Returns whether or not the insertion was successful. Intermediary nodes will be created implicitly, and subclasses can customize their values by overriding instantiateNode.

Overrides:

put in class PathTree<QualifiedPath,N extends HistoricalNode>

getBranches

public final List<String> getBranches(QualifiedPath path,
 boolean foldersOnly)

Description copied from class: PathTree

Returns the keys for the branches beneath the given point. Returns empty list if the point is not found, or there are no branches. If foldersOnly is true, will only return children that have null leaf values.

Overrides:

getBranches in class PathTree<QualifiedPath,N extends HistoricalNode>

getBranches

public final List<String> getBranches(QualifiedPath path)

Description copied from class: PathTree

Returns the keys for the branches beneath the given point. Returns empty list if the point is not found, or there are no branches.

Overrides:

getBranches in class PathTree<QualifiedPath,N extends HistoricalNode>

getAllNestedChildren

public final <R extends N> Collection<R> getAllNestedChildren(QualifiedPath path)

Description copied from class: PathTree

Returns all nested children under a given path using breadth-first search.

Overrides:

getAllNestedChildren in class PathTree<QualifiedPath,N extends HistoricalNode>

getChildren

public final <R extends N> Collection<R> getChildren(QualifiedPath path)

Description copied from class: PathTree

Returns the children under a given path. Used for browsing. Will never return null, just an empty collection if there are no children or the path doesn't exist. Does not return nested children.

Overrides:

getChildren in class PathTree<QualifiedPath,N extends HistoricalNode>

browse

public final List<N> browse(QualifiedPath path)

Description copied from class: PathTree

Essentially an alias for getChildren(path), though wraps the results in a list.

Overrides:

browse in class PathTree<QualifiedPath,N extends HistoricalNode>

size

public final int size()

Description copied from class: PathTree

Calculates the size of this tag tree. Note that this is not thread safe and is not efficient!

Overrides:

size in class PathTree<QualifiedPath,N extends HistoricalNode>

getRoot

@NotNull
protected final @NotNull PathTree<QualifiedPath,N>.TreeNode getRoot()

Overrides:

getRoot in class PathTree<QualifiedPath,N extends HistoricalNode>

instantiateNode

protected final PathTree<QualifiedPath,N>.TreeNode instantiateNode(PathTree<QualifiedPath,N>.TreeNode parent,
 QualifiedPath path,
 int pos)

Description copied from class: PathTree

Instantiates a TreeNode under the parent, for the given path position of the path. Subclasses can override this method to provide custom node types, and to create default values for implicit nodes.

Overrides:

instantiateNode in class PathTree<QualifiedPath,N extends HistoricalNode>

Parameters:

parent - the parent node

path - the complete path of the ultimate node being created

pos - the position in the path that the node is being created for

Returns:

the new node

withReadLock

public <T,
E extends Exception> T withReadLock(CheckedSupplier<T,E> action)
                                       throws E

Throws:

E extends Exception

withReadLock

public <E extends Exception> void withReadLock(CheckedRunnable<E> action)
                                        throws E

Throws:

E extends Exception

withWriteLock

public <T,
E extends Exception> T withWriteLock(CheckedSupplier<T,E> action)
                                        throws E

Throws:

E extends Exception

withWriteLock

public <E extends Exception> void withWriteLock(CheckedRunnable<E> action)
                                         throws E

Throws:

E extends Exception