FileDocCategorySizeDatePackage
DTMNodeProxy.javaAPI DocJava SE 6 API64653Tue Jun 10 00:22:58 BST 2008com.sun.org.apache.xml.internal.dtm.ref

DTMNodeProxy

public class DTMNodeProxy extends Object implements Comment, Node, Element, Text, Document, Attr, ProcessingInstruction, 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
org.w3c.dom

Fields Summary
public DTM
dtm
The DTM for this node.
int
node
The DTM node handle.
private static final String
EMPTYSTRING
The return value as Empty String.
static final DOMImplementation
implementation
The DOMImplementation object
protected String
fDocumentURI
DOM Level 3 feature: documentURI
protected String
actualEncoding
DOM Level 3 feature: Document actualEncoding
private String
xmlEncoding
private boolean
xmlStandalone
private String
xmlVersion
Constructors Summary
public DTMNodeProxy(DTM dtm, int node)
Create a DTMNodeProxy Node representing a specific Node in a DTM

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


                              
      
  
    this.dtm = dtm;
    this.node = node;
  
Methods Summary
public org.w3c.dom.NodeadoptNode(org.w3c.dom.Node source)
NEEDSDOC Method adoptNode NEEDSDOC @param source NEEDSDOC (adoptNode) @return

throws
DOMException


    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.NodeappendChild(org.w3c.dom.Node newChild)

param
newChild
throws
DOMException
see
org.w3c.dom.Node -- DTMNodeProxy is read-only

    throw new DTMDOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR);
  
public final voidappendData(java.lang.String arg)

param
arg
throws
DOMException
see
org.w3c.dom.CharacterData

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.NodecloneNode(boolean deep)

param
deep
see
org.w3c.dom.Node -- DTMNodeProxy is read-only

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public shortcompareDocumentPosition(org.w3c.dom.Node other)
Compares a node with this node with regard to their position in the document.

param
other The node to compare against this node.
return
Returns how the given node is positioned relatively to this node.
since
DOM Level 3

        return 0;
    
public final org.w3c.dom.AttrcreateAttribute(java.lang.String name)

param
name
throws
DOMException
see
org.w3c.dom.Document

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.AttrcreateAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName)

param
namespaceURI
param
qualifiedName
throws
DOMException
see
org.w3c.dom.Document as of DOM Level 2

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.CDATASectioncreateCDATASection(java.lang.String data)

param
data
throws
DOMException
see
org.w3c.dom.Document

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.CommentcreateComment(java.lang.String data)

param
data
see
org.w3c.dom.Document

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.DocumentFragmentcreateDocumentFragment()

see
org.w3c.dom.Document

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.ElementcreateElement(java.lang.String tagName)

param
tagName
throws
DOMException
see
org.w3c.dom.Document

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.ElementcreateElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName)

param
namespaceURI
param
qualifiedName
throws
DOMException
see
org.w3c.dom.Document as of DOM Level 2

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.EntityReferencecreateEntityReference(java.lang.String name)

param
name
throws
DOMException
see
org.w3c.dom.Document

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.ProcessingInstructioncreateProcessingInstruction(java.lang.String target, java.lang.String data)

param
target
param
data
throws
DOMException
see
org.w3c.dom.Document

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.TextcreateTextNode(java.lang.String data)

param
data
see
org.w3c.dom.Document

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final voiddeleteData(int offset, int count)

param
offset
param
count
throws
DOMException
see
org.w3c.dom.CharacterData

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final booleanequals(org.w3c.dom.Node node)
Test for equality based on node number.

param
node A DTM node proxy reference.
return
true if the given node has the same handle as this node.


    try
    {
      DTMNodeProxy dtmp = (DTMNodeProxy) node;

      // return (dtmp.node == this.node);
      // Patch attributed to Gary L Peskin <garyp@firstech.com>
      return (dtmp.node == this.node) && (dtmp.dtm == this.dtm);
    }
    catch (ClassCastException cce)
    {
      return false;
    }
  
public final booleanequals(java.lang.Object node)
Test for equality based on node number.

param
node A DTM node proxy reference.
return
true if the given node has the same handle as this node.


    try
    {

      // DTMNodeProxy dtmp = (DTMNodeProxy)node;
      // return (dtmp.node == this.node);
      // Patch attributed to Gary L Peskin <garyp@firstech.com>
      return equals((Node) node);
    }
    catch (ClassCastException cce)
    {
      return false;
    }
  
public java.lang.StringgetActualEncoding()
DOM Level 3 An attribute specifying the actual encoding of this document. This is null otherwise.
This attribute represents the property [character encoding scheme] defined in .

since
DOM Level 3

        return actualEncoding;
    
public final java.lang.StringgetAttribute(java.lang.String name)

param
name
see
org.w3c.dom.Element


    DTMNamedNodeMap  map = new DTMNamedNodeMap(dtm, node);
    Node node = map.getNamedItem(name);
    return (null == node) ? EMPTYSTRING : node.getNodeValue();  
