FileDocCategorySizeDatePackage
UnImplNode.javaAPI DocJava SE 5 API56992Fri Aug 26 14:56:04 BST 2005com.sun.org.apache.xml.internal.utils

UnImplNode

public class UnImplNode extends Object implements Node, Element, NodeList, Document
To be subclassed by classes that wish to fake being nodes.

Fields Summary
protected String
fDocumentURI
Experimental DOM Level 3 feature: documentURI
protected String
actualEncoding
Experimental DOM Level 3 feature: Document actualEncoding
private String
xmlEncoding
private boolean
xmlStandalone
private String
xmlVersion
Constructors Summary
public UnImplNode()
Constructor UnImplNode

Methods Summary
public org.w3c.dom.NodeadoptNode(org.w3c.dom.Node source)
NEEDSDOC Method adoptNode


NEEDSDOC @param source

NEEDSDOC (adoptNode) @return
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.NodeappendChild(org.w3c.dom.Node newChild)
Unimplemented. See org.w3c.dom.Node
param
newChild New node to append to the list of this node's children
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"appendChild not supported!");

    return null;
  
public voidappendData(java.lang.String arg)
Unimplemented.
param
arg String data to append
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
public org.w3c.dom.NodecloneNode(boolean deep)
Unimplemented. See org.w3c.dom.Node
param
deep Flag indicating whether to clone deep (clone member variables)
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"cloneNode not supported!");

    return null;
  
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 org.w3c.dom.AttrcreateAttribute(java.lang.String name)
Unimplemented. See org.w3c.dom.Document
param
name Attribute name
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.AttrcreateAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName)
Unimplemented. See org.w3c.dom.Document
param
namespaceURI Namespace URI of the attribute
param
qualifiedName Qualified name of the attribute
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.CDATASectioncreateCDATASection(java.lang.String data)
Unimplemented. See org.w3c.dom.Document
param
data Data for CDATA section
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.CommentcreateComment(java.lang.String data)
Unimplemented. See org.w3c.dom.Document
param
data Data for comment
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.DocumentFragmentcreateDocumentFragment()
Unimplemented. See org.w3c.dom.Document
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.ElementcreateElement(java.lang.String tagName)
Unimplemented. See org.w3c.dom.Document
param
tagName Element tag name
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.ElementcreateElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName)
Unimplemented. See org.w3c.dom.Document
param
namespaceURI Namespace URI for the element
param
qualifiedName Qualified name of the element
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.EntityReferencecreateEntityReference(java.lang.String name)
Unimplemented. See org.w3c.dom.Document
param
name Entity Reference name
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.ProcessingInstructioncreateProcessingInstruction(java.lang.String target, java.lang.String data)
Unimplemented. See org.w3c.dom.Document
param
target Target for Processing instruction
param
data Data for Processing instruction
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.TextcreateTextNode(java.lang.String data)
Unimplemented. See org.w3c.dom.Document
param
data Data for text node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public voiddeleteData(int offset, int count)
Unimplemented.
param
offset Start offset of substring to delete.
param
count The length of the substring to delete.
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
public voiderror(java.lang.String msg)
Throw an error.
param
msg Message Key for the error

    System.out.println("DOM ERROR! class: " + this.getClass().getName());

    throw new RuntimeException(XMLMessages.createXMLMessage(msg, null));
  
public voiderror(java.lang.String msg, java.lang.Object[] args)
Throw an error.
param
msg Message Key for the error
param
args Array of arguments to be used in the error message

    System.out.println("DOM ERROR! class: " + this.getClass().getName());

    throw new RuntimeException(XMLMessages.createXMLMessage(msg, args));  //"UnImplNode error: "+msg);
  
public java.lang.StringgetActualEncoding()
DOM Level 3 WD - Experimental.
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 java.lang.StringgetAttribute(java.lang.String name)
Unimplemented. See org.w3c.dom.Element
param
name Name of attribute to get
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getAttribute not supported!");

    return null;
  
public java.lang.StringgetAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Unimplemented. See org.w3c.dom.Element
param
namespaceURI Namespace URI of attribute node to get
param
localName Local part of qualified name of attribute node to get
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getAttributeNS not supported!");

    return null;
  
public org.w3c.dom.AttrgetAttributeNode(java.lang.String name)
Unimplemented. See org.w3c.dom.Element
param
name Attribute node name
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getAttributeNode not supported!");

    return null;
  
public org.w3c.dom.AttrgetAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)
Unimplemented. See org.w3c.dom.Element
param
namespaceURI Namespace URI of attribute node to get
param
localName Local part of qualified name of attribute node to get
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getAttributeNodeNS not supported!");

    return null;
  
public org.w3c.dom.NamedNodeMapgetAttributes()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getAttributes not supported!");

    return null;
  
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 org.w3c.dom.NodeListgetChildNodes()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getChildNodes not supported!");

    return null;
  
