ilog.views.appframe.settings
Class IlvSettingsNode

java.lang.Object
  ilog.views.appframe.settings.IlvSettingsNode

All Implemented Interfaces:

Node

Direct Known Subclasses:

IlvSettingsAttribute, IlvSettingsElement

public abstract class IlvSettingsNode
extends Object
implements Node

Defines nodes that are returned by selection queries to IlvSettings instances.

Field Summary

static short	ATTRIBUTE_NODE Node type that identifies attribute nodes, instances of the IlvSettingsAttribute class.
static short	ELEMENT_NODE Node type that identifies element nodes, instances of the IlvSettingsElement class.
static short	ROOT_ELEMENT_NODE Node type that identifies element nodes that are root elements.

Fields inherited from interface org.w3c.dom.Node

CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

short	compareDocumentPosition(Node other)
String	getBaseURI()
Object	getFeature(String feature, String version)
abstract short	getNodeType() Returns the type of this node.
IlvSettingsElement	getParent() Returns the parent element that contains this node.
Node	getParentNode() The parent of this node.
IlvSettings	getSettings() Returns the settings that have created this settings node.
String	getTextContent()
Object	getUserData(String key)
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isSameNode(Node other)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
abstract boolean	matchType(String type) Determines whether this node matches the specified type.
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Field Detail

ATTRIBUTE_NODE

public static short ATTRIBUTE_NODE

Node type that identifies attribute nodes, instances of the IlvSettingsAttribute class.

ELEMENT_NODE

public static short ELEMENT_NODE

Node type that identifies element nodes, instances of the IlvSettingsElement class.

ROOT_ELEMENT_NODE

public static short ROOT_ELEMENT_NODE

Node type that identifies element nodes that are root elements. This node type is used internally by the settings engine and should not be used.

Method Detail

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

getFeature

public Object getFeature(String feature,
                         String version)

Specified by:

getFeature in interface Node

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

Specified by:

setUserData in interface Node

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

getSettings

public IlvSettings getSettings()

Returns the settings that have created this settings node.

getNodeType

public abstract short getNodeType()

Returns the type of this node. The returned value is one of the following values:

• ATTRIBUTE_NODE for attribute nodes.
• ELEMENT_NODE for element nodes.

Specified by:

getNodeType in interface Node

Returns:

The type of this node.

getParent

public IlvSettingsElement getParent()

Returns the parent element that contains this node.

Returns:

The parent element of this node or null, if this node is a root element within its model.

matchType

public abstract boolean matchType(String type)

Determines whether this node matches the specified type. If this node is an element, its type will be compared with the specified type. Otherwise, if this node is an attribute, its name will be compared with the specified type.

Parameters:

type - The type to compare the type of the node with.

Returns:

true if the specified type is null or equal to "*"; true is also returned if the type of the node is equal to the specified type; false otherwise.

getParentNode

public Node getParentNode()

The parent of this node. If a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.

Specified by:

getParentNode in interface Node