public final java.lang.StringgetAttributeNS(java.lang.String namespaceURI, java.lang.String localName)

param
namespaceURI
param
localName
see
org.w3c.dom.Element

    Node retNode = null;
    int n = dtm.getAttributeNode(node,namespaceURI,localName);
    if(n != DTM.NULL)
            retNode = dtm.getNode(n);
    return (null == retNode) ? EMPTYSTRING : retNode.getNodeValue();
  
public final org.w3c.dom.AttrgetAttributeNode(java.lang.String name)

param
name
see
org.w3c.dom.Element


    DTMNamedNodeMap  map = new DTMNamedNodeMap(dtm, node);
    return (Attr)map.getNamedItem(name);
  
public final org.w3c.dom.AttrgetAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)

param
namespaceURI
param
localName
see
org.w3c.dom.Element

       Attr retAttr = null;
       int n = dtm.getAttributeNode(node,namespaceURI,localName);
       if(n != DTM.NULL)
               retAttr = (Attr) dtm.getNode(n);
       return retAttr;

  
public final org.w3c.dom.NamedNodeMapgetAttributes()

see
org.w3c.dom.Node


    return new DTMNamedNodeMap(dtm, node);
  
public java.lang.StringgetBaseURI()
The absolute base URI of this node or null if undefined. This value is computed according to . However, when the Document supports the feature "HTML" , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise.
When the node is an Element, a Document or a a ProcessingInstruction, this attribute represents the properties [base URI] defined in . When the node is a Notation, an Entity, or an EntityReference, this attribute represents the properties [declaration base URI] in the . How will this be affected by resolution of relative namespace URIs issue?It's not.Should this only be on Document, Element, ProcessingInstruction, Entity, and Notation nodes, according to the infoset? If not, what is it equal to on other nodes? Null? An empty string? I think it should be the parent's.No.Should this be read-only and computed or and actual read-write attribute?Read-only and computed (F2F 19 Jun 2000 and teleconference 30 May 2001).If the base HTML element is not yet attached to a document, does the insert change the Document.baseURI? Yes. (F2F 26 Sep 2001)

since
DOM Level 3

        return null;
    
public final org.w3c.dom.NodeListgetChildNodes()

see
org.w3c.dom.Node

                
    // Annoyingly, AxisIterators do not currently implement DTMIterator, so
    // we can't just wap DTMNodeList around an Axis.CHILD iterator.
    // Instead, we've created a special-case operating mode for that object.
    return new DTMChildIterNodeList(dtm,node);

    // throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final com.sun.org.apache.xml.internal.dtm.DTMgetDTM()
NON-DOM: Return the DTM model

return
The DTM that this proxy is a representative for.

    return dtm;
  
public final intgetDTMNodeNumber()
NON-DOM: Return the DTM node number

return
The DTM node handle.

    return node;
  
public final java.lang.StringgetData()

throws
DOMException
see
org.w3c.dom.CharacterData

    return dtm.getNodeValue(node);
  
public final org.w3c.dom.DocumentTypegetDoctype()

see
org.w3c.dom.Document

    return null;
  
public final 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. We can make it work in the well-formed cases but would that be confusing for others?

see
org.w3c.dom.Document

		int dochandle=dtm.getDocument();
		int elementhandle=DTM.NULL;
		for(int kidhandle=dtm.getFirstChild(dochandle);
				kidhandle!=DTM.NULL;
				kidhandle=dtm.getNextSibling(kidhandle))
		{
			switch(dtm.getNodeType(kidhandle))
			{
			case Node.ELEMENT_NODE:
				if(elementhandle!=DTM.NULL) 
				{
					elementhandle=DTM.NULL; // More than one; ill-formed.
					kidhandle=dtm.getLastChild(dochandle); // End loop
				}
				else
					elementhandle=kidhandle;
				break;
				
			// These are harmless; document is still wellformed
			case Node.COMMENT_NODE:
			case Node.PROCESSING_INSTRUCTION_NODE:
			case Node.DOCUMENT_TYPE_NODE:
				break;
					
			default:
				elementhandle=DTM.NULL; // ill-formed
				kidhandle=dtm.getLastChild(dochandle); // End loop
				break;
			}
		}
		if(elementhandle==DTM.NULL)
			throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
		else
			return (Element)(dtm.getNode(elementhandle));
  
public java.lang.StringgetDocumentURI()
DOM Level 3 The location of the document or null if undefined.
Beware that when the Document supports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.

since
DOM Level 3

        return fDocumentURI;
    
public org.w3c.dom.DOMConfigurationgetDomConfig()
The configuration used when Document.normalizeDocument is invoked.

since
DOM Level 3

       return null;
    
public final org.w3c.dom.ElementgetElementById(java.lang.String elementId)

