Class 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.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
    • Field Detail

      • dtm_

        public final DTM dtm_
        The DTM for this node.
      • node_

        final int node_
        The DTM node handle.
      • EMPTYSTRING

        private static final java.lang.String EMPTYSTRING
        The return value as Empty String.
        See Also:
        Constant Field Values
      • implementation

        static final org.w3c.dom.DOMImplementation implementation
        The DOMImplementation object
      • fDocumentURI

        protected java.lang.String fDocumentURI
      • xmlStandalone

        private boolean xmlStandalone
      • xmlVersion

        private java.lang.String xmlVersion
    • 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

      • 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)
        Overrides:
        equals in class java.lang.Object
      • getNodeName

        public final java.lang.String getNodeName()
        Specified by:
        getNodeName in interface org.w3c.dom.Node
      • getTarget

        public final java.lang.String getTarget()
        Specified by:
        getTarget in interface org.w3c.dom.ProcessingInstruction
      • getLocalName

        public final java.lang.String getLocalName()
        Specified by:
        getLocalName in interface org.w3c.dom.Node
      • getPrefix

        public final java.lang.String getPrefix()
        Specified by:
        getPrefix in interface org.w3c.dom.Node
      • setPrefix

        public final void setPrefix​(java.lang.String prefix)
                             throws org.w3c.dom.DOMException
        Specified by:
        setPrefix in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • getNamespaceURI

        public final java.lang.String getNamespaceURI()
        Specified by:
        getNamespaceURI in interface org.w3c.dom.Node
      • isSupported

        public final boolean isSupported​(java.lang.String feature,
                                         java.lang.String version)
        Specified by:
        isSupported in interface org.w3c.dom.Node
      • getNodeValue

        public final java.lang.String getNodeValue()
                                            throws org.w3c.dom.DOMException
        Specified by:
        getNodeValue in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • setNodeValue

        public final void setNodeValue​(java.lang.String nodeValue)
                                throws org.w3c.dom.DOMException
        Specified by:
        setNodeValue in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • getNodeType

        public final short getNodeType()
        Specified by:
        getNodeType in interface org.w3c.dom.Node
      • getParentNode

        public final org.w3c.dom.Node getParentNode()
        Specified by:
        getParentNode in interface org.w3c.dom.Node
      • getChildNodes

        public final org.w3c.dom.NodeList getChildNodes()
        Specified by:
        getChildNodes in interface org.w3c.dom.Node
      • getFirstChild

        public final org.w3c.dom.Node getFirstChild()
        Specified by:
        getFirstChild in interface org.w3c.dom.Node
      • getLastChild

        public final org.w3c.dom.Node getLastChild()
        Specified by:
        getLastChild in interface org.w3c.dom.Node
      • getPreviousSibling

        public final org.w3c.dom.Node getPreviousSibling()
        Specified by:
        getPreviousSibling in interface org.w3c.dom.Node
      • getNextSibling

        public final org.w3c.dom.Node getNextSibling()
        Specified by:
        getNextSibling in interface org.w3c.dom.Node
      • getAttributes

        public final org.w3c.dom.NamedNodeMap getAttributes()
        Specified by:
        getAttributes in interface org.w3c.dom.Node
      • hasAttribute

        public boolean hasAttribute​(java.lang.String name)
        Specified by:
        hasAttribute in interface org.w3c.dom.Element
      • hasAttributeNS

        public boolean hasAttributeNS​(java.lang.String namespaceURI,
                                      java.lang.String localName)
        Specified by:
        hasAttributeNS in interface org.w3c.dom.Element
      • getOwnerDocument

        public final org.w3c.dom.Document getOwnerDocument()
        Specified by:
        getOwnerDocument in interface org.w3c.dom.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:
        insertBefore in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • 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:
        replaceChild in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • removeChild

        public final org.w3c.dom.Node removeChild​(org.w3c.dom.Node oldChild)
                                           throws org.w3c.dom.DOMException
        Specified by:
        removeChild in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • appendChild

        public final org.w3c.dom.Node appendChild​(org.w3c.dom.Node newChild)
                                           throws org.w3c.dom.DOMException
        Specified by:
        appendChild in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • hasChildNodes

        public final boolean hasChildNodes()
        Specified by:
        hasChildNodes in interface org.w3c.dom.Node
      • cloneNode

        public final org.w3c.dom.Node cloneNode​(boolean deep)
        Specified by:
        cloneNode in interface org.w3c.dom.Node
      • getDoctype

        public final org.w3c.dom.DocumentType getDoctype()
        Specified by:
        getDoctype in interface org.w3c.dom.Document
      • getImplementation

        public final org.w3c.dom.DOMImplementation getImplementation()
        Specified by:
        getImplementation in interface org.w3c.dom.Document
      • getDocumentElement

        public final org.w3c.dom.Element getDocumentElement()
        Specified by:
        getDocumentElement in interface org.w3c.dom.Document
      • createElement

        public final org.w3c.dom.Element createElement​(java.lang.String tagName)
                                                throws org.w3c.dom.DOMException
        Specified by:
        createElement in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • createDocumentFragment

        public final org.w3c.dom.DocumentFragment createDocumentFragment()
        Specified by:
        createDocumentFragment in interface org.w3c.dom.Document
      • createTextNode

        public final org.w3c.dom.Text createTextNode​(java.lang.String data)
        Specified by:
        createTextNode in interface org.w3c.dom.Document
      • createComment

        public final org.w3c.dom.Comment createComment​(java.lang.String data)
        Specified by:
        createComment in interface org.w3c.dom.Document
      • createCDATASection

        public final org.w3c.dom.CDATASection createCDATASection​(java.lang.String data)
                                                          throws org.w3c.dom.DOMException
        Specified by:
        createCDATASection in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • createProcessingInstruction

        public final org.w3c.dom.ProcessingInstruction createProcessingInstruction​(java.lang.String target,
                                                                                   java.lang.String data)
                                                                            throws org.w3c.dom.DOMException
        Specified by:
        createProcessingInstruction in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • createAttribute

        public final org.w3c.dom.Attr createAttribute​(java.lang.String name)
                                               throws org.w3c.dom.DOMException
        Specified by:
        createAttribute in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • createEntityReference

        public final org.w3c.dom.EntityReference createEntityReference​(java.lang.String name)
                                                                throws org.w3c.dom.DOMException
        Specified by:
        createEntityReference in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • getElementsByTagName

        public final org.w3c.dom.NodeList getElementsByTagName​(java.lang.String tagname)
        Specified by:
        getElementsByTagName in interface org.w3c.dom.Document
        Specified by:
        getElementsByTagName in interface org.w3c.dom.Element
      • traverseChildren

        private void traverseChildren​(java.util.List<org.w3c.dom.Node> listVector,
                                      org.w3c.dom.Node tempNode,
                                      java.lang.String tagname,
                                      boolean isTagNameWildCard)
      • importNode

        public final org.w3c.dom.Node importNode​(org.w3c.dom.Node importedNode,
                                                 boolean deep)
                                          throws org.w3c.dom.DOMException
        Specified by:
        importNode in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • createElementNS

        public final org.w3c.dom.Element createElementNS​(java.lang.String namespaceURI,
                                                         java.lang.String qualifiedName)
                                                  throws org.w3c.dom.DOMException
        Specified by:
        createElementNS in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • createAttributeNS

        public final org.w3c.dom.Attr createAttributeNS​(java.lang.String namespaceURI,
                                                        java.lang.String qualifiedName)
                                                 throws org.w3c.dom.DOMException
        Specified by:
        createAttributeNS in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • getElementsByTagNameNS

        public final org.w3c.dom.NodeList getElementsByTagNameNS​(java.lang.String namespaceURI,
                                                                 java.lang.String localName)
        Specified by:
        getElementsByTagNameNS in interface org.w3c.dom.Document
        Specified by:
        getElementsByTagNameNS in interface org.w3c.dom.Element
      • traverseChildren

        private void traverseChildren​(java.util.List<org.w3c.dom.Node> listVector,
                                      org.w3c.dom.Node tempNode,
                                      java.lang.String namespaceURI,
                                      java.lang.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 org.w3c.dom.Element getElementById​(java.lang.String elementId)
        Specified by:
        getElementById in interface org.w3c.dom.Document
      • splitText

        public final org.w3c.dom.Text splitText​(int offset)
                                         throws org.w3c.dom.DOMException
        Specified by:
        splitText in interface org.w3c.dom.Text
        Throws:
        org.w3c.dom.DOMException
      • getData

        public final java.lang.String getData()
                                       throws org.w3c.dom.DOMException
        Specified by:
        getData in interface org.w3c.dom.CharacterData
        Specified by:
        getData in interface org.w3c.dom.ProcessingInstruction
        Throws:
        org.w3c.dom.DOMException
      • setData

        public final void setData​(java.lang.String data)
                           throws org.w3c.dom.DOMException
        Specified by:
        setData in interface org.w3c.dom.CharacterData
        Specified by:
        setData in interface org.w3c.dom.ProcessingInstruction
        Throws:
        org.w3c.dom.DOMException
      • getLength

        public final int getLength()
        Specified by:
        getLength in interface org.w3c.dom.CharacterData
      • substringData

        public final java.lang.String substringData​(int offset,
                                                    int count)
                                             throws org.w3c.dom.DOMException
        Specified by:
        substringData in interface org.w3c.dom.CharacterData
        Throws:
        org.w3c.dom.DOMException
      • appendData

        public final void appendData​(java.lang.String arg)
                              throws org.w3c.dom.DOMException
        Specified by:
        appendData in interface org.w3c.dom.CharacterData
        Throws:
        org.w3c.dom.DOMException
      • insertData

        public final void insertData​(int offset,
                                     java.lang.String arg)
                              throws org.w3c.dom.DOMException
        Specified by:
        insertData in interface org.w3c.dom.CharacterData
        Throws:
        org.w3c.dom.DOMException
      • deleteData

        public final void deleteData​(int offset,
                                     int count)
                              throws org.w3c.dom.DOMException
        Specified by:
        deleteData in interface org.w3c.dom.CharacterData
        Throws:
        org.w3c.dom.DOMException
      • replaceData

        public final void replaceData​(int offset,
                                      int count,
                                      java.lang.String arg)
                               throws org.w3c.dom.DOMException
        Specified by:
        replaceData in interface org.w3c.dom.CharacterData
        Throws:
        org.w3c.dom.DOMException
      • getTagName

        public final java.lang.String getTagName()
        Specified by:
        getTagName in interface org.w3c.dom.Element
      • getAttribute

        public final java.lang.String getAttribute​(java.lang.String name)
        Specified by:
        getAttribute in interface org.w3c.dom.Element
      • setAttribute

        public final void setAttribute​(java.lang.String name,
                                       java.lang.String value)
                                throws org.w3c.dom.DOMException
        Specified by:
        setAttribute in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException
      • removeAttribute

        public final void removeAttribute​(java.lang.String name)
                                   throws org.w3c.dom.DOMException
        Specified by:
        removeAttribute in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException
      • getAttributeNode

        public final org.w3c.dom.Attr getAttributeNode​(java.lang.String name)
        Specified by:
        getAttributeNode in interface org.w3c.dom.Element
      • setAttributeNode

        public final org.w3c.dom.Attr setAttributeNode​(org.w3c.dom.Attr newAttr)
                                                throws org.w3c.dom.DOMException
        Specified by:
        setAttributeNode in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException
      • removeAttributeNode

        public final org.w3c.dom.Attr removeAttributeNode​(org.w3c.dom.Attr oldAttr)
                                                   throws org.w3c.dom.DOMException
        Specified by:
        removeAttributeNode in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException
      • hasAttributes

        public boolean hasAttributes()
        Specified by:
        hasAttributes in interface org.w3c.dom.Node
      • normalize

        public final void normalize()
        Specified by:
        normalize in interface org.w3c.dom.Node
      • getAttributeNS

        public final java.lang.String getAttributeNS​(java.lang.String namespaceURI,
                                                     java.lang.String localName)
        Specified by:
        getAttributeNS in interface org.w3c.dom.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:
        setAttributeNS in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException
      • removeAttributeNS

        public final void removeAttributeNS​(java.lang.String namespaceURI,
                                            java.lang.String localName)
                                     throws org.w3c.dom.DOMException
        Specified by:
        removeAttributeNS in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException
      • getAttributeNodeNS

        public final org.w3c.dom.Attr getAttributeNodeNS​(java.lang.String namespaceURI,
                                                         java.lang.String localName)
        Specified by:
        getAttributeNodeNS in interface org.w3c.dom.Element
      • setAttributeNodeNS

        public final org.w3c.dom.Attr setAttributeNodeNS​(org.w3c.dom.Attr newAttr)
                                                  throws org.w3c.dom.DOMException
        Specified by:
        setAttributeNodeNS in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException
      • getName

        public final java.lang.String getName()
        Specified by:
        getName in interface org.w3c.dom.Attr
      • getSpecified

        public final boolean getSpecified()
        Specified by:
        getSpecified in interface org.w3c.dom.Attr
      • getValue

        public final java.lang.String getValue()
        Specified by:
        getValue in interface org.w3c.dom.Attr
      • setValue

        public final void setValue​(java.lang.String value)
        Specified by:
        setValue in interface org.w3c.dom.Attr
      • getOwnerElement

        public final org.w3c.dom.Element getOwnerElement()
        Specified by:
        getOwnerElement in interface org.w3c.dom.Attr
      • adoptNode

        public org.w3c.dom.Node adoptNode​(org.w3c.dom.Node source)
                                   throws org.w3c.dom.DOMException
        Specified by:
        adoptNode in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • getInputEncoding

        public java.lang.String getInputEncoding()
        Specified by:
        getInputEncoding in interface org.w3c.dom.Document
      • getStrictErrorChecking

        public boolean getStrictErrorChecking()
        Specified by:
        getStrictErrorChecking in interface org.w3c.dom.Document
      • setStrictErrorChecking

        public void setStrictErrorChecking​(boolean strictErrorChecking)
        Specified by:
        setStrictErrorChecking in interface org.w3c.dom.Document
      • setUserData

        public java.lang.Object setUserData​(java.lang.String key,
                                            java.lang.Object data,
                                            org.w3c.dom.UserDataHandler handler)
        Specified by:
        setUserData in interface org.w3c.dom.Node
      • getUserData

        public java.lang.Object getUserData​(java.lang.String key)
        Specified by:
        getUserData in interface org.w3c.dom.Node
      • getFeature

        public java.lang.Object getFeature​(java.lang.String feature,
                                           java.lang.String version)
        Specified by:
        getFeature in interface org.w3c.dom.Node
      • isEqualNode

        public boolean isEqualNode​(org.w3c.dom.Node arg)
        Specified by:
        isEqualNode in interface org.w3c.dom.Node
      • lookupNamespaceURI

        public java.lang.String lookupNamespaceURI​(java.lang.String specifiedPrefix)
        Specified by:
        lookupNamespaceURI in interface org.w3c.dom.Node
      • isDefaultNamespace

        public boolean isDefaultNamespace​(java.lang.String namespaceURI)
        Specified by:
        isDefaultNamespace in interface org.w3c.dom.Node
      • lookupPrefix

        public java.lang.String lookupPrefix​(java.lang.String namespaceURI)
        Specified by:
        lookupPrefix in interface org.w3c.dom.Node
      • isSameNode

        public boolean isSameNode​(org.w3c.dom.Node other)
        Specified by:
        isSameNode in interface org.w3c.dom.Node
      • setTextContent

        public void setTextContent​(java.lang.String textContent)
                            throws org.w3c.dom.DOMException
        Specified by:
        setTextContent in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • getTextContent

        public java.lang.String getTextContent()
                                        throws org.w3c.dom.DOMException
        Specified by:
        getTextContent in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • compareDocumentPosition

        public short compareDocumentPosition​(org.w3c.dom.Node other)
                                      throws org.w3c.dom.DOMException
        Specified by:
        compareDocumentPosition in interface org.w3c.dom.Node
        Throws:
        org.w3c.dom.DOMException
      • getBaseURI

        public java.lang.String getBaseURI()
        Specified by:
        getBaseURI in interface org.w3c.dom.Node
      • renameNode

        public org.w3c.dom.Node renameNode​(org.w3c.dom.Node n,
                                           java.lang.String namespaceURI,
                                           java.lang.String name)
                                    throws org.w3c.dom.DOMException
        Specified by:
        renameNode in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • normalizeDocument

        public void normalizeDocument()
        Specified by:
        normalizeDocument in interface org.w3c.dom.Document
      • getDomConfig

        public org.w3c.dom.DOMConfiguration getDomConfig()
        Specified by:
        getDomConfig in interface org.w3c.dom.Document
      • setDocumentURI

        public void setDocumentURI​(java.lang.String documentURI)
        Specified by:
        setDocumentURI in interface org.w3c.dom.Document
      • getDocumentURI

        public java.lang.String getDocumentURI()
        Specified by:
        getDocumentURI in interface org.w3c.dom.Document
      • replaceWholeText

        public org.w3c.dom.Text replaceWholeText​(java.lang.String content)
                                          throws org.w3c.dom.DOMException
        Specified by:
        replaceWholeText in interface org.w3c.dom.Text
        Throws:
        org.w3c.dom.DOMException
      • getWholeText

        public java.lang.String getWholeText()
        Specified by:
        getWholeText in interface org.w3c.dom.Text
      • isElementContentWhitespace

        public boolean isElementContentWhitespace()
        Specified by:
        isElementContentWhitespace in interface org.w3c.dom.Text
      • setIdAttribute

        public void setIdAttribute​(java.lang.String name,
                                   boolean makeId)
        Specified by:
        setIdAttribute in interface org.w3c.dom.Element
      • setIdAttributeNode

        public void setIdAttributeNode​(org.w3c.dom.Attr at,
                                       boolean makeId)
        Specified by:
        setIdAttributeNode in interface org.w3c.dom.Element
      • setIdAttributeNS

        public void setIdAttributeNS​(java.lang.String namespaceURI,
                                     java.lang.String localName,
                                     boolean makeId)
        Specified by:
        setIdAttributeNS in interface org.w3c.dom.Element
      • getSchemaTypeInfo

        public org.w3c.dom.TypeInfo getSchemaTypeInfo()
        Specified by:
        getSchemaTypeInfo in interface org.w3c.dom.Attr
        Specified by:
        getSchemaTypeInfo in interface org.w3c.dom.Element
      • isId

        public boolean isId()
        Specified by:
        isId in interface org.w3c.dom.Attr
      • getXmlEncoding

        public java.lang.String getXmlEncoding()
        Specified by:
        getXmlEncoding in interface org.w3c.dom.Document
      • getXmlStandalone

        public boolean getXmlStandalone()
        Specified by:
        getXmlStandalone in interface org.w3c.dom.Document
      • setXmlStandalone

        public void setXmlStandalone​(boolean xmlStandalone)
                              throws org.w3c.dom.DOMException
        Specified by:
        setXmlStandalone in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException
      • getXmlVersion

        public java.lang.String getXmlVersion()
        Specified by:
        getXmlVersion in interface org.w3c.dom.Document
      • setXmlVersion

        public void setXmlVersion​(java.lang.String xmlVersion)
                           throws org.w3c.dom.DOMException
        Specified by:
        setXmlVersion in interface org.w3c.dom.Document
        Throws:
        org.w3c.dom.DOMException