Package org.htmlunit.xpath.xml.dtm.ref

Class DTMNodeProxy

java.lang.Object

org.htmlunit.xpath.xml.dtm.ref.DTMNodeProxy

All Implemented Interfaces:

Attr, CharacterData, Comment, Document, DocumentFragment, Element, Node, ProcessingInstruction, Text

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	DTMNodeProxy.DTMNodeProxyImplementation	Inner class to support getDOMImplementation.

Field Summary

Fields

Modifier and Type	Field	Description
final DTM	dtm_	The DTM for this node.
private static final String	EMPTYSTRING	The return value as Empty String.
protected String	fDocumentURI
(package private) static final DOMImplementation	implementation	The DOMImplementation object
(package private) final int	node_	The DTM node handle.
private boolean	xmlStandalone
private String	xmlVersion

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

Modifier and Type	Method	Description
Node	adoptNode(Node source)
final Node	appendChild(Node newChild)
final void	appendData(String arg)
final Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
final Attr	createAttribute(String name)
final Attr	createAttributeNS(String namespaceURI, String qualifiedName)
final CDATASection	createCDATASection(String data)
final Comment	createComment(String data)
final DocumentFragment	createDocumentFragment()
final Element	createElement(String tagName)
final Element	createElementNS(String namespaceURI, String qualifiedName)
final EntityReference	createEntityReference(String name)
final ProcessingInstruction	createProcessingInstruction(String target, String data)
final Text	createTextNode(String data)
final void	deleteData(int offset, int count)
final boolean	equals(Object node)
final boolean	equals(Node node)	Test for equality based on node number.
final String	getAttribute(String name)
final Attr	getAttributeNode(String name)
final Attr	getAttributeNodeNS(String namespaceURI, String localName)
final String	getAttributeNS(String namespaceURI, String localName)
final NamedNodeMap	getAttributes()
String	getBaseURI()
final NodeList	getChildNodes()
final String	getData()
final DocumentType	getDoctype()
final Element	getDocumentElement()
String	getDocumentURI()
DOMConfiguration	getDomConfig()
final int	getDTMNodeNumber()	NON-DOM: Return the DTM node number
final Element	getElementById(String elementId)
final NodeList	getElementsByTagName(String tagname)
final NodeList	getElementsByTagNameNS(String namespaceURI, String localName)
Object	getFeature(String feature, String version)
final Node	getFirstChild()
final DOMImplementation	getImplementation()
String	getInputEncoding()
final Node	getLastChild()
final int	getLength()
final String	getLocalName()
final String	getName()
final String	getNamespaceURI()
final Node	getNextSibling()
final String	getNodeName()
final short	getNodeType()
final String	getNodeValue()
final Document	getOwnerDocument()
final Element	getOwnerElement()
final Node	getParentNode()
final String	getPrefix()
final Node	getPreviousSibling()
TypeInfo	getSchemaTypeInfo()
final boolean	getSpecified()
boolean	getStrictErrorChecking()
final String	getTagName()
final String	getTarget()
String	getTextContent()
Object	getUserData(String key)
final String	getValue()
String	getWholeText()
String	getXmlEncoding()
boolean	getXmlStandalone()
String	getXmlVersion()
boolean	hasAttribute(String name)
boolean	hasAttributeNS(String namespaceURI, String localName)
boolean	hasAttributes()
final boolean	hasChildNodes()
final Node	importNode(Node importedNode, boolean deep)
final Node	insertBefore(Node newChild, Node refChild)
final void	insertData(int offset, String arg)
boolean	isDefaultNamespace(String namespaceURI)
boolean	isElementContentWhitespace()
boolean	isEqualNode(Node arg)
boolean	isId()
boolean	isSameNode(Node other)
final boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String specifiedPrefix)
String	lookupPrefix(String namespaceURI)
final void	normalize()
void	normalizeDocument()
final void	removeAttribute(String name)
final Attr	removeAttributeNode(Attr oldAttr)
final void	removeAttributeNS(String namespaceURI, String localName)
final Node	removeChild(Node oldChild)
Node	renameNode(Node n, String namespaceURI, String name)
final Node	replaceChild(Node newChild, Node oldChild)
final void	replaceData(int offset, int count, String arg)
Text	replaceWholeText(String content)
final void	setAttribute(String name, String value)
final Attr	setAttributeNode(Attr newAttr)
final Attr	setAttributeNodeNS(Attr newAttr)
final void	setAttributeNS(String namespaceURI, String qualifiedName, String value)
final void	setData(String data)
void	setDocumentURI(String documentURI)
void	setIdAttribute(String name, boolean makeId)
void	setIdAttributeNode(Attr at, boolean makeId)
void	setIdAttributeNS(String namespaceURI, String localName, boolean makeId)
final void	setNodeValue(String nodeValue)
final void	setPrefix(String prefix)
void	setStrictErrorChecking(boolean strictErrorChecking)
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
final void	setValue(String value)
void	setXmlStandalone(boolean xmlStandalone)
void	setXmlVersion(String xmlVersion)
final Text	splitText(int offset)
final String	substringData(int offset, int count)
private void	traverseChildren(List<Node> listVector, Node tempNode, String tagname, boolean isTagNameWildCard)
private void	traverseChildren(List<Node> listVector, Node tempNode, String namespaceURI, String localname, boolean isNamespaceURIWildCard, boolean isLocalNameWildCard)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dtm_