param
elementId
see
org.w3c.dom.Document as of DOM Level 2

       return (Element) dtm.getNode(dtm.getElementById(elementId));
  
public final org.w3c.dom.NodeListgetElementsByTagName(java.lang.String tagname)

param
tagname
see
org.w3c.dom.Document

       Vector listVector = new Vector();
       Node retNode = dtm.getNode(node);
       if (retNode != null) 
       {
         boolean isTagNameWildCard = "*".equals(tagname);
         if (DTM.ELEMENT_NODE == retNode.getNodeType()) 
         {
           NodeList nodeList = retNode.getChildNodes();
           for (int i = 0; i < nodeList.getLength(); i++) 
           {
             traverseChildren(listVector, nodeList.item(i), tagname,
                              isTagNameWildCard);
           }
         } else if (DTM.DOCUMENT_NODE == retNode.getNodeType()) {
           traverseChildren(listVector, dtm.getNode(node), tagname,
                            isTagNameWildCard);
         }
       }
       int size = listVector.size();
       NodeSet nodeSet = new NodeSet(size);
       for (int i = 0; i < size; i++) 
       {
         nodeSet.addNode((Node) listVector.elementAt(i));
       }
       return (NodeList) nodeSet;
  
public final org.w3c.dom.NodeListgetElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)

param
namespaceURI
param
localName
see
org.w3c.dom.Document as of DOM Level 2

    Vector listVector = new Vector();
    Node retNode = dtm.getNode(node);
    if (retNode != null)
    {               
      boolean isNamespaceURIWildCard = "*".equals(namespaceURI);
      boolean isLocalNameWildCard    = "*".equals(localName);
      if (DTM.ELEMENT_NODE == retNode.getNodeType())
      {
        NodeList nodeList = retNode.getChildNodes();                    
        for(int i = 0; i < nodeList.getLength(); i++)
        {
          traverseChildren(listVector, nodeList.item(i), namespaceURI, localName, isNamespaceURIWildCard, isLocalNameWildCard);
        }
      }
      else if(DTM.DOCUMENT_NODE == retNode.getNodeType())
      {
        traverseChildren(listVector, dtm.getNode(node), namespaceURI, localName, isNamespaceURIWildCard, isLocalNameWildCard);
      }
    }
    int size = listVector.size();
    NodeSet nodeSet = new NodeSet(size);
    for (int i = 0; i < size; i++)
    {
      nodeSet.addNode((Node)listVector.elementAt(i));
    }
    return (NodeList) nodeSet;
  
public 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. 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.

param
feature The name of the feature requested (case-insensitive).
param
version This is the version number of the feature to test. If the version is null or the empty string, supporting any version of the feature will cause the method to return an object that supports at least one version of the feature.
return
Returns an object which implements the specialized APIs of the specified feature and version, if any, or null if there is no object which implements interfaces associated with that feature. If the DOMObject returned by this method implements the Node interface, it must delegate to the primary core Node and not return results inconsistent with the primary core Node such as attributes, childNodes, etc.
since
DOM Level 3

        // we don't have any alternate node, either this node does the job
        // or we don't have anything that does
        return isSupported(feature, version) ? this : null;
    
public final org.w3c.dom.NodegetFirstChild()

see
org.w3c.dom.Node


    int newnode = dtm.getFirstChild(node);

    return (newnode == DTM.NULL) ? null : dtm.getNode(newnode);
  
public final org.w3c.dom.DOMImplementationgetImplementation()

see
org.w3c.dom.Document

    return implementation;
  
public java.lang.StringgetInputEncoding()

EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..

An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified.

since
DOM Level 3 NEEDSDOC ($objectName$) @return


    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.NodegetLastChild()

see
org.w3c.dom.Node


    int newnode = dtm.getLastChild(node);

    return (newnode == DTM.NULL) ? null : dtm.getNode(newnode);
  
public final intgetLength()

see
org.w3c.dom.CharacterData

    // %OPT% This should do something smarter?
    return dtm.getNodeValue(node).length();
  
public final java.lang.StringgetLocalName()

see
org.w3c.dom.Node as of DOM Level 2

    return dtm.getLocalName(node);
  
public final java.lang.StringgetName()

see
org.w3c.dom.Attr

    return dtm.getNodeName(node);
  
public final java.lang.StringgetNamespaceURI()

see
org.w3c.dom.Node as of DOM Level 2

    return dtm.getNamespaceURI(node);
  
public final org.w3c.dom.NodegetNextSibling()

see
org.w3c.dom.Node


    // Attr's Next is defined at DTM level, but not at DOM level.
    if (dtm.getNodeType(node) == Node.ATTRIBUTE_NODE)
      return null;

    int newnode = dtm.getNextSibling(node);

    return (newnode == DTM.NULL) ? null : dtm.getNode(newnode);
  
public final java.lang.StringgetNodeName()

see
org.w3c.dom.Node

    return dtm.getNodeName(node);
  
