org.jvoicexml.xml
Class XmlDocument

java.lang.Object
  org.jvoicexml.xml.XmlDocument

All Implemented Interfaces:

XmlWritable, Document, Node

Direct Known Subclasses:

CcxmlDocument, SrgsXmlDocument, VoiceXmlDocument

public abstract class XmlDocument
extends Object
implements XmlWritable, Document

An XML Document abstract base class.

VoiceXML is designed for creating audio dialogs that feature synthesized speech, digitized audio, regognition of spoken and DTMF key input, recording of spoken input, telephony and mixed initiative conversations. Its major goal is to bring the advantages of web-based development and content delivery to interactive voiceresponse applications.

Objects of this class can create such VoiceXML documents or parse them.

Version:

$Revision: 1.10 $

Copyright © 2005 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Steve Doyle

Field Summary

protected Document

document The encapsulated document.

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_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, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

XmlDocument()
Create an empty XML document.

XmlDocument(Document doc)
Construct a new XML document with the given document.

XmlDocument(InputSource source)
Constructs a new XML document from the given input source.

Method Summary

Node	adoptNode(Node source) Attempts to adopt a node from another document to this document.
Node	appendChild(Node newChild) Adds the node newChild to the end of the list of children of this node.
Node	cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
short	compareDocumentPosition(Node other) Compares the reference node, i.e.
Attr	createAttribute(String name) Creates an Attr of the given name.
Attr	createAttributeNS(String namespaceURI, String qualifiedName) Creates an attribute of the given qualified name and namespace URI.
CDATASection	createCDATASection(String data) Creates a CDATASection node whose value is the specified string.
Comment	createComment(String data) Creates a Comment node given the specified string.
DocumentFragment	createDocumentFragment() Creates an empty DocumentFragment object.
Element	createElement(String tagName) Creates an element of the type specified.
Element	createElementNS(String namespaceURI, String qualifiedName) Creates an element of the given qualified name and namespace URI.
EntityReference	createEntityReference(String name) Creates an EntityReference object.
ProcessingInstruction	createProcessingInstruction(String target, String data) Creates a ProcessingInstruction node given the specified name and data strings.
protected abstract Node	createRootNode() Create the root node of the document.
Text	createTextNode(String data) Creates a Text node given the specified string.
NamedNodeMap	getAttributes() A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
String	getBaseURI() The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
NodeList	getChildNodes() A NodeList that contains all children of this node.
DocumentType	getDoctype() The Document Type Declaration (see DocumentType) associated with this document.
Element	getDocumentElement() This is a convenience attribute that allows direct access to the child node that is the root element of the document.
String	getDocumentURI() The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument.
DOMConfiguration	getDomConfig() The configuration used when Document.normalizeDocument() is invoked.
Element	getElementById(String elementId) Returns the Element whose ID is given by elementId.
NodeList	getElementsByTagName(String tagname) Returns a NodeList of all the Elements with a given tag name in the order in which they are encountered in a preorder traversal of the Document tree.
NodeList	getElementsByTagNameNS(String namespaceURI, String localName) Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the Document tree.
Object	getFeature(String feature, String version) This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .
Node	getFirstChild() The first child of this node.
DOMImplementation	getImplementation() The DOMImplementation object that handles this document.
String	getInputEncoding() An attribute specifying the encoding used for this document at the time of the parsing.
Node	getLastChild() The last child of this node.
String	getLocalName() Returns the local part of the qualified name of this node.
String	getNamespaceURI() The namespace URI of this node, or null if it is unspecified.
Node	getNextSibling() The node immediately following this node.
String	getNodeName() The name of this node, depending on its type; see the table above.
short	getNodeType() A code representing the type of the underlying object, as defined above.
String	getNodeValue() The value of this node, depending on its type; see the table above.
Document	getOwnerDocument() The Document object associated with this node.
Node	getParentNode() The parent of this node.
String	getPrefix() The namespace prefix of this node, or null if it is unspecified.
Node	getPreviousSibling() The node immediately preceding this node.
private Node	getRawNode(Node arg) Get the raw node encapsulated by the specified node.
boolean	getStrictErrorChecking() An attribute specifying whether error checking is enforced or not.
String	getTextContent() This attribute returns the text content of this node and its descendants.
Object	getUserData(String key) Retrieves the object associated to a key on a this node.
String	getXmlEncoding() An attribute specifying, as part of the XML declaration, the encoding of this document.
protected abstract Node	getXmlNode(Node node) Get the XmlNode object corresponding to the node.
protected abstract NodeList	getXmlNodeList(NodeList nodeList) Get the XmlNodeList object corresponding to the nodelist.
boolean	getXmlStandalone() An attribute specifying, as part of the XML declaration, whether this document is standalone.
String	getXmlVersion() An attribute specifying, as part of the XML declaration, the version number of this document.
boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
boolean	hasChildNodes() Returns whether this node has any children.
Node	importNode(Node importedNode, boolean deep) Imports a node from another document to this document.
Node	insertBefore(Node newChild, Node refChild) Inserts the node newChild before the existing child node refChild.
boolean	isDefaultNamespace(String namespaceURI) This method checks if the specified namespaceURI is the default namespace or not.
boolean	isEqualNode(Node arg) Tests whether two nodes are equal.
boolean	isSameNode(Node other) Returns whether this node is the same node as the given one.
boolean	isSupported(String feature, String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
String	lookupNamespaceURI(String prefix) Look up the namespace URI associated to the given prefix, starting from this node.
String	lookupPrefix(String namespaceURI) Look up the prefix associated to the given namespace URI, starting from this node.
void	normalize() Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "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	normalizeDocument() This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form.
Node	removeChild(Node oldChild) Removes the child node indicated by oldChild from the list of children, and returns it.
Node	renameNode(Node n, String namespaceURI, String qualifiedName) Rename an existing node of type ELEMENT_NODE or ATTRIBUTE_NODE.
Node	replaceChild(Node newChild, Node oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
void	setDocumentURI(String documentURI) The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument.
void	setNodeValue(String nodeValue) The value of this node, depending on its type; see the table above.
void	setPrefix(String prefix) The namespace prefix of this node, or null if it is unspecified.
void	setStrictErrorChecking(boolean strictErrorChecking) An attribute specifying whether error checking is enforced or not.
void	setTextContent(String textContent) This attribute returns the text content of this node and its descendants.
Object	setUserData(String key, Object data, UserDataHandler handler) Associate an object to a key on this node.
void	setXmlStandalone(boolean xmlStandalone) An attribute specifying, as part of the XML declaration, whether this document is standalone.
void	setXmlVersion(String xmlVersion) An attribute specifying, as part of the XML declaration, the version number of this document.
String	toString() Creates a representation as an XML string.
String	toXml() Returns the contents of this object as an XML formatted string.
void	writeChildrenXml(XmlWriter writer) Used to write any children of a node.
void	writeXml(XmlWriter writer) This is the primary method used to write an object and its children as XML text.

Methods inherited from class java.lang.Object

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

Field Detail

document

protected final Document document

The encapsulated document.

Constructor Detail

XmlDocument

public XmlDocument()
            throws ParserConfigurationException

Create an empty XML document.

Throws:

ParserConfigurationException - Error creating the document builder.

XmlDocument

public XmlDocument(InputSource source)
            throws ParserConfigurationException,
                   SAXException,
                   IOException

Constructs a new XML document from the given input source.

Parameters:

source - Input source for a single XML document.

Throws:

ParserConfigurationException - Error creating the document builder.

SAXException - Error parsing the input source.

IOException - Error reading the input source.

XmlDocument

public XmlDocument(Document doc)

Construct a new XML document with the given document.

Parameters:

doc - Encapsulated document.

Method Detail

createRootNode

protected abstract Node createRootNode()

Create the root node of the document.

Returns:

Root node

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Adds the node newChild to the end of the list of children of this node.

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 or this node itself.
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 or if the previous parent of the node being inserted is readonly.

cloneNode

public Node cloneNode(boolean deep)

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.

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.

createAttribute

public Attr createAttribute(String name)
                     throws DOMException

Creates an Attr of the given name.

Specified by:

createAttribute in interface Document

Parameters:

name - The name of the attribute.

Returns:

A new Attr object with the nodeName attribute set to name, and localName, prefix, and namespaceURI set to null. The value of the attribute is the empty string.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
                              String qualifiedName)
                       throws DOMException

Creates an attribute of the given qualified name and namespace URI.

Specified by:

createAttributeNS in interface Document

Parameters:

namespaceURI - The namespace URI of the attribute to create.

qualifiedName - The qualified name of the attribute to instantiate.

Returns:

A new Attr object with the following attributes:

Attribute	Value
Node.nodeName	qualifiedName
Node.namespaceURI	namespaceURI
Node.prefix	prefix, extracted from qualifiedName, or null if there is no prefix
Node.localName	local name, extracted from qualifiedName
Attr.name	qualifiedName
Node.nodeValue	the empty string

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace", or if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from " http://www.w3.org/2000/xmlns/".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.

createCDATASection

public CDATASection createCDATASection(String data)
                                throws DOMException

Creates a CDATASection node whose value is the specified string.

Specified by:

createCDATASection in interface Document

Parameters:

data - The data for the CDATASection contents.

Returns:

The new CDATASection object.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createComment

public Comment createComment(String data)

Creates a Comment node given the specified string.

Specified by:

createComment in interface Document

Parameters:

data - The data for the node.

Returns:

The new Comment object.

createDocumentFragment

public DocumentFragment createDocumentFragment()

Creates an empty DocumentFragment object.

Specified by:

createDocumentFragment in interface Document

Returns:

A new DocumentFragment.

createElement

public Element createElement(String tagName)
                      throws DOMException

Creates an element of the type specified.

Specified by:

createElement in interface Document

Parameters:

tagName - The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the tagName parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.

Returns:

A new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createElementNS

public Element createElementNS(String namespaceURI,
                               String qualifiedName)
                        throws DOMException

Creates an element of the given qualified name and namespace URI.

Specified by:

createElementNS in interface Document

Parameters:

namespaceURI - The namespace URI of the element to create.

qualifiedName - The qualified name of the element type to instantiate.

Returns:

A new Element object with the following attributes:

Attribute	Value
Node.nodeName	qualifiedName
Node.namespaceURI	namespaceURI
Node.prefix	prefix, extracted from qualifiedName, or null if there is no prefix
Node.localName	local name, extracted from qualifiedName
Element.tagName	qualifiedName

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" .
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.

createEntityReference

public EntityReference createEntityReference(String name)
                                      throws DOMException

Creates an EntityReference object.

Specified by:

createEntityReference in interface Document

Parameters:

name - The name of the entity to reference.

Returns:

The new EntityReference object.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
                                                         String data)
                                                  throws DOMException

