com.inductiveautomation.xopc.driver.api.browsing

Class AbstractBrowseNode

java.lang.Object

com.inductiveautomation.xopc.driver.api.browsing.AbstractBrowseNode

All Implemented Interfaces:

BrowseNode, java.io.Serializable

Direct Known Subclasses:

DataVariableNode, FolderNode, ObjectNode

public abstract class AbstractBrowseNode
extends java.lang.Object
implements BrowseNode, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractBrowseNode(java.lang.String address)
AbstractBrowseNode(java.lang.String address, java.lang.String name)
AbstractBrowseNode(java.lang.String address, java.lang.String browseName, java.lang.String displayName, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
void	addChild(BrowseNode child)
void	addProperty(Property prop)
java.lang.String	getAddress() The address of this node.
java.lang.String	getBrowseName() The browse name for this node.
java.util.Iterator<BrowseNode>	getChildren() Returns an iterator for this node's child nodes.
java.lang.String	getDescription() An optional description for this node
java.lang.String	getDisplayName() A human-friendly display name for this node
java.util.Iterator<Property>	getProperties() Returns an iterator for this node's property nodes, if any.
Node	getUANode()
void	setUANode(Node node)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.xopc.driver.api.browsing.BrowseNode

getBrowseNodeType

Constructor Detail

AbstractBrowseNode

public AbstractBrowseNode(java.lang.String address)

AbstractBrowseNode

public AbstractBrowseNode(java.lang.String address,
                          java.lang.String name)

AbstractBrowseNode

public AbstractBrowseNode(java.lang.String address,
                          java.lang.String browseName,
                          java.lang.String displayName,
                          java.lang.String description)

Method Detail

addChild

public void addChild(BrowseNode child)

addProperty

public void addProperty(Property prop)

getChildren

public java.util.Iterator<BrowseNode> getChildren()

Description copied from interface: BrowseNode

Returns an iterator for this node's child nodes.

Specified by:

getChildren in interface BrowseNode

getProperties

public java.util.Iterator<Property> getProperties()

Description copied from interface: BrowseNode

Returns an iterator for this node's property nodes, if any.

Specified by:

getProperties in interface BrowseNode

getAddress

public java.lang.String getAddress()

Description copied from interface: BrowseNode

The address of this node.

Specified by:

getAddress in interface BrowseNode

getBrowseName

public java.lang.String getBrowseName()

Description copied from interface: BrowseNode

The browse name for this node. Browse names of properties must be unique within their peers

Specified by:

getBrowseName in interface BrowseNode

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: BrowseNode

A human-friendly display name for this node

Specified by:

getDisplayName in interface BrowseNode

getDescription

public java.lang.String getDescription()

Description copied from interface: BrowseNode

An optional description for this node

Specified by:

getDescription in interface BrowseNode

getUANode

public Node getUANode()

Specified by:

getUANode in interface BrowseNode

setUANode

public void setUANode(Node node)

Specified by:

setUANode in interface BrowseNode