public final shortgetNodeType()

see
org.w3c.dom.Node

    return (short) dtm.getNodeType(node);
  
public final java.lang.StringgetNodeValue()

throws
DOMException
see
org.w3c.dom.Node

    return dtm.getNodeValue(node);
  
public final org.w3c.dom.DocumentgetOwnerDocument()

see
org.w3c.dom.Node

  	// Note that this uses the DOM-compatable version of the call
	return (Document)(dtm.getNode(dtm.getOwnerDocument(node)));
  
public final org.w3c.dom.ElementgetOwnerElement()
Get the owner element of an attribute.

see
org.w3c.dom.Attr as of DOM Level 2

    if (getNodeType() != Node.ATTRIBUTE_NODE)
      return null;
    // In XPath and DTM data models, unlike DOM, an Attr's parent is its
    // owner element.
    int newnode = dtm.getParent(node);
    return (newnode == DTM.NULL) ? null : (Element)(dtm.getNode(newnode));
  
public final org.w3c.dom.NodegetOwnerNode()

see
org.w3c.dom.Node


    int newnode = dtm.getParent(node);

    return (newnode == DTM.NULL) ? null : dtm.getNode(newnode);
  
public final org.w3c.dom.NodegetParentNode()

see
org.w3c.dom.Node


    if (getNodeType() == Node.ATTRIBUTE_NODE)
      return null;

    int newnode = dtm.getParent(node);

    return (newnode == DTM.NULL) ? null : dtm.getNode(newnode);
  
public final java.lang.StringgetPrefix()

return
The prefix for this node.
see
org.w3c.dom.Node as of DOM Level 2

    return dtm.getPrefix(node);
  
public final org.w3c.dom.NodegetPreviousSibling()

see
org.w3c.dom.Node


    int newnode = dtm.getPreviousSibling(node);

    return (newnode == DTM.NULL) ? null : dtm.getNode(newnode);
  
public org.w3c.dom.TypeInfogetSchemaTypeInfo()
Method getSchemaTypeInfo.

return
TypeInfo

      return null; //PENDING
    
public final booleangetSpecified()

see
org.w3c.dom.Attr

    // We really don't know which attributes might have come from the
    // source document versus from the DTD. Treat them all as having
    // been provided by the user.
    // %REVIEW% if/when we become aware of DTDs/schemae.
    return true;
  
public booleangetStandalone()

EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..

An attribute specifying, as part of the XML declaration, whether this document is standalone.

since
DOM Level 3 NEEDSDOC ($objectName$) @return


    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public booleangetStrictErrorChecking()

EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..

An attribute specifying whether errors checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException. In case of error, the behavior is undefined. This attribute is true by defaults.

since
DOM Level 3 NEEDSDOC ($objectName$) @return


    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final java.lang.StringgetStringValue()

return
The string value of the node
throws
DOMException

  	return dtm.getStringValue(node).toString();
  
public final java.lang.StringgetTagName()

see
org.w3c.dom.Element

    return dtm.getNodeName(node);
  
public final java.lang.StringgetTarget()
A PI's "target" states what processor channel the PI's data should be directed to. It is defined differently in HTML and XML.

In XML, a PI's "target" is the first (whitespace-delimited) token following the " In HTML, target is always null.

Note that getNodeName is aliased to getTarget.

    return dtm.getNodeName(node);
  
public java.lang.StringgetTextContent()
This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type Content
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null

exception
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
exception
DOMException DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
since
DOM Level 3

        return getNodeValue();  // overriden in some subclasses
    
public java.lang.ObjectgetUserData(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 calling setUserData with the same key.

param
key The key the object is associated to.
return
Returns the DOMObject associated to the given key on this node, or null if there was none.
since
DOM Level 3

        return getOwnerDocument().getUserData( key);
    
public final java.lang.StringgetValue()

see
org.w3c.dom.Attr

    return dtm.getNodeValue(node);
  
public java.lang.StringgetVersion()

EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..

An attribute specifying, as part of the XML declaration, the version number of this document. This is null when unspecified.

since
DOM Level 3 NEEDSDOC ($objectName$) @return


    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public java.lang.StringgetWholeText()
DOM Level 3 Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.

since
DOM Level 3


/*
        if (needsSyncData()) {
            synchronizeData();
        }
        if (nextSibling == null) {
            return data;
        }
        StringBuffer buffer = new StringBuffer();
        if (data != null && data.length() != 0) {
            buffer.append(data);
        }
        getWholeText(nextSibling, buffer);
        return buffer.toString();
*/
        return null; // PENDING

    
public java.lang.StringgetXmlEncoding()

        return xmlEncoding;
    
public booleangetXmlStandalone()

        return xmlStandalone;
    
public java.lang.StringgetXmlVersion()

        return xmlVersion;
    
public booleanhasAttribute(java.lang.String name)
Method hasAttribute

param
name

    return DTM.NULL != dtm.getAttributeNode(node,null,name);
  
public booleanhasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Method hasAttributeNS

param
namespaceURI
param
localName

    return DTM.NULL != dtm.getAttributeNode(node,namespaceURI,localName);
  
public booleanhasAttributes()
Introduced in DOM Level 2.

    return DTM.NULL != dtm.getFirstAttribute(node);
  
public final booleanhasChildNodes()

see
org.w3c.dom.Node

    return (DTM.NULL != dtm.getFirstChild(node));
  
public final org.w3c.dom.NodeimportNode(org.w3c.dom.Node importedNode, boolean deep)

param
importedNode
param
deep
throws
DOMException
see
org.w3c.dom.Document as of DOM Level 2 -- DTMNodeProxy is read-only

    throw new DTMDOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR);
  
