org.apache.xml.dtm.ref

Class DTMNodeProxy

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
DTMdtm
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
NodeadoptNode(Node source)
NEEDSDOC Method adoptNode NEEDSDOC @param source
NodeappendChild(Node newChild)
voidappendData(String arg)
NodecloneNode(boolean deep)
shortcompareDocumentPosition(Node other)
Compares a node with this node with regard to their position in the document.
AttrcreateAttribute(String name)
AttrcreateAttributeNS(String namespaceURI, String qualifiedName)
CDATASectioncreateCDATASection(String data)
CommentcreateComment(String data)
DocumentFragmentcreateDocumentFragment()
ElementcreateElement(String tagName)
ElementcreateElementNS(String namespaceURI, String qualifiedName)
EntityReferencecreateEntityReference(String name)
ProcessingInstructioncreateProcessingInstruction(String target, String data)
TextcreateTextNode(String data)
voiddeleteData(int offset, int count)
booleanequals(Node node)
Test for equality based on node number.
booleanequals(Object node)
Test for equality based on node number.
StringgetActualEncoding()
DOM Level 3 An attribute specifying the actual encoding of this document.
StringgetAttribute(String name)
AttrgetAttributeNode(String name)
AttrgetAttributeNodeNS(String namespaceURI, String localName)
StringgetAttributeNS(String namespaceURI, String localName)
NamedNodeMapgetAttributes()
StringgetBaseURI()
The absolute base URI of this node or null if undefined.
NodeListgetChildNodes()
StringgetData()
DocumentTypegetDoctype()
ElementgetDocumentElement()
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.
StringgetDocumentURI()
DOM Level 3 The location of the document or null if undefined.
DOMConfigurationgetDomConfig()
The configuration used when Document.normalizeDocument is invoked.
DTMgetDTM()
NON-DOM: Return the DTM model
intgetDTMNodeNumber()
NON-DOM: Return the DTM node number
ElementgetElementById(String elementId)
NodeListgetElementsByTagName(String tagname)
NodeListgetElementsByTagNameNS(String namespaceURI, String localName)
ObjectgetFeature(String feature, String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version.
NodegetFirstChild()
DOMImplementationgetImplementation()
StringgetInputEncoding()
NodegetLastChild()
intgetLength()
StringgetLocalName()
StringgetName()
StringgetNamespaceURI()
NodegetNextSibling()
StringgetNodeName()
shortgetNodeType()
StringgetNodeValue()
DocumentgetOwnerDocument()
ElementgetOwnerElement()
Get the owner element of an attribute.
NodegetOwnerNode()
NodegetParentNode()
StringgetPrefix()
NodegetPreviousSibling()
TypeInfogetSchemaTypeInfo()
booleangetSpecified()
booleangetStrictErrorChecking()
StringgetStringValue()
StringgetTagName()
StringgetTarget()
A PI's "target" states what processor channel the PI's data should be directed to.
StringgetTextContent()
This attribute returns the text content of this node and its descendants.
ObjectgetUserData(String key)
Retrieves the object associated to a key on a this node.
StringgetValue()
StringgetWholeText()
DOM Level 3 Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
StringgetXmlEncoding()
booleangetXmlStandalone()
StringgetXmlVersion()
booleanhasAttribute(String name)
Method hasAttribute
booleanhasAttributeNS(String namespaceURI, String localName)
Method hasAttributeNS
booleanhasAttributes()
Introduced in DOM Level 2.
booleanhasChildNodes()
NodeimportNode(Node importedNode, boolean deep)
NodeinsertBefore(Node newChild, Node refChild)
voidinsertData(int offset, String arg)
booleanisDefaultNamespace(String namespaceURI)
DOM Level 3: This method checks if the specified namespaceURI is the default namespace or not.
booleanisElementContentWhitespace()
DOM Level 3 Returns whether this text node contains whitespace in element content, often abusively called "ignorable whitespace".
booleanisEqualNode(Node arg)
Tests whether two nodes are equal.
booleanisId()
booleanisSameNode(Node other)
Returns whether this node is the same node as the given one.
booleanisSupported(String feature, String version)
Ask whether we support a given DOM feature.
StringlookupNamespaceURI(String specifiedPrefix)
DOM Level 3: Look up the namespace URI associated to the given prefix, starting from this node.
StringlookupPrefix(String namespaceURI)
DOM Level 3: Look up the prefix associated to the given namespace URI, starting from this node.
voidnormalize()
voidnormalizeDocument()
DOM Level 3 Normalize document.
voidremoveAttribute(String name)
AttrremoveAttributeNode(Attr oldAttr)
voidremoveAttributeNS(String namespaceURI, String localName)
NoderemoveChild(Node oldChild)
NoderenameNode(Node n, String namespaceURI, String name)
DOM Level 3 Renaming node
NodereplaceChild(Node newChild, Node oldChild)
voidreplaceData(int offset, int count, String arg)
TextreplaceWholeText(String content)
DOM Level 3
booleansameNodeAs(Node other)
FUTURE DOM: Test node identity, in lieu of Node==Node
voidsetActualEncoding(String value)
DOM Level 3 An attribute specifying the actual encoding of this document.
voidsetAttribute(String name, String value)
AttrsetAttributeNode(Attr newAttr)
AttrsetAttributeNodeNS(Attr newAttr)
voidsetAttributeNS(String namespaceURI, String qualifiedName, String value)
voidsetData(String data)
voidsetDocumentURI(String documentURI)
DOM Level 3
voidsetIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type.
voidsetIdAttribute(String name, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
voidsetIdAttributeNode(Attr at, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
voidsetIdAttributeNS(String namespaceURI, String localName, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
voidsetNodeValue(String nodeValue)
voidsetPrefix(String prefix)
voidsetStrictErrorChecking(boolean strictErrorChecking)
voidsetTextContent(String textContent)
This attribute returns the text content of this node and its descendants.
ObjectsetUserData(String key, Object data, UserDataHandler handler)
voidsetValue(String value)
voidsetXmlEncoding(String xmlEncoding)
voidsetXmlStandalone(boolean xmlStandalone)
voidsetXmlVersion(String xmlVersion)
TextsplitText(int offset)
StringsubstringData(int offset, int count)
booleansupports(String feature, String version)
Ask whether we support a given DOM feature.

Field Detail

dtm

public DTM dtm
The DTM for this node.

Constructor Detail

DTMNodeProxy

public DTMNodeProxy(DTM dtm, int node)
Create a DTMNodeProxy Node representing a specific Node in a DTM

Parameters: dtm The DTM Reference, must be non-null. node The DTM node handle.

Method Detail

adoptNode

public Node adoptNode(Node source)
NEEDSDOC Method adoptNode NEEDSDOC @param source

Throws: DOMException

appendChild

public final Node appendChild(Node newChild)

Parameters: newChild

Throws: DOMException

See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only

appendData

public final void appendData(String arg)

Parameters: arg

Throws: DOMException

See Also: org.w3c.dom.CharacterData

cloneNode

public final Node cloneNode(boolean deep)

Parameters: deep

See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only

compareDocumentPosition

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.

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

Since: DOM Level 3

createAttribute

public final Attr createAttribute(String name)

Parameters: name

Throws: DOMException

See Also: org.w3c.dom.Document

createAttributeNS

public final Attr createAttributeNS(String namespaceURI, String qualifiedName)

Parameters: namespaceURI qualifiedName

Throws: DOMException

See Also: org.w3c.dom.Document as of DOM Level 2

createCDATASection

public final CDATASection createCDATASection(String data)

Parameters: data

Throws: DOMException

See Also: org.w3c.dom.Document

createComment

public final Comment createComment(String data)

Parameters: data

See Also: org.w3c.dom.Document

createDocumentFragment

public final DocumentFragment createDocumentFragment()

See Also: org.w3c.dom.Document

createElement

public final Element createElement(String tagName)

Parameters: tagName

Throws: DOMException

See Also: org.w3c.dom.Document

createElementNS

public final Element createElementNS(String namespaceURI, String qualifiedName)

Parameters: namespaceURI qualifiedName

Throws: DOMException

See Also: org.w3c.dom.Document as of DOM Level 2

createEntityReference

public final EntityReference createEntityReference(String name)

Parameters: name

Throws: DOMException

See Also: org.w3c.dom.Document

createProcessingInstruction

public final ProcessingInstruction createProcessingInstruction(String target, String data)

Parameters: target data

Throws: DOMException

See Also: org.w3c.dom.Document

createTextNode

public final Text createTextNode(String data)

Parameters: data

See Also: org.w3c.dom.Document

deleteData

public final void deleteData(int offset, int count)

Parameters: offset count

Throws: DOMException

See Also: org.w3c.dom.CharacterData

equals

public final boolean equals(Node node)
Test for equality based on node number.

Parameters: node A DTM node proxy reference.

Returns: true if the given node has the same handle as this node.

equals

public final boolean equals(Object node)
Test for equality based on node number.

Parameters: node A DTM node proxy reference.

Returns: true if the given node has the same handle as this node.

getActualEncoding

public String getActualEncoding()
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

getAttribute

public final String getAttribute(String name)

Parameters: name

See Also: org.w3c.dom.Element

getAttributeNode

public final Attr getAttributeNode(String name)

Parameters: name

See Also: org.w3c.dom.Element

getAttributeNodeNS

public final Attr getAttributeNodeNS(String namespaceURI, String localName)

Parameters: namespaceURI localName

See Also: org.w3c.dom.Element

getAttributeNS

public final String getAttributeNS(String namespaceURI, String localName)

Parameters: namespaceURI localName

See Also: org.w3c.dom.Element

getAttributes

public final NamedNodeMap getAttributes()

See Also: org.w3c.dom.Node

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)

Since: DOM Level 3

getChildNodes

public final NodeList getChildNodes()

See Also: org.w3c.dom.Node

getData

public final String getData()

Throws: DOMException

See Also: org.w3c.dom.CharacterData

getDoctype

public final DocumentType getDoctype()

See Also: org.w3c.dom.Document

getDocumentElement

public final 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. 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()
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()
The configuration used when Document.normalizeDocument is invoked.

Since: DOM Level 3

getDTM

public final DTM getDTM()
NON-DOM: Return the DTM model

Returns: The DTM that this proxy is a representative for.

getDTMNodeNumber

public final int getDTMNodeNumber()
NON-DOM: Return the DTM node number

Returns: The DTM node handle.

getElementById

public final Element getElementById(String elementId)

Parameters: elementId

See Also: org.w3c.dom.Document as of DOM Level 2

getElementsByTagName

public final NodeList getElementsByTagName(String tagname)

Parameters: tagname

See Also: org.w3c.dom.Document

getElementsByTagNameNS

public final NodeList getElementsByTagNameNS(String namespaceURI, String localName)

Parameters: namespaceURI localName

See Also: org.w3c.dom.Document as of DOM Level 2

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.

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

getFirstChild

public final Node getFirstChild()

See Also: org.w3c.dom.Node

getImplementation

public final DOMImplementation getImplementation()

See Also: org.w3c.dom.Document

getInputEncoding

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. This is null when unspecified.

Since: DOM Level 3

getLastChild

public final Node getLastChild()

See Also: org.w3c.dom.Node

getLength

public final int getLength()

See Also: org.w3c.dom.CharacterData

getLocalName

public final String getLocalName()

See Also: org.w3c.dom.Node as of DOM Level 2

getName

public final String getName()

See Also: org.w3c.dom.Attr

getNamespaceURI

public final String getNamespaceURI()

See Also: org.w3c.dom.Node as of DOM Level 2

getNextSibling

public final Node getNextSibling()

See Also: org.w3c.dom.Node

getNodeName

public final String getNodeName()

See Also: org.w3c.dom.Node

getNodeType

public final short getNodeType()

See Also: org.w3c.dom.Node

getNodeValue

public final String getNodeValue()

Throws: DOMException

See Also: org.w3c.dom.Node

getOwnerDocument

public final Document getOwnerDocument()

See Also: org.w3c.dom.Node

getOwnerElement

public final Element getOwnerElement()
Get the owner element of an attribute.

See Also: org.w3c.dom.Attr as of DOM Level 2

getOwnerNode

public final Node getOwnerNode()

See Also: org.w3c.dom.Node

getParentNode

public final Node getParentNode()

See Also: org.w3c.dom.Node

getPrefix

public final String getPrefix()

Returns: The prefix for this node.

See Also: org.w3c.dom.Node as of DOM Level 2

getPreviousSibling

public final Node getPreviousSibling()

See Also: org.w3c.dom.Node

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

getSpecified

public final boolean getSpecified()

See Also: org.w3c.dom.Attr

getStrictErrorChecking

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.

Since: DOM Level 3

getStringValue

public final String getStringValue()

Returns: The string value of the node

Throws: DOMException

getTagName

public final String getTagName()

See Also: org.w3c.dom.Element

getTarget

public final String getTarget()
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()
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

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

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.

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

getValue

public final String getValue()

See Also: org.w3c.dom.Attr

getWholeText

public String getWholeText()
DOM Level 3 Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.

Since: DOM Level 3

getXmlEncoding

public String getXmlEncoding()

getXmlStandalone

public boolean getXmlStandalone()

getXmlVersion

public String getXmlVersion()

hasAttribute

public boolean hasAttribute(String name)
Method hasAttribute

Parameters: name

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI, String localName)
Method hasAttributeNS

Parameters: namespaceURI localName

hasAttributes

public boolean hasAttributes()
Introduced in DOM Level 2.

hasChildNodes

public final boolean hasChildNodes()

See Also: org.w3c.dom.Node

importNode

public final Node importNode(Node importedNode, boolean deep)

Parameters: importedNode deep

Throws: DOMException

See Also: org.w3c.dom.Document as of DOM Level 2 -- DTMNodeProxy is read-only

insertBefore

public final Node insertBefore(Node newChild, Node refChild)

Parameters: newChild refChild

Throws: DOMException

See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only

insertData

public final void insertData(int offset, String arg)

Parameters: offset arg

Throws: DOMException

See Also: org.w3c.dom.CharacterData

isDefaultNamespace

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.

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

Since: DOM Level 3

isElementContentWhitespace

public boolean isElementContentWhitespace()
DOM Level 3 Returns whether this text node contains whitespace in element content, often abusively called "ignorable whitespace".

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.

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

isId

public boolean isId()

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.

Parameters: other The node to test against.

Returns: Returns true if the nodes are the same, false otherwise.

Since: DOM Level 3

isSupported

public final boolean isSupported(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.

Parameters: feature version

Returns: false

See Also: org.w3c.dom.Node as of DOM Level 2

lookupNamespaceURI

public String lookupNamespaceURI(String specifiedPrefix)
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

Returns: th URI for the namespace

Since: DOM Level 3

lookupPrefix

public String lookupPrefix(String namespaceURI)
DOM Level 3: Look up the prefix associated to the given namespace URI, starting from this node.

Parameters: namespaceURI

Returns: the prefix for the namespace

normalize

public final void normalize()

See Also: org.w3c.dom.Element

normalizeDocument

public void normalizeDocument()
DOM Level 3 Normalize document.

removeAttribute

public final void removeAttribute(String name)

Parameters: name

Throws: DOMException

See Also: org.w3c.dom.Element

removeAttributeNode

public final Attr removeAttributeNode(Attr oldAttr)

Parameters: oldAttr

Throws: DOMException

See Also: org.w3c.dom.Element

removeAttributeNS

public final void removeAttributeNS(String namespaceURI, String localName)

Parameters: namespaceURI localName

Throws: DOMException

See Also: org.w3c.dom.Element

removeChild

public final Node removeChild(Node oldChild)

Parameters: oldChild

Throws: DOMException

See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only

renameNode

public Node renameNode(Node n, String namespaceURI, String name)
DOM Level 3 Renaming node

replaceChild

public final Node replaceChild(Node newChild, Node oldChild)

Parameters: newChild oldChild

Throws: DOMException

See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only

replaceData

public final void replaceData(int offset, int count, String arg)

Parameters: offset count arg

Throws: DOMException

See Also: org.w3c.dom.CharacterData

replaceWholeText

public Text replaceWholeText(String content)
DOM Level 3

sameNodeAs

public final boolean sameNodeAs(Node other)
FUTURE DOM: Test node identity, in lieu of Node==Node

Parameters: other

Returns: true if the given node has the same handle as this node.

setActualEncoding

public void setActualEncoding(String value)
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

setAttribute

public final void setAttribute(String name, String value)

Parameters: name value

Throws: DOMException

See Also: org.w3c.dom.Element

setAttributeNode

public final Attr setAttributeNode(Attr newAttr)

Parameters: newAttr

Throws: DOMException

See Also: org.w3c.dom.Element

setAttributeNodeNS

public final Attr setAttributeNodeNS(Attr newAttr)

Parameters: newAttr

Throws: DOMException

See Also: org.w3c.dom.Element

setAttributeNS

public final void setAttributeNS(String namespaceURI, String qualifiedName, String value)

Parameters: namespaceURI qualifiedName value

Throws: DOMException

See Also: org.w3c.dom.Element

setData

public final void setData(String data)

Parameters: data

Throws: DOMException

See Also: org.w3c.dom.CharacterData

setDocumentURI

public void setDocumentURI(String documentURI)
DOM Level 3

setIdAttribute

public void setIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type.

Parameters: id

setIdAttribute

public void setIdAttribute(String name, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute

setIdAttributeNode

public void setIdAttributeNode(Attr at, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI, String localName, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute

setNodeValue

public final void setNodeValue(String nodeValue)

Parameters: nodeValue

Throws: DOMException

See Also: org.w3c.dom.Node -- DTMNodeProxy is read-only

setPrefix

public final void setPrefix(String prefix)

Parameters: prefix

Throws: DOMException

See Also: org.w3c.dom.Node as of DOM Level 2 -- DTMNodeProxy is read-only

setStrictErrorChecking

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.

Since: DOM Level 3 NEEDSDOC @param strictErrorChecking

setTextContent

public void setTextContent(String textContent)
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

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

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

setValue

public final void setValue(String value)

Parameters: value

See Also: org.w3c.dom.Attr

setXmlEncoding

public void setXmlEncoding(String xmlEncoding)

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)

setXmlVersion

public void setXmlVersion(String xmlVersion)

splitText

public final Text splitText(int offset)

Parameters: offset

Throws: DOMException

See Also: org.w3c.dom.Text

substringData

public final String substringData(int offset, int count)

Parameters: offset count

Throws: DOMException

See Also: org.w3c.dom.CharacterData

supports

public final 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. 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 version

Returns: false

Copyright B) 2005 Apache XML Project. All Rights Reserved.