public final DTM dtm_

The DTM for this node.

node_

final int node_

The DTM node handle.

EMPTYSTRING

private static final String EMPTYSTRING

The return value as Empty String.

See Also:

• Constant Field Values

implementation

static final DOMImplementation implementation

The DOMImplementation object

fDocumentURI

protected String fDocumentURI

xmlStandalone

private boolean xmlStandalone

xmlVersion

private String xmlVersion

Constructor Details

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 Details

getDTMNodeNumber

public final int getDTMNodeNumber()

NON-DOM: Return the DTM node number

Returns:

The DTM node handle.

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)

Overrides:

equals in class Object

getNodeName

public final String getNodeName()

Specified by:

getNodeName in interface Node

getTarget

public final String getTarget()

Specified by:

getTarget in interface ProcessingInstruction

getLocalName

public final String getLocalName()

Specified by:

getLocalName in interface Node

getPrefix

public final String getPrefix()

Specified by:

getPrefix in interface Node

setPrefix

public final void setPrefix(String prefix)
                     throws DOMException

Specified by:

setPrefix in interface Node

Throws:

DOMException

getNamespaceURI

public final String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

isSupported

public final boolean isSupported(String feature,
 String version)

Specified by:

isSupported in interface Node

getNodeValue

public final String getNodeValue()
                          throws DOMException

Specified by:

getNodeValue in interface Node

Throws:

DOMException

setNodeValue

public final void setNodeValue(String nodeValue)
                        throws DOMException

Specified by:

setNodeValue in interface Node

Throws:

DOMException

getNodeType

public final short getNodeType()

Specified by:

getNodeType in interface Node

getParentNode

public final Node getParentNode()

Specified by:

getParentNode in interface Node

getChildNodes

public final NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getFirstChild

public final Node getFirstChild()

Specified by:

getFirstChild in interface Node

getLastChild

public final Node getLastChild()

Specified by:

getLastChild in interface Node

getPreviousSibling

public final Node getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

getNextSibling

public final Node getNextSibling()

Specified by:

getNextSibling in interface Node

getAttributes

public final NamedNodeMap getAttributes()

Specified by:

getAttributes in interface Node

hasAttribute

public boolean hasAttribute(String name)

Specified by:

hasAttribute in interface Element

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
 String localName)

Specified by:

hasAttributeNS in interface Element

getOwnerDocument

public final Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

insertBefore

public final Node insertBefore(Node newChild,
 Node refChild)
                        throws DOMException

Specified by:

insertBefore in interface Node

Throws:

DOMException

replaceChild

public final Node replaceChild(Node newChild,
 Node oldChild)
                        throws DOMException

Specified by:

replaceChild in interface Node

Throws:

DOMException

removeChild

public final Node removeChild(Node oldChild)
                       throws DOMException

Specified by:

removeChild in interface Node

Throws:

DOMException

appendChild

public final Node appendChild(Node newChild)
                       throws DOMException

Specified by:

appendChild in interface Node

Throws:

DOMException

hasChildNodes

public final boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

cloneNode

public final Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

getDoctype

public final DocumentType getDoctype()

Specified by:

getDoctype in interface Document

getImplementation

public final DOMImplementation getImplementation()

Specified by:

getImplementation in interface Document

getDocumentElement

public final Element getDocumentElement()

Specified by:

getDocumentElement in interface Document