public final org.w3c.dom.NodeinsertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)

param
newChild
param
refChild
throws
DOMException
see
org.w3c.dom.Node -- DTMNodeProxy is read-only

    throw new DTMDOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR);
  
public final voidinsertData(int offset, java.lang.String arg)

param
offset
param
arg
throws
DOMException
see
org.w3c.dom.CharacterData

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public booleanisDefaultNamespace(java.lang.String namespaceURI)
DOM Level 3 This method checks if the specified namespaceURI is the default namespace or not.

param
namespaceURI The namespace URI to look for.
return
true if the specified namespaceURI is the default namespace, false otherwise.
since
DOM Level 3

       /*
        // REVISIT: remove casts when DOM L3 becomes REC.
        short type = this.getNodeType();
        switch (type) {
        case Node.ELEMENT_NODE: {
            String namespace = this.getNamespaceURI();
            String prefix = this.getPrefix();

            // REVISIT: is it possible that prefix is empty string?
            if (prefix == null || prefix.length() == 0) {
                if (namespaceURI == null) {
                    return (namespace == namespaceURI);
                }
                return namespaceURI.equals(namespace);
            }
            if (this.hasAttributes()) {
                ElementImpl elem = (ElementImpl)this;
                NodeImpl attr = (NodeImpl)elem.getAttributeNodeNS("http://www.w3.org/2000/xmlns/", "xmlns");
                if (attr != null) {
                    String value = attr.getNodeValue();
                    if (namespaceURI == null) {
                        return (namespace == value);
                    }
                    return namespaceURI.equals(value);
                }
            }

            NodeImpl ancestor = (NodeImpl)getElementAncestor(this);
            if (ancestor != null) {
                return ancestor.isDefaultNamespace(namespaceURI);
            }
            return false;
        }
        case Node.DOCUMENT_NODE:{
                return((NodeImpl)((Document)this).getDocumentElement()).isDefaultNamespace(namespaceURI);
            }

        case Node.ENTITY_NODE :
          case Node.NOTATION_NODE:
        case Node.DOCUMENT_FRAGMENT_NODE:
        case Node.DOCUMENT_TYPE_NODE:
            // type is unknown
            return false;
        case Node.ATTRIBUTE_NODE:{
                if (this.ownerNode.getNodeType() == Node.ELEMENT_NODE) {
                    return ownerNode.isDefaultNamespace(namespaceURI);

                }
                return false;
            }
        default:{  
                NodeImpl ancestor = (NodeImpl)getElementAncestor(this);
                if (ancestor != null) {
                    return ancestor.isDefaultNamespace(namespaceURI);
                }
                return false;
            }

        }
*/
        return false;


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

        return false;
    
