Class DTMNodeProxy
- java.lang.Object
-
- org.apache.xml.dtm.ref.DTMNodeProxy
-
- All Implemented Interfaces:
org.w3c.dom.Attr,org.w3c.dom.CharacterData,org.w3c.dom.Comment,org.w3c.dom.Document,org.w3c.dom.DocumentFragment,org.w3c.dom.Element,org.w3c.dom.Node,org.w3c.dom.ProcessingInstruction,org.w3c.dom.Text
public class DTMNodeProxy extends java.lang.Object implements org.w3c.dom.Node, org.w3c.dom.Document, org.w3c.dom.Text, org.w3c.dom.Element, org.w3c.dom.Attr, org.w3c.dom.ProcessingInstruction, org.w3c.dom.Comment, org.w3c.dom.DocumentFragmentDTMNodeProxypresents 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
-
-
Field Summary
Fields Modifier and Type Field Description DTMdtmThe DTM for this node.-
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Constructor Summary
Constructors Constructor Description DTMNodeProxy(DTM dtm, int node)Create a DTMNodeProxy Node representing a specific Node in a DTM
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.w3c.dom.NodeadoptNode(org.w3c.dom.Node source)NEEDSDOC Method adoptNode NEEDSDOC @param sourceorg.w3c.dom.NodeappendChild(org.w3c.dom.Node newChild)voidappendData(java.lang.String arg)org.w3c.dom.NodecloneNode(boolean deep)shortcompareDocumentPosition(org.w3c.dom.Node other)Compares a node with this node with regard to their position in the document.org.w3c.dom.AttrcreateAttribute(java.lang.String name)org.w3c.dom.AttrcreateAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName)org.w3c.dom.CDATASectioncreateCDATASection(java.lang.String data)org.w3c.dom.CommentcreateComment(java.lang.String data)org.w3c.dom.DocumentFragmentcreateDocumentFragment()org.w3c.dom.ElementcreateElement(java.lang.String tagName)org.w3c.dom.ElementcreateElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName)org.w3c.dom.EntityReferencecreateEntityReference(java.lang.String name)org.w3c.dom.ProcessingInstructioncreateProcessingInstruction(java.lang.String target, java.lang.String data)org.w3c.dom.TextcreateTextNode(java.lang.String data)voiddeleteData(int offset, int count)booleanequals(java.lang.Object node)Test for equality based on node number.booleanequals(org.w3c.dom.Node node)Test for equality based on node number.java.lang.StringgetActualEncoding()DOM Level 3 An attribute specifying the actual encoding of this document.java.lang.StringgetAttribute(java.lang.String name)org.w3c.dom.AttrgetAttributeNode(java.lang.String name)org.w3c.dom.AttrgetAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)java.lang.StringgetAttributeNS(java.lang.String namespaceURI, java.lang.String localName)org.w3c.dom.NamedNodeMapgetAttributes()java.lang.StringgetBaseURI()The absolute base URI of this node ornullif undefined.org.w3c.dom.NodeListgetChildNodes()java.lang.StringgetData()org.w3c.dom.DocumentTypegetDoctype()org.w3c.dom.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.java.lang.StringgetDocumentURI()DOM Level 3 The location of the document ornullif undefined.org.w3c.dom.DOMConfigurationgetDomConfig()The configuration used whenDocument.normalizeDocumentis invoked.DTMgetDTM()NON-DOM: Return the DTM modelintgetDTMNodeNumber()NON-DOM: Return the DTM node numberorg.w3c.dom.ElementgetElementById(java.lang.String elementId)org.w3c.dom.NodeListgetElementsByTagName(java.lang.String tagname)org.w3c.dom.NodeListgetElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)java.lang.ObjectgetFeature(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.org.w3c.dom.NodegetFirstChild()org.w3c.dom.DOMImplementationgetImplementation()java.lang.StringgetInputEncoding()org.w3c.dom.NodegetLastChild()intgetLength()java.lang.StringgetLocalName()java.lang.StringgetName()java.lang.StringgetNamespaceURI()org.w3c.dom.NodegetNextSibling()java.lang.StringgetNodeName()shortgetNodeType()java.lang.StringgetNodeValue()org.w3c.dom.DocumentgetOwnerDocument()org.w3c.dom.ElementgetOwnerElement()Get the owner element of an attribute.org.w3c.dom.NodegetOwnerNode()org.w3c.dom.NodegetParentNode()java.lang.StringgetPrefix()org.w3c.dom.NodegetPreviousSibling()org.w3c.dom.TypeInfogetSchemaTypeInfo()booleangetSpecified()booleangetStrictErrorChecking()java.lang.StringgetStringValue()java.lang.StringgetTagName()java.lang.StringgetTarget()A PI's "target" states what processor channel the PI's data should be directed to.java.lang.StringgetTextContent()This attribute returns the text content of this node and its descendants.java.lang.ObjectgetUserData(java.lang.String key)Retrieves the object associated to a key on a this node.java.lang.StringgetValue()java.lang.StringgetWholeText()DOM Level 3 Returns all text ofTextnodes logically-adjacent text nodes to this node, concatenated in document order.java.lang.StringgetXmlEncoding()booleangetXmlStandalone()java.lang.StringgetXmlVersion()booleanhasAttribute(java.lang.String name)Method hasAttributebooleanhasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)Method hasAttributeNSbooleanhasAttributes()Introduced in DOM Level 2.booleanhasChildNodes()org.w3c.dom.NodeimportNode(org.w3c.dom.Node importedNode, boolean deep)org.w3c.dom.NodeinsertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)voidinsertData(int offset, java.lang.String arg)booleanisDefaultNamespace(java.lang.String namespaceURI)DOM Level 3: This method checks if the specifiednamespaceURIis 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(org.w3c.dom.Node arg)Tests whether two nodes are equal.booleanisId()booleanisSameNode(org.w3c.dom.Node other)Returns whether this node is the same node as the given one.booleanisSupported(java.lang.String feature, java.lang.String version)Ask whether we support a given DOM feature.java.lang.StringlookupNamespaceURI(java.lang.String specifiedPrefix)DOM Level 3: Look up the namespace URI associated to the given prefix, starting from this node.java.lang.StringlookupPrefix(java.lang.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(java.lang.String name)org.w3c.dom.AttrremoveAttributeNode(org.w3c.dom.Attr oldAttr)voidremoveAttributeNS(java.lang.String namespaceURI, java.lang.String localName)org.w3c.dom.NoderemoveChild(org.w3c.dom.Node oldChild)org.w3c.dom.NoderenameNode(org.w3c.dom.Node n, java.lang.String namespaceURI, java.lang.String name)DOM Level 3 Renaming nodeorg.w3c.dom.NodereplaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)voidreplaceData(int offset, int count, java.lang.String arg)org.w3c.dom.TextreplaceWholeText(java.lang.String content)DOM Level 3booleansameNodeAs(org.w3c.dom.Node other)FUTURE DOM: Test node identity, in lieu of Node==NodevoidsetActualEncoding(java.lang.String value)DOM Level 3 An attribute specifying the actual encoding of this document.voidsetAttribute(java.lang.String name, java.lang.String value)org.w3c.dom.AttrsetAttributeNode(org.w3c.dom.Attr newAttr)org.w3c.dom.AttrsetAttributeNodeNS(org.w3c.dom.Attr newAttr)voidsetAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)voidsetData(java.lang.String data)voidsetDocumentURI(java.lang.String documentURI)DOM Level 3voidsetIdAttribute(boolean id)NON-DOM: set the type of this attribute to be ID type.voidsetIdAttribute(java.lang.String name, boolean makeId)DOM Level 3: register the given attribute node as an ID attributevoidsetIdAttributeNode(org.w3c.dom.Attr at, boolean makeId)DOM Level 3: register the given attribute node as an ID attributevoidsetIdAttributeNS(java.lang.String namespaceURI, java.lang.String localName, boolean makeId)DOM Level 3: register the given attribute node as an ID attributevoidsetNodeValue(java.lang.String nodeValue)voidsetPrefix(java.lang.String prefix)voidsetStrictErrorChecking(boolean strictErrorChecking)voidsetTextContent(java.lang.String textContent)This attribute returns the text content of this node and its descendants.java.lang.ObjectsetUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)voidsetValue(java.lang.String value)voidsetXmlEncoding(java.lang.String xmlEncoding)voidsetXmlStandalone(boolean xmlStandalone)voidsetXmlVersion(java.lang.String xmlVersion)org.w3c.dom.TextsplitText(int offset)java.lang.StringsubstringData(int offset, int count)booleansupports(java.lang.String feature, java.lang.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
-
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.
-
equals
public final boolean equals(org.w3c.dom.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(java.lang.Object node)
Test for equality based on node number.- Overrides:
equalsin classjava.lang.Object- Parameters:
node- A DTM node proxy reference.- Returns:
- true if the given node has the same handle as this node.
-
sameNodeAs
public final boolean sameNodeAs(org.w3c.dom.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.
-
getNodeName
public final java.lang.String getNodeName()
- Specified by:
getNodeNamein interfaceorg.w3c.dom.Node- See Also:
Node
-
getTarget
public final java.lang.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 "" token that begins the PI.
In HTML, target is always null.
Note that getNodeName is aliased to getTarget.
- Specified by:
getTargetin interfaceorg.w3c.dom.ProcessingInstruction
-
getLocalName
public final java.lang.String getLocalName()
- Specified by:
getLocalNamein interfaceorg.w3c.dom.Node- See Also:
as of DOM Level 2
-
getPrefix
public final java.lang.String getPrefix()
- Specified by:
getPrefixin interfaceorg.w3c.dom.Node- Returns:
- The prefix for this node.
- See Also:
as of DOM Level 2
-
setPrefix
public final void setPrefix(java.lang.String prefix) throws org.w3c.dom.DOMException- Specified by:
setPrefixin interfaceorg.w3c.dom.Node- Parameters:
prefix-- Throws:
org.w3c.dom.DOMException- See Also:
as of DOM Level 2 -- DTMNodeProxy is read-only
-
getNamespaceURI
public final java.lang.String getNamespaceURI()
- Specified by:
getNamespaceURIin interfaceorg.w3c.dom.Node- See Also:
as of DOM Level 2
-
supports
public final boolean supports(java.lang.String feature, java.lang.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
-
isSupported
public final boolean isSupported(java.lang.String feature, java.lang.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.- Specified by:
isSupportedin interfaceorg.w3c.dom.Node- Parameters:
feature-version-- Returns:
- false
- See Also:
as of DOM Level 2
-
getNodeValue
public final java.lang.String getNodeValue() throws org.w3c.dom.DOMException- Specified by:
getNodeValuein interfaceorg.w3c.dom.Node- Throws:
org.w3c.dom.DOMException- See Also:
Node
-
getStringValue
public final java.lang.String getStringValue() throws org.w3c.dom.DOMException- Returns:
- The string value of the node
- Throws:
org.w3c.dom.DOMException
-
setNodeValue
public final void setNodeValue(java.lang.String nodeValue) throws org.w3c.dom.DOMException- Specified by:
setNodeValuein interfaceorg.w3c.dom.Node- Parameters:
nodeValue-- Throws:
org.w3c.dom.DOMException- See Also:
-- DTMNodeProxy is read-only
-
getNodeType
public final short getNodeType()
- Specified by:
getNodeTypein interfaceorg.w3c.dom.Node- See Also:
Node
-
getParentNode
public final org.w3c.dom.Node getParentNode()
- Specified by:
getParentNodein interfaceorg.w3c.dom.Node- See Also:
Node
-
getOwnerNode
public final org.w3c.dom.Node getOwnerNode()
- See Also:
Node
-
getChildNodes
public final org.w3c.dom.NodeList getChildNodes()
- Specified by:
getChildNodesin interfaceorg.w3c.dom.Node- See Also:
Node
-
getFirstChild
public final org.w3c.dom.Node getFirstChild()
- Specified by:
getFirstChildin interfaceorg.w3c.dom.Node- See Also:
Node
-
getLastChild
public final org.w3c.dom.Node getLastChild()
- Specified by:
getLastChildin interfaceorg.w3c.dom.Node- See Also:
Node
-
getPreviousSibling
public final org.w3c.dom.Node getPreviousSibling()
- Specified by:
getPreviousSiblingin interfaceorg.w3c.dom.Node- See Also:
Node
-
getNextSibling
public final org.w3c.dom.Node getNextSibling()
- Specified by:
getNextSiblingin interfaceorg.w3c.dom.Node- See Also:
Node
-
getAttributes
public final org.w3c.dom.NamedNodeMap getAttributes()
- Specified by:
getAttributesin interfaceorg.w3c.dom.Node- See Also:
Node
-
hasAttribute
public boolean hasAttribute(java.lang.String name)
Method hasAttribute- Specified by:
hasAttributein interfaceorg.w3c.dom.Element- Parameters:
name-
-
hasAttributeNS
public boolean hasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)Method hasAttributeNS- Specified by:
hasAttributeNSin interfaceorg.w3c.dom.Element- Parameters:
namespaceURI-localName-
-
getOwnerDocument
public final org.w3c.dom.Document getOwnerDocument()
- Specified by:
getOwnerDocumentin interfaceorg.w3c.dom.Node- See Also:
Node
-
insertBefore
public final org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) throws org.w3c.dom.DOMException- Specified by:
insertBeforein interfaceorg.w3c.dom.Node- Parameters:
newChild-refChild-- Throws:
org.w3c.dom.DOMException- See Also:
-- DTMNodeProxy is read-only
-
replaceChild
public final org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMException- Specified by:
replaceChildin interfaceorg.w3c.dom.Node- Parameters:
newChild-oldChild-- Throws:
org.w3c.dom.DOMException- See Also:
-- DTMNodeProxy is read-only
-
removeChild
public final org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMException- Specified by:
removeChildin interfaceorg.w3c.dom.Node- Parameters:
oldChild-- Throws:
org.w3c.dom.DOMException- See Also:
-- DTMNodeProxy is read-only
-
appendChild
public final org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild) throws org.w3c.dom.DOMException- Specified by:
appendChildin interfaceorg.w3c.dom.Node- Parameters:
newChild-- Throws:
org.w3c.dom.DOMException- See Also:
-- DTMNodeProxy is read-only
-
hasChildNodes
public final boolean hasChildNodes()
- Specified by:
hasChildNodesin interfaceorg.w3c.dom.Node- See Also:
Node
-
cloneNode
public final org.w3c.dom.Node cloneNode(boolean deep)
- Specified by:
cloneNodein interfaceorg.w3c.dom.Node- Parameters:
deep-- See Also:
-- DTMNodeProxy is read-only
-
getDoctype
public final org.w3c.dom.DocumentType getDoctype()
- Specified by:
getDoctypein interfaceorg.w3c.dom.Document- See Also:
Document
-
getImplementation
public final org.w3c.dom.DOMImplementation getImplementation()
- Specified by:
getImplementationin interfaceorg.w3c.dom.Document- See Also:
Document
-
getDocumentElement
public final org.w3c.dom.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?- Specified by:
getDocumentElementin interfaceorg.w3c.dom.Document- See Also:
Document
-
createElement
public final org.w3c.dom.Element createElement(java.lang.String tagName) throws org.w3c.dom.DOMException- Specified by:
createElementin interfaceorg.w3c.dom.Document- Parameters:
tagName-- Throws:
org.w3c.dom.DOMException- See Also:
Document
-
createDocumentFragment
public final org.w3c.dom.DocumentFragment createDocumentFragment()
- Specified by:
createDocumentFragmentin interfaceorg.w3c.dom.Document- See Also:
Document
-
createTextNode
public final org.w3c.dom.Text createTextNode(java.lang.String data)
- Specified by:
createTextNodein interfaceorg.w3c.dom.Document- Parameters:
data-- See Also:
Document
-
createComment
public final org.w3c.dom.Comment createComment(java.lang.String data)
- Specified by:
createCommentin interfaceorg.w3c.dom.Document- Parameters:
data-- See Also:
Document
-
createCDATASection
public final org.w3c.dom.CDATASection createCDATASection(java.lang.String data) throws org.w3c.dom.DOMException- Specified by:
createCDATASectionin interfaceorg.w3c.dom.Document- Parameters:
data-- Throws:
org.w3c.dom.DOMException- See Also:
Document
-
createProcessingInstruction
public final org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String target, java.lang.String data) throws org.w3c.dom.DOMException- Specified by:
createProcessingInstructionin interfaceorg.w3c.dom.Document- Parameters:
target-data-- Throws:
org.w3c.dom.DOMException- See Also:
Document
-
createAttribute
public final org.w3c.dom.Attr createAttribute(java.lang.String name) throws org.w3c.dom.DOMException- Specified by:
createAttributein interfaceorg.w3c.dom.Document- Parameters:
name-- Throws:
org.w3c.dom.DOMException- See Also:
Document
-
createEntityReference
public final org.w3c.dom.EntityReference createEntityReference(java.lang.String name) throws org.w3c.dom.DOMException- Specified by:
createEntityReferencein interfaceorg.w3c.dom.Document- Parameters:
name-- Throws:
org.w3c.dom.DOMException- See Also:
Document
-
getElementsByTagName
public final org.w3c.dom.NodeList getElementsByTagName(java.lang.String tagname)
- Specified by:
getElementsByTagNamein interfaceorg.w3c.dom.Document- Specified by:
getElementsByTagNamein interfaceorg.w3c.dom.Element- Parameters:
tagname-- See Also:
Document
-
importNode
public final org.w3c.dom.Node importNode(org.w3c.dom.Node importedNode, boolean deep) throws org.w3c.dom.DOMException- Specified by:
importNodein interfaceorg.w3c.dom.Document- Parameters:
importedNode-deep-- Throws:
org.w3c.dom.DOMException- See Also:
as of DOM Level 2 -- DTMNodeProxy is read-only
-
createElementNS
public final org.w3c.dom.Element createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws org.w3c.dom.DOMException- Specified by:
createElementNSin interfaceorg.w3c.dom.Document- Parameters:
namespaceURI-qualifiedName-- Throws:
org.w3c.dom.DOMException- See Also:
as of DOM Level 2
-
createAttributeNS
public final org.w3c.dom.Attr createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws org.w3c.dom.DOMException- Specified by:
createAttributeNSin interfaceorg.w3c.dom.Document- Parameters:
namespaceURI-qualifiedName-- Throws:
org.w3c.dom.DOMException- See Also:
as of DOM Level 2
-
getElementsByTagNameNS
public final org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)- Specified by:
getElementsByTagNameNSin interfaceorg.w3c.dom.Document- Specified by:
getElementsByTagNameNSin interfaceorg.w3c.dom.Element- Parameters:
namespaceURI-localName-- See Also:
as of DOM Level 2
-
getElementById
public final org.w3c.dom.Element getElementById(java.lang.String elementId)
- Specified by:
getElementByIdin interfaceorg.w3c.dom.Document- Parameters:
elementId-- See Also:
as of DOM Level 2
-
splitText
public final org.w3c.dom.Text splitText(int offset) throws org.w3c.dom.DOMException- Specified by:
splitTextin interfaceorg.w3c.dom.Text- Parameters:
offset-- Throws:
org.w3c.dom.DOMException- See Also:
Text
-
getData
public final java.lang.String getData() throws org.w3c.dom.DOMException- Specified by:
getDatain interfaceorg.w3c.dom.CharacterData- Specified by:
getDatain interfaceorg.w3c.dom.ProcessingInstruction- Throws:
org.w3c.dom.DOMException- See Also:
CharacterData
-
setData
public final void setData(java.lang.String data) throws org.w3c.dom.DOMException- Specified by:
setDatain interfaceorg.w3c.dom.CharacterData- Specified by:
setDatain interfaceorg.w3c.dom.ProcessingInstruction- Parameters:
data-- Throws:
org.w3c.dom.DOMException- See Also:
CharacterData
-
getLength
public final int getLength()
- Specified by:
getLengthin interfaceorg.w3c.dom.CharacterData- See Also:
CharacterData
-
substringData
public final java.lang.String substringData(int offset, int count) throws org.w3c.dom.DOMException- Specified by:
substringDatain interfaceorg.w3c.dom.CharacterData- Parameters:
offset-count-- Throws:
org.w3c.dom.DOMException- See Also:
CharacterData
-
appendData
public final void appendData(java.lang.String arg) throws org.w3c.dom.DOMException- Specified by:
appendDatain interfaceorg.w3c.dom.CharacterData- Parameters:
arg-- Throws:
org.w3c.dom.DOMException- See Also:
CharacterData
-
insertData
public final void insertData(int offset, java.lang.String arg) throws org.w3c.dom.DOMException- Specified by:
insertDatain interfaceorg.w3c.dom.CharacterData- Parameters:
offset-arg-- Throws:
org.w3c.dom.DOMException- See Also:
CharacterData
-
deleteData
public final void deleteData(int offset, int count) throws org.w3c.dom.DOMException- Specified by:
deleteDatain interfaceorg.w3c.dom.CharacterData- Parameters:
offset-count-- Throws:
org.w3c.dom.DOMException- See Also:
CharacterData
-
replaceData
public final void replaceData(int offset, int count, java.lang.String arg) throws org.w3c.dom.DOMException- Specified by:
replaceDatain interfaceorg.w3c.dom.CharacterData- Parameters:
offset-count-arg-- Throws:
org.w3c.dom.DOMException- See Also:
CharacterData
-
getTagName
public final java.lang.String getTagName()
- Specified by:
getTagNamein interfaceorg.w3c.dom.Element- See Also:
Element
-
getAttribute
public final java.lang.String getAttribute(java.lang.String name)
- Specified by:
getAttributein interfaceorg.w3c.dom.Element- Parameters:
name-- See Also:
Element
-
setAttribute
public final void setAttribute(java.lang.String name, java.lang.String value) throws org.w3c.dom.DOMException- Specified by:
setAttributein interfaceorg.w3c.dom.Element- Parameters:
name-value-- Throws:
org.w3c.dom.DOMException- See Also:
Element
-
removeAttribute
public final void removeAttribute(java.lang.String name) throws org.w3c.dom.DOMException- Specified by:
removeAttributein interfaceorg.w3c.dom.Element- Parameters:
name-- Throws:
org.w3c.dom.DOMException- See Also:
Element
-
getAttributeNode
public final org.w3c.dom.Attr getAttributeNode(java.lang.String name)
- Specified by:
getAttributeNodein interfaceorg.w3c.dom.Element- Parameters:
name-- See Also:
Element
-
setAttributeNode
public final org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr newAttr) throws org.w3c.dom.DOMException- Specified by:
setAttributeNodein interfaceorg.w3c.dom.Element- Parameters:
newAttr-- Throws:
org.w3c.dom.DOMException- See Also:
Element
-
removeAttributeNode
public final org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr oldAttr) throws org.w3c.dom.DOMException- Specified by:
removeAttributeNodein interfaceorg.w3c.dom.Element- Parameters:
oldAttr-- Throws:
org.w3c.dom.DOMException- See Also:
Element
-
hasAttributes
public boolean hasAttributes()
Introduced in DOM Level 2.- Specified by:
hasAttributesin interfaceorg.w3c.dom.Node
-
normalize
public final void normalize()
- Specified by:
normalizein interfaceorg.w3c.dom.Node- See Also:
Element
-
getAttributeNS
public final java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.String localName)- Specified by:
getAttributeNSin interfaceorg.w3c.dom.Element- Parameters:
namespaceURI-localName-- See Also:
Element
-
setAttributeNS
public final void setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value) throws org.w3c.dom.DOMException- Specified by:
setAttributeNSin interfaceorg.w3c.dom.Element- Parameters:
namespaceURI-qualifiedName-value-- Throws:
org.w3c.dom.DOMException- See Also:
Element
-
removeAttributeNS
public final void removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName) throws org.w3c.dom.DOMException- Specified by:
removeAttributeNSin interfaceorg.w3c.dom.Element- Parameters:
namespaceURI-localName-- Throws:
org.w3c.dom.DOMException- See Also:
Element
-
getAttributeNodeNS
public final org.w3c.dom.Attr getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)- Specified by:
getAttributeNodeNSin interfaceorg.w3c.dom.Element- Parameters:
namespaceURI-localName-- See Also:
Element
-
setAttributeNodeNS
public final org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr newAttr) throws org.w3c.dom.DOMException- Specified by:
setAttributeNodeNSin interfaceorg.w3c.dom.Element- Parameters:
newAttr-- Throws:
org.w3c.dom.DOMException- See Also:
Element
-
getName
public final java.lang.String getName()
- Specified by:
getNamein interfaceorg.w3c.dom.Attr- See Also:
Attr
-
getSpecified
public final boolean getSpecified()
- Specified by:
getSpecifiedin interfaceorg.w3c.dom.Attr- See Also:
Attr
-
getValue
public final java.lang.String getValue()
- Specified by:
getValuein interfaceorg.w3c.dom.Attr- See Also:
Attr
-
setValue
public final void setValue(java.lang.String value)
- Specified by:
setValuein interfaceorg.w3c.dom.Attr- Parameters:
value-- See Also:
Attr
-
getOwnerElement
public final org.w3c.dom.Element getOwnerElement()
Get the owner element of an attribute.- Specified by:
getOwnerElementin interfaceorg.w3c.dom.Attr- See Also:
as of DOM Level 2
-
adoptNode
public org.w3c.dom.Node adoptNode(org.w3c.dom.Node source) throws org.w3c.dom.DOMExceptionNEEDSDOC Method adoptNode NEEDSDOC @param source- Specified by:
adoptNodein interfaceorg.w3c.dom.Document- Throws:
org.w3c.dom.DOMException
-
getInputEncoding
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
nullwhen unspecified.- Specified by:
getInputEncodingin interfaceorg.w3c.dom.Document- Since:
- DOM Level 3
-
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 anyDOMException. In case of error, the behavior is undefined. This attribute istrueby defaults.- Specified by:
getStrictErrorCheckingin interfaceorg.w3c.dom.Document- Since:
- DOM Level 3
-
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 anyDOMException. In case of error, the behavior is undefined. This attribute istrueby defaults.- Specified by:
setStrictErrorCheckingin interfaceorg.w3c.dom.Document- Since:
- DOM Level 3 NEEDSDOC @param strictErrorChecking
-
setUserData
public java.lang.Object setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)- Specified by:
setUserDatain interfaceorg.w3c.dom.Node
-
getUserData
public java.lang.Object getUserData(java.lang.String key)
Retrieves the object associated to a key on a this node. The object must first have been set to this node by callingsetUserDatawith the same key.- Specified by:
getUserDatain interfaceorg.w3c.dom.Node- Parameters:
key- The key the object is associated to.- Returns:
- Returns the
DOMObjectassociated to the given key on this node, ornullif there was none. - Since:
- DOM Level 3
-
getFeature
public 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. The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in Mixed DOM implementations.- Specified by:
getFeaturein interfaceorg.w3c.dom.Node- Parameters:
feature- The name of the feature requested (case-insensitive).version- This is the version number of the feature to test. If the version isnullor 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
nullif there is no object which implements interfaces associated with that feature. If theDOMObjectreturned by this method implements theNodeinterface, it must delegate to the primary coreNodeand not return results inconsistent with the primary coreNodesuch as attributes, childNodes, etc. - Since:
- DOM Level 3
-
isEqualNode
public boolean isEqualNode(org.w3c.dom.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 withNode.isSameNode. All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied: The two nodes are of the same type.The following string attributes are equal:nodeName,localName,namespaceURI,prefix,nodeValue,baseURI. This is: they are bothnull, or they have the same length and are character for character identical. TheattributesNamedNodeMapsare equal. This is: they are bothnull, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.ThechildNodesNodeListsare equal. This is: they are bothnull, or they have the same length and contain equal nodes at the same index. This is true forAttrnodes as for any other type of node. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For twoDocumentTypenodes to be equal, the following conditions must also be satisfied: The following string attributes are equal:publicId,systemId,internalSubset.TheentitiesNamedNodeMapsare equal.ThenotationsNamedNodeMapsare equal.
On the other hand, the following do not affect equality: theownerDocumentattribute, thespecifiedattribute forAttrnodes, theisWhitespaceInElementContentattribute forTextnodes, as well as any user data or event listeners registered on the nodes.- Specified by:
isEqualNodein interfaceorg.w3c.dom.Node- Parameters:
arg- The node to compare equality with.deep- Iftrue, recursively compare the subtrees; iffalse, compare only the nodes themselves (and its attributes, if it is anElement).- Returns:
- If the nodes, and possibly subtrees are equal,
trueotherwisefalse. - Since:
- DOM Level 3
-
lookupNamespaceURI
public 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. Use lookupNamespaceURI(null) to lookup the default namespace- Specified by:
lookupNamespaceURIin interfaceorg.w3c.dom.Node- Parameters:
namespaceURI-- Returns:
- th URI for the namespace
- Since:
- DOM Level 3
-
isDefaultNamespace
public boolean isDefaultNamespace(java.lang.String namespaceURI)
DOM Level 3: This method checks if the specifiednamespaceURIis the default namespace or not.- Specified by:
isDefaultNamespacein interfaceorg.w3c.dom.Node- Parameters:
namespaceURI- The namespace URI to look for.- Returns:
trueif the specifiednamespaceURIis the default namespace,falseotherwise.- Since:
- DOM Level 3
-
lookupPrefix
public 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.- Specified by:
lookupPrefixin interfaceorg.w3c.dom.Node- Parameters:
namespaceURI-- Returns:
- the prefix for the namespace
-
isSameNode
public boolean isSameNode(org.w3c.dom.Node other)
Returns whether this node is the same node as the given one.
This method provides a way to determine whether twoNodereferences returned by the implementation reference the same object. When twoNodereferences are references to the same object, even if through a proxy, the references may be used completely interchangably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.- Specified by:
isSameNodein interfaceorg.w3c.dom.Node- Parameters:
other- The node to test against.- Returns:
- Returns
trueif the nodes are the same,falseotherwise. - Since:
- DOM Level 3
-
setTextContent
public void setTextContent(java.lang.String textContent) throws org.w3c.dom.DOMExceptionThis 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 singleTextnode 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 textContentattribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodesATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValueDOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
setTextContentin interfaceorg.w3c.dom.Node- Throws:
org.w3c.dom.DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.org.w3c.dom.DOMException- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMStringvariable on the implementation platform.- Since:
- DOM Level 3
-
getTextContent
public java.lang.String getTextContent() throws org.w3c.dom.DOMExceptionThis 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 singleTextnode 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 textContentattribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodesATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValueDOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
getTextContentin interfaceorg.w3c.dom.Node- Throws:
org.w3c.dom.DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.org.w3c.dom.DOMException- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMStringvariable on the implementation platform.- Since:
- DOM Level 3
-
compareDocumentPosition
public short compareDocumentPosition(org.w3c.dom.Node other) throws org.w3c.dom.DOMExceptionCompares a node with this node with regard to their position in the document.- Specified by:
compareDocumentPositionin interfaceorg.w3c.dom.Node- Parameters:
other- The node to compare against this node.- Returns:
- Returns how the given node is positioned relatively to this node.
- Throws:
org.w3c.dom.DOMException- Since:
- DOM Level 3
-
getBaseURI
public java.lang.String getBaseURI()
The absolute base URI of this node ornullif undefined. This value is computed according to . However, when theDocumentsupports 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 thedocumentURIattribute from theDocumentinterface otherwise.
When the node is anElement, aDocumentor a aProcessingInstruction, this attribute represents the properties [base URI] defined in . When the node is aNotation, anEntity, or anEntityReference, this attribute represents the properties [declaration base URI] in the . How will this be affected by resolution of relative namespace URIs issue?It's not.Should this only be on Document, Element, ProcessingInstruction, Entity, and Notation nodes, according to the infoset? If not, what is it equal to on other nodes? Null? An empty string? I think it should be the parent's.No.Should this be read-only and computed or and actual read-write attribute?Read-only and computed (F2F 19 Jun 2000 and teleconference 30 May 2001).If the base HTML element is not yet attached to a document, does the insert change the Document.baseURI? Yes. (F2F 26 Sep 2001)- Specified by:
getBaseURIin interfaceorg.w3c.dom.Node- Since:
- DOM Level 3
-
renameNode
public org.w3c.dom.Node renameNode(org.w3c.dom.Node n, java.lang.String namespaceURI, java.lang.String name) throws org.w3c.dom.DOMExceptionDOM Level 3 Renaming node- Specified by:
renameNodein interfaceorg.w3c.dom.Document- Throws:
org.w3c.dom.DOMException
-
normalizeDocument
public void normalizeDocument()
DOM Level 3 Normalize document.- Specified by:
normalizeDocumentin interfaceorg.w3c.dom.Document
-
getDomConfig
public org.w3c.dom.DOMConfiguration getDomConfig()
The configuration used whenDocument.normalizeDocumentis invoked.- Specified by:
getDomConfigin interfaceorg.w3c.dom.Document- Since:
- DOM Level 3
-
setDocumentURI
public void setDocumentURI(java.lang.String documentURI)
DOM Level 3- Specified by:
setDocumentURIin interfaceorg.w3c.dom.Document
-
getDocumentURI
public java.lang.String getDocumentURI()
DOM Level 3 The location of the document ornullif undefined.
Beware that when theDocumentsupports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.- Specified by:
getDocumentURIin interfaceorg.w3c.dom.Document- Since:
- DOM Level 3
-
getActualEncoding
public java.lang.String getActualEncoding()
DOM Level 3 An attribute specifying the actual encoding of this document. This isnullotherwise.
This attribute represents the property [character encoding scheme] defined in .- Since:
- DOM Level 3
-
setActualEncoding
public void setActualEncoding(java.lang.String value)
DOM Level 3 An attribute specifying the actual encoding of this document. This isnullotherwise.
This attribute represents the property [character encoding scheme] defined in .- Since:
- DOM Level 3
-
replaceWholeText
public org.w3c.dom.Text replaceWholeText(java.lang.String content) throws org.w3c.dom.DOMExceptionDOM Level 3- Specified by:
replaceWholeTextin interfaceorg.w3c.dom.Text- Throws:
org.w3c.dom.DOMException
-
getWholeText
public java.lang.String getWholeText()
DOM Level 3 Returns all text ofTextnodes logically-adjacent text nodes to this node, concatenated in document order.- Specified by:
getWholeTextin interfaceorg.w3c.dom.Text- 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".- Specified by:
isElementContentWhitespacein interfaceorg.w3c.dom.Text
-
setIdAttribute
public void setIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type.- Parameters:
id-
-
setIdAttribute
public void setIdAttribute(java.lang.String name, boolean makeId)DOM Level 3: register the given attribute node as an ID attribute- Specified by:
setIdAttributein interfaceorg.w3c.dom.Element
-
setIdAttributeNode
public void setIdAttributeNode(org.w3c.dom.Attr at, boolean makeId)DOM Level 3: register the given attribute node as an ID attribute- Specified by:
setIdAttributeNodein interfaceorg.w3c.dom.Element
-
setIdAttributeNS
public void setIdAttributeNS(java.lang.String namespaceURI, java.lang.String localName, boolean makeId)DOM Level 3: register the given attribute node as an ID attribute- Specified by:
setIdAttributeNSin interfaceorg.w3c.dom.Element
-
getSchemaTypeInfo
public org.w3c.dom.TypeInfo getSchemaTypeInfo()
- Specified by:
getSchemaTypeInfoin interfaceorg.w3c.dom.Attr- Specified by:
getSchemaTypeInfoin interfaceorg.w3c.dom.Element
-
isId
public boolean isId()
- Specified by:
isIdin interfaceorg.w3c.dom.Attr
-
getXmlEncoding
public java.lang.String getXmlEncoding()
- Specified by:
getXmlEncodingin interfaceorg.w3c.dom.Document
-
setXmlEncoding
public void setXmlEncoding(java.lang.String xmlEncoding)
-
getXmlStandalone
public boolean getXmlStandalone()
- Specified by:
getXmlStandalonein interfaceorg.w3c.dom.Document
-
setXmlStandalone
public void setXmlStandalone(boolean xmlStandalone) throws org.w3c.dom.DOMException- Specified by:
setXmlStandalonein interfaceorg.w3c.dom.Document- Throws:
org.w3c.dom.DOMException
-
getXmlVersion
public java.lang.String getXmlVersion()
- Specified by:
getXmlVersionin interfaceorg.w3c.dom.Document
-
setXmlVersion
public void setXmlVersion(java.lang.String xmlVersion) throws org.w3c.dom.DOMException- Specified by:
setXmlVersionin interfaceorg.w3c.dom.Document- Throws:
org.w3c.dom.DOMException
-
-