org.docx4j.org.apache.xml.dtm.ref.dom2dtm

Class DOM2DTMdefaultNamespaceDeclarationNode

java.lang.Object

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

All Implemented Interfaces:

Attr, Node, TypeInfo

public class DOM2DTMdefaultNamespaceDeclarationNode
extends Object
implements Attr, TypeInfo

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

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Method Summary

Modifier and Type	Method and Description
Node	appendChild(Node a)
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other) Compares a node with this node with regard to their position in the document.
NamedNodeMap	getAttributes()
String	getBaseURI() The absolute base URI of this node or null if undefined.
NodeList	getChildNodes()
Object	getFeature(String feature, String version) This method returns a specialized object which implements the specialized APIs of the specified feature and version.
Node	getFirstChild()
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()
String	getLocalName()
String	getName()
String	getNamespaceURI()
Node	getNextSibling()
String	getNodeName()
short	getNodeType()
String	getNodeValue()
Document	getOwnerDocument()
Element	getOwnerElement()
Node	getParentNode()
String	getPrefix()
Node	getPreviousSibling()
TypeInfo	getSchemaTypeInfo()
boolean	getSpecified()
String	getTextContent() This attribute returns the text content of this node and its descendants.
String	getTypeName()
String	getTypeNamespace()
Object	getUserData(String key) Retrieves the object associated to a key on a this node.
String	getValue()
boolean	hasAttributes()
boolean	hasChildNodes()
Node	insertBefore(Node a, Node b)
boolean	isDefaultNamespace(String namespaceURI) DOM Level 3: Experimental This method checks if the specified namespaceURI is the default namespace or not.
boolean	isDerivedFrom(String ns, String localName, int derivationMethod)
boolean	isEqualNode(Node arg) Tests whether two nodes are equal.
boolean	isId()
boolean	isSameNode(Node other) Returns whether this node is the same node as the given one.
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String specifiedPrefix) DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node.
String	lookupPrefix(String namespaceURI) DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.
void	normalize()
Node	removeChild(Node a)
Node	replaceChild(Node a, Node b)
void	setNodeValue(String value)
void	setPrefix(String value)
void	setTextContent(String textContent) This attribute returns the text content of this node and its descendants.
Object	setUserData(String key, Object data, UserDataHandler handler) Associate an object to a key on this node.
void	setValue(String value)

Methods inherited from class java.lang.Object

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

Method Detail

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

getName

public String getName()

Specified by:

getName in interface Attr

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

getNodeValue

public String getNodeValue()

Specified by:

getNodeValue in interface Node

getValue

public String getValue()

Specified by:

getValue in interface Attr

getOwnerElement

public Element getOwnerElement()

Specified by:

getOwnerElement in interface Attr

isSupported

public boolean isSupported(String feature,
                           String version)

Specified by:

isSupported in interface Node

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

getFirstChild

public Node getFirstChild()

Specified by:

getFirstChild in interface Node

getLastChild

public Node getLastChild()

Specified by:

getLastChild in interface Node

getPreviousSibling

public Node getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

getNextSibling

public Node getNextSibling()

Specified by:

getNextSibling in interface Node

getSpecified

public boolean getSpecified()

Specified by:

getSpecified in interface Attr

normalize

public void normalize()

Specified by:

normalize in interface Node

getChildNodes

public NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getAttributes

public NamedNodeMap getAttributes()

Specified by:

getAttributes in interface Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

setNodeValue

public void setNodeValue(String value)

Specified by:

setNodeValue in interface Node

setValue

public void setValue(String value)

Specified by:

setValue in interface Attr

setPrefix

public void setPrefix(String value)

Specified by:

setPrefix in interface Node

insertBefore

public Node insertBefore(Node a,
                         Node b)

Specified by:

insertBefore in interface Node

replaceChild

public Node replaceChild(Node a,
                         Node b)

Specified by:

replaceChild in interface Node

appendChild

public Node appendChild(Node a)

Specified by:

appendChild in interface Node

removeChild

public Node removeChild(Node a)

Specified by:

removeChild in interface Node

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

cloneNode

public Node cloneNode(boolean deep)

Specified by:

cloneNode in interface 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.

getTypeName

public String getTypeName()

