Package com.inductiveautomation.ignition.client.tags.tree.node

Class AbstractBrowseNode

java.lang.Object

com.inductiveautomation.ignition.client.tags.tree.node.AbstractBrowseNode

All Implemented Interfaces:

BrowseTreeNode, InfoNode, AsynchronousTreeNode, TreeNode

Direct Known Subclasses:

AllProvidersNode, DatasetColumnTreeNode, RootTagManagerNode, TagTreeNode, UdtDefBrowseNode

public abstract class AbstractBrowseNode
extends Object
implements BrowseTreeNode

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractBrowseNode.BrowseTreeComparator
static class	AbstractBrowseNode.InfoComparator
protected class	AbstractBrowseNode.Loader
protected static enum	AbstractBrowseNode.LoadingStatus
protected static class	AbstractBrowseNode.NodeWrapper	Simple wrapper containing a BrowseTreeNode and the index at which the node occurs in this node.

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractBrowseNode.LoadingStatus	childStatus
protected ErrorNode	errorNode
protected static ExecutorService	executor	Static single-thread executor that will service all child load reqs
static final Set<TagObjectType>	folderTypes
protected NodeBrowseInfo	info
protected LoadingNode	loadingNode
protected AbstractBrowseNode.Loader	loadRunner
protected static LoggerEx	log
protected List<? extends BrowseTreeNode>	nodeList
protected Map<String,AbstractBrowseNode.NodeWrapper>	nodeMap	Map of named nodes used for name-based lookup and quick index lookup
protected int[]	parentIndex
static AbstractBrowseNode.BrowseTreeComparator	TAG_COMP
protected TagTreeModel	treeModel
protected boolean	visible

Fields inherited from interface com.inductiveautomation.ignition.client.tags.tree.node.BrowseTreeNode

NO_TYPES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBrowseNode(NodeBrowseInfo info)

Method Summary

Modifier and Type	Method	Description
void	blockLoad()	Force this tree node to load it's children (if not already loaded) synchronously.
Enumeration	children()
protected AbstractBrowseNode.Loader	createLoader(boolean synchronous)
protected Map<String,AbstractBrowseNode.NodeWrapper>	createNodeMap(List<? extends BrowseTreeNode> nodeList)
boolean	equals(Object obj)
protected abstract List<BrowseTreeNode>	executeChildrenBrowse()
BrowseTreeNode	findChildNodeByName(String name)
protected void	fireLightweightChange()	Fires a lightweight change through treeModel.nodesChanged()
protected void	fireNodeChanged()	Fires a heavyweight changethrough treeModel.reload()
boolean	getAllowsChildren()
BrowseTreeNode	getChildAt(int idx)
int	getChildCount()
ClientContext	getClientContext()
int	getIndex(TreeNode node)
NodeBrowseInfo	getInfo()
ClientTagManager	getManager()
static int	getRank(TagObjectType type)
TagPath	getTagPath()	Returns the tag path for this tree node
boolean	hasChild(String name)
int	hashCode()
void	install(TagTreeModel model, int index)	Called then the node is created.
boolean	isLeaf()
boolean	isMetaNode()	Returns true if this node is a meta node.
boolean	isVisible()
protected void	loadCancelled(List<? extends BrowseTreeNode> nodeList, Map<String,AbstractBrowseNode.NodeWrapper> nodeMap)
protected void	loadChildrenAsync(boolean force)
protected void	loadChildrenWithStatus(boolean force, boolean synchronous)
protected void	loadDone(List<? extends BrowseTreeNode> nodeList, Map<String,AbstractBrowseNode.NodeWrapper> nodeMap)
protected void	loadError(Exception ex)
protected void	logLoaded()
void	maybeBrowseAsync()	Will perform an async browse and load for the children of this node if they have not already been loaded.
protected void	notifyVisibilityChange()
void	reload()	Will perform a full browse a reload for the children of this node
void	reloadSynchronous()
void	setInfo(NodeBrowseInfo info)
void	setVisible(boolean visible)	Notifies this node if it is currently displayed or not.
String	toString()
void	uninstall()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.client.tags.tree.node.BrowseTreeNode

getAllowedNewObjectTypes, getEditRights, getName, getParent, getTooltipText

Methods inherited from interface com.inductiveautomation.ignition.client.tags.tree.node.InfoNode

getTagType

Field Details

folderTypes

public static final Set<TagObjectType> folderTypes

log

protected static LoggerEx log

TAG_COMP

public static AbstractBrowseNode.BrowseTreeComparator TAG_COMP

treeModel

protected TagTreeModel treeModel

parentIndex

protected int[] parentIndex

visible

protected boolean visible