public org.w3c.dom.DocumentTypegetDoctype()
Unimplemented. See org.w3c.dom.Document
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.ElementgetDocumentElement()
Unimplemented. See org.w3c.dom.Document
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public java.lang.StringgetDocumentURI()
DOM Level 3 WD - Experimental.
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 org.w3c.dom.ElementgetElementById(java.lang.String elementId)
Unimplemented. See org.w3c.dom.Document
param
elementId ID of the element to get
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.NodeListgetElementsByTagName(java.lang.String name)
Unimplemented. See org.w3c.dom.Element
param
name Name of the element
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getElementsByTagName not supported!");

    return null;
  
public org.w3c.dom.NodeListgetElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
Unimplemented. See org.w3c.dom.Element
param
namespaceURI Namespace URI of the element
param
localName Local part of qualified name of the element
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getElementsByTagNameNS not supported!");

    return null;
  
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 org.w3c.dom.NodegetFirstChild()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getFirstChild not supported!");

    return null;
  
public org.w3c.dom.DOMImplementationgetImplementation()
Unimplemented. See org.w3c.dom.Document
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
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

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.NodegetLastChild()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getLastChild not supported!");

    return null;
  
public intgetLength()
Unimplemented. See org.w3c.dom.NodeList
return
0

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getLength not supported!");

    return 0;
  
public java.lang.StringgetLocalName()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getLocalName not supported!");

    return null;
  
public java.lang.StringgetNamespaceURI()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getNamespaceURI not supported!");

    return null;
  
public org.w3c.dom.NodegetNextSibling()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getNextSibling not supported!");

    return null;
  
public java.lang.StringgetNodeName()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getNodeName not supported!");

    return null;
  
public shortgetNodeType()
Unimplemented. See org.w3c.dom.Node
return
0

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getNodeType not supported!");

    return 0;
  
public java.lang.StringgetNodeValue()
Unimplemented. See org.w3c.dom.Node
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getNodeValue not supported!");

    return null;
  
public org.w3c.dom.DocumentgetOwnerDocument()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getOwnerDocument not supported!");

    return null;
  
public org.w3c.dom.ElementgetOwnerElement()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getOwnerElement not supported!");

    return null;
  
public org.w3c.dom.NodegetParentNode()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getParentNode not supported!");

    return null;
  
public java.lang.StringgetPrefix()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getPrefix not supported!");

    return null;
  
public org.w3c.dom.NodegetPreviousSibling()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getPreviousSibling not supported!");

    return null;
  
public org.w3c.dom.TypeInfogetSchemaTypeInfo()
Method getSchemaTypeInfo.
return
TypeInfo
      return null; //PENDING
    
public booleangetSpecified()
Unimplemented. See org.w3c.dom.Node
return
False

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"setValue not supported!");

    return false;
  
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

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return false;
  
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

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return false;
  
public java.lang.StringgetTagName()
Unimplemented. See org.w3c.dom.Node
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"getTagName not supported!");

    return null;
  
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 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

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public java.lang.StringgetWholeText()
DOM Level 3 WD - Experimental.
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)
Unimplemented. See org.w3c.dom.Element
param
name Name of an attribute
return
false

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"hasAttribute not supported!");

    return false;
  
public booleanhasAttributeNS(java.lang.String name, java.lang.String x)
Unimplemented. See org.w3c.dom.Element
param
name
param
x
return
false

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"hasAttributeNS not supported!");

    return false;
  
public booleanhasAttributes()
Unimplemented. Introduced in DOM Level 2.
return
false

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"hasAttributes not supported!");

    return false;
  
public booleanhasChildNodes()
Unimplemented. See org.w3c.dom.Node
return
false

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"hasChildNodes not supported!");

    return false;
  
public org.w3c.dom.NodeimportNode(org.w3c.dom.Node importedNode, boolean deep)
Unimplemented. See org.w3c.dom.Document
param
importedNodeThe node to import.
param
deepIf true, recursively import the subtree under
the specified node; if false, import only the node
itself, as explained above. This has no effect on Attr
, EntityReference, and Notation nodes.

NEEDSDOC @param importedNode
NEEDSDOC @param deep
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public org.w3c.dom.NodeinsertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)
Unimplemented. See org.w3c.dom.Node
param
newChild New child node to insert
param
refChild Insert in front of this child
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"insertBefore not supported!");

    return null;
  
public voidinsertData(int offset, java.lang.String arg)
Unimplemented.
param
offset Start offset of substring to insert.
param
count The length of the substring to insert.
NEEDSDOC @param arg
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
public booleanisDefaultNamespace(java.lang.String namespaceURI)
DOM Level 3: Experimental
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 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 booleanisSupported(java.lang.String feature, java.lang.String version)
Tests whether the DOM implementation implements a specific feature and
that feature is supported by this node.
param
featureThe name of the feature to test. This is the same name
which can be passed to the method hasFeature on
DOMImplementation.
param
versionThis is the version number of the feature to test. In
Level 2, version 1, this is the string "2.0". If the version is not
specified, supporting any version of the feature will cause the
method to return true.