createElement

public final Element createElement(String tagName)
                            throws DOMException

Specified by:

createElement in interface Document

Throws:

DOMException

createDocumentFragment

public final DocumentFragment createDocumentFragment()

Specified by:

createDocumentFragment in interface Document

createTextNode

public final Text createTextNode(String data)

Specified by:

createTextNode in interface Document

createComment

public final Comment createComment(String data)

Specified by:

createComment in interface Document

createCDATASection

public final CDATASection createCDATASection(String data)
                                      throws DOMException

Specified by:

createCDATASection in interface Document

Throws:

DOMException

createProcessingInstruction

public final ProcessingInstruction createProcessingInstruction(String target,
 String data)
                                                        throws DOMException

Specified by:

createProcessingInstruction in interface Document

Throws:

DOMException

createAttribute

public final Attr createAttribute(String name)
                           throws DOMException

Specified by:

createAttribute in interface Document

Throws:

DOMException

createEntityReference

public final EntityReference createEntityReference(String name)
                                            throws DOMException

Specified by:

createEntityReference in interface Document

Throws:

DOMException

getElementsByTagName

public final NodeList getElementsByTagName(String tagname)

Specified by:

getElementsByTagName in interface Document

Specified by:

getElementsByTagName in interface Element

traverseChildren

private void traverseChildren(List<Node> listVector,
 Node tempNode,
 String tagname,
 boolean isTagNameWildCard)

importNode

public final Node importNode(Node importedNode,
 boolean deep)
                      throws DOMException

Specified by:

importNode in interface Document

Throws:

DOMException

createElementNS

public final Element createElementNS(String namespaceURI,
 String qualifiedName)
                              throws DOMException

Specified by:

createElementNS in interface Document

Throws:

DOMException

createAttributeNS

public final Attr createAttributeNS(String namespaceURI,
 String qualifiedName)
                             throws DOMException

Specified by:

createAttributeNS in interface Document

Throws:

DOMException

getElementsByTagNameNS

public final NodeList getElementsByTagNameNS(String namespaceURI,
 String localName)

Specified by:

getElementsByTagNameNS in interface Document

Specified by:

getElementsByTagNameNS in interface Element

traverseChildren

private void traverseChildren(List<Node> listVector,
 Node tempNode,
 String namespaceURI,
 String localname,
 boolean isNamespaceURIWildCard,
 boolean isLocalNameWildCard)

Parameters:

listVector -

tempNode -

namespaceURI -

localname -

isNamespaceURIWildCard -

isLocalNameWildCard -

Private method to be used for recursive iterations to obtain elements by tag name and namespaceURI.

getElementById

public final Element getElementById(String elementId)

Specified by:

getElementById in interface Document

splitText

public final Text splitText(int offset)
                     throws DOMException

Specified by:

splitText in interface Text

Throws:

DOMException

getData

public final String getData()
                     throws DOMException

Specified by:

getData in interface CharacterData

Specified by:

getData in interface ProcessingInstruction

Throws:

DOMException

setData

public final void setData(String data)
                   throws DOMException

Specified by:

setData in interface CharacterData

Specified by:

setData in interface ProcessingInstruction

Throws:

DOMException

getLength

public final int getLength()

Specified by:

getLength in interface CharacterData

substringData

public final String substringData(int offset,
 int count)
                           throws DOMException

Specified by:

substringData in interface CharacterData

Throws:

DOMException

appendData

public final void appendData(String arg)
                      throws DOMException

Specified by:

appendData in interface CharacterData

Throws:

DOMException

insertData

public final void insertData(int offset,
 String arg)
                      throws DOMException

Specified by:

insertData in interface CharacterData

Throws:

DOMException

deleteData

public final void deleteData(int offset,
 int count)
                      throws DOMException

Specified by:

deleteData in interface CharacterData

Throws:

DOMException

replaceData

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

Specified by:

replaceData in interface CharacterData

Throws:

DOMException

getTagName

public final String getTagName()

Specified by:

getTagName in interface Element

getAttribute

public final String getAttribute(String name)

Specified by:

getAttribute in interface Element

setAttribute

public final void setAttribute(String name,
 String value)
                        throws DOMException

Specified by:

setAttribute in interface Element

Throws:

DOMException

removeAttribute

public final void removeAttribute(String name)
                           throws DOMException

Specified by:

removeAttribute in interface Element