public booleanisEqualNode(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 with Node.isSameNode. All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied: The two nodes are of the same type.The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue , baseURI. This is: they are both null, or they have the same length and are character for character identical. The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. This is true for Attr nodes as for any other type of node. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For two DocumentType nodes to be equal, the following conditions must also be satisfied: The following string attributes are equal: publicId, systemId, internalSubset.The entities NamedNodeMaps are equal.The notations NamedNodeMaps are equal.
On the other hand, the following do not affect equality: the ownerDocument attribute, the specified attribute for Attr nodes, the isWhitespaceInElementContent attribute for Text nodes, as well as any user data or event listeners registered on the nodes.

param
arg The node to compare equality with.
param
deep If true, recursively compare the subtrees; if false, compare only the nodes themselves (and its attributes, if it is an Element).
return
If the nodes, and possibly subtrees are equal, true otherwise false.
since
DOM Level 3

        if (arg == this) {
            return true;
        }
        if (arg.getNodeType() != getNodeType()) {
            return false;
        }
        // in theory nodeName can't be null but better be careful
        // who knows what other implementations may be doing?...
        if (getNodeName() == null) {
            if (arg.getNodeName() != null) {
                return false;
            }
        }
        else if (!getNodeName().equals(arg.getNodeName())) {
            return false;
        }

        if (getLocalName() == null) {
            if (arg.getLocalName() != null) {
                return false;
            }
        }
        else if (!getLocalName().equals(arg.getLocalName())) {
            return false;
        }

        if (getNamespaceURI() == null) {
            if (arg.getNamespaceURI() != null) {
                return false;
            }
        }
        else if (!getNamespaceURI().equals(arg.getNamespaceURI())) {
            return false;
        }

        if (getPrefix() == null) {
            if (arg.getPrefix() != null) {
                return false;
            }
        }
        else if (!getPrefix().equals(arg.getPrefix())) {
            return false;
        }

        if (getNodeValue() == null) {
            if (arg.getNodeValue() != null) {
                return false;
            }
        }
        else if (!getNodeValue().equals(arg.getNodeValue())) {
            return false;
        }
    /*
        if (getBaseURI() == null) {
            if (((NodeImpl) arg).getBaseURI() != null) {
                return false;
            }
        }
        else if (!getBaseURI().equals(((NodeImpl) arg).getBaseURI())) {
            return false;
        }
*/

             return true;
    
public booleanisId()

        return false; //PENDING
    
public booleanisSameNode(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 two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.

param
other The node to test against.
return
Returns true if the nodes are the same, false otherwise.
since
DOM Level 3

        // we do not use any wrapper so the answer is obvious
        return this == other;
    
public final booleanisSupported(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.

param
feature
param
version
return
false
see
org.w3c.dom.Node as of DOM Level 2

    return implementation.hasFeature(feature,version);
    // throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public java.lang.StringlookupNamespaceURI(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

param
namespaceURI
return
th URI for the namespace
since
DOM Level 3

        short type = this.getNodeType();
        switch (type) {
        case Node.ELEMENT_NODE : {

                String namespace = this.getNamespaceURI();
                String prefix = this.getPrefix();
                if (namespace !=null) {
                    // REVISIT: is it possible that prefix is empty string?
                    if (specifiedPrefix== null && prefix==specifiedPrefix) {
                        // looking for default namespace
                        return namespace;
                    } else if (prefix != null && prefix.equals(specifiedPrefix)) {
                        // non default namespace
                        return namespace;
                    }
                }
                if (this.hasAttributes()) {
                    NamedNodeMap map = this.getAttributes();
                    int length = map.getLength();
                    for (int i=0;i<length;i++) {
                        Node attr = map.item(i);
                        String attrPrefix = attr.getPrefix();
                        String value = attr.getNodeValue();
                        namespace = attr.getNamespaceURI();
                        if (namespace !=null && namespace.equals("http://www.w3.org/2000/xmlns/")) {
                            // at this point we are dealing with DOM Level 2 nodes only
                            if (specifiedPrefix == null &&
                                attr.getNodeName().equals("xmlns")) {
                                // default namespace
                                return value;
                            } else if (attrPrefix !=null &&
                                       attrPrefix.equals("xmlns") &&
                                       attr.getLocalName().equals(specifiedPrefix)) {
                 // non default namespace
                                return value;
                            }
                        }
                    }
                }
		/*
                NodeImpl ancestor = (NodeImpl)getElementAncestor(this);
                if (ancestor != null) {
                    return ancestor.lookupNamespaceURI(specifiedPrefix);
                }
		*/

                return null;


            }
/*
        case Node.DOCUMENT_NODE : {
                return((NodeImpl)((Document)this).getDocumentElement()).lookupNamespaceURI(specifiedPrefix) ;
            }
*/
        case Node.ENTITY_NODE :
        case Node.NOTATION_NODE:
        case Node.DOCUMENT_FRAGMENT_NODE:
        case Node.DOCUMENT_TYPE_NODE:
            // type is unknown
            return null;
        case Node.ATTRIBUTE_NODE:{
                if (this.getOwnerElement().getNodeType() == Node.ELEMENT_NODE) {
                    return getOwnerElement().lookupNamespaceURI(specifiedPrefix);

                }
                return null;
            }
        default:{
	   /*
                NodeImpl ancestor = (NodeImpl)getElementAncestor(this);
                if (ancestor != null) {
                    return ancestor.lookupNamespaceURI(specifiedPrefix);
                }
             */
                return null;
            }

        }
    
public java.lang.StringlookupPrefix(java.lang.String namespaceURI)
DOM Level 3 Look up the prefix associated to the given namespace URI, starting from this node.

param
namespaceURI
return
the prefix for the namespace


        // REVISIT: When Namespaces 1.1 comes out this may not be true
        // Prefix can't be bound to null namespace
        if (namespaceURI == null) {
            return null;
        }

        short type = this.getNodeType();

        switch (type) {
/*
        case Node.ELEMENT_NODE: {

                String namespace = this.getNamespaceURI(); // to flip out children
                return lookupNamespacePrefix(namespaceURI, (ElementImpl)this);
            }

        case Node.DOCUMENT_NODE:{
                return((NodeImpl)((Document)this).getDocumentElement()).lookupPrefix(namespaceURI);
            }
*/
        case Node.ENTITY_NODE :
        case Node.NOTATION_NODE:
        case Node.DOCUMENT_FRAGMENT_NODE:
        case Node.DOCUMENT_TYPE_NODE:
            // type is unknown
            return null;
        case Node.ATTRIBUTE_NODE:{
                if (this.getOwnerElement().getNodeType() == Node.ELEMENT_NODE) {
                    return getOwnerElement().lookupPrefix(namespaceURI);

                }
                return null;
            }
        default:{ 
/*
                NodeImpl ancestor = (NodeImpl)getElementAncestor(this);
                if (ancestor != null) {
                    return ancestor.lookupPrefix(namespaceURI);
                }
*/
                return null;
            }
         }
    
public final voidnormalize()

see
org.w3c.dom.Element

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public voidnormalizeDocument()
DOM Level 3 Normalize document.

   

    
public final voidremoveAttribute(java.lang.String name)

param
name
throws
DOMException
see
org.w3c.dom.Element

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final voidremoveAttributeNS(java.lang.String namespaceURI, java.lang.String localName)

param
namespaceURI
param
localName
throws
DOMException
see
org.w3c.dom.Element

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.AttrremoveAttributeNode(org.w3c.dom.Attr oldAttr)

param
oldAttr
throws
DOMException
see
org.w3c.dom.Element

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.NoderemoveChild(org.w3c.dom.Node oldChild)

param
oldChild
throws
DOMException
see
org.w3c.dom.Node -- DTMNodeProxy is read-only

    throw new DTMDOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR);
  
public org.w3c.dom.NoderenameNode(org.w3c.dom.Node n, java.lang.String namespaceURI, java.lang.String name)
DOM Level 3 Renaming node

        return n;
    
public final org.w3c.dom.NodereplaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)

param
newChild
param
oldChild
throws
DOMException
see
org.w3c.dom.Node -- DTMNodeProxy is read-only

    throw new DTMDOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR);
  
