Package org.apache.xml.dtm.ref.dom2dtm
Class DOM2DTMdefaultNamespaceDeclarationNode
java.lang.Object
org.apache.xml.dtm.ref.dom2dtm.DOM2DTMdefaultNamespaceDeclarationNode
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 TypeMethodDescriptionappendChild
(Node a) cloneNode
(boolean deep) short
compareDocumentPosition
(Node other) Compares a node with this node with regard to their position in the document.The absolute base URI of this node ornull
if undefined.getFeature
(String feature, String version) This method returns a specialized object which implements the specialized APIs of the specified feature and version.int
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.getName()
short
boolean
This attribute returns the text content of this node and its descendants.getUserData
(String key) Retrieves the object associated to a key on a this node.getValue()
boolean
boolean
insertBefore
(Node a, Node b) boolean
isDefaultNamespace
(String namespaceURI) DOM Level 3: Experimental This method checks if the specifiednamespaceURI
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) lookupNamespaceURI
(String specifiedPrefix) DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node.lookupPrefix
(String namespaceURI) DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.void
removeChild
(Node a) replaceChild
(Node a, Node b) void
setNodeValue
(String value) void
void
setTextContent
(String textContent) This attribute returns the text content of this node and its descendants.setUserData
(String key, Object data, UserDataHandler handler) Associate an object to a key on this node.void
-
Method Details
-
getNodeName
- Specified by:
getNodeName
in interfaceNode
-
getName
-
getNamespaceURI
- Specified by:
getNamespaceURI
in interfaceNode
-
getPrefix
-
getLocalName
- Specified by:
getLocalName
in interfaceNode
-
getNodeValue
- Specified by:
getNodeValue
in interfaceNode
-
getValue
-
getOwnerElement
- Specified by:
getOwnerElement
in interfaceAttr
-
isSupported
- Specified by:
isSupported
in interfaceNode
-
hasChildNodes
public boolean hasChildNodes()- Specified by:
hasChildNodes
in interfaceNode
-
hasAttributes
public boolean hasAttributes()- Specified by:
hasAttributes
in interfaceNode
-
getParentNode
- Specified by:
getParentNode
in interfaceNode
-
getFirstChild
- Specified by:
getFirstChild
in interfaceNode
-
getLastChild
- Specified by:
getLastChild
in interfaceNode
-
getPreviousSibling
- Specified by:
getPreviousSibling
in interfaceNode
-
getNextSibling
- Specified by:
getNextSibling
in interfaceNode
-
getSpecified
public boolean getSpecified()- Specified by:
getSpecified
in interfaceAttr
-
normalize
public void normalize() -
getChildNodes
- Specified by:
getChildNodes
in interfaceNode
-
getAttributes
- Specified by:
getAttributes
in interfaceNode
-
getNodeType
public short getNodeType()- Specified by:
getNodeType
in interfaceNode
-
setNodeValue
- Specified by:
setNodeValue
in interfaceNode
-
setValue
-
setPrefix
-
insertBefore
- Specified by:
insertBefore
in interfaceNode
-
replaceChild
- Specified by:
replaceChild
in interfaceNode
-
appendChild
- Specified by:
appendChild
in interfaceNode
-
removeChild
- Specified by:
removeChild
in interfaceNode
-
getOwnerDocument
- Specified by:
getOwnerDocument
in interfaceNode
-
cloneNode
-
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
- Specified by:
getTypeName
in interfaceTypeInfo
- See Also:
-
getTypeNamespace
- Specified by:
getTypeNamespace
in interfaceTypeInfo
- See Also:
-
isDerivedFrom
- Specified by:
isDerivedFrom
in interfaceTypeInfo
- See Also:
-
getSchemaTypeInfo
- Specified by:
getSchemaTypeInfo
in interfaceAttr
-
isId
public boolean isId() -
setUserData
Associate an object to a key on this node. The object can later be retrieved from this node by callinggetUserData
with the same key.- Specified by:
setUserData
in interfaceNode
- Parameters:
key
- The key to associate the object to.data
- The object to associate to the given key, ornull
to remove any existing association to that key.handler
- The handler to associate to that key, ornull
.- Returns:
- Returns the
DOMObject
previously associated to the given key on this node, ornull
if there was none. - Since:
- DOM Level 3
-
getUserData
Retrieves the object associated to a key on a this node. The object must first have been set to this node by callingsetUserData
with the same key.- Specified by:
getUserData
in interfaceNode
- Parameters:
key
- The key the object is associated to.- Returns:
- Returns the
DOMObject
associated to the given key on this node, ornull
if there was none. - Since:
- DOM Level 3
-
getFeature
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 interfaceNode
- Parameters:
feature
- The name of the feature requested (case-insensitive).version
- This is the version number of the feature to test. If the version isnull
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 theDOMObject
returned by this method implements theNode
interface, it must delegate to the primary coreNode
and not return results inconsistent with the primary coreNode
such as attributes, childNodes, etc. - Since:
- DOM Level 3
-
isEqualNode
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 withNode.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 bothnull
, or they have the same length and are character for character identical. Theattributes
NamedNodeMaps
are equal. This is: they are bothnull
, 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.ThechildNodes
NodeLists
are equal. This is: they are bothnull
, or they have the same length and contain equal nodes at the same index. This is true forAttr
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 twoDocumentType
nodes to be equal, the following conditions must also be satisfied: The following string attributes are equal:publicId
,systemId
,internalSubset
.Theentities
NamedNodeMaps
are equal.Thenotations
NamedNodeMaps
are equal.
On the other hand, the following do not affect equality: theownerDocument
attribute, thespecified
attribute forAttr
nodes, theisWhitespaceInElementContent
attribute forText
nodes, as well as any user data or event listeners registered on the nodes.- Specified by:
isEqualNode
in interfaceNode
- Parameters:
arg
- The node to compare equality with.deep
- Iftrue
, recursively compare the subtrees; iffalse
, compare only the nodes themselves (and its attributes, if it is anElement
).- Returns:
- If the nodes, and possibly subtrees are equal,
true
otherwisefalse
. - Since:
- DOM Level 3
-
lookupNamespaceURI
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 interfaceNode
- Parameters:
namespaceURI
-- Returns:
- th URI for the namespace
- Since:
- DOM Level 3
-
isDefaultNamespace
DOM Level 3: Experimental This method checks if the specifiednamespaceURI
is the default namespace or not.- Specified by:
isDefaultNamespace
in interfaceNode
- Parameters:
namespaceURI
- The namespace URI to look for.- Returns:
true
if the specifiednamespaceURI
is the default namespace,false
otherwise.- Since:
- DOM Level 3
-
lookupPrefix
DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.- Specified by:
lookupPrefix
in interfaceNode
- Parameters:
namespaceURI
-- Returns:
- the prefix for the namespace
-
isSameNode
Returns whether this node is the same node as the given one.
This method provides a way to determine whether twoNode
references returned by the implementation reference the same object. When twoNode
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 interfaceNode
- Parameters:
other
- The node to test against.- Returns:
- Returns
true
if the nodes are the same,false
otherwise. - Since:
- DOM Level 3
-
setTextContent
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 singleText
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 nodesATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
setTextContent
in interfaceNode
- 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 aDOMString
variable on the implementation platform.- Since:
- DOM Level 3
-
getTextContent
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 singleText
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 nodesATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
getTextContent
in interfaceNode
- 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 aDOMString
variable on the implementation platform.- Since:
- DOM Level 3
-
compareDocumentPosition
Compares a node with this node with regard to their position in the document.- Specified by:
compareDocumentPosition
in interfaceNode
- 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
The absolute base URI of this node ornull
if undefined. This value is computed according to . However, when theDocument
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 thedocumentURI
attribute from theDocument
interface otherwise.
When the node is anElement
, aDocument
or a aProcessingInstruction
, this attribute represents the properties [base URI] defined in . When the node is aNotation
, anEntity
, or anEntityReference
, 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 interfaceNode
- Since:
- DOM Level 3
-