Throws:

DOMException

getAttributeNode

public final Attr getAttributeNode(String name)

Specified by:

getAttributeNode in interface Element

setAttributeNode

public final Attr setAttributeNode(Attr newAttr)
                            throws DOMException

Specified by:

setAttributeNode in interface Element

Throws:

DOMException

removeAttributeNode

public final Attr removeAttributeNode(Attr oldAttr)
                               throws DOMException

Specified by:

removeAttributeNode in interface Element

Throws:

DOMException

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

normalize

public final void normalize()

Specified by:

normalize in interface Node

getAttributeNS

public final String getAttributeNS(String namespaceURI,
 String localName)

Specified by:

getAttributeNS in interface Element

setAttributeNS

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

Specified by:

setAttributeNS in interface Element

Throws:

DOMException

removeAttributeNS

public final void removeAttributeNS(String namespaceURI,
 String localName)
                             throws DOMException

Specified by:

removeAttributeNS in interface Element

Throws:

DOMException

getAttributeNodeNS

public final Attr getAttributeNodeNS(String namespaceURI,
 String localName)

Specified by:

getAttributeNodeNS in interface Element

setAttributeNodeNS

public final Attr setAttributeNodeNS(Attr newAttr)
                              throws DOMException

Specified by:

setAttributeNodeNS in interface Element

Throws:

DOMException

getName

public final String getName()

Specified by:

getName in interface Attr

getSpecified

public final boolean getSpecified()

Specified by:

getSpecified in interface Attr

getValue

public final String getValue()

Specified by:

getValue in interface Attr

setValue

public final void setValue(String value)

Specified by:

setValue in interface Attr

getOwnerElement

public final Element getOwnerElement()

Specified by:

getOwnerElement in interface Attr

adoptNode

public Node adoptNode(Node source)
               throws DOMException

Specified by:

adoptNode in interface Document

Throws:

DOMException

getInputEncoding

public String getInputEncoding()

Specified by:

getInputEncoding in interface Document

getStrictErrorChecking

public boolean getStrictErrorChecking()

Specified by:

getStrictErrorChecking in interface Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

Specified by:

setStrictErrorChecking in interface Document

setUserData

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

Specified by:

setUserData in interface Node

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

getFeature

public Object getFeature(String feature,
 String version)

Specified by:

getFeature in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String specifiedPrefix)

Specified by:

lookupNamespaceURI in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

renameNode

public Node renameNode(Node n,
 String namespaceURI,
 String name)
                throws DOMException

Specified by:

renameNode in interface Document

Throws:

DOMException

normalizeDocument

public void normalizeDocument()

Specified by:

normalizeDocument in interface Document

getDomConfig

public DOMConfiguration getDomConfig()

Specified by:

getDomConfig in interface Document

setDocumentURI

public void setDocumentURI(String documentURI)

Specified by:

setDocumentURI in interface Document

getDocumentURI

public String getDocumentURI()

Specified by:

getDocumentURI in interface Document

replaceWholeText

public Text replaceWholeText(String content)
                      throws DOMException

Specified by:

replaceWholeText in interface Text

Throws:

DOMException

getWholeText

public String getWholeText()

Specified by:

getWholeText in interface Text

isElementContentWhitespace

public boolean isElementContentWhitespace()

Specified by:

isElementContentWhitespace in interface Text

setIdAttribute

public void setIdAttribute(String name,
 boolean makeId)

Specified by:

setIdAttribute in interface Element

setIdAttributeNode

public void setIdAttributeNode(Attr at,
 boolean makeId)

Specified by:

setIdAttributeNode in interface Element

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
 String localName,
 boolean makeId)

Specified by:

setIdAttributeNS in interface Element

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface Attr

Specified by:

getSchemaTypeInfo in interface Element

isId

public boolean isId()

Specified by:

isId in interface Attr

getXmlEncoding

public String getXmlEncoding()

Specified by:

getXmlEncoding in interface Document

getXmlStandalone

public boolean getXmlStandalone()

Specified by:

getXmlStandalone in interface Document

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException

Specified by:

setXmlStandalone in interface Document

Throws:

DOMException

getXmlVersion

public String getXmlVersion()

Specified by:

getXmlVersion in interface Document

setXmlVersion

public void setXmlVersion(String xmlVersion)
                   throws DOMException

Specified by:

setXmlVersion in interface Document

Throws:

DOMException