childStatus

protected AbstractBrowseNode.LoadingStatus childStatus

loadingNode

protected LoadingNode loadingNode

errorNode

protected ErrorNode errorNode

info

protected NodeBrowseInfo info

nodeList

protected List<? extends BrowseTreeNode> nodeList

nodeMap

protected Map<String,AbstractBrowseNode.NodeWrapper> nodeMap

Map of named nodes used for name-based lookup and quick index lookup

executor

protected static ExecutorService executor

Static single-thread executor that will service all child load reqs

loadRunner

protected AbstractBrowseNode.Loader loadRunner

Constructor Details

AbstractBrowseNode

protected AbstractBrowseNode(NodeBrowseInfo info)

Method Details

getClientContext

public ClientContext getClientContext()

getInfo

public NodeBrowseInfo getInfo()

Specified by:

getInfo in interface BrowseTreeNode

Specified by:

getInfo in interface InfoNode

setInfo

public void setInfo(NodeBrowseInfo info)

getTagPath

public TagPath getTagPath()

Description copied from interface: BrowseTreeNode

Returns the tag path for this tree node

Specified by:

getTagPath in interface BrowseTreeNode

createNodeMap

protected Map<String,AbstractBrowseNode.NodeWrapper> createNodeMap(List<? extends BrowseTreeNode> nodeList)

maybeBrowseAsync

public void maybeBrowseAsync()

Description copied from interface: BrowseTreeNode

Will perform an async browse and load for the children of this node if they have not already been loaded.

Specified by:

maybeBrowseAsync in interface BrowseTreeNode

executeChildrenBrowse

protected abstract List<BrowseTreeNode> executeChildrenBrowse()
                                                       throws Exception

Throws:

Exception

loadDone

protected void loadDone(List<? extends BrowseTreeNode> nodeList,
 Map<String,AbstractBrowseNode.NodeWrapper> nodeMap)

loadCancelled

protected void loadCancelled(List<? extends BrowseTreeNode> nodeList,
 Map<String,AbstractBrowseNode.NodeWrapper> nodeMap)

logLoaded

protected void logLoaded()

loadError

protected void loadError(Exception ex)

loadChildrenAsync

protected void loadChildrenAsync(boolean force)

loadChildrenWithStatus

protected void loadChildrenWithStatus(boolean force,
 boolean synchronous)

blockLoad

public void blockLoad()

Description copied from interface: AsynchronousTreeNode

Force this tree node to load it's children (if not already loaded) synchronously.

Specified by:

blockLoad in interface AsynchronousTreeNode

createLoader

protected AbstractBrowseNode.Loader createLoader(boolean synchronous)

children

public Enumeration children()

Specified by:

children in interface TreeNode

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

getIndex

public int getIndex(TreeNode node)

Specified by:

getIndex in interface TreeNode

hasChild

public boolean hasChild(String name)

Specified by:

hasChild in interface BrowseTreeNode

findChildNodeByName

public BrowseTreeNode findChildNodeByName(@Nonnull
 String name)

Specified by:

findChildNodeByName in interface BrowseTreeNode

getChildAt

public BrowseTreeNode getChildAt(int idx)

Specified by:

getChildAt in interface TreeNode

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface TreeNode

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

install

public void install(TagTreeModel model,
 int index)

Description copied from interface: BrowseTreeNode

Called then the node is created.

Specified by:

install in interface BrowseTreeNode

index - The index at which this node occurs in its parent

getManager

public ClientTagManager getManager()

uninstall

public void uninstall()

Specified by:

uninstall in interface BrowseTreeNode

reload

public void reload()

Description copied from interface: BrowseTreeNode

Will perform a full browse a reload for the children of this node

Specified by:

reload in interface BrowseTreeNode

reloadSynchronous

public void reloadSynchronous()

fireNodeChanged

protected void fireNodeChanged()

Fires a heavyweight changethrough treeModel.reload()

fireLightweightChange

protected void fireLightweightChange()

Fires a lightweight change through treeModel.nodesChanged()

setVisible

public void setVisible(boolean visible)

Description copied from interface: BrowseTreeNode

Notifies this node if it is currently displayed or not.

Specified by:

setVisible in interface BrowseTreeNode

isVisible

public boolean isVisible()

Specified by:

isVisible in interface BrowseTreeNode

notifyVisibilityChange

protected void notifyVisibilityChange()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isMetaNode

public boolean isMetaNode()

Description copied from interface: BrowseTreeNode

Returns true if this node is a meta node. (Like a loading node). Don't try to use the tag path of a Meta node

Specified by:

isMetaNode in interface BrowseTreeNode

getRank

public static int getRank(TagObjectType type)