NEEDSDOC @param feature
NEEDSDOC @param version
return
Returns false
since
DOM Level 2
    return false;
  
public booleanisWhitespaceInElementContent()
DOM Level 3 WD - Experimental.
Returns whether this text node contains whitespace in element content,
often abusively called "ignorable whitespace".
        return false;
    
public org.w3c.dom.Nodeitem(int index)
Unimplemented. See org.w3c.dom.NodeList
param
index index of a child of this node in its list of children
return
null

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"item not supported!");

    return null;
  
public java.lang.StringlookupNamespaceURI(java.lang.String specifiedPrefix)
DOM Level 3 - Experimental:
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 - Experimental:
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 voidnormalize()
Unimplemented. See org.w3c.dom.Node
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"normalize not supported!");
  
public voidnormalizeDocument()
DOM Level 3 WD - Experimental
Normalize document.
   

    
public voidremoveAttribute(java.lang.String name)
Unimplemented. See org.w3c.dom.Element
param
name Attribute node name to remove from list of attributes
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"removeAttribute not supported!");
  
public voidremoveAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Unimplemented. See org.w3c.dom.Element
param
namespaceURI Namespace URI of attribute node to remove
param
localName Local part of qualified name of attribute node to remove
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"removeAttributeNS not supported!");
  
public org.w3c.dom.AttrremoveAttributeNode(org.w3c.dom.Attr oldAttr)
Unimplemented. See org.w3c.dom.Element
param
oldAttr Attribute to be removed from this node's list of attributes
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"removeAttributeNode not supported!");

    return null;
  
public org.w3c.dom.NoderemoveChild(org.w3c.dom.Node oldChild)
Unimplemented. See org.w3c.dom.Node
param
oldChild Child to be removed
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"replaceChild not supported!");

    return null;
  
public org.w3c.dom.NoderenameNode(org.w3c.dom.Node n, java.lang.String namespaceURI, java.lang.String name)
DOM Level 3 WD - Experimental.
Renaming node
        return n;
    
public org.w3c.dom.NodereplaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)
Unimplemented. See org.w3c.dom.Node
param
newChild Replace existing child with this one
param
oldChild Existing child to be replaced
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"replaceChild not supported!");

    return null;
  
public voidreplaceData(int offset, int count, java.lang.String arg)
Unimplemented.
param
offset Start offset of substring to replace.
param
count The length of the substring to replace.
param
arg substring to replace with
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
public org.w3c.dom.TextreplaceWholeText(java.lang.String content)
DOM Level 3 WD - Experimental.
/*

        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 voidsetActualEncoding(java.lang.String value)
DOM Level 3 WD - Experimental.
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 voidsetAttribute(java.lang.String name, java.lang.String value)
Unimplemented. See org.w3c.dom.Element
param
name Name of attribute to set
param
value Value of attribute
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"setAttribute not supported!");
  
public voidsetAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)
Unimplemented. See org.w3c.dom.Element
param
namespaceURI Namespace URI of attribute node to set
param
localName Local part of qualified name of attribute node to set
NEEDSDOC @param qualifiedName
param
value value of attribute
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"setAttributeNS not supported!");
  
public org.w3c.dom.AttrsetAttributeNode(org.w3c.dom.Attr newAttr)
Unimplemented. See org.w3c.dom.Element
param
newAttr Attribute node to be added to this node's list of attributes
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"setAttributeNode not supported!");

    return null;
  
public org.w3c.dom.AttrsetAttributeNodeNS(org.w3c.dom.Attr newAttr)
Unimplemented. See org.w3c.dom.Element
param
newAttr Attribute to set
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"setAttributeNodeNS not supported!");

    return null;
  
public voidsetData(java.lang.String data)
Set Node data
param
data data to set for this node
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
public voidsetDocumentURI(java.lang.String documentURI)
DOM Level 3 WD - Experimental.
        
        fDocumentURI= documentURI;
    
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 voidsetInputEncoding(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
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
public voidsetNodeValue(java.lang.String nodeValue)
Unimplemented. See org.w3c.dom.Node
param
nodeValue Value to set this node to
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"setNodeValue not supported!");
  
public voidsetPrefix(java.lang.String prefix)
Unimplemented. See org.w3c.dom.Node
param
prefix Prefix to set for this node
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"setPrefix not supported!");
  
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
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
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
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
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 voidsetValue(java.lang.String value)
Unimplemented. See org.w3c.dom.Node
param
value Value to set this node to
throws
DOMException
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);  //"setValue not supported!");
  
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
    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);
  
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 org.w3c.dom.TextsplitText(int offset)
Unimplemented.
param
offset Offset into text to split
return
null, unimplemented
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;
  
public java.lang.StringsubstringData(int offset, int count)
Unimplemented.
param
offset Start offset of substring to extract.
param
count The length of the substring to extract.
return
null
throws
DOMException

    error(XMLErrorResources.ER_FUNCTION_NOT_SUPPORTED);

    return null;