|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--org.apache.xml.dtm.ref.DTMNodeProxy
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.
| 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(java.lang.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(java.lang.String name)
|
Attr |
createAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
|
CDATASection |
createCDATASection(java.lang.String data)
|
Comment |
createComment(java.lang.String data)
|
DocumentFragment |
createDocumentFragment()
|
Element |
createElement(java.lang.String tagName)
|
Element |
createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
|
EntityReference |
createEntityReference(java.lang.String name)
|
ProcessingInstruction |
createProcessingInstruction(java.lang.String target,
java.lang.String data)
|
Text |
createTextNode(java.lang.String data)
|
void |
deleteData(int offset,
int count)
|
boolean |
equals(Node node)
Test for equality based on node number. |
boolean |
equals(java.lang.Object node)
Test for equality based on node number. |
java.lang.String |
getActualEncoding()
DOM Level 3 An attribute specifying the actual encoding of this document. |
java.lang.String |
getAttribute(java.lang.String name)
|
Attr |
getAttributeNode(java.lang.String name)
|
Attr |
getAttributeNodeNS(java.lang.String namespaceURI,
java.lang.String localName)
|
java.lang.String |
getAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
|
NamedNodeMap |
getAttributes()
|
java.lang.String |
getBaseURI()
The absolute base URI of this node or null if undefined. |
NodeList |
getChildNodes()
|
java.lang.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. |
java.lang.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(java.lang.String elementId)
|
NodeList |
getElementsByTagName(java.lang.String tagname)
|
NodeList |
getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.String localName)
|
java.lang.Object |
getFeature(java.lang.String feature,
java.lang.String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version. |
Node |
getFirstChild()
|
DOMImplementation |
getImplementation()
|
java.lang.String |
getInputEncoding()
Based on the Document Object Model (DOM) Level 3 Core Specification of 07 April 2004.. |
Node |
getLastChild()
|
int |
getLength()
|
java.lang.String |
getLocalName()
|
java.lang.String |
getName()
|
java.lang.String |
getNamespaceURI()
|
Node |
getNextSibling()
|
java.lang.String |
getNodeName()
|
short |
getNodeType()
|
java.lang.String |
getNodeValue()
|
Document |
getOwnerDocument()
|
Element |
getOwnerElement()
Get the owner element of an attribute. |
Node |
getOwnerNode()
|
Node |
getParentNode()
|
java.lang.String |
getPrefix()
|
Node |
getPreviousSibling()
|
TypeInfo |
getSchemaTypeInfo()
|
boolean |
getSpecified()
|
boolean |
getStrictErrorChecking()
Based on the Document Object Model (DOM) Level 3 Core Specification of 07 April 2004.. |
java.lang.String |
getStringValue()
|
java.lang.String |
getTagName()
|
java.lang.String |
getTarget()
A PI's "target" states what processor channel the PI's data should be directed to. |
java.lang.String |
getTextContent()
This attribute returns the text content of this node and its descendants. |
java.lang.Object |
getUserData(java.lang.String key)
Retrieves the object associated to a key on a this node. |
java.lang.String |
getValue()
|
java.lang.String |
getWholeText()
DOM Level 3 Returns all text of Text nodes logically-adjacent text
nodes to this node, concatenated in document order. |
java.lang.String |
getXmlEncoding()
|
boolean |
getXmlStandalone()
|
java.lang.String |
getXmlVersion()
|
boolean |
hasAttribute(java.lang.String name)
Method hasAttribute |
boolean |
hasAttributeNS(java.lang.String namespaceURI,
java.lang.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,
java.lang.String arg)
|
boolean |
isDefaultNamespace(java.lang.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(java.lang.String feature,
java.lang.String version)
Ask whether we support a given DOM feature. |
java.lang.String |
lookupNamespaceURI(java.lang.String specifiedPrefix)
DOM Level 3: Look up the namespace URI associated to the given prefix, starting from this node. |
java.lang.String |
lookupPrefix(java.lang.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(java.lang.String name)
|
Attr |
removeAttributeNode(Attr oldAttr)
|
void |
removeAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
|
Node |
removeChild(Node oldChild)
|
Node |
renameNode(Node n,
java.lang.String namespaceURI,
java.lang.String name)
DOM Level 3 Renaming node |
Node |
replaceChild(Node newChild,
Node oldChild)
|
void |
replaceData(int offset,
int count,
java.lang.String arg)
|
Text |
replaceWholeText(java.lang.String content)
DOM Level 3 |
boolean |
sameNodeAs(Node other)
FUTURE DOM: Test node identity, in lieu of Node==Node |
void |
setActualEncoding(java.lang.String value)
DOM Level 3 An attribute specifying the actual encoding of this document. |
void |
setAttribute(java.lang.String name,
java.lang.String value)
|
Attr |
setAttributeNode(Attr newAttr)
|
Attr |
setAttributeNodeNS(Attr newAttr)
|
void |
setAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String value)
|
void |
setData(java.lang.String data)
|
void |
setDocumentURI(java.lang.String documentURI)
DOM Level 3 |
void |
setIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type. |
void |
setIdAttribute(java.lang.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(java.lang.String namespaceURI,
java.lang.String localName,
boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute |
void |
setNodeValue(java.lang.String nodeValue)
|
void |
setPrefix(java.lang.String prefix)
|
void |
setStrictErrorChecking(boolean strictErrorChecking)
Based on the Document Object Model (DOM) Level 3 Core Specification of 07 April 2004.. |
void |
setTextContent(java.lang.String textContent)
This attribute returns the text content of this node and its descendants. |
java.lang.Object |
setUserData(java.lang.String key,
java.lang.Object data,
UserDataHandler handler)
|
void |
setValue(java.lang.String value)
|
void |
setXmlEncoding(java.lang.String xmlEncoding)
|
void |
setXmlStandalone(boolean xmlStandalone)
|
void |
setXmlVersion(java.lang.String xmlVersion)
|
Text |
splitText(int offset)
|
java.lang.String |
substringData(int offset,
int count)
|
boolean |
supports(java.lang.String feature,
java.lang.String version)
Ask whether we support a given DOM feature. |
| Methods inherited from class java.lang.Object |
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
| Field Detail |
public DTM dtm
| Constructor Detail |
public DTMNodeProxy(DTM dtm,
int node)
dtm - The DTM Reference, must be non-null.node - The DTM node handle.| Method Detail |
public final DTM getDTM()
public final int getDTMNodeNumber()
public final boolean equals(Node node)
node - A DTM node proxy reference.public final boolean equals(java.lang.Object node)
node - A DTM node proxy reference.public final boolean sameNodeAs(Node other)
other - public final java.lang.String getNodeName()
Nodepublic final java.lang.String getTarget()
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.
public final java.lang.String getLocalName()
public final java.lang.String getPrefix()
public final void setPrefix(java.lang.String prefix)
throws DOMException
prefix - public final java.lang.String getNamespaceURI()
public final boolean supports(java.lang.String feature,
java.lang.String version)
feature - version -
public final boolean isSupported(java.lang.String feature,
java.lang.String version)
feature - version -
public final java.lang.String getNodeValue()
throws DOMException
Node
public final java.lang.String getStringValue()
throws DOMException
public final void setNodeValue(java.lang.String nodeValue)
throws DOMException
nodeValue - public final short getNodeType()
Nodepublic final Node getParentNode()
Nodepublic final Node getOwnerNode()
Nodepublic final NodeList getChildNodes()
Nodepublic final Node getFirstChild()
Nodepublic final Node getLastChild()
Nodepublic final Node getPreviousSibling()
Nodepublic final Node getNextSibling()
Nodepublic final NamedNodeMap getAttributes()
Nodepublic boolean hasAttribute(java.lang.String name)
name -
public boolean hasAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
namespaceURI - localName - public final Document getOwnerDocument()
Node
public final Node insertBefore(Node newChild,
Node refChild)
throws DOMException
newChild - refChild -
public final Node replaceChild(Node newChild,
Node oldChild)
throws DOMException
newChild - oldChild -
public final Node removeChild(Node oldChild)
throws DOMException
oldChild -
public final Node appendChild(Node newChild)
throws DOMException
newChild - public final boolean hasChildNodes()
Nodepublic final Node cloneNode(boolean deep)
deep - public final DocumentType getDoctype()
Documentpublic final DOMImplementation getImplementation()
Documentpublic final Element getDocumentElement()
Document
public final Element createElement(java.lang.String tagName)
throws DOMException
tagName - Documentpublic final DocumentFragment createDocumentFragment()
Documentpublic final Text createTextNode(java.lang.String data)
data - Documentpublic final Comment createComment(java.lang.String data)
data - Document
public final CDATASection createCDATASection(java.lang.String data)
throws DOMException
data - Document
public final ProcessingInstruction createProcessingInstruction(java.lang.String target,
java.lang.String data)
throws DOMException
target - data - Document
public final Attr createAttribute(java.lang.String name)
throws DOMException
name - Document
public final EntityReference createEntityReference(java.lang.String name)
throws DOMException
name - Documentpublic final NodeList getElementsByTagName(java.lang.String tagname)
tagname - Document
public final Node importNode(Node importedNode,
boolean deep)
throws DOMException
importedNode - deep -
public final Element createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
throws DOMException
namespaceURI - qualifiedName -
public final Attr createAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
throws DOMException
namespaceURI - qualifiedName -
public final NodeList getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.String localName)
namespaceURI - localName - public final Element getElementById(java.lang.String elementId)
elementId -
public final Text splitText(int offset)
throws DOMException
offset - Text
public final java.lang.String getData()
throws DOMException
CharacterData
public final void setData(java.lang.String data)
throws DOMException
data - CharacterDatapublic final int getLength()
CharacterData
public final java.lang.String substringData(int offset,
int count)
throws DOMException
offset - count - CharacterData
public final void appendData(java.lang.String arg)
throws DOMException
arg - CharacterData
public final void insertData(int offset,
java.lang.String arg)
throws DOMException
offset - arg - CharacterData
public final void deleteData(int offset,
int count)
throws DOMException
offset - count - CharacterData
public final void replaceData(int offset,
int count,
java.lang.String arg)
throws DOMException
offset - count - arg - CharacterDatapublic final java.lang.String getTagName()
Elementpublic final java.lang.String getAttribute(java.lang.String name)
name - Element
public final void setAttribute(java.lang.String name,
java.lang.String value)
throws DOMException
name - value - Element
public final void removeAttribute(java.lang.String name)
throws DOMException
name - Elementpublic final Attr getAttributeNode(java.lang.String name)
name - Element
public final Attr setAttributeNode(Attr newAttr)
throws DOMException
newAttr - Element
public final Attr removeAttributeNode(Attr oldAttr)
throws DOMException
oldAttr - Elementpublic boolean hasAttributes()
public final void normalize()
Element
public final java.lang.String getAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
namespaceURI - localName - Element
public final void setAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String value)
throws DOMException
namespaceURI - qualifiedName - value - Element
public final void removeAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
throws DOMException
namespaceURI - localName - Element
public final Attr getAttributeNodeNS(java.lang.String namespaceURI,
java.lang.String localName)
namespaceURI - localName - Element
public final Attr setAttributeNodeNS(Attr newAttr)
throws DOMException
newAttr - Elementpublic final java.lang.String getName()
Attrpublic final boolean getSpecified()
Attrpublic final java.lang.String getValue()
Attrpublic final void setValue(java.lang.String value)
value - Attrpublic final Element getOwnerElement()
public Node adoptNode(Node source)
throws DOMException
public java.lang.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. This is null when unspecified.
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. In case of error, the
behavior is undefined. This attribute is true by
defaults.
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. In case of error, the
behavior is undefined. This attribute is true by
defaults.
public java.lang.Object setUserData(java.lang.String key,
java.lang.Object data,
UserDataHandler handler)
public java.lang.Object getUserData(java.lang.String key)
setUserData with the same key.key - The key the object is associated to.DOMObject associated to the given key
on this node, or null if there was none.
public java.lang.Object getFeature(java.lang.String feature,
java.lang.String version)
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.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.public boolean isEqualNode(Node arg)
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.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).true otherwise false.public java.lang.String lookupNamespaceURI(java.lang.String specifiedPrefix)
namespaceURI - public boolean isDefaultNamespace(java.lang.String namespaceURI)
namespaceURI is the
default namespace or not.namespaceURI - The namespace URI to look for.true if the specified namespaceURI
is the default namespace, false otherwise.public java.lang.String lookupPrefix(java.lang.String namespaceURI)
namespaceURI - public boolean isSameNode(Node other)
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.other - The node to test against.true if the nodes are the same,
false otherwise.
public void setTextContent(java.lang.String textContent)
throws DOMException
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 |
DOMString variable on the implementation
platform.
public java.lang.String getTextContent()
throws DOMException
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 |
DOMString variable on the implementation
platform.
public short compareDocumentPosition(Node other)
throws DOMException
other - The node to compare against this node.public java.lang.String getBaseURI()
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)
public Node renameNode(Node n,
java.lang.String namespaceURI,
java.lang.String name)
throws DOMException
public void normalizeDocument()
public DOMConfiguration getDomConfig()
Document.normalizeDocument is
invoked.public void setDocumentURI(java.lang.String documentURI)
public java.lang.String getDocumentURI()
null if undefined.
Document supports the feature
"HTML" , the href attribute of the HTML BASE element takes precedence
over this attribute.public java.lang.String getActualEncoding()
null otherwise.
public void setActualEncoding(java.lang.String value)
null otherwise.
public Text replaceWholeText(java.lang.String content)
throws DOMException
public java.lang.String getWholeText()
Text nodes logically-adjacent text
nodes to this node, concatenated in document order.public boolean isElementContentWhitespace()
public void setIdAttribute(boolean id)
id -
public void setIdAttribute(java.lang.String name,
boolean makeId)
public void setIdAttributeNode(Attr at,
boolean makeId)
public void setIdAttributeNS(java.lang.String namespaceURI,
java.lang.String localName,
boolean makeId)
public TypeInfo getSchemaTypeInfo()
public boolean isId()
public java.lang.String getXmlEncoding()
public void setXmlEncoding(java.lang.String xmlEncoding)
public boolean getXmlStandalone()
public void setXmlStandalone(boolean xmlStandalone)
throws DOMException
public java.lang.String getXmlVersion()
public void setXmlVersion(java.lang.String xmlVersion)
throws DOMException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||