oracle.xml.parser.v2
Class XMLNode

java.lang.Object
oracle.xml.parser.v2.XMLNode

All Implemented Interfaces:

java.lang.Cloneable, EventTarget, java.io.Externalizable, Node, NodeEditVAL, java.io.Serializable

Direct Known Subclasses:

AttrDecl, oracle.xml.parser.v2.CharData, DTD, ElementDecl, XMLNotation, XMLNSNode

public abstract class XMLNode

extends java.lang.Object

implements Node, EventTarget, NodeEditVAL, java.lang.Cloneable, java.io.Externalizable

Implements the DOM Node interface and serves as the primary datatype for the entire Document Object Model. It represents a single node in the document tree.

The attributes nodeName, nodeValue and attributes are included as a mechanism to get at node information without casting down to the specific derived instance. In cases where there is no obvious mapping of these attributes for a specific nodeType (e.g., nodeValue for an Element or attributes for a Comment), this returns null. Note that the derived classes may contain additional and more convenient mechanisms to get and set the relevant information.

See Also:

Serialized Form

Field Summary

static short	ATTRDECL A attribute declaration node
static java.lang.String	Auto_Events Flag to set Auto EVENTS
static java.lang.String	capturing
static java.lang.String	DOMAttrModified
static java.lang.String	DOMCharacterDataModified
static java.lang.String	DOMNodeInserted
static java.lang.String	DOMNodeInsertedIntoDocument
static java.lang.String	DOMNodeRemoved
static java.lang.String	DOMNodeRemovedFromDocument
static java.lang.String	DOMSubtreeModified
static short	ELEMENTDECL An element declaration node.
static short	NAMESPACE_NODE A namespace node
static java.lang.String	noncapturing
static java.lang.String	RANGE_DELETE_EVENT Flag to delete range event
static java.lang.String	RANGE_DELETETEXT_EVENT Flag to set range delete text event
static java.lang.String	RANGE_INSERT_EVENT Flag to set range event
static java.lang.String	RANGE_INSERTTEXT_EVENT Flag to set range insert text event
static java.lang.String	RANGE_REPLACE_EVENT Flag to replace range event
static java.lang.String	RANGE_SETTEXT_EVENT Flag to set range text event
static java.lang.String	TRAVERSAL_DELETE_EVENT Flag to set traversal delete event
static java.lang.String	TRAVERSAL_REPLACE_EVENT Flag to set traversal replace event
static int	XDB_DATA
static short	XMLDECL_NODE A attribute declaration node

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.w3c.dom.validation.NodeEditVAL

VAL_FALSE, VAL_INCOMPLETE, VAL_NS_WF, VAL_SCHEMA, VAL_TRUE, VAL_UNKNOWN, VAL_WF

Constructor Summary

protected

XMLNode() Constructs a new XMLNode

Method Summary

