org.apache.xml.dtm.ref
public class DTMNodeProxy extends Object implements Node, Document, Text, Element, Attr, ProcessingInstruction, Comment, DocumentFragment
DTMNodeProxy
presents a DOM Node API front-end to the DTM model.
It does _not_ attempt to address the "node identity" question; no effort is made to prevent the creation of multiple proxies referring to a single DTM node. Users can create a mechanism for managing this, or relinquish the use of "==" and use the .sameNodeAs() mechanism, which is under consideration for future versions of the DOM.
DTMNodeProxy may be subclassed further to present specific DOM node types.
See Also: org.w3c.dom
UNKNOWN: internal
Field Summary | |
---|---|
DTM | dtm The DTM for this node. |
Constructor Summary | |
---|---|
DTMNodeProxy(DTM dtm, int node)
Create a DTMNodeProxy Node representing a specific Node in a DTM
|
Method Summary | |
---|---|
Node | adoptNode(Node source)
NEEDSDOC Method adoptNode
NEEDSDOC @param source
|
Node | appendChild(Node newChild) |
void | appendData(String arg) |
Node | cloneNode(boolean deep) |
short | compareDocumentPosition(Node other)
Compares a node with this node with regard to their position in the
document. |
Attr | createAttribute(String name) |
Attr | createAttributeNS(String namespaceURI, String qualifiedName) |
CDATASection | createCDATASection(String data) |
Comment | createComment(String data) |
DocumentFragment | createDocumentFragment() |
Element | createElement(String tagName) |
Element | createElementNS(String namespaceURI, String qualifiedName) |
EntityReference | createEntityReference(String name) |
ProcessingInstruction | createProcessingInstruction(String target, String data) |
Text | createTextNode(String data) |
void | deleteData(int offset, int count) |
boolean | equals(Node node)
Test for equality based on node number.
|
boolean | equals(Object node)
Test for equality based on node number.
|
String | getActualEncoding()
DOM Level 3
An attribute specifying the actual encoding of this document. |
String | getAttribute(String name) |
Attr | getAttributeNode(String name) |
Attr | getAttributeNodeNS(String namespaceURI, String localName) |
String | getAttributeNS(String namespaceURI, String localName) |
NamedNodeMap | getAttributes() |
String | getBaseURI()
The absolute base URI of this node or null if undefined.
|
NodeList | getChildNodes() |
String | getData() |
DocumentType | getDoctype() |
Element | getDocumentElement() This is a bit of a problem in DTM, since a DTM may be a Document
Fragment and hence not have a clear-cut Document Element. |
String | getDocumentURI()
DOM Level 3
The location of the document or null if undefined.
|
DOMConfiguration | getDomConfig()
The configuration used when Document.normalizeDocument is
invoked. |
DTM | getDTM()
NON-DOM: Return the DTM model
|
int | getDTMNodeNumber()
NON-DOM: Return the DTM node number
|
Element | getElementById(String elementId) |
NodeList | getElementsByTagName(String tagname) |
NodeList | getElementsByTagNameNS(String namespaceURI, String localName) |
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() |
DOMImplementation | getImplementation() |
String | getInputEncoding() |
Node | getLastChild() |
int | getLength() |
String | getLocalName() |
String | getName() |
String | getNamespaceURI() |
Node | getNextSibling() |
String | getNodeName() |
short | getNodeType() |
String | getNodeValue() |
Document | getOwnerDocument() |
Element | getOwnerElement()
Get the owner element of an attribute.
|
Node | getOwnerNode() |
Node | getParentNode() |
String | getPrefix() |
Node | getPreviousSibling() |
TypeInfo | getSchemaTypeInfo() |
boolean | getSpecified() |
boolean | getStrictErrorChecking() |
String | getStringValue() |
String | getTagName() |
String | getTarget()
A PI's "target" states what processor channel the PI's data
should be directed to. |
String | getTextContent()
This attribute returns the text content of this node and its
descendants. |
Object | getUserData(String key)
Retrieves the object associated to a key on a this node. |
String | getValue() |
String | getWholeText()
DOM Level 3
Returns all text of Text nodes logically-adjacent text
nodes to this node, concatenated in document order. |
String | getXmlEncoding() |
boolean | getXmlStandalone() |
String | getXmlVersion() |
boolean | hasAttribute(String name)
Method hasAttribute
|
boolean | hasAttributeNS(String namespaceURI, String localName)
Method hasAttributeNS
|
boolean | hasAttributes()
Introduced in DOM Level 2.
|
boolean | hasChildNodes() |
Node | importNode(Node importedNode, boolean deep) |
Node | insertBefore(Node newChild, Node refChild) |
void | insertData(int offset, String arg) |
boolean | isDefaultNamespace(String namespaceURI)
DOM Level 3:
This method checks if the specified namespaceURI is the
default namespace or not. |
boolean | isElementContentWhitespace()
DOM Level 3
Returns whether this text node contains whitespace in element content,
often abusively called "ignorable whitespace". |
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) Ask whether we support a given DOM feature.
|
String | lookupNamespaceURI(String specifiedPrefix)
DOM Level 3:
Look up the namespace URI associated to the given prefix, starting from this node.
|
String | lookupPrefix(String namespaceURI)
DOM Level 3:
Look up the prefix associated to the given namespace URI, starting from this node.
|
void | normalize() |
void | normalizeDocument()
DOM Level 3
Normalize document. |
void | removeAttribute(String name) |
Attr | removeAttributeNode(Attr oldAttr) |
void | removeAttributeNS(String namespaceURI, String localName) |
Node | removeChild(Node oldChild) |
Node | renameNode(Node n, String namespaceURI, String name)
DOM Level 3
Renaming node |
Node | replaceChild(Node newChild, Node oldChild) |
void | replaceData(int offset, int count, String arg) |
Text | replaceWholeText(String content)
DOM Level 3 |
boolean | sameNodeAs(Node other)
FUTURE DOM: Test node identity, in lieu of Node==Node
|
void | setActualEncoding(String value)
DOM Level 3
An attribute specifying the actual encoding of this document. |
void | setAttribute(String name, String value) |
Attr | setAttributeNode(Attr newAttr) |
Attr | setAttributeNodeNS(Attr newAttr) |
void | setAttributeNS(String namespaceURI, String qualifiedName, String value) |
void | setData(String data) |
void | setDocumentURI(String documentURI)
DOM Level 3 |
void | setIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type.
|
void | setIdAttribute(String name, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute |
void | setIdAttributeNode(Attr at, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute |
void | setIdAttributeNS(String namespaceURI, String localName, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute |
void | setNodeValue(String nodeValue) |
void | setPrefix(String prefix) |
void | setStrictErrorChecking(boolean strictErrorChecking) |
void | setTextContent(String textContent)
This attribute returns the text content of this node and its
descendants. |
Object | setUserData(String key, Object data, UserDataHandler handler) |
void | setValue(String value) |
void | setXmlEncoding(String xmlEncoding) |
void | setXmlStandalone(boolean xmlStandalone) |
void | setXmlVersion(String xmlVersion) |
Text | splitText(int offset) |
String | substringData(int offset, int count) |
boolean | supports(String feature, String version) Ask whether we support a given DOM feature.
|
Parameters: dtm The DTM Reference, must be non-null. node The DTM node handle.
Throws: DOMException
Parameters: newChild
Throws: DOMException
See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only
Parameters: arg
Throws: DOMException
See Also: org.w3c.dom.CharacterData
Parameters: deep
See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only
Parameters: other The node to compare against this node.
Returns: Returns how the given node is positioned relatively to this node.
Since: DOM Level 3
Parameters: name
Throws: DOMException
See Also: org.w3c.dom.Document
Parameters: namespaceURI qualifiedName
Throws: DOMException
See Also: org.w3c.dom.Document as of DOM Level 2
Parameters: data
Throws: DOMException
See Also: org.w3c.dom.Document
Parameters: data
See Also: org.w3c.dom.Document
See Also: org.w3c.dom.Document
Parameters: tagName
Throws: DOMException
See Also: org.w3c.dom.Document
Parameters: namespaceURI qualifiedName
Throws: DOMException
See Also: org.w3c.dom.Document as of DOM Level 2
Parameters: name
Throws: DOMException
See Also: org.w3c.dom.Document
Parameters: target data
Throws: DOMException
See Also: org.w3c.dom.Document
Parameters: data
See Also: org.w3c.dom.Document
Parameters: offset count
Throws: DOMException
See Also: org.w3c.dom.CharacterData
Parameters: node A DTM node proxy reference.
Returns: true if the given node has the same handle as this node.
Parameters: node A DTM node proxy reference.
Returns: true if the given node has the same handle as this node.
null
otherwise.
Since: DOM Level 3
Parameters: name
See Also: org.w3c.dom.Element
Parameters: name
See Also: org.w3c.dom.Element
Parameters: namespaceURI localName
See Also: org.w3c.dom.Element
Parameters: namespaceURI localName
See Also: org.w3c.dom.Element
See Also: org.w3c.dom.Node
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.
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)Since: DOM Level 3
See Also: org.w3c.dom.Node
Throws: DOMException
See Also: org.w3c.dom.CharacterData
See Also: org.w3c.dom.Document
See Also: org.w3c.dom.Document
null
if undefined.
Document
supports the feature
"HTML" , the href attribute of the HTML BASE element takes precedence
over this attribute.Since: DOM Level 3
Document.normalizeDocument
is
invoked.Since: DOM Level 3
Returns: The DTM that this proxy is a representative for.
Returns: The DTM node handle.
Parameters: elementId
See Also: org.w3c.dom.Document as of DOM Level 2
Parameters: tagname
See Also: org.w3c.dom.Document
Parameters: namespaceURI localName
See Also: org.w3c.dom.Document as of DOM Level 2
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
See Also: org.w3c.dom.Node
See Also: org.w3c.dom.Document
Based on the Document Object Model (DOM) Level 3 Core Specification of 07 April 2004..
An attribute specifying, as part of the XML declaration, the encoding
of this document. This is null
when unspecified.
Since: DOM Level 3
See Also: org.w3c.dom.Node
See Also: org.w3c.dom.CharacterData
See Also: org.w3c.dom.Node as of DOM Level 2
See Also: org.w3c.dom.Attr
See Also: org.w3c.dom.Node as of DOM Level 2
See Also: org.w3c.dom.Node
See Also: org.w3c.dom.Node
See Also: org.w3c.dom.Node
Throws: DOMException
See Also: org.w3c.dom.Node
See Also: org.w3c.dom.Node
See Also: org.w3c.dom.Attr as of DOM Level 2
See Also: org.w3c.dom.Node
See Also: org.w3c.dom.Node
Returns: The prefix for this node.
See Also: org.w3c.dom.Node as of DOM Level 2
See Also: org.w3c.dom.Node
See Also: org.w3c.dom.Attr
Based on the Document Object Model (DOM) Level 3 Core Specification of 07 April 2004..
An attribute specifying whether errors 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
. In case of error, the
behavior is undefined. This attribute is true
by
defaults.
Since: DOM Level 3
Returns: The string value of the node
Throws: DOMException
See Also: org.w3c.dom.Element
In XML, a PI's "target" is the first (whitespace-delimited) token following the "" token that begins the PI.
In HTML, target is always null.
Note that getNodeName is aliased to getTarget.
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.
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 |
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
setUserData
with the same key.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
See Also: org.w3c.dom.Attr
Text
nodes logically-adjacent text
nodes to this node, concatenated in document order.Since: DOM Level 3
Parameters: name
Parameters: namespaceURI localName
See Also: org.w3c.dom.Node
Parameters: importedNode deep
Throws: DOMException
See Also: org.w3c.dom.Document as of DOM Level 2 -- DTMNodeProxy is read-only
Parameters: newChild refChild
Throws: DOMException
See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only
Parameters: offset arg
Throws: DOMException
See Also: org.w3c.dom.CharacterData
namespaceURI
is the
default namespace or not.Parameters: namespaceURI The namespace URI to look for.
Returns: true
if the specified namespaceURI
is the default namespace, false
otherwise.
Since: DOM Level 3
Node.isSameNode
. All nodes that are the same
will also be equal, though the reverse may not be true.
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.
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.
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.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
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.Parameters: other The node to test against.
Returns: Returns true
if the nodes are the same,
false
otherwise.
Since: DOM Level 3
Parameters: feature version
Returns: false
See Also: org.w3c.dom.Node as of DOM Level 2
Parameters: namespaceURI
Returns: th URI for the namespace
Since: DOM Level 3
Parameters: namespaceURI
Returns: the prefix for the namespace
See Also: org.w3c.dom.Element
Parameters: name
Throws: DOMException
See Also: org.w3c.dom.Element
Parameters: oldAttr
Throws: DOMException
See Also: org.w3c.dom.Element
Parameters: namespaceURI localName
Throws: DOMException
See Also: org.w3c.dom.Element
Parameters: oldChild
Throws: DOMException
See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only
Parameters: newChild oldChild
Throws: DOMException
See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only
Parameters: offset count arg
Throws: DOMException
See Also: org.w3c.dom.CharacterData
Parameters: other
Returns: true if the given node has the same handle as this node.
null
otherwise.
Since: DOM Level 3
Parameters: name value
Throws: DOMException
See Also: org.w3c.dom.Element
Parameters: newAttr
Throws: DOMException
See Also: org.w3c.dom.Element
Parameters: newAttr
Throws: DOMException
See Also: org.w3c.dom.Element
Parameters: namespaceURI qualifiedName value
Throws: DOMException
See Also: org.w3c.dom.Element
Parameters: data
Throws: DOMException
See Also: org.w3c.dom.CharacterData
Parameters: id
Parameters: nodeValue
Throws: DOMException
See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only
Parameters: prefix
Throws: DOMException
See Also: org.w3c.dom.Node as of DOM Level 2 -- DTMNodeProxy is read-only
Based on the Document Object Model (DOM) Level 3 Core Specification of 07 April 2004..
An attribute specifying whether errors 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
. In case of error, the
behavior is undefined. This attribute is true
by
defaults.
Since: DOM Level 3 NEEDSDOC @param strictErrorChecking
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.
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 |
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
Parameters: value
See Also: org.w3c.dom.Attr
Parameters: offset
Throws: DOMException
See Also: org.w3c.dom.Text
Parameters: offset count
Throws: DOMException
See Also: org.w3c.dom.CharacterData
Parameters: feature version
Returns: false