Creates a ProcessingInstruction node given the specified name and data strings.

Specified by:

createProcessingInstruction in interface Document

Parameters:

target - The target part of the processing instruction.

data - The data for the node.

Returns:

The new ProcessingInstruction object.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createTextNode

public Text createTextNode(String data)

Creates a Text node given the specified string.

Specified by:

createTextNode in interface Document

Parameters:

data - The data for the node.

Returns:

The new Text object.

getAttributes

public NamedNodeMap getAttributes()

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

Specified by:

getAttributes in interface Node

Returns:

NamedNodeMap

getChildNodes

public NodeList getChildNodes()

A NodeList that contains all children of this node.

Specified by:

getChildNodes in interface Node

Returns:

NodeList

getDoctype

public DocumentType getDoctype()

The Document Type Declaration (see DocumentType) associated with this document.

Specified by:

getDoctype in interface Document

Returns:

DocumentType

getDocumentElement

public Element getDocumentElement()

This is a convenience attribute that allows direct access to the child node that is the root element of the document.

Specified by:

getDocumentElement in interface Document

Returns:

Element

getElementById

public Element getElementById(String elementId)

Returns the Element whose ID is given by elementId.

Specified by:

getElementById in interface Document

Parameters:

elementId - The unique id value for an element.

Returns:

The matching element.

getElementsByTagName

public NodeList getElementsByTagName(String tagname)

Returns a NodeList of all the Elements with a given tag name in the order in which they are encountered in a preorder traversal of the Document tree.

Specified by:

getElementsByTagName in interface Document

Parameters:

tagname - The name of the tag to match on. The special value "*" matches all tags.

Returns:

A new NodeList object containing all the matched Elements.

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the Document tree.

Specified by:

getElementsByTagNameNS in interface Document

Parameters:

namespaceURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces.

localName - The local name of the elements to match on. The special value "*" matches all local names.

Returns:

A new NodeList object containing all the matched Elements.

getXmlNode

protected abstract Node getXmlNode(Node node)

Get the XmlNode object corresponding to the node.

Parameters:

node - - Node to convert to an XmlNode

Returns:

XmlNode representing the node.

getXmlNodeList

protected abstract NodeList getXmlNodeList(NodeList nodeList)

Get the XmlNodeList object corresponding to the nodelist.

Parameters:

nodeList - - Node to convert to an XmlNodeList

Returns:

XmlNodeList representing the node.

getFirstChild

public Node getFirstChild()

The first child of this node.

Specified by:

getFirstChild in interface Node

Returns:

Node

getImplementation

public DOMImplementation getImplementation()