public final voidreplaceData(int offset, int count, java.lang.String arg)

param
offset
param
count
param
arg
throws
DOMException
see
org.w3c.dom.CharacterData

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public org.w3c.dom.TextreplaceWholeText(java.lang.String content)
DOM Level 3

/*

        if (needsSyncData()) {
            synchronizeData();
        }

        // make sure we can make the replacement
        if (!canModify(nextSibling)) {
            throw new DOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR,
                DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NO_MODIFICATION_ALLOWED_ERR", null));
        }

        Node parent = this.getParentNode();
        if (content == null || content.length() == 0) {
            // remove current node
            if (parent !=null) { // check if node in the tree
                parent.removeChild(this);
                return null;
            }
        }
        Text currentNode = null;
        if (isReadOnly()){
            Text newNode = this.ownerDocument().createTextNode(content);
            if (parent !=null) { // check if node in the tree
                parent.insertBefore(newNode, this);
                parent.removeChild(this);
                currentNode = newNode;
            } else {
                return newNode;
            }
        }  else {
            this.setData(content);
            currentNode = this;
        }
        Node sibling =  currentNode.getNextSibling();
        while ( sibling !=null) {
            parent.removeChild(sibling);
            sibling = currentNode.getNextSibling();
        }

        return currentNode;
*/
        return null; //Pending
    
public final booleansameNodeAs(org.w3c.dom.Node other)
FUTURE DOM: Test node identity, in lieu of Node==Node

param
other
return
true if the given node has the same handle as this node.


    if (!(other instanceof DTMNodeProxy))
      return false;

    DTMNodeProxy that = (DTMNodeProxy) other;

    return this.dtm == that.dtm && this.node == that.node;
  
public voidsetActualEncoding(java.lang.String value)
DOM Level 3 An attribute specifying the actual encoding of this document. This is null otherwise.
This attribute represents the property [character encoding scheme] defined in .

since
DOM Level 3

        actualEncoding = value;
    
public final voidsetAttribute(java.lang.String name, java.lang.String value)

param
name
param
value
throws
DOMException
see
org.w3c.dom.Element

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final voidsetAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)

param
namespaceURI
param
qualifiedName
param
value
throws
DOMException
see
org.w3c.dom.Element

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.AttrsetAttributeNode(org.w3c.dom.Attr newAttr)

param
newAttr
throws
DOMException
see
org.w3c.dom.Element

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final org.w3c.dom.AttrsetAttributeNodeNS(org.w3c.dom.Attr newAttr)

param
newAttr
throws
DOMException
see
org.w3c.dom.Element

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final voidsetData(java.lang.String data)

param
data
throws
DOMException
see
org.w3c.dom.CharacterData

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public voidsetDocumentURI(java.lang.String documentURI)
DOM Level 3

        
        fDocumentURI= documentURI;
    
public voidsetEncoding(java.lang.String encoding)

EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..

An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified.

