org.apache.xml.dtm.ref.dom2dtm
Class DOM2DTMdefaultNamespaceDeclarationNode

java.lang.Object
  org.apache.xml.dtm.ref.dom2dtm.DOM2DTMdefaultNamespaceDeclarationNode

All Implemented Interfaces:

Attr, Node

public class DOM2DTMdefaultNamespaceDeclarationNode

extends java.lang.Object

implements Attr

This is a kluge to let us shove a declaration for xml: into the DOM2DTM model. Basically, it creates a proxy node in DOM space to carry the additional information. This is _NOT_ a full DOM implementation, and shouldn't be one since it sits alongside the DOM rather than becoming part of the DOM model. (This used to be an internal class within DOM2DTM. Moved out because I need to perform an instanceof operation on it to support a temporary workaround in DTMManagerDefault.) %REVIEW% What if the DOM2DTM was built around a DocumentFragment and there isn't a single root element? I think this fails that case... %REVIEW% An alternative solution would be to create the node _only_ in DTM space, but given how DOM2DTM is currently written I think this is simplest.

Field Summary

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

Method Summary

Node	appendChild(Node a) 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.
NamedNodeMap	getAttributes() A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
NodeList	getChildNodes() A NodeList that contains all children of this node.
Node	getFirstChild() The first child of this node.
int	getHandleOfNode() Non-DOM method, part of the temporary kluge %REVIEW% This would be a pruning problem, but since it will always be added to the root element and we prune on elements, we shouldn't have to worry.
Node	getLastChild() The last child of this node.
java.lang.String	getLocalName() Returns the local part of the qualified name of this node.
java.lang.String	getName() Returns the name of this attribute.
java.lang.String	getNamespaceURI() The namespace URI of this node, or null if it is unspecified.
Node	getNextSibling() The node immediately following this node.
java.lang.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.
java.lang.String	getNodeValue() The value of this node, depending on its type; see the table above.
Document	getOwnerDocument() The Document object associated with this node.
Element	getOwnerElement() The Element node this attribute is attached to or null if this attribute is not in use.
Node	getParentNode() The parent of this node.
java.lang.String	getPrefix() The namespace prefix of this node, or null if it is unspecified.
Node	getPreviousSibling() The node immediately preceding this node.
boolean	getSpecified() If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false.
java.lang.String	getValue() On retrieval, the value of the attribute is returned as a string.
boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
boolean	hasChildNodes() Returns whether this node has any children.
Node	insertBefore(Node a, Node b) Inserts the node newChild before the existing child node refChild.
boolean	isSupported(java.lang.String feature, java.lang.String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
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.
Node	removeChild(Node a) Removes the child node indicated by oldChild from the list of children, and returns it.
Node	replaceChild(Node a, Node b) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
void	setNodeValue(java.lang.String value) The value of this node, depending on its type; see the table above.
void	setPrefix(java.lang.String value) The namespace prefix of this node, or null if it is unspecified.
void	setValue(java.lang.String value) On retrieval, the value of the attribute is returned as a string.

Methods inherited from class java.lang.Object

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

Method Detail

getNodeName

public java.lang.String getNodeName()

Description copied from interface: Node

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

Specified by:

getNodeName in interface Node

getName

public java.lang.String getName()

Description copied from interface: Attr

Returns the name of this attribute.

Specified by:

getName in interface Attr

getNamespaceURI

public java.lang.String getNamespaceURI()

Description copied from interface: Node

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

getPrefix

public java.lang.String getPrefix()

Description copied from interface: Node

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

getLocalName

public java.lang.String getLocalName()

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

Specified by:

getLocalName in interface Node

getNodeValue

public java.lang.String getNodeValue()

Description copied from interface: 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.

Specified by:

getNodeValue in interface Node

getValue

public java.lang.String getValue()

Description copied from interface: Attr

On retrieval, the value of the attribute is returned as a string. Character and general entity references are replaced with their values. See also the method getAttribute on the Element interface.
On setting, this creates a Text node with the unparsed contents of the string. I.e. any characters that an XML processor would recognize as markup are instead treated as literal text. See also the method setAttribute on the Element interface.

Specified by:

getValue in interface Attr

getOwnerElement

public Element getOwnerElement()

Description copied from interface: Attr

The Element node this attribute is attached to or null if this attribute is not in use.

Specified by:

getOwnerElement in interface Attr

isSupported

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

Description copied from interface: Node

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

Specified by:

isSupported in interface Node

Parameters:

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

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

Returns:

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

hasChildNodes

public boolean hasChildNodes()

Description copied from interface: Node

Returns whether this node has any children.

Specified by:

hasChildNodes in interface Node

Returns:

true if this node has any children, false otherwise.

hasAttributes

public boolean hasAttributes()

Description copied from interface: Node

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

Specified by:

hasAttributes in interface Node

Returns:

true if this node has any attributes, false otherwise.

getParentNode

public Node getParentNode()

Description copied from interface: 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

getFirstChild

public Node getFirstChild()

Description copied from interface: 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: 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: 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: Node

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

Specified by:

getNextSibling in interface Node

getSpecified

public boolean getSpecified()

Description copied from interface: Attr

If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false. Note that the implementation is in charge of this attribute, not the user. If the user changes the value of the attribute (even if it ends up having the same value as the default value) then the specified flag is automatically flipped to true. To re-specify the attribute as the default value from the DTD, the user must delete the attribute. The implementation will then make a new attribute available with specified set to false and the default value (if one exists).
In summary: If the attribute has an assigned value in the document then specified is true, and the value is the assigned value.If the attribute has no assigned value in the document and has a default value in the DTD, then specified is false, and the value is the default value in the DTD.If the attribute has no assigned value in the document and has a value of #IMPLIED in the DTD, then the attribute does not appear in the structure model of the document.If the ownerElement attribute is null (i.e. because it was just created or was set to null by the various removal and cloning operations) specified is true.

Specified by:

getSpecified in interface Attr

normalize

public void normalize()

Description copied from interface: 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 lookups) that depend on a particular document tree structure are to be used.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