The DOMImplementation object that handles this document.

Specified by:

getImplementation in interface Document

Returns:

DOMImplementation

getLastChild

public Node getLastChild()

The last child of this node.

Specified by:

getLastChild in interface Node

Returns:

Node

getLocalName

public String getLocalName()

Returns the local part of the qualified name of this node.

Specified by:

getLocalName in interface Node

Returns:

String

getNamespaceURI

public String getNamespaceURI()

The namespace URI of this node, or null if it is unspecified.

Specified by:

getNamespaceURI in interface Node

Returns:

String

getNextSibling

public Node getNextSibling()

The node immediately following this node.

Specified by:

getNextSibling in interface Node

Returns:

Node

getNodeName

public String getNodeName()

The name of this node, depending on its type; see the table above.

Specified by:

getNodeName in interface Node

Returns:

String

getNodeType

public short getNodeType()

A code representing the type of the underlying object, as defined above.

Specified by:

getNodeType in interface Node

Returns:

short

getNodeValue

public String getNodeValue()
                    throws DOMException

The value of this node, depending on its type; see the table above.

Specified by:

getNodeValue in interface Node

Returns:

String

Throws:

DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

getOwnerDocument

public Document getOwnerDocument()

The Document object associated with this node.

Specified by:

getOwnerDocument in interface Node

Returns:

Document

getParentNode

public Node getParentNode()

The parent of this node.

Specified by:

getParentNode in interface Node

Returns:

Node

getPrefix

public String getPrefix()

The namespace prefix of this node, or null if it is unspecified.

Specified by:

getPrefix in interface Node

Returns:

String

getPreviousSibling

public Node getPreviousSibling()

The node immediately preceding this node.

Specified by:

getPreviousSibling in interface Node

Returns:

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()

Returns whether this node has any children.

Specified by:

hasChildNodes in interface Node

Returns:

true if this node has any children, false otherwise.

importNode

public Node importNode(Node importedNode,
                       boolean deep)
                throws DOMException

Imports a node from another document to this document.

Specified by:

importNode in interface Document

Parameters:

importedNode - The node to import.

deep - If true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This has no effect on Attr , EntityReference, and Notation nodes.

Returns:

The imported node that belongs to this Document.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.

getInputEncoding

public String getInputEncoding()

An attribute specifying the encoding used for this document at the time of the parsing.

Specified by:

getInputEncoding in interface Document

Returns:

String

getXmlEncoding

public String getXmlEncoding()

An attribute specifying, as part of the XML declaration, the encoding of this document.

Specified by:

getXmlEncoding in interface Document

Returns:

String

getXmlStandalone

public boolean getXmlStandalone()

An attribute specifying, as part of the XML declaration, whether this document is standalone.

Specified by:

getXmlStandalone in interface Document