since
DOM Level 3 NEEDSDOC @param encoding

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public voidsetIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type.

param
id

        //PENDING
    
public voidsetIdAttribute(java.lang.String name, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute

        //PENDING
    
public voidsetIdAttributeNS(java.lang.String namespaceURI, java.lang.String localName, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute

        //PENDING
    
public voidsetIdAttributeNode(org.w3c.dom.Attr at, boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute

        //PENDING
    
public final voidsetNodeValue(java.lang.String nodeValue)

param
nodeValue
throws
DOMException
see
org.w3c.dom.Node -- DTMNodeProxy is read-only

    throw new DTMDOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR);
  
public final voidsetPrefix(java.lang.String prefix)

param
prefix
throws
DOMException
see
org.w3c.dom.Node as of DOM Level 2 -- DTMNodeProxy is read-only

    throw new DTMDOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR);
  
public voidsetStandalone(boolean standalone)

EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..

An attribute specifying, as part of the XML declaration, whether this document is standalone.

since
DOM Level 3 NEEDSDOC @param standalone

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public voidsetStrictErrorChecking(boolean strictErrorChecking)

EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..

An attribute specifying whether errors checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException. In case of error, the behavior is undefined. This attribute is true by defaults.

since
DOM Level 3 NEEDSDOC @param strictErrorChecking

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public voidsetTextContent(java.lang.String textContent)
This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type Content
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null

exception
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
exception
DOMException DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
since
DOM Level 3

        setNodeValue(textContent);
    
public java.lang.ObjectsetUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)

        return getOwnerDocument().setUserData( key, data, handler);
    
public final voidsetValue(java.lang.String value)

param
value
see
org.w3c.dom.Attr

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public voidsetVersion(java.lang.String version)

EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..

An attribute specifying, as part of the XML declaration, the version number of this document. This is null when unspecified.

since
DOM Level 3 NEEDSDOC @param version

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public voidsetXmlEncoding(java.lang.String xmlEncoding)

        this.xmlEncoding = xmlEncoding;
    
public voidsetXmlStandalone(boolean xmlStandalone)

        this.xmlStandalone = xmlStandalone;
    
public voidsetXmlVersion(java.lang.String xmlVersion)

        this.xmlVersion = xmlVersion;
    
public final org.w3c.dom.TextsplitText(int offset)

param
offset
throws
DOMException
see
org.w3c.dom.Text

    throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
public final java.lang.StringsubstringData(int offset, int count)

param
offset
param
count
throws
DOMException
see
org.w3c.dom.CharacterData

    return getData().substring(offset,offset+count);
  
public final booleansupports(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.

param
feature
param
version
return
false

    return implementation.hasFeature(feature,version);
    //throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);
  
private final voidtraverseChildren(java.util.Vector listVector, org.w3c.dom.Node tempNode, java.lang.String tagname, boolean isTagNameWildCard)

param
listVector
param
tempNode
param
tagname
param
isTagNameWildCard Private method to be used for recursive iterations to obtain elements by tag name.

    if (tempNode == null) 
    {
      return;
    } 
    else
    { 
      if (tempNode.getNodeType() == DTM.ELEMENT_NODE
            && (isTagNameWildCard || tempNode.getNodeName().equals(tagname)))
      {
        listVector.add(tempNode);
      }
      if(tempNode.hasChildNodes())
      {
        NodeList nodeList = tempNode.getChildNodes();
        for (int i = 0; i < nodeList.getLength(); i++)
        {
          traverseChildren(listVector, nodeList.item(i), tagname,
                           isTagNameWildCard);
        }
      }
    }
  
private final voidtraverseChildren(java.util.Vector listVector, org.w3c.dom.Node tempNode, java.lang.String namespaceURI, java.lang.String localname, boolean isNamespaceURIWildCard, boolean isLocalNameWildCard)

param
listVector
param
tempNode
param
namespaceURI
param
localname
param
isNamespaceURIWildCard
param
isLocalNameWildCard Private method to be used for recursive iterations to obtain elements by tag name and namespaceURI.

    if (tempNode == null)
    {
      return;
    }
    else 
    {
      if (tempNode.getNodeType() == DTM.ELEMENT_NODE
              && (isLocalNameWildCard
                      || tempNode.getLocalName().equals(localname)))
      {         
        String nsURI = tempNode.getNamespaceURI();
        if ((namespaceURI == null && nsURI == null)
               || isNamespaceURIWildCard
               || (namespaceURI != null && namespaceURI.equals(nsURI)))
        {     
          listVector.add(tempNode); 
        } 
      }
      if(tempNode.hasChildNodes())
      {
        NodeList nl = tempNode.getChildNodes();                 
        for(int i = 0; i < nl.getLength(); i++)
        {
          traverseChildren(listVector, nl.item(i), namespaceURI, localname,
                           isNamespaceURIWildCard, isLocalNameWildCard);
        }
      }
    }