getChildNodes

public NodeList getChildNodes()

Description copied from interface: 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

getAttributes

public NamedNodeMap getAttributes()

Description copied from interface: Node

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

Specified by:

getAttributes in interface Node

getNodeType

public short getNodeType()

Description copied from interface: Node

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

Specified by:

getNodeType in interface Node

setNodeValue

public void setNodeValue(java.lang.String value)

Description copied from interface: 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.

Specified by:

setNodeValue in interface Node

setValue

public void setValue(java.lang.String value)

Description copied from interface: Attr

On retrieval, the value of the attribute is returned as a string. Character and general entity references are replaced with their values. See also the method getAttribute on the Element interface.
On setting, this creates a Text node with the unparsed contents of the string. I.e. any characters that an XML processor would recognize as markup are instead treated as literal text. See also the method setAttribute on the Element interface.

Specified by:

setValue in interface Attr

setPrefix

public void setPrefix(java.lang.String value)

Description copied from interface: Node

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

insertBefore

public Node insertBefore(Node a,
                         Node b)

Description copied from interface: 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.

Specified by:

insertBefore in interface Node

Parameters:

a - The node to insert.

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

Returns:

The node being inserted.

replaceChild

public Node replaceChild(Node a,
                         Node b)

Description copied from interface: 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.

Specified by:

replaceChild in interface Node

Parameters:

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

b - The node being replaced in the list.

Returns:

The node replaced.

appendChild

public Node appendChild(Node a)

Description copied from interface: 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:

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

removeChild

public Node removeChild(Node a)

Description copied from interface: Node

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

Specified by:

removeChild in interface Node

Parameters:

a - The node being removed.

Returns:

The node removed.

getOwnerDocument

public Document getOwnerDocument()

Description copied from interface: 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

cloneNode

public Node cloneNode(boolean deep)

Description copied from interface: 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.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning an Attribute directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute ( specified is true). 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.

getHandleOfNode

public int getHandleOfNode()

Non-DOM method, part of the temporary kluge %REVIEW% This would be a pruning problem, but since it will always be added to the root element and we prune on elements, we shouldn't have to worry.