Returns:

boolean

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException

An attribute specifying, as part of the XML declaration, whether this document is standalone.

Specified by:

setXmlStandalone in interface Document

Parameters:

xmlStandalone - boolean

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.

getXmlVersion

public String getXmlVersion()

An attribute specifying, as part of the XML declaration, the version number of this document.

Specified by:

getXmlVersion in interface Document

Returns:

String

setXmlVersion

public void setXmlVersion(String xmlVersion)
                   throws DOMException

An attribute specifying, as part of the XML declaration, the version number of this document.

Specified by:

setXmlVersion in interface Document

Parameters:

xmlVersion - String

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by this Document or if this document does not support the "XML" feature.

getStrictErrorChecking

public boolean getStrictErrorChecking()

An attribute specifying whether error checking is enforced or not.

Specified by:

getStrictErrorChecking in interface Document

Returns:

boolean

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

An attribute specifying whether error checking is enforced or not.

Specified by:

setStrictErrorChecking in interface Document

Parameters:

strictErrorChecking - boolean

getDocumentURI

public String getDocumentURI()

The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument.

Specified by:

getDocumentURI in interface Document

Returns:

String

setDocumentURI

public void setDocumentURI(String documentURI)

The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument.

Specified by:

setDocumentURI in interface Document

Parameters:

documentURI - String

adoptNode

public Node adoptNode(Node source)
               throws DOMException

Attempts to adopt a node from another document to this document.

Specified by:

adoptNode in interface Document

Parameters:

source - The node to move into this document.

Returns:

The adopted node, or null if this operation fails, such as when the source node comes from a different implementation.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if the source node is of type DOCUMENT, DOCUMENT_TYPE.
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.

getDomConfig

public DOMConfiguration getDomConfig()

The configuration used when Document.normalizeDocument() is invoked.

Specified by:

getDomConfig in interface Document

Returns:

DOMConfiguration

normalizeDocument

public void normalizeDocument()

This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form.

Specified by:

normalizeDocument in interface Document

renameNode

public Node renameNode(Node n,
                       String namespaceURI,
                       String qualifiedName)
                throws DOMException

Rename an existing node of type ELEMENT_NODE or ATTRIBUTE_NODE.

Specified by:

renameNode in interface Document

Parameters:

n - The node to rename.

namespaceURI - The new namespace URI.

qualifiedName - The new qualified name.

Returns:

The renamed node. This is either the specified node or the new node that was created to replace the specified node.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised when the type of the specified node is neither ELEMENT_NODE nor ATTRIBUTE_NODE, or if the implementation does not support the renaming of the document element.
INVALID_CHARACTER_ERR: Raised if the new qualified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
WRONG_DOCUMENT_ERR: Raised when the specified node was created from a different document than this document.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" [XML Namespaces] . Also raised, when the node being renamed is an attribute, if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from " http://www.w3.org/2000/xmlns/".

insertBefore

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

Inserts the node newChild before the existing child node refChild.

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 or this node itself.
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 or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.

isSupported

