com.teamkonzept.dom4jb.dom
Class Document

java.lang.Object
  |
  +--com.teamkonzept.dom4jb.dom.NodeList
        |
        +--com.teamkonzept.dom4jb.dom.Node
              |
              +--com.teamkonzept.dom4jb.dom.Document

All Implemented Interfaces:

Document, Node, NodeList

Direct Known Subclasses:

Document

public class Document

extends Node

implements Document

Nested Class Summary

static class

Document.NodeList

Field Summary

Fields inherited from class com.teamkonzept.dom4jb.dom.Node

document

Fields inherited from class com.teamkonzept.dom4jb.dom.NodeList

EMPTY, initialCapacity, nodeData, nodeIterator, parent, size

Fields inherited from interface org.w3c.dom.Node

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

Constructor Summary

Document()
Creates new Document

Method Summary

boolean	accept(Filter filter)
Node	adoptNode(Node node)
Node	appendChild(Node newChild) Adds the node newChild to the end of the list of children of this node.
Attribute	createAttribute(AttributeDescriptor descriptor, Object bean)
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.
CDATA	createCDATASection(CDATADescriptor descriptor, Object bean)
CDATASection	createCDATASection(String data) Creates a CDATASection node whose value is the specified string.
Comment	createComment(String data) Creates a org.w3c.dom.Comment node given the specified string.
DocumentFragment	createDocumentFragment() Creates an empty DocumentFragment object.
Element	createElement(ElementDescriptor descriptor, Object bean)
Element	createElement(String tagName) Creates an element of the type specified.
Element	createElement(String name, Object bean)
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	createText(TextDescriptor descriptor, Object bean)
Text	createTextNode(String data) Creates a Text node given the specified string.
NodeList	getChildNodes() A NodeList that contains all children of this node.
DocumentType	getDoctype() The Document Type Declaration (see org.w3c.dom.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.
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.
String	getEncoding()
Node	getFirstChild() The first child of this node.
DOMImplementation	getImplementation() The DOMImplementation object that handles this document.
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.
Node	getParentNode() The parent of this nodes.
String	getPrefix() The namespace prefix of this node, or null if it is unspecified.
Node	getPreviousSibling() The node immediately preceding this node.
boolean	getStandalone()
boolean	getStrictErrorChecking()
String	getVersion()
boolean	hasChildNodes() Returns whether this node has any children.
Node	importNode(Node importedNode, boolean deep) Imports a node from another document to this document.
void	setEncoding(String s)
void	setPrefix(String prefix) The namespace prefix of this node, or null if it is unspecified.
void	setStandalone(boolean b)
void	setStrictErrorChecking(boolean b)
void	setVersion(String s)

Methods inherited from class com.teamkonzept.dom4jb.dom.Node

attach, cloneNode, getAttributes, getChildIndex, getNodeValue, getOwnerDocument, hasAttributes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue

Methods inherited from class com.teamkonzept.dom4jb.dom.NodeList

add, clear, ensureCapacity, get, getLength, isEmpty, item, setIterator, setParentNode, size, trimToSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Node

cloneNode, getAttributes, getNodeValue, getOwnerDocument, hasAttributes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue

Constructor Detail

Document

public Document()

Creates new Document

Method Detail

adoptNode

public Node adoptNode(Node node)

appendChild

public Node appendChild(Node newChild)

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

Overrides:

appendChild in class 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.

getParentNode

public final Node getParentNode()

Description copied from class: NodeList

The parent of this nodes. 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

Overrides:

getParentNode in class NodeList

getChildNodes

public NodeList getChildNodes()

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

Overrides:

getChildNodes in class Node

getFirstChild

public Node getFirstChild()

Description copied from class: Node

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

Specified by:

getFirstChild in interface Node

Overrides:

getFirstChild in class Node

getLastChild

public Node getLastChild()

Description copied from class: Node

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

Specified by:

getLastChild in interface Node

Overrides:

getLastChild in class Node

hasChildNodes

public boolean hasChildNodes()

Description copied from class: Node

Returns whether this node has any children.

Specified by:

hasChildNodes in interface Node

Overrides:

hasChildNodes in class Node

Returns:

true if this node has any children, false otherwise.

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.

Since:

DOM Level 2

getNodeName

public final String getNodeName()

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

Specified by:

getNodeName in interface Node

createDocumentFragment

public DocumentFragment createDocumentFragment()

Creates an empty DocumentFragment object.

Specified by:

createDocumentFragment in interface Document

Returns:

A new DocumentFragment.

importNode

public Node importNode(Node importedNode,
                       boolean deep)

Imports a node from another document to this document. The returned node has no parent; (parentNode is null). The source node is not altered or removed from the original document; this method creates a new copy of the source node.
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 on a Node, the source node is not altered.
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 element are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Otherwise, this simply generates an empty DocumentFragment.

DOCUMENT_NODE

Document nodes cannot be imported.

DOCUMENT_TYPE_NODE

org.w3c.dom.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 org.w3c.dom.DocumentType is readonly. Ability to add these imported nodes to a org.w3c.dom.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 org.w3c.dom.DocumentType is readonly. Ability to add these imported nodes to a org.w3c.dom.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 Notation nodes since they never have any children.

PROCESSING_INSTRUCTION_NODE

The imported node copies its target and data values from those of the source node.

TEXT_NODE, CDATA_SECTION_NODE, org.w3c.dom.Comment_NODE

These three types of nodes inheriting from CharacterData copy their data and length attributes from those of the source node.

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.

Since:

DOM Level 2

getImplementation

public DOMImplementation getImplementation()

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

Specified by:

getImplementation in interface Document

getPrefix

public String getPrefix()

The namespace prefix of this node, or null if it is unspecified.
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.
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

Overrides:

getPrefix in class Node

Since:

DOM Level 2

getPreviousSibling

public Node getPreviousSibling()

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

Specified by:

getPreviousSibling in interface Node

Overrides:

getPreviousSibling in class Node

getNodeType

public short getNodeType()

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

Specified by:

getNodeType in interface Node

getDoctype

public DocumentType getDoctype()

The Document Type Declaration (see org.w3c.dom.DocumentType) associated with this document. For HTML documents as well as XML documents without a document type declaration this returns null. The DOM Level 2 does not support editing the Document Type Declaration. docType cannot be altered in any way, including through the use of methods inherited from the Node interface, such as insertNode or removeNode.

Specified by:

getDoctype in interface Document

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. For HTML documents, this is the element with the tagName "HTML".

Specified by:

getDocumentElement in interface Document

getEncoding

public String getEncoding()

getStandalone

public boolean getStandalone()

getStrictErrorChecking

public boolean getStrictErrorChecking()

getVersion

public String getVersion()

setEncoding

public void setEncoding(String s)

setStandalone

public void setStandalone(boolean b)

setStrictErrorChecking

public void setStrictErrorChecking(boolean b)

setVersion

public void setVersion(String s)

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
                              String qualifiedName)

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

