SimpleHtmlDocument

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jdesktop.dom
Class SimpleHtmlDocument

java.lang.Object
  org.jdesktop.dom.SimpleHtmlDocument

All Implemented Interfaces:: Document, org.w3c.dom.html.HTMLDocument, Node

public class SimpleHtmlDocument
extends Object
implements org.w3c.dom.html.HTMLDocument
extends Object
implements org.w3c.dom.html.HTMLDocument

A DOM Document that makes it easier to work with DOM documents. This class simply wraps a delegate HTMLDocument and delegates all calls to the Document. This allows this class to work with any HTMLDocument.

Field Summary

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`

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
`SimpleHtmlDocument()` Create a new, empty, SimpleHtmlDocument
`SimpleHtmlDocument(org.w3c.dom.html.HTMLDocument dom)` Creates a new instance of SimpleHtmlDocument.

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.
`void`	`close()` Closes a document stream opened by `open()` and forces rendering.
`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.
`Text`	`createTextNode(String data)` Creates a `Text` node given the specified string.
`SimpleHtmlCollection`	`getAnchors()` A collection of all the anchor (`A` ) elements in a document with a value for the `name` attribute.
`SimpleHtmlCollection`	`getApplets()` A collection of all the `OBJECT` elements that include applets and `APPLET` ( deprecated ) elements in a document.
`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.
`org.w3c.dom.html.HTMLElement`	`getBody()` The element that contains the content for the document.
`int`	`getChildElementCount(Node parent)` Returns the number of child elements for the given node.
`SimpleNodeList`	`getChildElements(Node parent)` Returns the child elements of the specified node.
`SimpleNodeList`	`getChildNodes()` A `NodeList` that contains all children of this node.
`String`	`getCookie()` The cookies associated with this document.
`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 document element of the document.
`String`	`getDocumentURI()` The location of the document or `null` if undefined or if the `Document` was created using `DOMImplementation.createDocument`.
`String`	`getDomain()` The domain name of the server that served the document, or `null` if the server cannot be identified by a domain name.
`DOMConfiguration`	`getDomConfig()` The configuration used when `Document.normalizeDocument()` is invoked.
`Node`	`getElement(String expression)` Returns a Node matching the given expression.
`Node`	`getElement(String expression, Node node)` Returns a Node matching the given expression.
`Element`	`getElementById(String elementId)` Returns the `Element` that has an ID attribute with the given value.
`SimpleNodeList`	`getElements(String expression)` Returns a `SimpleNodeList` containing all the nodes that match the given expression.
`SimpleNodeList`	`getElements(String expression, Node node)` Returns a `SimpleNodeList` containing all the nodes that match the given expression when executed on the given node (as opposed to the dom as a whole).
`SimpleNodeList`	`getElementsByName(String elementName)` Returns the (possibly empty) collection of elements whose `name` value is given by `elementName` .
`SimpleNodeList`	`getElementsByTagName(String tagname)` Returns a `NodeList` of all the `Elements` in document order with a given tag name and are contained in the document.
`SimpleNodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)` Returns a `NodeList` of all the `Elements` with a given local name and namespace URI in document order.
`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.
`SimpleHtmlCollection`	`getForms()` A collection of all the forms of a document.
`SimpleHtmlCollection`	`getImages()` A collection of all the `IMG` elements in a document.
`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.
`SimpleHtmlCollection`	`getLinks()` A collection of all `AREA` elements and anchor ( `A` ) elements in a document with a value for the `href` attribute.
`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 (see ).
`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.
`String`	`getReferrer()` Returns the URI of the page that linked to this page.
`boolean`	`getStrictErrorChecking()` An attribute specifying whether error checking is enforced or not.
`String`	`getString(String expression)` Returns the text content of the Node matching the given expression.
`String`	`getString(String expression, Node node)` Returns the text content of the Node matching the given expression.
`String`	`getTextContent()` This attribute returns the text content of this node and its descendants.
`String`	`getTitle()` The title of a document as specified by the `TITLE` element in the head of the document.
`String`	`getURL()` The complete URI of the document.
`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.
`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, without altering or removing the source node from the original document; this method creates a new copy of the source node.
`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, as specified in .
`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.
`void`	`open()` Note.
`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`	`setBody(org.w3c.dom.html.HTMLElement body)`
`void`	`setCookie(String cookie)`
`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.
`void`	`setTitle(String title)`
`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`	`toXML()` Exports this DOM as a String
`String`	`toXML(Node n)`
`void`	`write(String text)` Write a string of text to a document stream opened by `open()` .
`void`	`writeln(String text)` Write a string of text followed by a newline character to a document stream opened by `open()` .

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SimpleHtmlDocument

public SimpleHtmlDocument()

Create a new, empty, SimpleHtmlDocument

SimpleHtmlDocument

public SimpleHtmlDocument(org.w3c.dom.html.HTMLDocument dom)

Creates a new instance of SimpleHtmlDocument.

Parameters:: Document - the HTML DOM document to wrap within this SimpleDocument.

Method Detail

toXML

public String toXML()

Exports this DOM as a String

Returns:: an XML String representation of this DOM

toXML

public String toXML(Node n)

getChildElements

public SimpleNodeList getChildElements(Node parent)

Returns the child elements of the specified node. This returns only the immediate child Nodes of type ELEMENT_NODE.

Parameters:: parent - the parent node
Returns:: a SimpleNodeList containing all of the immediate child elements

getChildElementCount

public int getChildElementCount(Node parent)

Returns the number of child elements for the given node. Only immediate child nodes of type ELEMENT_NODE are counted.

Parameters:: parent - the parent node
Returns:: the number of immediate child Elements of the given parent node

getElements

public SimpleNodeList getElements(String expression)

Returns a SimpleNodeList containing all the nodes that match the given expression.

Parameters:: expression - an XPath expression
Returns:: SimpleNodeList containing the results from the expression. This will never be null, but may contain no results.
Throws:: IllegalArgumentException - if the expression does not parse

getElements

public SimpleNodeList getElements(String expression,
                                  Node node)

Returns a SimpleNodeList containing all the nodes that match the given expression when executed on the given node (as opposed to the dom as a whole).

Parameters:: expression - an XPath expression; node - the contextual node
Returns:: SimpleNodeList containing the results from the expression. This will never be null, but may contain no results.
Throws:: IllegalArgumentException - if the expression does not parse

getElement

public Node getElement(String expression)

Returns a Node matching the given expression. If more than one node matches, the return value is undefined.

Parameters:: expression - an XPath expression
Returns:: Node. May be null.
Throws:: IllegalArgumentException - if the expression does not parse

getElement

public Node getElement(String expression,
                       Node node)

Returns a Node matching the given expression. If more than one node matches, the return value is undefined.

Parameters:: expression - an XPath expression; node - the contextual node
Returns:: Node. May be null.
Throws:: IllegalArgumentException - if the expression does not parse

getString

public String getString(String expression)

Returns the text content of the Node matching the given expression. If more than one node matches, the return value is undefined.

Parameters:: expression - an XPath expression
Returns:: text content of the selected Node. May be null.
Throws:: IllegalArgumentException - if the expression does not parse

getString

public String getString(String expression,
                        Node node)

Returns the text content of the Node matching the given expression. If more than one node matches, the return value is undefined.

Parameters:: expression - an XPath expression; node - the contextual node
Returns:: text content of the selected Node. May be null.
Throws:: IllegalArgumentException - if the expression does not parse

getDoctype

public DocumentType getDoctype()

Description copied from interface: org.w3c.dom.Document

The Document Type Declaration (see DocumentType) associated with this document. For XML documents without a document type declaration this returns null. For HTML documents, a DocumentType object may be returned, independently of the presence or absence of document type declaration in the HTML document.
This provides direct access to the DocumentType node, child node of this Document. This node can be set at document creation time and later changed through the use of child nodes manipulation methods, such as Node.insertBefore, or Node.replaceChild. Note, however, that while some implementations may instantiate different types of Document objects supporting additional features than the "Core", such as "HTML" [DOM Level 2 HTML] , based on the DocumentType specified at creation time, changing it afterwards is very unlikely to result in a change of the features supported.

Specified by:: getDoctype in interface Document

getImplementation

public DOMImplementation getImplementation()

Description copied from interface: org.w3c.dom.Document

The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.

Specified by:: getImplementation in interface Document

getDocumentElement

public Element getDocumentElement()

Description copied from interface: org.w3c.dom.Document

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

Specified by:: getDocumentElement in interface Document

createElement

public Element createElement(String tagName)
                      throws DOMException

Description copied from interface: org.w3c.dom.Document

Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.
In addition, if there are known attributes with default values, Attr nodes representing them are automatically created and attached to the element.
To create an element with a qualified name and namespace URI, use the createElementNS method.

Specified by:: createElement in interface Document

Parameters:: tagName - The name of the element type to instantiate. For XML, this is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use. In that case, the name is mapped to the canonical form of that markup 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 is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.

createDocumentFragment

public DocumentFragment createDocumentFragment()

Description copied from interface: org.w3c.dom.Document

Creates an empty DocumentFragment object.

Specified by:: createDocumentFragment in interface Document

Returns:: A new DocumentFragment.

createTextNode

public Text createTextNode(String data)

Description copied from interface: org.w3c.dom.Document

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.

createComment

public Comment createComment(String data)

Description copied from interface: org.w3c.dom.Document

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.

createCDATASection

public CDATASection createCDATASection(String data)
                                throws DOMException

Description copied from interface: org.w3c.dom.Document

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.

createProcessingInstruction

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

Description copied from interface: org.w3c.dom.Document

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.Unlike Document.createElementNS or Document.createAttributeNS, no namespace well-formed checking is done on the target name. Applications should invoke Document.normalizeDocument() with the parameter " namespaces" set to true in order to ensure that the target name is namespace well-formed.; data - The data for the node.
Returns:: The new ProcessingInstruction object.
Throws:: DOMException - INVALID_CHARACTER_ERR: Raised if the specified target is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createAttribute

public Attr createAttribute(String name)
                     throws DOMException

Description copied from interface: org.w3c.dom.Document

Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttributeNode method.
To create an attribute with a qualified name and namespace URI, use the createAttributeNS method.

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 is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.

createEntityReference

public EntityReference createEntityReference(String name)
                                      throws DOMException

Description copied from interface: org.w3c.dom.Document

Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node.

Note: If any descendant of the Entity node has an unbound namespace prefix, the corresponding descendant of the created EntityReference node is also unbound; (its namespaceURI is null). The DOM Level 2 and 3 do not support any mechanism to resolve namespace prefixes in this case.

Specified by:: createEntityReference in interface Document

Parameters:: name - The name of the entity to reference.Unlike Document.createElementNS or Document.createAttributeNS, no namespace well-formed checking is done on the entity name. Applications should invoke Document.normalizeDocument() with the parameter " namespaces" set to true in order to ensure that the entity name is namespace well-formed.
Returns:: The new EntityReference object.
Throws:: DOMException - INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

getElementsByTagName

public SimpleNodeList getElementsByTagName(String tagname)

Description copied from interface: org.w3c.dom.Document

Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document.

Specified by:: getElementsByTagName in interface Document

Parameters:: tagname - The name of the tag to match on. The special value "*" matches all tags. For XML, the tagname parameter is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use.
Returns:: A new NodeList object containing all the matched Elements.

importNode

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

Description copied from interface: org.w3c.dom.Document

Imports a node from another document to this document, without altering or removing the source node from the original document; this method creates a new copy of the source node. The returned node has no parent; (parentNode is null).
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's nodeName and nodeType, plus the attributes related to namespaces (prefix, localName, and namespaceURI). As in the cloneNode operation, the source node is not altered. User data associated to the imported node is not carried over. However, if any UserDataHandlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
Additional information is copied as appropriate to the nodeType, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node.

ATTRIBUTE_NODE: The ownerElement attribute is set to null and the specified flag is set to true on the generated Attr. The descendants of the source Attr are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the deep parameter has no effect on Attr nodes; they always carry their children with them when imported.
DOCUMENT_FRAGMENT_NODE: If the deep option was set to true, the descendants of the source DocumentFragment are recursively imported and the resulting nodes reassembled under the imported DocumentFragment to form the corresponding subtree. Otherwise, this simply generates an empty DocumentFragment.
DOCUMENT_NODE: Document nodes cannot be imported.
DOCUMENT_TYPE_NODE: DocumentType nodes cannot be imported.
ELEMENT_NODE: Specified attribute nodes of the source element are imported, and the generated Attr nodes are attached to the generated Element. Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If the importNode deep parameter was set to true, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
ENTITY_NODE: Entity nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM.On import, the publicId, systemId, and notationName attributes are copied. If a deep import is requested, the descendants of the the source Entity are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
ENTITY_REFERENCE_NODE: Only the EntityReference itself is copied, even if a deep import is requested, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
NOTATION_NODE: Notation nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM.On import, the publicId and systemId attributes are copied. Note that the deep parameter has no effect on this type of nodes since they cannot have any children.
PROCESSING_INSTRUCTION_NODE: The imported node copies its target and data values from those of the source node.Note that the deep parameter has no effect on this type of nodes since they cannot have any children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE: These three types of nodes inheriting from CharacterData copy their data and length attributes from those of the source node.Note that the deep parameter has no effect on these types of nodes since they cannot have any children.

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 nodes that cannot have any children, and on Attr, and EntityReference 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.
INVALID_CHARACTER_ERR: Raised if one of the imported names is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute. This may happen when importing an XML 1.1 [XML 1.1] element into an XML 1.0 document, for instance.

createElementNS

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

Description copied from interface: org.w3c.dom.Document

Creates an element of the given qualified name and namespace URI.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

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 qualifiedName is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
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] , or if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.

createAttributeNS

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

Description copied from interface: org.w3c.dom.Document

Creates an attribute of the given qualified name and namespace URI.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

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 qualifiedName is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, 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", if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.

getElementsByTagNameNS

public SimpleNodeList getElementsByTagNameNS(String namespaceURI,
                                             String localName)

Description copied from interface: org.w3c.dom.Document

Returns a NodeList of all the Elements with a given local name and namespace URI in document order.

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.

getElementById

public Element getElementById(String elementId)

Description copied from interface: org.w3c.dom.Document

Returns the Element that has an ID attribute with the given value. If no such element exists, this returns null . If more than one element has an ID attribute with that value, what is returned is undefined.
The DOM implementation is expected to use the attribute Attr.isId to determine if an attribute is of type ID.

Note: Attributes with the name "ID" or "id" are not of type ID unless so defined.

Specified by:: getElementById in interface Document

Parameters:: elementId - The unique id value for an element.
Returns:: The matching element or null if there is none.

getInputEncoding

public String getInputEncoding()

Description copied from interface: org.w3c.dom.Document

An attribute specifying the encoding used for this document at the time of the parsing. This is null when it is not known, such as when the Document was created in memory.

Specified by:: getInputEncoding in interface Document

getXmlEncoding

public String getXmlEncoding()

Description copied from interface: org.w3c.dom.Document

An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified or when it is not known, such as when the Document was created in memory.

Specified by:: getXmlEncoding in interface Document

getXmlStandalone

public boolean getXmlStandalone()

Description copied from interface: org.w3c.dom.Document

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

Note: No verification is done on the value when setting this attribute. Applications should use Document.normalizeDocument() with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].

Specified by:: getXmlStandalone in interface Document

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException

Description copied from interface: org.w3c.dom.Document

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

Specified by:: setXmlStandalone in interface Document

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

getXmlVersion

public String getXmlVersion()

Description copied from interface: org.w3c.dom.Document

An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0". If this document does not support the "XML" feature, the value is always null. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invoke Document.normalizeDocument() in order to check for invalid characters in the Nodes that are already part of this Document.
DOM applications may use the DOMImplementation.hasFeature(feature, version) method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. Document objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using Document.xmlVersion.

Specified by:: getXmlVersion in interface Document

setXmlVersion

public void setXmlVersion(String xmlVersion)
                   throws DOMException

Description copied from interface: org.w3c.dom.Document

Specified by:: setXmlVersion in interface Document

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

Description copied from interface: org.w3c.dom.Document

An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default.

Specified by:: getStrictErrorChecking in interface Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

Description copied from interface: org.w3c.dom.Document

Specified by:: setStrictErrorChecking in interface Document

getDocumentURI

public String getDocumentURI()

Description copied from interface: org.w3c.dom.Document

The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument. No lexical checking is performed when setting this attribute; this could result in a null value returned when using Node.baseURI .
Beware that when the Document supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computing Node.baseURI.

Specified by:: getDocumentURI in interface Document

setDocumentURI

public void setDocumentURI(String documentURI)

Description copied from interface: org.w3c.dom.Document

Specified by:: setDocumentURI in interface Document

adoptNode

public Node adoptNode(Node source)
               throws DOMException

Description copied from interface: org.w3c.dom.Document

Attempts to adopt a node from another document to this document. If supported, it changes the ownerDocument of the source node, its children, as well as the attached attribute nodes if there are any. If the source node has a parent it is first removed from the child list of its parent. This effectively allows moving a subtree from one document to another (unlike importNode() which create a copy of the source node instead of moving it). When it fails, applications should use Document.importNode() instead. Note that if the adopted node is already part of this document (i.e. the source and target document are the same), this method still has the effect of removing the source node from the child list of its parent, if any. The following list describes the specifics for each type of node.

ATTRIBUTE_NODE: The ownerElement attribute is set to null and the specified flag is set to true on the adopted Attr. The descendants of the source Attr are recursively adopted.
DOCUMENT_FRAGMENT_NODE: The descendants of the source node are recursively adopted.
DOCUMENT_NODE: Document nodes cannot be adopted.
DOCUMENT_TYPE_NODE: DocumentType nodes cannot be adopted.
ELEMENT_NODE: Specified attribute nodes of the source element are adopted. Default attributes are discarded, though if the document being adopted into defines default attributes for this element name, those are assigned. The descendants of the source element are recursively adopted.
ENTITY_NODE: Entity nodes cannot be adopted.
ENTITY_REFERENCE_NODE: Only the EntityReference node itself is adopted, the descendants are discarded, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
NOTATION_NODE: Notation nodes cannot be adopted.
PROCESSING_INSTRUCTION_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE: These nodes can all be adopted. No specifics.

Note: Since it does not create new nodes unlike the Document.importNode() method, this method does not raise an INVALID_CHARACTER_ERR exception, and applications should use the Document.normalizeDocument() method to check if an imported name is not an XML name according to the XML version in use.

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

Description copied from interface: org.w3c.dom.Document

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

Specified by:: getDomConfig in interface Document

normalizeDocument

public void normalizeDocument()

Description copied from interface: org.w3c.dom.Document

This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. As a consequence, this method updates the replacement tree of EntityReference nodes and normalizes Text nodes, as defined in the method Node.normalize().
Otherwise, the actual result depends on the features being set on the Document.domConfig object and governing what operations actually take place. Noticeably this method could also make the document namespace well-formed according to the algorithm described in , check the character normalization, remove the CDATASection nodes, etc. See DOMConfiguration for details.

// Keep in the document 
 the information defined // in the XML Information Set (Java example) 
 DOMConfiguration docConfig = myDocument.getDomConfig(); 
 docConfig.setParameter("infoset", Boolean.TRUE); 
 myDocument.normalizeDocument();

Mutation events, when supported, are generated to reflect the changes occurring on the document.
If errors occur during the invocation of this method, such as an attempt to update a read-only node or a Node.nodeName contains an invalid character according to the XML version in use, errors or warnings (DOMError.SEVERITY_ERROR or DOMError.SEVERITY_WARNING) will be reported using the DOMErrorHandler object associated with the "error-handler " parameter. Note this method might also report fatal errors ( DOMError.SEVERITY_FATAL_ERROR) if an implementation cannot recover from an error.

Specified by:: normalizeDocument in interface Document

renameNode

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

Description copied from interface: org.w3c.dom.Document

Rename an existing node of type ELEMENT_NODE or ATTRIBUTE_NODE.
When possible this simply changes the name of the given node, otherwise this creates a new node with the specified name and replaces the existing node with the new node as described below.
If simply changing the name of the given node is not possible, the following operations are performed: a new node is created, any registered event listener is registered on the new node, any user data attached to the old node is removed from that node, the old node is removed from its parent if it has one, the children are moved to the new node, if the renamed node is an Element its attributes are moved to the new node, the new node is inserted at the position the old node used to have in its parent's child nodes list if it has one, the user data that was attached to the old node is attached to the new node.
When the node being renamed is an Element only the specified attributes are moved, default attributes originated from the DTD are updated according to the new element name. In addition, the implementation may update default attributes from other schemas. Applications should use Document.normalizeDocument() to guarantee these attributes are up-to-date.
When the node being renamed is an Attr that is attached to an Element, the node is first removed from the Element attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.
In addition,

a user data event NODE_RENAMED is fired,
when the implementation supports the feature "MutationNameEvents", each mutation operation involved in this method fires the appropriate event, and in the end the event { http://www.w3.org/2001/xml-events, DOMElementNameChanged} or { http://www.w3.org/2001/xml-events, DOMAttributeNameChanged} is fired.

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/".

getNodeName

public String getNodeName()

Description copied from interface: org.w3c.dom.Node

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

Specified by:: getNodeName in interface Node

getNodeValue

public String getNodeValue()
                    throws DOMException

Description copied from interface: org.w3c.dom.Node

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only.

Specified by:: getNodeValue in interface Node

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

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

Description copied from interface: org.w3c.dom.Node

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only.

Specified by:: setNodeValue in interface Node

Throws:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to be null.

getNodeType

public short getNodeType()

Description copied from interface: org.w3c.dom.Node

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

Specified by:: getNodeType in interface Node

getParentNode

public Node getParentNode()

Description copied from interface: org.w3c.dom.Node

The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation 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

getChildNodes

public SimpleNodeList getChildNodes()

Description copied from interface: org.w3c.dom.Node

A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

Specified by:: getChildNodes in interface Node

getFirstChild

public Node getFirstChild()

Description copied from interface: org.w3c.dom.Node

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

Specified by:: getFirstChild in interface Node

getLastChild

public Node getLastChild()

Description copied from interface: org.w3c.dom.Node

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

Specified by:: getLastChild in interface Node

getPreviousSibling

public Node getPreviousSibling()

Description copied from interface: org.w3c.dom.Node

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

Specified by:: getPreviousSibling in interface Node

getNextSibling

public Node getNextSibling()

Description copied from interface: org.w3c.dom.Node

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

Specified by:: getNextSibling in interface Node

getAttributes

public NamedNodeMap getAttributes()

Description copied from interface: org.w3c.dom.Node

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

Specified by:: getAttributes in interface Node

getOwnerDocument

public Document getOwnerDocument()

Description copied from interface: org.w3c.dom.Node

The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

Specified by:: getOwnerDocument in interface Node

insertBefore

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

Description copied from interface: org.w3c.dom.Node

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.

Note: Inserting a node before itself is implementation dependent.

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, or if this node is of type Document and the DOM application attempts to insert a second DocumentType or Element node.
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.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the insertion of a DocumentType or Element node.

replaceChild

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

Description copied from interface: org.w3c.dom.Node

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.

Note: Replacing a node with itself is implementation dependent.

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, or if this node is of type Document and the result of the replacement operation would add a second DocumentType or Element on the Document node.
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.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the replacement of the DocumentType child or Element child.

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException

Description copied from interface: org.w3c.dom.Node

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.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or the Element child.

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Description copied from interface: org.w3c.dom.Node

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 or this node itself, or if this node is of type Document and the DOM application attempts to append a second DocumentType or Element node.
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.
NOT_SUPPORTED_ERR: if the newChild node is a child of the Document node, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or Element child.

hasChildNodes

public boolean hasChildNodes()

Description copied from interface: org.w3c.dom.Node

Returns whether this node has any children.

Specified by:: hasChildNodes in interface Node

Returns:: Returns true if this node has any children, false otherwise.

cloneNode

public Node cloneNode(boolean deep)

Description copied from interface: org.w3c.dom.Node

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent ( parentNode is null) and no user data. User data associated to the imported node is not carried over. However, if any UserDataHandlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
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 children it contains unless it is a deep clone. This includes text contained in an the Element since the text is contained in a child Text node. Cloning an Attr directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is true). Cloning an Attr always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning an EntityReference automatically constructs its subtree if a corresponding Entity is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly . In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.

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

Description copied from interface: org.w3c.dom.Node

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. 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 [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes.

Note: In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

Specified by:: normalize in interface Node

isSupported

public boolean isSupported(String feature,
                           String version)

Description copied from interface: org.w3c.dom.Node

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

Specified by:: isSupported in interface Node

Parameters:: feature - The name of the feature to test.; version - This is the version number of the feature to test.
Returns:: Returns true if the specified feature is supported on this node, false otherwise.

getNamespaceURI

public String getNamespaceURI()

Description copied from interface: org.w3c.dom.Node

The namespace URI of this node, or null if it is unspecified (see ).
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.

Note: Per the Namespaces in XML Specification [XML Namespaces] an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.

Specified by:: getNamespaceURI in interface Node

getPrefix

public String getPrefix()

Description copied from interface: org.w3c.dom.Node

The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Specified by:: getPrefix in interface Node

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Description copied from interface: org.w3c.dom.Node

Specified by:: setPrefix in interface Node

Throws:: DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character according to the XML version in use specified in the Document.xmlVersion attribute.
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" [XML Namespaces] .

getLocalName

public String getLocalName()

Description copied from interface: org.w3c.dom.Node

Returns the local part of the qualified name of this node.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.

Specified by:: getLocalName in interface Node

hasAttributes

public boolean hasAttributes()

Description copied from interface: org.w3c.dom.Node

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

Specified by:: hasAttributes in interface Node

Returns:: Returns true if this node has any attributes, false otherwise.

getBaseURI

public String getBaseURI()

Description copied from interface: org.w3c.dom.Node

The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. This value is computed as described in . However, when the Document supports the feature "HTML" [DOM Level 2 HTML] , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise.

Specified by:: getBaseURI in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Description copied from interface: org.w3c.dom.Node

Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.

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

Description copied from interface: org.w3c.dom.Node

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:

Node type	Content
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE	concatenation of the `textContent` attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE	`nodeValue`
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE	null

Specified by:: getTextContent in interface Node

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

Description copied from interface: org.w3c.dom.Node

Node type	Content
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE	concatenation of the `textContent` attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE	`nodeValue`
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE	null

Specified by:: setTextContent in interface Node

Throws:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

isSameNode

public boolean isSameNode(Node other)

Description copied from interface: org.w3c.dom.Node

Returns whether this node is the same node as the given one.
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.

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)

Description copied from interface: org.w3c.dom.Node

Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See for details on the algorithm used by this method.

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)

Description copied from interface: org.w3c.dom.Node

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)

Description copied from interface: org.w3c.dom.Node

Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.

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)

Description copied from interface: org.w3c.dom.Node

Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:

The two nodes are of the same type.
The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue . This is: they are both null, or they have the same length and are character for character identical.
The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.
The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.

For two DocumentType nodes to be equal, the following conditions must also be satisfied:

The following string attributes are equal: publicId, systemId, internalSubset.
The entities NamedNodeMaps are equal.
The notations NamedNodeMaps are equal.

On the other hand, the following do not affect equality: the ownerDocument, baseURI, and parentNode attributes, the specified attribute for Attr nodes, the schemaTypeInfo attribute for Attr and Element nodes, the Text.isElementContentWhitespace attribute for Text nodes, as well as any user data or event listeners registered on the nodes.

Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.

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)

Description copied from interface: org.w3c.dom.Node

This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support the Node interface.

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)

Description copied from interface: org.w3c.dom.Node

Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.

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)

Description copied from interface: org.w3c.dom.Node

Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.

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.

getTitle

public String getTitle()

Description copied from interface: org.w3c.dom.html.HTMLDocument

The title of a document as specified by the TITLE element in the head of the document.

Specified by:: getTitle in interface org.w3c.dom.html.HTMLDocument

setTitle

public void setTitle(String title)

Specified by:: setTitle in interface org.w3c.dom.html.HTMLDocument

getReferrer

public String getReferrer()

Description copied from interface: org.w3c.dom.html.HTMLDocument

Returns the URI of the page that linked to this page. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, via a bookmark).

Specified by:: getReferrer in interface org.w3c.dom.html.HTMLDocument

getDomain

public String getDomain()

Description copied from interface: org.w3c.dom.html.HTMLDocument

The domain name of the server that served the document, or null if the server cannot be identified by a domain name.

Specified by:: getDomain in interface org.w3c.dom.html.HTMLDocument

getURL

public String getURL()

Description copied from interface: org.w3c.dom.html.HTMLDocument

The complete URI of the document.

Specified by:: getURL in interface org.w3c.dom.html.HTMLDocument

getBody

public org.w3c.dom.html.HTMLElement getBody()

Description copied from interface: org.w3c.dom.html.HTMLDocument

The element that contains the content for the document. In documents with BODY contents, returns the BODY element. In frameset documents, this returns the outermost FRAMESET element.

Specified by:: getBody in interface org.w3c.dom.html.HTMLDocument

setBody

public void setBody(org.w3c.dom.html.HTMLElement body)

Specified by:: setBody in interface org.w3c.dom.html.HTMLDocument

getImages

public SimpleHtmlCollection getImages()

Description copied from interface: org.w3c.dom.html.HTMLDocument

A collection of all the IMG elements in a document. The behavior is limited to IMG elements for backwards compatibility.

Specified by:: getImages in interface org.w3c.dom.html.HTMLDocument

getApplets

public SimpleHtmlCollection getApplets()

Description copied from interface: org.w3c.dom.html.HTMLDocument

A collection of all the OBJECT elements that include applets and APPLET ( deprecated ) elements in a document.

Specified by:: getApplets in interface org.w3c.dom.html.HTMLDocument

getLinks

public SimpleHtmlCollection getLinks()

Description copied from interface: org.w3c.dom.html.HTMLDocument

A collection of all AREA elements and anchor ( A ) elements in a document with a value for the href attribute.

Specified by:: getLinks in interface org.w3c.dom.html.HTMLDocument

getForms

public SimpleHtmlCollection getForms()

Description copied from interface: org.w3c.dom.html.HTMLDocument

A collection of all the forms of a document.

Specified by:: getForms in interface org.w3c.dom.html.HTMLDocument

getAnchors

public SimpleHtmlCollection getAnchors()

Description copied from interface: org.w3c.dom.html.HTMLDocument

A collection of all the anchor (A ) elements in a document with a value for the name attribute. Note. For reasons of backwards compatibility, the returned set of anchors only contains those anchors created with the name attribute, not those created with the id attribute.

Specified by:: getAnchors in interface org.w3c.dom.html.HTMLDocument

getCookie

public String getCookie()

Description copied from interface: org.w3c.dom.html.HTMLDocument

The cookies associated with this document. If there are none, the value is an empty string. Otherwise, the value is a string: a semicolon-delimited list of "name, value" pairs for all the cookies associated with the page. For example, name=value;expires=date .

Specified by:: getCookie in interface org.w3c.dom.html.HTMLDocument

setCookie

public void setCookie(String cookie)

Specified by:: setCookie in interface org.w3c.dom.html.HTMLDocument

open

public void open()

Description copied from interface: org.w3c.dom.html.HTMLDocument

Note. This method and the ones following allow a user to add to or replace the structure model of a document using strings of unparsed HTML. At the time of writing alternate methods for providing similar functionality for both HTML and XML documents were being considered. The following methods may be deprecated at some point in the future in favor of a more general-purpose mechanism.
Open a document stream for writing. If a document exists in the target, this method clears it.

Specified by:: open in interface org.w3c.dom.html.HTMLDocument

close

public void close()

Description copied from interface: org.w3c.dom.html.HTMLDocument

Closes a document stream opened by open() and forces rendering.

Specified by:: close in interface org.w3c.dom.html.HTMLDocument

write

public void write(String text)

Description copied from interface: org.w3c.dom.html.HTMLDocument

Write a string of text to a document stream opened by open() . The text is parsed into the document's structure model.

Specified by:: write in interface org.w3c.dom.html.HTMLDocument

Parameters:: text - The string to be parsed into some structure in the document structure model.

writeln

public void writeln(String text)

Description copied from interface: org.w3c.dom.html.HTMLDocument

Write a string of text followed by a newline character to a document stream opened by open() . The text is parsed into the document's structure model.

Specified by:: writeln in interface org.w3c.dom.html.HTMLDocument

Parameters:: text - The string to be parsed into some structure in the document structure model.

getElementsByName

public SimpleNodeList getElementsByName(String elementName)

Description copied from interface: org.w3c.dom.html.HTMLDocument

Returns the (possibly empty) collection of elements whose name value is given by elementName .

Specified by:: getElementsByName in interface org.w3c.dom.html.HTMLDocument

Parameters:: elementName - The name attribute value for an element.
Returns:: The matching elements.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jdesktop.dom Class SimpleHtmlDocument

SimpleHtmlDocument

SimpleHtmlDocument

toXML

toXML

getChildElements

getChildElementCount

getElements

getElements

getElement

getElement

getString

getString

getDoctype

getImplementation

getDocumentElement

createElement

createDocumentFragment

createTextNode

createComment

createCDATASection

createProcessingInstruction

createAttribute

createEntityReference

getElementsByTagName

importNode

createElementNS

createAttributeNS

getElementsByTagNameNS

getElementById

getInputEncoding

getXmlEncoding

getXmlStandalone

setXmlStandalone

getXmlVersion

setXmlVersion

getStrictErrorChecking

setStrictErrorChecking

getDocumentURI

setDocumentURI

adoptNode

getDomConfig

normalizeDocument

renameNode

getNodeName

getNodeValue

setNodeValue

getNodeType

getParentNode

getChildNodes

getFirstChild

getLastChild

getPreviousSibling

getNextSibling

getAttributes

getOwnerDocument

insertBefore

replaceChild

removeChild

appendChild

hasChildNodes

cloneNode

normalize

isSupported

getNamespaceURI

getPrefix

setPrefix

getLocalName

hasAttributes

getBaseURI

compareDocumentPosition

getTextContent

setTextContent

isSameNode

lookupPrefix

isDefaultNamespace

lookupNamespaceURI

isEqualNode

getFeature

setUserData

org.jdesktop.dom
Class SimpleHtmlDocument