void	addEventListener(java.lang.String type, EventListener listener, boolean useCapture) This method allows the registration of event listeners on the event target
void	addText(char[] ch, int start, int length) Adds text to this node, or appends str to the last child if the last child is a text node.
Node	appendChild(Node newChild) Adds the node newChild to the end of the list of children of this node.
short	canAppendChild(Node newChild) Determines whether the Node.appendChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.
short	canInsertBefore(Node newChild, Node refChild) Determines whether the Node.insertBefore operation would make this document not compliant with the VAL_INCOMPLETE validity type.
short	canRemoveChild(Node oldChild) Determines whether the Node.removeChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.
short	canReplaceChild(Node newChild, Node oldChild) Determines whether the Node.replaceChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.
Node	cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
boolean	dispatchEvent(Event evtArg) This method allows the dispatch of events into the implementations event model
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
NamedNodeMap	getAttributes() Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
NodeList	getChildNodes() Gets a NodeList that contains all children of this node.
int	getColumnNumber() Get column number debug information
boolean	getDebugMode() Get debug information mode
java.lang.String	getDefaultValue() The default value specified in an attribute or an element declaration or null if unspecified.
DOMStringList	getEnumeratedValues() A DOMStringList, as described in [ DOM Level 3 Core] , of distinct values for an attribute or an element declaration or null if unspecified.
Node	getFirstChild() Gets the first child of this node.
Node	getLastChild() Gets the last child of this node.
int	getLineNumber() Get line number debug information
java.lang.String	getLocalName() Gets the Local Name of this node
java.lang.String	getNamespaceURI() Gets the namespace URI of this node.
Node	getNextSibling() Gets The node immediately following this node.
java.lang.String	getNodeName() Gets the name of this node
short	getNodeType() Gets the type of the node
java.lang.String	getNodeValue() Gets the value of this node, depending on its type
Document	getOwnerDocument() Gets the Document object associated with this node.
Node	getParentNode() Gets the parent of this node.
java.lang.String	getPrefix() Get the namespace prefix for this element.
Node	getPreviousSibling() Gets the node immediately preceding this node.
int	getPrimitiveTypeId() Get Schema primitive type id
java.lang.Object	getProperty(java.lang.String propName) Get a property of the node
QxName	getQName() Gets the QName of this node
javax.xml.namespace.QName	getSchemaTypeName() Gets the name of this node's schema type
java.lang.String	getSystemId() Get the system id of the entity contain this node
java.lang.String	getText() Returns the non-marked-up text contained by this element.
XMLError	getXMLError() Gets XMLError set in the document node
boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
boolean	hasChildNodes() This is a convenience method to allow easy determination of whether a node has any children.
int	hashCode() Returns a hash code value for the object.
Node	insertBefore(Node newChild, Node refChild) Inserts the node newChild before the existing child node refChild.
boolean	isDocumentFlag(int flag) Returns the document flag information
boolean	isNodeFlag(int flag) Returns the node flag information
boolean	isSupported(java.lang.String feature, java.lang.String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
short	nodeValidity(short wFValidityCheckLevel) Determines if the node is valid relative to the validation type specified in valType.
void	normalize() Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes,i.e., there are neither adjacent Text nodes nor empty Text nodes.
void	print(java.io.OutputStream out) Writes the contents of this node to the given output stream.
void	print(java.io.OutputStream out, java.lang.String enc) Writes the contents of this node to the given output stream.
void	print(java.io.PrintWriter out) Writes the contents of this node using the given print writer.
void	print(java.io.Writer out) Writes the contents of this node using the given print writer.
void	readExternal(java.io.ObjectInput inArg) This method reads the information written in the compressed stream by writeExternal method and restores the object correspondingly.
Node	removeChild(Node oldChild) Removes the child node indicated by oldChild from the list of children, and returns it.
void	removeEventListener(java.lang.String type, EventListener listener, boolean useCapture) This method allows the removal of event listeners from the event target.
Node	replaceChild(Node newChild, Node oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
void	reportSAXEvents(ContentHandler cntHandler) Report SAX Events from a DOM Tree
void	resetNodeFlag(int flag) Resets the node flag information
NodeList	selectNodes(java.lang.String pattern) Selects nodes from the tree which match the given pattern.
NodeList	selectNodes(java.lang.String pattern, NSResolver nsr) Selects nodes from the tree which match the given pattern
Node	selectSingleNode(java.lang.String pattern) Selects the first node from the tree that matches the given pattern
Node	selectSingleNode(java.lang.String pattern, NSResolver nsr) Selects the first node from the tree that matches the given pattern
void	setDebugInfo(int line, int col, java.lang.String sysid) Set debug information in the node
void	setNodeFlag(int flag) Sets the node flag information
void	setNodeFlag(int flag, boolean val) Sets or resets the node flag information
void	setNodeFlag(int flag, int mask) Sets the node multi bit flag information
void	setNodeValue(java.lang.String nodeValue) Sets the value of this node, depending on its type
void	setPrefix(java.lang.String prefix) Sets the prefix of this node
void	setProperty(java.lang.String propName, java.lang.Object propValue) Set a property of the node
DocumentFragment	transformNode(XSLStylesheet xsl) Transforms a node in the tree using the given stylesheet
java.lang.String	valueOf(java.lang.String pattern) Selects the value of the first node from tree that matches the pattern
java.lang.String	valueOf(java.lang.String pattern, NSResolver nsr) Selects the value of the first node from tree that matches the pattern
void	writeExternal(java.io.ObjectOutput out) This method saves the state of the object by creating a binary compressed stream with information about this object.
long	xdbGetNodeId()

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENTDECL

public static final short ELEMENTDECL

An element declaration node.

See Also:

Constant Field Values

ATTRDECL

public static final short ATTRDECL

A attribute declaration node

See Also:

Constant Field Values

XMLDECL_NODE

public static final short XMLDECL_NODE

A attribute declaration node

See Also:

Constant Field Values

NAMESPACE_NODE

public static final short NAMESPACE_NODE

A namespace node

See Also:

Constant Field Values

XDB_DATA

public static final int XDB_DATA

See Also:

Constant Field Values

Auto_Events

public static final java.lang.String Auto_Events

Flag to set Auto EVENTS

See Also:

Constant Field Values

RANGE_SETTEXT_EVENT

public static final java.lang.String RANGE_SETTEXT_EVENT

Flag to set range text event

See Also:

Constant Field Values

RANGE_INSERTTEXT_EVENT

public static final java.lang.String RANGE_INSERTTEXT_EVENT

Flag to set range insert text event

See Also:

Constant Field Values

RANGE_DELETETEXT_EVENT

public static final java.lang.String RANGE_DELETETEXT_EVENT

Flag to set range delete text event

See Also:

Constant Field Values

RANGE_INSERT_EVENT

public static final java.lang.String RANGE_INSERT_EVENT

Flag to set range event

See Also:

Constant Field Values

RANGE_DELETE_EVENT

public static final java.lang.String RANGE_DELETE_EVENT

Flag to delete range event

See Also:

Constant Field Values

RANGE_REPLACE_EVENT

public static final java.lang.String RANGE_REPLACE_EVENT

Flag to replace range event

See Also:

Constant Field Values

TRAVERSAL_DELETE_EVENT

public static final java.lang.String TRAVERSAL_DELETE_EVENT

Flag to set traversal delete event

See Also:

Constant Field Values

TRAVERSAL_REPLACE_EVENT

public static final java.lang.String TRAVERSAL_REPLACE_EVENT

Flag to set traversal replace event

See Also:

Constant Field Values

DOMSubtreeModified

public static final java.lang.String DOMSubtreeModified

See Also:

Constant Field Values

DOMNodeInserted

public static final java.lang.String DOMNodeInserted

See Also:

Constant Field Values

DOMNodeRemoved

public static final java.lang.String DOMNodeRemoved

See Also:

Constant Field Values

DOMNodeRemovedFromDocument

public static final java.lang.String DOMNodeRemovedFromDocument

See Also:

Constant Field Values

DOMNodeInsertedIntoDocument

public static final java.lang.String DOMNodeInsertedIntoDocument

See Also:

Constant Field Values

DOMAttrModified

public static final java.lang.String DOMAttrModified

See Also:

Constant Field Values

DOMCharacterDataModified

public static final java.lang.String DOMCharacterDataModified

See Also:

Constant Field Values

capturing

public static final java.lang.String capturing

See Also:

Constant Field Values

noncapturing

public static final java.lang.String noncapturing

See Also:

Constant Field Values

Constructor Detail

XMLNode

protected XMLNode()

Constructs a new XMLNode

Method Detail

getNodeType

public short getNodeType()

Gets the type of the node

Specified by:

getNodeType in interface Node

Returns:

type of the node

getSchemaTypeName

public javax.xml.namespace.QName getSchemaTypeName()

Gets the name of this node's schema type

Returns:

Name schema type

getNodeName

public java.lang.String getNodeName()

Gets the name of this node

Specified by:

getNodeName in interface Node

Returns:

Name of this node

getQName

public QxName getQName()

Gets the QName of this node

Returns:

QName of this node

getLocalName

public java.lang.String getLocalName()

Gets the Local Name of this node

Specified by:

getLocalName in interface Node

Returns:

LocalName of the node

getNamespaceURI

public java.lang.String getNamespaceURI()

Gets the namespace URI of this node.

Specified by:

getNamespaceURI in interface Node

Returns:

the namespace

getPrefix

public java.lang.String getPrefix()

Get the namespace prefix for this element.

Specified by:

getPrefix in interface Node

Returns:

the namespace prefix

setPrefix

public void setPrefix(java.lang.String prefix)
               throws DOMException

Sets the prefix of this node

Specified by:

setPrefix in interface Node

Parameters:

prefix - set the prefix

Throws:

DOMException

getNodeValue

public java.lang.String getNodeValue()
                              throws DOMException

Gets the value of this node, depending on its type

Specified by:

getNodeValue in interface Node

Returns:

Value of this node

Throws:

DOMException

setNodeValue

public void setNodeValue(java.lang.String nodeValue)
                  throws DOMException

Sets the value of this node, depending on its type

Specified by:

setNodeValue in interface Node

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

getParentNode

public Node getParentNode()

Gets the parent of this node. All nodes, except Document, DocumentFragment, and Attr may have a parent. However, 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

Returns:

The parent of this node

getChildNodes

public NodeList getChildNodes()

Gets a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.

Specified by:

getChildNodes in interface Node

Returns:

The children of this node

getFirstChild

public Node getFirstChild()

Gets the first child of this node. If there is no such node, this returns null.

Specified by:

getFirstChild in interface Node

Returns:

The first child of this node

getLastChild

public Node getLastChild()

Gets the last child of this node. If there is no such node, this returns null.

Specified by:

getLastChild in interface Node

Returns:

The last child of this node

getPreviousSibling

public Node getPreviousSibling()

Gets the node immediately preceding this node. If there is no such node, this returns null.

Specified by:

getPreviousSibling in interface Node

Returns:

the previous node

getNextSibling

public Node getNextSibling()

Gets The node immediately following this node. If there is no such node, this returns null.

Specified by:

getNextSibling in interface Node

Returns:

the next node

getAttributes

public NamedNodeMap getAttributes()

Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Specified by:

getAttributes in interface Node

Returns:

the attributes of this node

getOwnerDocument

public Document getOwnerDocument()

Gets the Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document this is null.

Specified by:

getOwnerDocument in interface Node

Returns:

The document associated with this node

hasAttributes

public boolean hasAttributes()

Returns whether this node (if it is an element) has any attributes.

Specified by:

hasAttributes in interface Node

Returns:

true if this node has any attributes, false otherwise.

hasChildNodes

public boolean hasChildNodes()

This is a convenience method to allow easy determination of whether a node has any children.

Specified by:

hasChildNodes in interface Node

Returns:

true if the node has any children, false if the node has no children.

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Specified by:

isSupported in interface Node

Returns:

true,if the feature is supported else false

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.

Specified by:

appendChild in interface Node

Parameters:

newChild - The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node

Returns:

The node added.

Throws:

DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException

Removes the child node indicated by oldChild from the list of children, and returns it.

Specified by:

removeChild in interface Node

Parameters:

oldChild - The node being removed.

Returns:

The node removed.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.

Specified by:

insertBefore in interface Node

Parameters:

newChild - The node to insert.

refChild - The reference node, i.e., the node before which the new node must be inserted.

Returns:

The node being inserted.

Throws:

DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws DOMException

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If the newChild is already in the tree, it is first removed.

Specified by:

replaceChild in interface Node

Parameters:

newChild - The new node to put in the child list.

oldChild - The node being replaced in the list.

Returns:

The node replaced.

Throws:

DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or it the node to put in is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

cloneNode

public Node cloneNode(boolean deep)

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent ( parentNode returns null.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning any other type of node simply returns a copy of this node.

Specified by:

cloneNode in interface Node

Parameters:

deep - If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Returns:

The duplicate node.

normalize

public void normalize()

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes,i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particulardocument tree structure are to be used.

Specified by:

normalize in interface Node

addEventListener

public void addEventListener(java.lang.String type,
                             EventListener listener,
                             boolean useCapture)

This method allows the registration of event listeners on the event target

Specified by:

addEventListener in interface EventTarget

Parameters:

type - the type of event for which the event listener wants to register

listener - the listener to be registered

useCapture - flag to indicate if the listener wants to initiate capture

removeEventListener

public void removeEventListener(java.lang.String type,
                                EventListener listener,
                                boolean useCapture)

Description copied from interface: EventTarget

This method allows the removal of event listeners from the event target. If an EventListener is removed from an EventTarget while it is processing an event, it will not be triggered by the current actions. EventListeners can never be invoked after being removed.
Calling removeEventListener with arguments which do not identify any currently registered EventListener on the EventTarget has no effect.

Specified by:

removeEventListener in interface EventTarget

dispatchEvent

public boolean dispatchEvent(Event evtArg)
                      throws DOMException

This method allows the dispatch of events into the implementations event model

Specified by:

dispatchEvent in interface EventTarget

Returns:

boolean value that indicates whether preventDefault or stopPropogation was called

Throws:

UNSPECIFIED_EVENT_TYPE: - Raised if the Event's type was not specified by initializing the event before dispatchEvent was called

DOMException

getDefaultValue

public java.lang.String getDefaultValue()

The default value specified in an attribute or an element declaration or null if unspecified. Elena wanted mention of XML Schema's canonical lexical representation here. Why?

Specified by:

getDefaultValue in interface NodeEditVAL

getEnumeratedValues

public DOMStringList getEnumeratedValues()

A DOMStringList, as described in [ DOM Level 3 Core] , of distinct values for an attribute or an element declaration or null if unspecified. Elena wanted mention of XML Schema's canonical lexical representation here. Why?

Specified by:

getEnumeratedValues in interface NodeEditVAL

canInsertBefore

public short canInsertBefore(Node newChild,
                             Node refChild)

Determines whether the Node.insertBefore operation would make this document not compliant with the VAL_INCOMPLETE validity type.

Specified by:

canInsertBefore in interface NodeEditVAL

Parameters:

newChild - Node to be inserted.

refChild - Reference Node.

Returns:

A validation state constant.

canRemoveChild

public short canRemoveChild(Node oldChild)

Determines whether the Node.removeChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.

Specified by:

canRemoveChild in interface NodeEditVAL

Parameters:

oldChild - Node to be removed.

Returns:

A validation state constant.

canReplaceChild

public short canReplaceChild(Node newChild,
                             Node oldChild)

Determines whether the Node.replaceChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.

Specified by:

canReplaceChild in interface NodeEditVAL

Parameters:

newChild - New Node.

oldChild - Node to be replaced.

Returns:

A validation state constant.

canAppendChild

public short canAppendChild(Node newChild)

Determines whether the Node.appendChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.

Specified by:

canAppendChild in interface NodeEditVAL

Parameters:

newChild - Node to be appended.

Returns:

A validation state constant.

nodeValidity

public short nodeValidity(short wFValidityCheckLevel)

Determines if the node is valid relative to the validation type specified in valType. This operation doesn't normalize before checking if it is valid. To do so, one would need to explicitly call a normalize method. The difference between this method and the validateDocument method on the DocumentVAL interface is that validateDocument only checks to determine whether the entire document is valid.

Specified by:

nodeValidity in interface NodeEditVAL

Parameters:

wFValidityCheckLevel - Flag to tell at what level validity and well-formedness checking is done.

Returns:

A validation state constant.

addText

public void addText(char[] ch,
                    int start,
                    int length)
             throws XMLDOMException

Adds text to this node, or appends str to the last child if the last child is a text node.

Parameters:

ch - char array to add

start - start index in the char array

length - no of chars to be added

Throws:

XMLDOMException - if text can't be added to this node

getText

public java.lang.String getText()

Returns the non-marked-up text contained by this element. For text elements, this is the raw data. For elements with child nodes, this method traverses the entire subtree and appends the text for each terminal text element, effectively stripping out the XML markup for the subtree. For example, if the XML document contains the following: <xmp> <AUTHOR> <FIRST>William</FIRST> <LAST>Shakespeare</LAST> </AUTHOR> </xmp>

XMLDocument.getText returns "William Shakespeare".

Returns:

non-marked-up text contained bu this element

reportSAXEvents

public void reportSAXEvents(ContentHandler cntHandler)
                     throws SAXException

Report SAX Events from a DOM Tree

Throws:

SAXException - thrown by SAX Callback functions

transformNode

public DocumentFragment transformNode(XSLStylesheet xsl)
                               throws XSLException

Transforms a node in the tree using the given stylesheet

Parameters:

xsl - XSLStylesheet to be used for transformation

Returns:

a document fragment

Throws:

XSLException - Raised if there is an error while doing the XSL transformation.

selectNodes

public NodeList selectNodes(java.lang.String pattern,
                            NSResolver nsr)
                     throws XSLException

Selects nodes from the tree which match the given pattern

Parameters:

pattern - XSL pattern to match

nsr - NSResolver to resolve any namespace prefixes that occur in the given pattern

Returns:

a list of matching nodes

Throws:

XSLException - Raised if there is an error while doing the match

selectNodes

public NodeList selectNodes(java.lang.String pattern)
                     throws XSLException

Selects nodes from the tree which match the given pattern. This method assumes that the pattern does not contain namespace prefixes.

Parameters:

pattern - XSL pattern to match

Returns:

a list of matching nodes

Throws:

XSLException - Raised if there is an error while doing the match

selectSingleNode

public Node selectSingleNode(java.lang.String pattern,
                             NSResolver nsr)
                      throws XSLException

Selects the first node from the tree that matches the given pattern

Parameters:

pattern - XSL pattern to match

nsr - NSResolver to resolve any prefixes that occur in given pattern

Returns:

matching node

Throws:

XSLException - Raised if there is an error while doing the match

selectSingleNode

public Node selectSingleNode(java.lang.String pattern)
                      throws XSLException

Selects the first node from the tree that matches the given pattern

Parameters:

pattern - XSL pattern to match

Returns:

matching node

Throws:

XSLException - Raised if there is an error while doing the match

valueOf

public java.lang.String valueOf(java.lang.String pattern,
                                NSResolver nsr)
                         throws XSLException

Selects the value of the first node from tree that matches the pattern

Parameters:

pattern - XSL pattern to match

nsr - NSResolver to resolve any prefixes that occur in given pattern

Returns:

value of the matching node

Throws:

XSLException - Raised if there is an error while doing the match

valueOf

public java.lang.String valueOf(java.lang.String pattern)
                         throws XSLException

Selects the value of the first node from tree that matches the pattern

Parameters:

pattern - XSL pattern to match

Returns:

value of the matching node

Throws:

XSLException - Raised if there is an error while doing the match

isNodeFlag

public boolean isNodeFlag(int flag)

Returns the node flag information

Returns:

true if the flag is set

isDocumentFlag

public boolean isDocumentFlag(int flag)

Returns the document flag information

Returns:

true if the flag is set

setNodeFlag

public void setNodeFlag(int flag)

Sets the node flag information

Parameters:

flag - the node flag

setNodeFlag

public void setNodeFlag(int flag,
                        boolean val)

Sets or resets the node flag information

Parameters:

flag - the node flag

val - boolean, the flag is set if val is true, otherwise reset

setNodeFlag

public void setNodeFlag(int flag,
                        int mask)

Sets the node multi bit flag information

Parameters:

flag - the node flag

mask - the mask for the multiple bits

resetNodeFlag

public void resetNodeFlag(int flag)

Resets the node flag information

Parameters:

flag - the node flag

getPrimitiveTypeId

public int getPrimitiveTypeId()

Get Schema primitive type id

Returns:

schema type id

getDebugMode

public boolean getDebugMode()

Get debug information mode

Returns:

flag debugging mode

setDebugInfo

public void setDebugInfo(int line,
                         int col,
                         java.lang.String sysid)

Set debug information in the node

Parameters:

line - the line number

col - the col number

sysid - the system id

getLineNumber

public int getLineNumber()

Get line number debug information

Returns:

line the line number

getColumnNumber

public int getColumnNumber()

Get column number debug information

Returns:

column the column number

getSystemId

public java.lang.String getSystemId()

Get the system id of the entity contain this node

Returns:

sysid the system id

getXMLError

public XMLError getXMLError()

Gets XMLError set in the document node

Returns:

XMLError

setProperty

public void setProperty(java.lang.String propName,
                        java.lang.Object propValue)

Set a property of the node

Parameters:

propName - - Name of the property

propValue - - Value of the property

getProperty

public java.lang.Object getProperty(java.lang.String propName)

Get a property of the node

Parameters:

propName - - Name of the property

Returns:

Object propValue - Value of the property

print

public void print(java.io.Writer out)
           throws java.io.IOException

Writes the contents of this node using the given print writer.

Parameters:

out - PrintWriter to use

Throws:

java.io.IOException - if an error occurs

print

public void print(java.io.PrintWriter out)
           throws java.io.IOException

Writes the contents of this node using the given print writer.

Parameters:

out - PrintWriter to use

Throws:

java.io.IOException - if an error occurs

print

public void print(java.io.OutputStream out)
           throws java.io.IOException

Writes the contents of this node to the given output stream.

Parameters:

out - OutputStream to write to

Throws:

java.io.IOException - if an error occurs

print

public void print(java.io.OutputStream out,
                  java.lang.String enc)
           throws java.io.IOException

Writes the contents of this node to the given output stream.

Parameters:

out - OutputStream to write to

enc - Encoding to use for the output

Throws:

java.io.IOException - if an invalid encoding was specified or if any other error occurs

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

This method saves the state of the object by creating a binary compressed stream with information about this object.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The ObjectOutput stream used to write the serialized/ compressed stream.

Throws:

java.io.IOException - is thrown when there is an exception while writing the serialized/compressed stream.

readExternal

public void readExternal(java.io.ObjectInput inArg)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

This method reads the information written in the compressed stream by writeExternal method and restores the object correspondingly.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

inArg - the ObjectInput used for reading the compressed stream

Throws:

java.io.IOException - is thrown when there is an error in reading the input stream.

java.lang.ClassNotFoundException - is thrown when the class is not found

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

Returns:

a hash code value for this object.

xdbGetNodeId

public long xdbGetNodeId()