Since:

DOM Level 2

getNextSibling

public Node getNextSibling()

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

Specified by:

getNextSibling in interface Node

Overrides:

getNextSibling in class Node

createComment

public Comment createComment(String data)

Creates a org.w3c.dom.Comment node given the specified string.

Specified by:

createComment in interface Document

Parameters:

data - The data for the node.

Returns:

The new org.w3c.dom.Comment object.

getNamespaceURI

public String getNamespaceURI()

The namespace URI of this node, or null if it is unspecified.
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 createElement from the Document interface, this is always null.Per the Namespaces in XML Specification 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

Overrides:

getNamespaceURI in class Node

Since:

DOM Level 2

createEntityReference

public EntityReference createEntityReference(String name)

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.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 does not support any mechanism to resolve namespace prefixes.

Specified by:

createEntityReference in interface Document

Parameters:

name - The name of the entity to reference.

Returns:

The new EntityReference object.

createCDATASection

public CDATASection createCDATASection(String data)

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.

createCDATASection

public CDATA createCDATASection(CDATADescriptor descriptor,
                                Object bean)

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.

getElementById

public Element getElementById(String elementId)

Returns the Element whose ID is given by elementId. If no such element exists, returns null. Behavior is not defined if more than one element has this ID. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.

Specified by:

getElementById in interface Document

Parameters:

elementId - The unique id value for an element.

Returns:

The matching element.

Since:

DOM Level 2

createElement

public Element createElement(String tagName)

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

createElement

public Element createElement(ElementDescriptor descriptor,
                             Object bean)

createElement

public Element createElement(String name,
                             Object bean)

createElementNS

public Element createElementNS(String namespaceURI,
                               String qualifiedName)

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

Since:

DOM Level 2

createAttribute

public Attr createAttribute(String name)

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.

createAttribute

public Attribute createAttribute(AttributeDescriptor descriptor,
                                 Object bean)

createText

public Text createText(TextDescriptor descriptor,
                       Object bean)

getLocalName

public String getLocalName()

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 createElement from the Document interface, this is always null.

Specified by:

getLocalName in interface Node

Overrides:

getLocalName in class Node

Since:

DOM Level 2

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.

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
                                                         String data)

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.

setPrefix

public void setPrefix(String prefix)

The namespace prefix of this node, or null if it is unspecified.
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.
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:

setPrefix in interface Node

Overrides:

setPrefix in class Node

Since:

DOM Level 2

accept

public boolean accept(Filter filter)

Specified by:

accept in class Node