| java.lang.Object
 org.apache.xml.dtm.ref.DTMNodeProxy
| DTMNodeProxy | | public class DTMNodeProxy implements Node,Document,Text,Element,Attr,ProcessingInstruction,Comment,DocumentFragment(Code) | | 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 |
| Method Summary | |
| public Node | adoptNode(Node source)
| | final public Node | appendChild(Node newChild)
| | final public void | appendData(String arg)
| | final public Node | cloneNode(boolean deep)
| | public short | compareDocumentPosition(Node other)
Compares a node with this node with regard to their position in the
document.
Parameters:
other - The node to compare against this node. | | final public Attr | createAttribute(String name)
| | final public Attr | createAttributeNS(String namespaceURI, String qualifiedName)
| | final public CDATASection | createCDATASection(String data)
| | final public Comment | createComment(String data)
| | final public DocumentFragment | createDocumentFragment()
| | final public Element | createElement(String tagName)
| | final public Element | createElementNS(String namespaceURI, String qualifiedName)
| | final public EntityReference | createEntityReference(String name)
| | final public ProcessingInstruction | createProcessingInstruction(String target, String data)
| | final public Text | createTextNode(String data)
| | final public void | deleteData(int offset, int count)
| | final public boolean | equals(Node node)
Test for equality based on node number.
Parameters:
node - A DTM node proxy reference. | | final public boolean | equals(Object node)
Test for equality based on node number.
Parameters:
node - A DTM node proxy reference. | | public String | getActualEncoding()
DOM Level 3
An attribute specifying the actual encoding of this document. | | final public String | getAttribute(String name)
| | final public String | getAttributeNS(String namespaceURI, String localName)
| | final public Attr | getAttributeNode(String name)
| | final public Attr | getAttributeNodeNS(String namespaceURI, String localName)
| | final public NamedNodeMap | getAttributes()
| | public String | getBaseURI()
The absolute base URI of this node or null if undefined.
This value is computed according to . | | final public NodeList | getChildNodes()
| | final public DTM | getDTM()
| | final public int | getDTMNodeNumber()
| | final public String | getData()
| | final public DocumentType | getDoctype()
| | final public 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. | | public String | getDocumentURI()
DOM Level 3
The location of the document or null if undefined. | | public DOMConfiguration | getDomConfig()
The configuration used when Document.normalizeDocument is
invoked. | | final public Element | getElementById(String elementId)
| | final public NodeList | getElementsByTagName(String tagname)
| | final public NodeList | getElementsByTagNameNS(String namespaceURI, String localName)
| | public Object | getFeature(String feature, String version)
This method returns a specialized object which implements the
specialized APIs of the specified feature and version. | | final public Node | getFirstChild()
| | final public DOMImplementation | getImplementation()
| | public String | getInputEncoding()
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. | | final public Node | getLastChild()
| | final public int | getLength()
| | final public String | getLocalName()
| | final public String | getName()
| | final public String | getNamespaceURI()
| | final public Node | getNextSibling()
| | final public String | getNodeName()
| | final public short | getNodeType()
| | final public String | getNodeValue()
| | final public Document | getOwnerDocument()
| | final public Element | getOwnerElement()
Get the owner element of an attribute. | | final public Node | getOwnerNode()
| | final public Node | getParentNode()
| | final public String | getPrefix()
| | final public Node | getPreviousSibling()
| | public TypeInfo | getSchemaTypeInfo()
| | final public boolean | getSpecified()
| | public boolean | getStrictErrorChecking()
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. | | final public String | getStringValue()
| | final public String | getTagName()
| | final public String | getTarget()
A PI's "target" states what processor channel the PI's data
should be directed to. | | public String | getTextContent()
This attribute returns the text content of this node and its
descendants. | | public Object | getUserData(String key)
Retrieves the object associated to a key on a this node. | | final public String | getValue()
| | public String | getWholeText()
DOM Level 3
Returns all text of Text nodes logically-adjacent text
nodes to this node, concatenated in document order. | | public String | getXmlEncoding()
| | public boolean | getXmlStandalone()
| | public String | getXmlVersion()
| | public boolean | hasAttribute(String name)
| | public boolean | hasAttributeNS(String namespaceURI, String localName)
| | public boolean | hasAttributes()
Introduced in DOM Level 2. | | final public boolean | hasChildNodes()
| | final public Node | importNode(Node importedNode, boolean deep)
| | final public Node | insertBefore(Node newChild, Node refChild)
| | final public void | insertData(int offset, String arg)
| | public boolean | isDefaultNamespace(String namespaceURI)
DOM Level 3:
This method checks if the specified namespaceURI is the
default namespace or not.
Parameters:
namespaceURI - The namespace URI to look for. | | public boolean | isElementContentWhitespace()
DOM Level 3
Returns whether this text node contains whitespace in element content,
often abusively called "ignorable whitespace". | | 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. | | public boolean | isId()
| | 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. | | final public boolean | isSupported(String feature, String version)
Ask whether we support a given DOM feature. | | public String | lookupNamespaceURI(String specifiedPrefix)
DOM Level 3:
Look up the namespace URI associated to the given prefix, starting from this node. | | public String | lookupPrefix(String namespaceURI)
DOM Level 3:
Look up the prefix associated to the given namespace URI, starting from this node. | | final public void | normalize()
| | public void | normalizeDocument()
DOM Level 3
Normalize document. | | final public void | removeAttribute(String name)
| | final public void | removeAttributeNS(String namespaceURI, String localName)
| | final public Attr | removeAttributeNode(Attr oldAttr)
| | final public Node | removeChild(Node oldChild)
| | public Node | renameNode(Node n, String namespaceURI, String name)
| | final public Node | replaceChild(Node newChild, Node oldChild)
| | final public void | replaceData(int offset, int count, String arg)
| | public Text | replaceWholeText(String content)
| | final public boolean | sameNodeAs(Node other)
| | public void | setActualEncoding(String value)
DOM Level 3
An attribute specifying the actual encoding of this document. | | final public void | setAttribute(String name, String value)
| | final public void | setAttributeNS(String namespaceURI, String qualifiedName, String value)
| | final public Attr | setAttributeNode(Attr newAttr)
| | final public Attr | setAttributeNodeNS(Attr newAttr)
| | final public void | setData(String data)
| | public void | setDocumentURI(String documentURI)
| | public void | setIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type. | | public void | setIdAttribute(String name, boolean makeId)
| | public void | setIdAttributeNS(String namespaceURI, String localName, boolean makeId)
| | public void | setIdAttributeNode(Attr at, boolean makeId)
| | final public void | setNodeValue(String nodeValue)
| | final public void | setPrefix(String prefix)
| | public void | setStrictErrorChecking(boolean strictErrorChecking)
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. | | public void | setTextContent(String textContent)
This attribute returns the text content of this node and its
descendants. | | public Object | setUserData(String key, Object data, UserDataHandler handler)
| | final public void | setValue(String value)
| | public void | setXmlEncoding(String xmlEncoding)
| | public void | setXmlStandalone(boolean xmlStandalone)
| | public void | setXmlVersion(String xmlVersion)
| | final public Text | splitText(int offset)
| | final public String | substringData(int offset, int count)
| | final public boolean | supports(String feature, String version)
Ask whether we support a given DOM feature.
In fact, we do not _fully_ support any DOM feature -- we're a
read-only subset -- so arguably we should always return false.
Or we could say that we support DOM Core Level 2 but all nodes
are read-only. |
| actualEncoding | | protected String actualEncoding(Code) | | DOM Level 3 feature: Document actualEncoding
|
| dtm | | public DTM dtm(Code) | | The DTM for this node.
|
| fDocumentURI | | protected String fDocumentURI(Code) | | DOM Level 3 feature: documentURI
|
| node | | int node(Code) | | The DTM node handle.
|
| DTMNodeProxy | | public DTMNodeProxy(DTM dtm, int node)(Code) | | Create a DTMNodeProxy Node representing a specific Node in a DTM
Parameters:
dtm - The DTM Reference, must be non-null.
Parameters:
node - The DTM node handle. |
| cloneNode | | final public Node cloneNode(boolean deep)(Code) | |
Parameters:
deep -
See Also: org.w3c.dom.Node
See Also: -- DTMNodeProxy is read-only |
| compareDocumentPosition | | public short compareDocumentPosition(Node other) throws DOMException(Code) | | Compares a node with this node with regard to their position in the
document.
Parameters:
other - The node to compare against this node. Returns how the given node is positioned relatively to thisnode.
since:
DOM Level 3 |
| equals | | final public boolean equals(Node node)(Code) | | Test for equality based on node number.
Parameters:
node - A DTM node proxy reference. true if the given node has the same handle as this node. |
| equals | | final public boolean equals(Object node)(Code) | | Test for equality based on node number.
Parameters:
node - A DTM node proxy reference. true if the given node has the same handle as this node. |
| getActualEncoding | | public String getActualEncoding()(Code) | | DOM Level 3
An attribute specifying the actual encoding of this document. This is
null otherwise.
This attribute represents the property [character encoding scheme]
defined in .
since:
DOM Level 3 |
| getBaseURI | | public String getBaseURI()(Code) | | 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)
since:
DOM Level 3 |
| getDTM | | final public DTM getDTM()(Code) | | NON-DOM: Return the DTM model
The DTM that this proxy is a representative for. |
| getDTMNodeNumber | | final public int getDTMNodeNumber()(Code) | | NON-DOM: Return the DTM node number
The DTM node handle. |
| getDocumentElement | | final public Element getDocumentElement()(Code) | | 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. We can
make it work in the well-formed cases but would that be confusing for others?
See Also: org.w3c.dom.Document |
| getDocumentURI | | public String getDocumentURI()(Code) | | DOM Level 3
The location of the document or null if undefined.
Beware that when the Document supports the feature
"HTML" , the href attribute of the HTML BASE element takes precedence
over this attribute.
since:
DOM Level 3 |
| getDomConfig | | public DOMConfiguration getDomConfig()(Code) | | The configuration used when Document.normalizeDocument is
invoked.
since:
DOM Level 3 |
| getFeature | | public Object getFeature(String feature, String version)(Code) | | 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.
Parameters:
feature - The name of the feature requested (case-insensitive).
Parameters:
version - This is the version number of the feature to test. Ifthe version is null or the empty string, supportingany version of the feature will cause the method to return anobject that supports at least one version of the feature. Returns an object which implements the specialized APIs ofthe specified feature and version, if any, or null ifthere is no object which implements interfaces associated with thatfeature. If the DOMObject returned by this methodimplements the Node interface, it must delegate to theprimary core Node and not return results inconsistentwith the primary core Node such as attributes,childNodes, etc.
since:
DOM Level 3 |
| getOwnerElement | | final public Element getOwnerElement()(Code) | | Get the owner element of an attribute.
See Also: org.w3c.dom.Attr
See Also: as of DOM Level 2 |
| getStrictErrorChecking | | public boolean getStrictErrorChecking()(Code) | | 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 |
| getTarget | | final public String getTarget()(Code) | | A PI's "target" states what processor channel the PI's data
should be directed to. It is defined differently in HTML and XML.
In XML, a PI's "target" is the first (whitespace-delimited) token
following the "
In HTML, target is always null.
Note that getNodeName is aliased to getTarget.
|
| getTextContent | | public String getTextContent() throws DOMException(Code) | | 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 |
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
exception:
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters thanfit in a DOMString variable on the implementationplatform.
since:
DOM Level 3 |
| getUserData | | public Object getUserData(String key)(Code) | | 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.
Parameters:
key - The key the object is associated to. Returns the DOMObject associated to the given keyon this node, or null if there was none.
since:
DOM Level 3 |
| getWholeText | | public String getWholeText()(Code) | | DOM Level 3
Returns all text of Text nodes logically-adjacent text
nodes to this node, concatenated in document order.
since:
DOM Level 3 |
| getXmlStandalone | | public boolean getXmlStandalone()(Code) | | |
| hasAttribute | | public boolean hasAttribute(String name)(Code) | | Method hasAttribute
Parameters:
name - |
| hasAttributeNS | | public boolean hasAttributeNS(String namespaceURI, String localName)(Code) | | Method hasAttributeNS
Parameters:
namespaceURI -
Parameters:
localName - |
| hasAttributes | | public boolean hasAttributes()(Code) | | Introduced in DOM Level 2.
|
| isDefaultNamespace | | public boolean isDefaultNamespace(String namespaceURI)(Code) | | DOM Level 3:
This method checks if the specified namespaceURI is the
default namespace or not.
Parameters:
namespaceURI - The namespace URI to look for. true if the specified namespaceURIis the default namespace, false otherwise.
since:
DOM Level 3 |
| isElementContentWhitespace | | public boolean isElementContentWhitespace()(Code) | | DOM Level 3
Returns whether this text node contains whitespace in element content,
often abusively called "ignorable whitespace".
|
| isEqualNode | | public boolean isEqualNode(Node arg)(Code) | | 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.
Parameters:
arg - The node to compare equality with.
Parameters:
deep - If true, recursively compare the subtrees; iffalse, compare only the nodes themselves (and itsattributes, if it is an Element). If the nodes, and possibly subtrees are equal,true otherwise false.
since:
DOM Level 3 |
| isId | | public boolean isId()(Code) | | |
| isSameNode | | public boolean isSameNode(Node other)(Code) | | 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.
Parameters:
other - The node to test against. Returns true if the nodes are the same,false otherwise.
since:
DOM Level 3 |
| isSupported | | final public boolean isSupported(String feature, String version)(Code) | | Ask whether we support a given DOM feature.
In fact, we do not _fully_ support any DOM feature -- we're a
read-only subset -- so arguably we should always return false.
Parameters:
feature -
Parameters:
version - false
See Also: org.w3c.dom.Node
See Also: as of DOM Level 2 |
| lookupNamespaceURI | | public String lookupNamespaceURI(String specifiedPrefix)(Code) | | DOM Level 3:
Look up the namespace URI associated to the given prefix, starting from this node.
Use lookupNamespaceURI(null) to lookup the default namespace
Parameters:
namespaceURI - th URI for the namespace
since:
DOM Level 3 |
| lookupPrefix | | public String lookupPrefix(String namespaceURI)(Code) | | DOM Level 3:
Look up the prefix associated to the given namespace URI, starting from this node.
Parameters:
namespaceURI - the prefix for the namespace |
| normalizeDocument | | public void normalizeDocument()(Code) | | DOM Level 3
Normalize document.
|
| sameNodeAs | | final public boolean sameNodeAs(Node other)(Code) | | FUTURE DOM: Test node identity, in lieu of Node==Node
Parameters:
other - true if the given node has the same handle as this node. |
| setActualEncoding | | public void setActualEncoding(String value)(Code) | | DOM Level 3
An attribute specifying the actual encoding of this document. This is
null otherwise.
This attribute represents the property [character encoding scheme]
defined in .
since:
DOM Level 3 |
| setDocumentURI | | public void setDocumentURI(String documentURI)(Code) | | DOM Level 3
|
| setIdAttribute | | public void setIdAttribute(boolean id)(Code) | | NON-DOM: set the type of this attribute to be ID type.
Parameters:
id - |
| setIdAttribute | | public void setIdAttribute(String name, boolean makeId)(Code) | | DOM Level 3: register the given attribute node as an ID attribute
|
| setIdAttributeNS | | public void setIdAttributeNS(String namespaceURI, String localName, boolean makeId)(Code) | | DOM Level 3: register the given attribute node as an ID attribute
|
| setIdAttributeNode | | public void setIdAttributeNode(Attr at, boolean makeId)(Code) | | DOM Level 3: register the given attribute node as an ID attribute
|
| setStrictErrorChecking | | public void setStrictErrorChecking(boolean strictErrorChecking)(Code) | | 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
since:
NEEDSDOC @param strictErrorChecking |
| setTextContent | | public void setTextContent(String textContent) throws DOMException(Code) | | 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 |
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
exception:
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters thanfit in a DOMString variable on the implementationplatform.
since:
DOM Level 3 |
| setXmlEncoding | | public void setXmlEncoding(String xmlEncoding)(Code) | | |
| setXmlStandalone | | public void setXmlStandalone(boolean xmlStandalone) throws DOMException(Code) | | |
| supports | | final public boolean supports(String feature, String version)(Code) | | Ask whether we support a given DOM feature.
In fact, we do not _fully_ support any DOM feature -- we're a
read-only subset -- so arguably we should always return false.
Or we could say that we support DOM Core Level 2 but all nodes
are read-only. Unclear which answer is least misleading.
NON-DOM method. This was present in early drafts of DOM Level 2,
but was renamed isSupported. It's present here only because it's
cheap, harmless, and might help some poor fool who is still trying
to use an early Working Draft of the DOM.
Parameters:
feature -
Parameters:
version - false |
|
|