Specified by:

getTypeName in interface TypeInfo

See Also:

TypeInfo.getTypeName()

getTypeNamespace

public String getTypeNamespace()

Specified by:

getTypeNamespace in interface TypeInfo

See Also:

TypeInfo.getTypeNamespace()

isDerivedFrom

public boolean isDerivedFrom(String ns,
                             String localName,
                             int derivationMethod)

Specified by:

isDerivedFrom in interface TypeInfo

See Also:

or.gw3c.dom.TypeInfo#isDerivedFrom(String,String,int)

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface Attr

isId

public boolean isId()

Specified by:

isId in interface Attr

setUserData

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

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 DOMObject previously associated to the given key on this node, or null if there was none.

Since:

DOM Level 3

getUserData

public Object getUserData(String key)

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 DOMObject associated to the given key on this node, or null if there was none.

Since:

DOM Level 3

getFeature

public Object getFeature(String feature,
                         String version)

This method returns a specialized object which implements the specialized APIs of the specified feature and version. The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in Mixed DOM implementations.

Specified by:

getFeature in interface Node

Parameters:

feature - The name of the feature requested (case-insensitive).

version - This is the version number of the feature to test. If the version is null or the empty string, supporting any version of the feature will cause the method to return an object that supports at least one version of the feature.

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.

Since:

DOM Level 3

isEqualNode

public boolean isEqualNode(Node arg)

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 , baseURI. 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. This is true for Attr nodes as for any other type of node. 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 attribute, the specified attribute for Attr nodes, the isWhitespaceInElementContent attribute for Text nodes, as well as any user data or event listeners registered on the nodes.

Specified by:

isEqualNode in interface Node

Parameters:

arg - The node to compare equality with.

deep - If true, recursively compare the subtrees; if false, compare only the nodes themselves (and its attributes, if it is an Element).

Returns:

If the nodes, and possibly subtrees are equal, true otherwise false.

Since:

DOM Level 3

lookupNamespaceURI

public String lookupNamespaceURI(String specifiedPrefix)

DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node. Use lookupNamespaceURI(null) to lookup the default namespace

Specified by:

lookupNamespaceURI in interface Node

Parameters:

namespaceURI -

Returns:

th URI for the namespace

Since:

DOM Level 3

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

DOM Level 3: Experimental 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:

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

Since:

DOM Level 3

lookupPrefix

public String lookupPrefix(String namespaceURI)

DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.

Specified by:

lookupPrefix in interface Node

Parameters:

namespaceURI -

Returns:

the prefix for the namespace

isSameNode

public boolean isSameNode(Node other)

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

Since:

DOM Level 3

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and 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, the returned string does not contain the element content whitespaces . 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, 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
ATTRIBUTE_NODE, 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.

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

Since:

DOM Level 3

getTextContent

public String getTextContent()
                      throws DOMException

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and 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, the returned string does not contain the element content whitespaces . 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, 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
ATTRIBUTE_NODE, 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 - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

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

Since:

DOM Level 3

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Compares a node with this node with regard to their position in the document.

Specified by:

compareDocumentPosition in interface Node

Parameters:

other - The node to compare against this node.

Returns:

Returns how the given node is positioned relatively to this node.

Throws:

DOMException

Since:

DOM Level 3

getBaseURI

public String getBaseURI()

The absolute base URI of this node or null if undefined. This value is computed according to . However, when the Document supports the feature "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.
When the node is an Element, a Document or a a ProcessingInstruction, this attribute represents the properties [base URI] defined in . When the node is a Notation, an Entity, or an EntityReference, this attribute represents the properties [declaration base URI] in the . How will this be affected by resolution of relative namespace URIs issue?It's not.Should this only be on Document, Element, ProcessingInstruction, Entity, and Notation nodes, according to the infoset? If not, what is it equal to on other nodes? Null? An empty string? I think it should be the parent's.No.Should this be read-only and computed or and actual read-write attribute?Read-only and computed (F2F 19 Jun 2000 and teleconference 30 May 2001).If the base HTML element is not yet attached to a document, does the insert change the Document.baseURI? Yes. (F2F 26 Sep 2001)

Specified by:

getBaseURI in interface Node

Since:

DOM Level 3