public boolean isSupported(String feature,
                           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

Parameters:

feature - The name of the feature to test. This is the same name which can be passed to the method hasFeature on DOMImplementation.

version - This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.

Returns:

Returns true if the specified feature is supported on this node, false otherwise.

normalize

public void normalize()

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "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.

Specified by:

normalize in interface Node

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.

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.

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 if the node to put in is one of this node's ancestors or this node itself.
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 or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

The value of this node, depending on its type; see the table above.

Specified by:

setNodeValue in interface Node

Parameters:

nodeValue - String

Throws:

DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setPrefix

public void setPrefix(String prefix)
               throws DOMException

The namespace prefix of this node, or null if it is unspecified.

Specified by:

setPrefix in interface Node

Parameters:

prefix - String

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character, per the XML 1.0 specification .
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed per the Namespaces in XML specification, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" .

getBaseURI

public String getBaseURI()

The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.

Specified by:

getBaseURI in interface Node

Returns:

String

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Compares the reference node, i.e.

Specified by:

compareDocumentPosition in interface Node

Parameters:

other - The node to compare against the reference node.

Returns:

Returns how the node is positioned relatively to the reference node.

Throws:

DOMException - NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.

getTextContent

public String getTextContent()
                      throws DOMException

This attribute returns the text content of this node and its descendants.

Specified by:

getTextContent in interface Node

Returns:

String

Throws:

DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

This attribute returns the text content of this node and its descendants.

Specified by:

setTextContent in interface Node

Parameters:

textContent - String

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

isSameNode

public boolean isSameNode(Node other)

Returns whether this node is the same node as the given one.

Specified by:

isSameNode in interface Node

Parameters:

other - The node to test against.

Returns:

Returns true if the nodes are the same, false otherwise.

lookupPrefix

public String lookupPrefix(String namespaceURI)

Look up the prefix associated to the given namespace URI, starting from this node.

Specified by:

lookupPrefix in interface Node

Parameters:

namespaceURI - The namespace URI to look for.

Returns:

Returns an associated namespace prefix if found or null if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent.

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

This method checks if the specified namespaceURI is the default namespace or not.

Specified by:

isDefaultNamespace in interface Node

Parameters:

namespaceURI - The namespace URI to look for.

Returns:

Returns true if the specified namespaceURI is the default namespace, false otherwise.

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Look up the namespace URI associated to the given prefix, starting from this node.

Specified by:

lookupNamespaceURI in interface Node

Parameters:

prefix - The prefix to look for. If this parameter is null, the method will return the default namespace URI if any.

Returns:

Returns the associated namespace URI or null if none is found.

isEqualNode

public boolean isEqualNode(Node arg)

Tests whether two nodes are equal.

Specified by:

isEqualNode in interface Node

Parameters:

arg - The node to compare equality with.

Returns:

Returns true if the nodes are equal, false otherwise.

getFeature

public Object getFeature(String feature,
                         String version)

This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .

Specified by:

getFeature in interface Node

Parameters:

feature - The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method.

version - This is the version number of the feature to test.

Returns:

Returns an object which implements the specialized APIs of the specified feature and version, if any, or null if there is no object which implements interfaces associated with that feature. If the DOMObject returned by this method implements the Node interface, it must delegate to the primary core Node and not return results inconsistent with the primary core Node such as attributes, childNodes, etc.

setUserData

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

Associate an object to a key on this node.

Specified by:

setUserData in interface Node

Parameters:

key - The key to associate the object to.

data - The object to associate to the given key, or null to remove any existing association to that key.

handler - The handler to associate to that key, or null.

Returns:

Returns the DOMUserData previously associated to the given key on this node, or null if there was none.

getUserData

public Object getUserData(String key)

Retrieves the object associated to a key on a this node.

Specified by:

getUserData in interface Node

Parameters:

key - The key the object is associated to.

Returns:

Returns the DOMUserData associated to the given key on this node, or null if there was none.

writeXml

public void writeXml(XmlWriter writer)
              throws IOException

This is the primary method used to write an object and its children as XML text. Implementations with children should use writeChildrenXml to write those children, to allow selective overriding.

Specified by:

writeXml in interface XmlWritable

Parameters:

writer - XMLWriter used when writing XML text.

Throws:

IOException - Error in writing.

writeChildrenXml

public void writeChildrenXml(XmlWriter writer)
                      throws IOException

Used to write any children of a node.

Specified by:

writeChildrenXml in interface XmlWritable

Parameters:

writer - XMLWriter used when writing XML text.

Throws:

IOException - Error in writing.

toXml

public String toXml()
             throws IOException

Returns the contents of this object as an XML formatted string.

Returns:

XML representation of this object.

Throws:

IOException - Error writing to the writer.

toString

public String toString()

Creates a representation as an XML string. If this is not possible for some reason, the conventional toString creation is used.

Overrides:

toString in class Object

Since:

0.3

getRawNode

private Node getRawNode(Node arg)

Get the raw node encapsulated by the specified node. If the specified node is a raw node then it is returned.

Parameters:

arg - The node that may be wrapping a raw node.

Returns:

The raw node.