| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.icl.saxon.om.AbstractNode
This class is an abstract implementation of the Saxon NodeInfo interface; it also contains concrete implementations of most of the DOM methods in terms of the NodeInfo methods. These include all the methods defined on the DOM Node class itself, and most of those defined on subclasses such as Document, Text, and Comment: because of the absence of multiple inheritance, this is the only way of making these methods reusable by multiple implementations. The class contains no data, and can be used as a common superclass for different implementations of Node and NodeInfo.
| Field Summary | |
| static char[] | NODE_LETTERChararacteristic letters to identify each type of node, indexed using the node type values. | 
| Fields inherited from interface org.w3c.dom.Node | 
| ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE | 
| Fields inherited from interface com.icl.saxon.om.NodeInfo | 
| ATTRIBUTE, COMMENT, ELEMENT, NAMESPACE, NODE, NONE, NUMBER_OF_TYPES, PI, ROOT, TEXT | 
| Constructor Summary | |
| AbstractNode() | |
| Method Summary | |
|  org.w3c.dom.Node | appendChild(org.w3c.dom.Node newChild)Adds the node newChildto the end of the list of children
 of this node. | 
|  void | appendData(java.lang.String arg)Append the string to the end of the character data of the node. | 
|  org.w3c.dom.Node | cloneNode(boolean deep)Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. | 
|  short | compareDocumentPosition(org.w3c.dom.Node other)Compares the reference node, i.e. | 
| abstract  int | compareOrder(NodeInfo other)Determine the relative position of this node and another node, in document order. | 
|  void | copyStringValue(Outputter out)Copy the string-value of this node to a given outputter. | 
|  org.w3c.dom.Attr | createAttribute(java.lang.String name)Create an Attrof the given name. | 
|  org.w3c.dom.Attr | createAttributeNS(java.lang.String namespaceURI,
                  java.lang.String qualifiedName)Create an attribute of the given qualified name and namespace URI. | 
|  org.w3c.dom.CDATASection | createCDATASection(java.lang.String data)Create a CDATASectionnode whose value  is the specified
 string. | 
|  org.w3c.dom.Comment | createComment(java.lang.String data)Create a Commentnode given the specified string. | 
|  org.w3c.dom.DocumentFragment | createDocumentFragment()Creates an empty DocumentFragmentobject. | 
|  org.w3c.dom.Element | createElement(java.lang.String tagName)Creates an element of the type specified. | 
|  org.w3c.dom.Element | createElementNS(java.lang.String namespaceURI,
                java.lang.String qualifiedName)Create an element of the given qualified name and namespace URI. | 
|  org.w3c.dom.EntityReference | createEntityReference(java.lang.String name)Create an EntityReferenceobject. | 
|  org.w3c.dom.ProcessingInstruction | createProcessingInstruction(java.lang.String target,
                            java.lang.String data)Create a ProcessingInstructionnode given the specified
 name and data strings. | 
|  org.w3c.dom.Text | createTextNode(java.lang.String data)Create a Textnode given the specified string. | 
|  void | deleteData(int offset,
           int count)Remove a range of 16-bit units from the node. | 
| protected  void | disallowUpdate()Internal method used to indicate that update operations are not allowed | 
| abstract  java.lang.String | generateId()Get a character string that uniquely identifies this node | 
|  java.lang.String | getAttribute(java.lang.String name)Retrieves an attribute value by name. | 
|  org.w3c.dom.Attr | getAttributeNode(java.lang.String name)Retrieves an attribute node by name. | 
|  org.w3c.dom.Attr | getAttributeNodeNS(java.lang.String namespaceURI,
                   java.lang.String localName)Retrieves an Attrnode by local name and namespace URI. | 
|  java.lang.String | getAttributeNS(java.lang.String namespaceURI,
               java.lang.String localName)Retrieves an attribute value by local name and namespace URI. | 
|  org.w3c.dom.NamedNodeMap | getAttributes()Return a NamedNodeMapcontaining the attributes of this node (if
 it is anElement) ornullotherwise. | 
| abstract  java.lang.String | getAttributeValue(int fingerprint)Get the value of a given attribute of this node | 
| abstract  java.lang.String | getAttributeValue(java.lang.String uri,
                  java.lang.String localName)Find the value of a given attribute of this node. | 
| abstract  java.lang.String | getBaseURI()Get the base URI for the node. | 
|  org.w3c.dom.NodeList | getChildNodes()Return a NodeListthat contains all children of this node. | 
|  int | getColumnNumber()Get the column number of the node. | 
|  java.lang.String | getData()Get the character data of a Text or Comment node. | 
|  java.lang.String | getDisplayName()Get the display name of this node. | 
|  org.w3c.dom.DocumentType | getDoctype()Get the Document Type Declaration (see DocumentType)
 associated with this document. | 
|  org.w3c.dom.Element | getDocumentElement()Get the outermost element. | 
|  DocumentInfo | getDocumentRoot()Get the root (document) node | 
|  org.w3c.dom.Element | getElementById(java.lang.String elementId)Return the ElementwhoseIDis given byelementId. | 
|  org.w3c.dom.NodeList | getElementsByTagName(java.lang.String tagname)Return a NodeListof all theElementswith
 a given tag name in the order in which they are encountered in a
 preorder traversal of theDocumenttree. | 
|  org.w3c.dom.NodeList | getElementsByTagNameNS(java.lang.String namespaceURI,
                       java.lang.String localName)Return a NodeListof all theElementswith
 a given  local name and namespace URI in the order in which they are
 encountered in a preorder traversal of theDocumenttree. | 
| abstract  AxisEnumeration | getEnumeration(byte axisNumber,
               NodeTest nodeTest)Return an enumeration over the nodes reached by the given axis from this node | 
|  java.lang.Object | getFeature(java.lang.String feature,
           java.lang.String version)This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . | 
| abstract  int | getFingerprint()Get the fingerprint of the node, used for matching names | 
|  org.w3c.dom.Node | getFirstChild()Get first child (DOM method) | 
|  org.w3c.dom.DOMImplementation | getImplementation()Get a DOMImplementationobject that handles this document. | 
|  org.w3c.dom.Node | getLastChild()Get last child (DOM method) | 
|  int | getLength()Get the length of a Text or Comment node. | 
|  int | getLineNumber()Get the line number of the node within its source document entity. | 
| abstract  java.lang.String | getLocalName()Get the local name of this node. | 
|  java.lang.String | getName()Get the name of an attribute node (the QName) (DOM method) | 
| abstract  int | getNameCode()Get the name code of the node, used for displaying names | 
|  java.lang.String | getNamespaceURI()The namespace URI of this node, or nullif it is
 unspecified. | 
|  org.w3c.dom.Node | getNextSibling()Get next sibling node (DOM method) | 
|  java.lang.String | getNodeName()Get the name of this node, following the DOM rules | 
|  java.lang.String | getNodeValue()Get the node value as defined in the DOM. | 
|  org.w3c.dom.Node | getOriginatingNode()Get the node corresponding to this javax.xml.transform.dom.DOMLocator | 
|  org.w3c.dom.Document | getOwnerDocument()Return the Documentobject associated with this node. | 
|  org.w3c.dom.Element | getOwnerElement()The Elementnode this attribute is attached to ornullif this attribute is not in use. | 
| abstract  NodeInfo | getParent()Find the parent node of this node. | 
|  org.w3c.dom.Node | getParentNode()Find the parent node of this node (DOM method). | 
| abstract  java.lang.String | getPrefix()Get the prefix part of the name of this node. | 
|  org.w3c.dom.Node | getPreviousSibling()Get the previous sibling of the node (DOM method) | 
|  java.lang.String | getPublicId()Get the public identifier of the document entity containing this node. | 
|  org.w3c.dom.TypeInfo | getSchemaTypeInfo()The type information associated with this attribute. | 
|  boolean | getSpecified()If this attribute was explicitly given a value in the original document, this is true; otherwise, it isfalse. | 
| abstract  java.lang.String | getSystemId()Get the system ID for the entity containing the node. | 
|  java.lang.String | getTagName()The name of the element (DOM interface). | 
|  java.lang.String | getTextContent()This attribute returns the text content of this node and its descendants. | 
| abstract  java.lang.String | getURI()Get the URI part of the name of this node. | 
|  java.lang.Object | getUserData(java.lang.String key)Retrieves the object associated to a key on a this node. | 
|  java.lang.String | getValue()Return the character value of an attribute node (DOM method) | 
|  java.lang.String | getWholeText()Returns all text of Textnodes logically-adjacent text
 nodes to this node, concatenated in document order. | 
|  boolean | hasAttribute(java.lang.String name)Returns truewhen an attribute with a given name is
 specified on this element or has a default value,falseotherwise. | 
|  boolean | hasAttributeNS(java.lang.String namespaceURI,
               java.lang.String localName)Returns truewhen an attribute with a given local name
 and namespace URI is specified on this element or has a default value,falseotherwise. | 
| abstract  boolean | hasAttributes()Returns whether this node has any attributes. | 
| abstract  boolean | hasChildNodes()Determine whether the node has any children. | 
|  org.w3c.dom.Node | importNode(org.w3c.dom.Node importedNode,
           boolean deep)Import a node from another document to this document. | 
|  org.w3c.dom.Node | insertBefore(org.w3c.dom.Node newChild,
             org.w3c.dom.Node refChild)Insert the node newChildbefore the existing child noderefChild. | 
|  void | insertData(int offset,
           java.lang.String arg)Insert a string at the specified character offset. | 
|  boolean | isDefaultNamespace(java.lang.String namespaceURI)This method checks if the specified namespaceURIis the
 default namespace or not. | 
|  boolean | isElementContentWhitespace()Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace". | 
|  boolean | isEqualNode(org.w3c.dom.Node arg)Tests whether two nodes are equal. | 
|  boolean | isId()Returns whether this attribute is known to be of type ID (i.e. | 
|  boolean | isSameNode(org.w3c.dom.Node other)Returns whether this node is the same node as the given one. | 
| abstract  boolean | isSameNodeInfo(NodeInfo other)Determine whether this is the same node as another node | 
|  boolean | isSupported(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. | 
|  java.lang.String | lookupNamespaceURI(java.lang.String prefix)Look up the namespace URI associated to the given prefix, starting from this node. | 
|  java.lang.String | lookupPrefix(java.lang.String namespaceURI)Look up the prefix associated to the given namespace URI, starting from this node. | 
|  void | normalize()Puts all Textnodes in the full depth of the sub-tree
 underneath thisNode, including attribute nodes, into a
 "normal" form where only structure (e.g., elements, comments,
 processing instructions, CDATA sections, and entity references)
 separatesTextnodes, i.e., there are neither adjacentTextnodes nor emptyTextnodes. | 
|  void | outputNamespaceNodes(Outputter out,
                     boolean includeAncestors)Output all namespace nodes associated with this element. | 
|  void | removeAttribute(java.lang.String oldAttr)Removes the specified attribute. | 
|  org.w3c.dom.Attr | removeAttributeNode(org.w3c.dom.Attr oldAttr)Removes the specified attribute node. | 
|  void | removeAttributeNS(java.lang.String namespaceURI,
                  java.lang.String localName)Removes an attribute by local name and namespace URI. | 
|  org.w3c.dom.Node | removeChild(org.w3c.dom.Node oldChild)Remove the child node indicated by oldChildfrom the
 list of children, and returns it. | 
|  org.w3c.dom.Node | replaceChild(org.w3c.dom.Node newChild,
             org.w3c.dom.Node oldChild)Replace the child node oldChildwithnewChildin the list of children, and returns theoldChildnode. | 
|  void | replaceData(int offset,
            int count,
            java.lang.String arg)Replace the characters starting at the specified 16-bit unit offset with the specified string. | 
|  org.w3c.dom.Text | replaceWholeText(java.lang.String content)Replaces the text of the current node and all logically-adjacent text nodes with the specified text. | 
|  org.w3c.dom.Attr | setAttributeNode(org.w3c.dom.Attr newAttr)Adds a new attribute node. | 
|  org.w3c.dom.Attr | setAttributeNodeNS(org.w3c.dom.Attr newAttr)Add a new attribute. | 
|  void | setAttributeNS(java.lang.String namespaceURI,
               java.lang.String qualifiedName,
               java.lang.String value)Adds a new attribute. | 
|  void | setData(java.lang.String data)Set the character data of a Text or Comment node. | 
|  void | setIdAttribute(java.lang.String name,
               boolean isId)If the parameter isIdistrue, this method
 declares the specified attribute to be a user-determined ID attribute
 . | 
|  void | setIdAttributeNode(org.w3c.dom.Attr idAttr,
                   boolean isId)If the parameter isIdistrue, this method
 declares the specified attribute to be a user-determined ID attribute
 . | 
|  void | setIdAttributeNS(java.lang.String namespaceURI,
                 java.lang.String localName,
                 boolean isId)If the parameter isIdistrue, this method
 declares the specified attribute to be a user-determined ID attribute
 . | 
|  void | setNodeValue(java.lang.String nodeValue)Set the node value. | 
|  void | setPrefix(java.lang.String prefix)Set the namespace prefix of this node. | 
|  void | setTextContent(java.lang.String textContent)This attribute returns the text content of this node and its descendants. | 
|  java.lang.Object | setUserData(java.lang.String key,
            java.lang.Object data,
            org.w3c.dom.UserDataHandler handler)Associate an object to a key on this node. | 
|  void | setValue(java.lang.String value)Set the value of an attribute node. | 
|  org.w3c.dom.Text | splitText(int offset)Break this node into two nodes at the specified offset, keeping both in the tree as siblings. | 
|  java.lang.String | substringData(int offset,
              int count)Extract a range of data from a Text or Comment node. | 
|  boolean | supports(java.lang.String feature,
         java.lang.String version)Alternative to isSupported(), defined in a draft DOM spec | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface org.w3c.dom.Node | 
| getNodeType | 
| Methods inherited from interface com.icl.saxon.om.NodeInfo | 
| copy, getNodeType, getStringValue | 
| Methods inherited from interface javax.xml.transform.Source | 
| setSystemId | 
| Field Detail | 
public static final char[] NODE_LETTER
| Constructor Detail | 
public AbstractNode()
| Method Detail | 
public abstract boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo in interface NodeInfopublic abstract java.lang.String generateId()
generateId in interface NodeInfopublic abstract java.lang.String getSystemId()
getSystemId in interface NodeInfopublic abstract java.lang.String getBaseURI()
getBaseURI in interface NodeInfopublic org.w3c.dom.Node getOriginatingNode()
getOriginatingNode in interface DOMLocatorpublic abstract int compareOrder(NodeInfo other)
compareOrder in interface NodeInfoother - The other node, whose position is to be compared with this node
public abstract int getNameCode()
getNameCode in interface NodeInfoallocate, 
getFingerprintpublic abstract int getFingerprint()
getFingerprint in interface NodeInfopublic java.lang.String getNodeName()
getNodeName in interface org.w3c.dom.Nodepublic abstract java.lang.String getPrefix()
getPrefix in interface org.w3c.dom.Nodepublic abstract java.lang.String getURI()
getURI in interface NodeInfopublic java.lang.String getDisplayName()
getDisplayName in interface NodeInfopublic abstract java.lang.String getLocalName()
getLocalName in interface org.w3c.dom.Nodepublic abstract boolean hasChildNodes()
hasChildNodes in interface org.w3c.dom.Nodetrue if this node has any attributes,
   false otherwise.public abstract boolean hasAttributes()
hasAttributes in interface org.w3c.dom.Nodetrue if this node has any attributes,
   false otherwise.
public abstract java.lang.String getAttributeValue(java.lang.String uri,
                                                   java.lang.String localName)
getAttributeValue in interface NodeInfouri - the namespace uri of an attributelocalName - the local name of an attribute
public abstract java.lang.String getAttributeValue(int fingerprint)
getAttributeValue in interface NodeInfofingerprint - The fingerprint of the attribute name
public int getLineNumber()
getLineNumber in interface NodeInfopublic int getColumnNumber()
getColumnNumber in interface SourceLocatorSourceLocator.getLineNumber()public java.lang.String getPublicId()
getPublicId in interface SourceLocatorSourceLocator.getSystemId()
public abstract AxisEnumeration getEnumeration(byte axisNumber,
                                               NodeTest nodeTest)
getEnumeration in interface NodeInfoaxisNumber - The axis to be used (a constant in class Axis)nodeTest - A pattern to be matched by the returned nodes
public abstract NodeInfo getParent()
getParent in interface NodeInfopublic DocumentInfo getDocumentRoot()
getDocumentRoot in interface NodeInfopublic org.w3c.dom.Node getParentNode()
getParentNode in interface org.w3c.dom.Nodepublic org.w3c.dom.Node getPreviousSibling()
getPreviousSibling in interface org.w3c.dom.Nodepublic org.w3c.dom.Node getNextSibling()
getNextSibling in interface org.w3c.dom.Nodepublic org.w3c.dom.Node getFirstChild()
getFirstChild in interface org.w3c.dom.Nodepublic org.w3c.dom.Node getLastChild()
getLastChild in interface org.w3c.dom.Nodepublic org.w3c.dom.Element getDocumentElement()
public void copyStringValue(Outputter out)
                     throws TransformerException
copyStringValue in interface NodeInfoTransformerException
public void outputNamespaceNodes(Outputter out,
                                 boolean includeAncestors)
                          throws TransformerException
outputNamespaceNodes in interface NodeInfoout - The relevant outputterincludeAncestors - True if namespaces declared on ancestor elements must
 be output; false if it is known that these are already on the result tree
TransformerExceptionpublic java.lang.String getNodeValue()
getNodeValue in interface org.w3c.dom.Node
public void setNodeValue(java.lang.String nodeValue)
                  throws org.w3c.dom.DOMException
setNodeValue in interface org.w3c.dom.Nodeorg.w3c.dom.DOMExceptionpublic org.w3c.dom.NodeList getChildNodes()
NodeList that contains all children of this node. If
 there are no children, this is a NodeList containing no
 nodes. DOM Method.
getChildNodes in interface org.w3c.dom.Nodepublic org.w3c.dom.NamedNodeMap getAttributes()
NamedNodeMap containing the attributes of this node (if
 it is an Element ) or null otherwise. (DOM method)
getAttributes in interface org.w3c.dom.Nodepublic org.w3c.dom.Document getOwnerDocument()
Document object associated with this node. (DOM method)
getOwnerDocument in interface org.w3c.dom.Node
public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)
                              throws org.w3c.dom.DOMException
newChild before the existing child node
 refChild. DOM method: always fails.
insertBefore in interface org.w3c.dom.NodenewChild - The node to insert.refChild - The reference node, i.e., the node before which the
   new node must be inserted.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Always raised.
public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node oldChild)
                              throws org.w3c.dom.DOMException
oldChild with
 newChild in the list of children, and returns the
 oldChild node. Always fails.
replaceChild in interface org.w3c.dom.NodenewChild - The new node to put in the child list.oldChild - The node being replaced in the list.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Always raised.
public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                             throws org.w3c.dom.DOMException
oldChild from the
 list of children, and returns it. DOM method: always fails.
removeChild in interface org.w3c.dom.NodeoldChild - The node being removed.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Always raised.
public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
                             throws org.w3c.dom.DOMException
newChild to the end of the list of children
 of this node. DOM method: always fails.
appendChild in interface org.w3c.dom.NodenewChild - The node to add.
org.w3c.dom.DOMException - public org.w3c.dom.Node cloneNode(boolean deep)
cloneNode in interface org.w3c.dom.Nodedeep - If true , recursively clone the subtree under
   the specified node; if false , clone only the node
   itself (and its attributes, if it is an Element ).
public void normalize()
Text nodes in the full depth of the sub-tree
 underneath this Node, including attribute nodes, into a
 "normal" form where only structure (e.g., elements, comments,
 processing instructions, CDATA sections, and entity references)
 separates Text nodes, i.e., there are neither adjacent
 Text nodes nor empty Text nodes.
normalize in interface org.w3c.dom.Node
public boolean isSupported(java.lang.String feature,
                           java.lang.String version)
isSupported in interface org.w3c.dom.Nodefeature - The name of the feature to test. This is the same name
   which can be passed to the method hasFeature on
   DOMImplementation .version - This 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 .
true if the specified feature is supported
    on this node, false otherwise.
public boolean supports(java.lang.String feature,
                        java.lang.String version)
public java.lang.String getNamespaceURI()
null if it is
 unspecified. DOM method.
 ELEMENT_NODE and
 ATTRIBUTE_NODE and nodes created with a DOM Level 1
 method, such as createElement from the
 Document interface, this is always null .
 Per the  Namespaces in XML Specification  an attribute does not
 inherit its namespace from the element it is attached to. If an
 attribute is not explicitly given a namespace, it simply has no
 namespace.
getNamespaceURI in interface org.w3c.dom.Node
public void setPrefix(java.lang.String prefix)
               throws org.w3c.dom.DOMException
setPrefix in interface org.w3c.dom.Nodeorg.w3c.dom.DOMException
protected void disallowUpdate()
                       throws org.w3c.dom.DOMException
org.w3c.dom.DOMExceptionpublic org.w3c.dom.DocumentType getDoctype()
DocumentType )
 associated with this document. For HTML documents as well as XML
 documents without a document type declaration this returns
 null. DOM method.
public org.w3c.dom.DOMImplementation getImplementation()
DOMImplementation object that handles this document.
 A DOM application may use objects from multiple implementations.
 DOM method.
public org.w3c.dom.Element createElement(java.lang.String tagName)
                                  throws org.w3c.dom.DOMException
org.w3c.dom.DOMExceptionpublic org.w3c.dom.DocumentFragment createDocumentFragment()
DocumentFragment object.
DocumentFragment .
 DOM method: returns null, because the Saxon tree is not updateable.public org.w3c.dom.Text createTextNode(java.lang.String data)
Text node given the specified string.
 DOM method: returns null, because the Saxon tree is not updateable.
data - The data for the node.
Text object.public org.w3c.dom.Comment createComment(java.lang.String data)
Comment node given the specified string.
 DOM method: returns null, because the Saxon tree is not updateable.
data - The data for the node.
Comment object.
public org.w3c.dom.CDATASection createCDATASection(java.lang.String data)
                                            throws org.w3c.dom.DOMException
CDATASection node whose value  is the specified
 string.
 DOM method: always fails, because the Saxon tree is not updateable.
data - The data for the CDATASection contents.
CDATASection object.
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String target,
                                                                     java.lang.String data)
                                                              throws org.w3c.dom.DOMException
ProcessingInstruction node given the specified
 name and data strings.
 DOM method: returns null, because the Saxon tree is not updateable.
target - The target part of the processing instruction.data - The data for the node.
ProcessingInstruction object.
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified target contains an
   illegal character.
   
public org.w3c.dom.Attr createAttribute(java.lang.String name)
                                 throws org.w3c.dom.DOMException
Attr of the given name.
 DOM method: always fails, because the Saxon tree is not updateable.
name - The name of the attribute.
Attr object with the nodeName
   attribute set to name , and localName ,
   prefix , and namespaceURI set to
   null .
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
   illegal character.
public org.w3c.dom.EntityReference createEntityReference(java.lang.String name)
                                                  throws org.w3c.dom.DOMException
EntityReference object.
 DOM method: returns null, because the Saxon tree is not updateable.
name - The name of the entity to reference.
EntityReference object.
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
   illegal character.
   public org.w3c.dom.NodeList getElementsByTagName(java.lang.String tagname)
NodeList of all the Elements with
 a given tag name in the order in which they are encountered in a
 preorder traversal of the Document tree.
tagname - The name of the tag to match on. The special value "*"
   matches all tags.
NodeList object containing all the matched
   Elements .
public org.w3c.dom.Node importNode(org.w3c.dom.Node importedNode,
                                   boolean deep)
                            throws org.w3c.dom.DOMException
org.w3c.dom.DOMException
public org.w3c.dom.Element createElementNS(java.lang.String namespaceURI,
                                           java.lang.String qualifiedName)
                                    throws org.w3c.dom.DOMException
namespaceURI - The  namespace URI of the element to create.qualifiedName - The  qualified name of the element type to
   instantiate.
Element object
org.w3c.dom.DOMException
public org.w3c.dom.Attr createAttributeNS(java.lang.String namespaceURI,
                                          java.lang.String qualifiedName)
                                   throws org.w3c.dom.DOMException
namespaceURI - The  namespace URI of the attribute to create.qualifiedName - The  qualified name of the attribute to
   instantiate.
Attr object.
org.w3c.dom.DOMException
public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespaceURI,
                                                   java.lang.String localName)
NodeList of all the Elements with
 a given  local name and namespace URI in the order in which they are
 encountered in a preorder traversal of the Document tree.
 DOM method.
namespaceURI - The  namespace URI of the elements to match on.
   The special value "*" matches all namespaces.localName - The  local name of the elements to match on. The
   special value "*" matches all local names.
NodeList object containing all the matched
   Elements .public org.w3c.dom.Element getElementById(java.lang.String elementId)
Element whose ID is given by
 elementId . If no such element exists, returns
 null . Behavior is not defined if more than one element
 has this ID .  The DOM implementation must have
 information that says which attributes are of type ID. Attributes with
 the name "ID" are not of type ID unless so defined. Implementations
 that do not know whether attributes are of type ID or not are expected
 to return null .
elementId - The unique id value for an element.
public java.lang.String getTagName()
public java.lang.String getAttribute(java.lang.String name)
name - The QName of the attribute to retrieve.
Attr value as a string, or the empty string if
    that attribute does not have a specified or default value.public org.w3c.dom.Attr getAttributeNode(java.lang.String name)
getAttributeNodeNS method.
name - The name (nodeName ) of the attribute to
   retrieve.
Attr node with the specified name (
   nodeName ) or null if there is no such
   attribute.
public org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr newAttr)
                                  throws org.w3c.dom.DOMException
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void removeAttribute(java.lang.String oldAttr)
                     throws org.w3c.dom.DOMException
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr oldAttr)
                                     throws org.w3c.dom.DOMException
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public java.lang.String getAttributeNS(java.lang.String namespaceURI,
                                       java.lang.String localName)
namespaceURI - The  namespace URI of the attribute to retrieve.localName - The  local name of the attribute to retrieve.
Attr value as a string, or the empty string if
    that attribute does not have a specified or default value.
public void setAttributeNS(java.lang.String namespaceURI,
                           java.lang.String qualifiedName,
                           java.lang.String value)
                    throws org.w3c.dom.DOMException
namespaceURI - The  namespace URI of the attribute to create or
   alter.qualifiedName - The  qualified name of the attribute to create or
   alter.value - The value to set in string form.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void removeAttributeNS(java.lang.String namespaceURI,
                              java.lang.String localName)
                       throws org.w3c.dom.DOMException
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public org.w3c.dom.Attr getAttributeNodeNS(java.lang.String namespaceURI,
                                           java.lang.String localName)
Attr node by local name and namespace URI.
 DOM method, so namespace declarations count as attributes.
namespaceURI - The  namespace URI of the attribute to retrieve.localName - The  local name of the attribute to retrieve.
Attr node with the specified attribute local
   name and namespace URI or null if there is no such
   attribute.
public org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr newAttr)
                                    throws org.w3c.dom.DOMException
newAttr - The Attr node to add to the attribute list.
newAttr attribute replaces an existing
   attribute with the same  local name and  namespace URI , the
   replaced Attr node is returned, otherwise
   null is returned.
org.w3c.dom.DOMException - public boolean hasAttribute(java.lang.String name)
true when an attribute with a given name is
 specified on this element or has a default value, false
 otherwise.
 Namespace declarations will not be retrieved.
name - The name of the attribute to look for.
true if an attribute with the given name is
   specified on this element or has a default value, false
   otherwise.
public boolean hasAttributeNS(java.lang.String namespaceURI,
                              java.lang.String localName)
true when an attribute with a given local name
 and namespace URI is specified on this element or has a default value,
 false otherwise.
 Namespace declarations will not be retrieved.
namespaceURI - The  namespace URI of the attribute to look for.localName - The  local name of the attribute to look for.
true if an attribute with the given local name and
   namespace URI is specified or has a default value on this element,
   false otherwise.public java.lang.String getData()
public void setData(java.lang.String data)
             throws org.w3c.dom.DOMException
org.w3c.dom.DOMExceptionpublic int getLength()
public java.lang.String substringData(int offset,
                                      int count)
                               throws org.w3c.dom.DOMException
offset - Start offset of substring to extract.count - The number of 16-bit units to extract.
offset and
   count exceeds the length , then all 16-bit
   units to the end of the data are returned.
org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
   negative or greater than the number of 16-bit units in
   data , or if the specified count is
   negative.
public void appendData(java.lang.String arg)
                throws org.w3c.dom.DOMException
arg - The DOMString to append.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void insertData(int offset,
                       java.lang.String arg)
                throws org.w3c.dom.DOMException
offset - The character offset at which to insert.arg - The DOMString to insert.
org.w3c.dom.DOMException
public void deleteData(int offset,
                       int count)
                throws org.w3c.dom.DOMException
offset - The offset from which to start removing.count - The number of 16-bit units to delete.
org.w3c.dom.DOMException
public void replaceData(int offset,
                        int count,
                        java.lang.String arg)
                 throws org.w3c.dom.DOMException
offset - The offset from which to start replacing.count - The number of 16-bit units to replace.arg - The DOMString with which the range must be
   replaced.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public org.w3c.dom.Text splitText(int offset)
                           throws org.w3c.dom.DOMException
offset - The 16-bit unit offset at which to split, starting from 0.
org.w3c.dom.DOMExceptionpublic java.lang.String getName()
public java.lang.String getValue()
public boolean getSpecified()
true ; otherwise, it is
 false. (DOM method)
public void setValue(java.lang.String value)
              throws org.w3c.dom.DOMException
org.w3c.dom.DOMExceptionpublic org.w3c.dom.Element getOwnerElement()
Element node this attribute is attached to or
 null if this attribute is not in use.
public org.w3c.dom.TypeInfo getSchemaTypeInfo()
Document.normalizeDocument(), schemaTypeInfo
 may not be reliable if the node was moved.
 This implementation always returns null;
public boolean isId()
This implementation always returns false.
public short compareDocumentPosition(org.w3c.dom.Node other)
                              throws org.w3c.dom.DOMException
other - The node to compare against the reference node.
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: when the compared nodes are from different DOM
                                  implementations that do not coordinate to return consistent
                                  implementation-specific results.
public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)
Node
 interface.
feature - The name of the feature requested. Note that any plus
                sign "+" prepended to the name of the feature will be ignored since
                it is not significant in the context of this method.version - This is the version number of the feature to test.
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.
 The Saxon implementation of this method always returns null
public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException
null, setting it
 has no effect. On setting, any possible children this node may have
 are removed and, if it the new string is not empty or
 null, replaced by a single Text node
 containing the string this attribute is set to.
 Text.isElementContentWhitespace). Similarly, on setting,
 no parsing is performed either, the input string is taken as pure
 textual content.
 | Node type | Content | 
|---|---|
| ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the textContentattribute value of every child node, excluding COMMENT_NODE and
 PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the
 node has no children. | 
| TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue | 
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null | 
The Saxon implementation returns the same result as getStringValue()
org.w3c.dom.DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than
                                  fit in a DOMString variable on the implementation
                                  platform.public java.lang.Object getUserData(java.lang.String key)
setUserData with the same key.
 The Saxon implementation always returns null.
key - The key the object is associated to.
DOMUserData associated to the given
         key on this node, or null if there was none.public boolean isDefaultNamespace(java.lang.String namespaceURI)
namespaceURI is the
 default namespace or not.
namespaceURI - The namespace URI to look for.
true if the specified
         namespaceURI is the default namespace,
         false otherwise.public boolean isEqualNode(org.w3c.dom.Node arg)
Node.isSameNode(). All nodes that are the
 same will also be equal, though the reverse may not be true.
 nodeName, localName,
 namespaceURI, prefix, nodeValue
 . This is: they are both null, or they have the same
 length and are character for character identical.
 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.
 childNodes NodeLists are equal.
 This is: they are both null, or they have the same
 length and contain equal nodes at the same index. Note that
 normalization can affect equality; to avoid this, nodes should be
 normalized before being compared.
 DocumentType nodes to be equal, the following
 conditions must also be satisfied:
 publicId, systemId,
 internalSubset.
 entities
 NamedNodeMaps are equal.
 notations
 NamedNodeMaps are equal.
 ownerDocument, baseURI, and
 parentNode attributes, the specified
 attribute for Attr nodes, the schemaTypeInfo
 attribute for Attr and Element nodes, the
 Text.isElementContentWhitespace attribute for
 Text nodes, as well as any user data or event listeners
 registered on the nodes.
 Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.
arg - The node to compare equality with.
true if the nodes are equal,
         false otherwise.public boolean isSameNode(org.w3c.dom.Node other)
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 interchangeably, such that all attributes have the
 same values and calling the same DOM method on either reference
 always has exactly the same effect.
other - The node to test against.
true if the nodes are the same,
         false otherwise.public java.lang.String lookupNamespaceURI(java.lang.String prefix)
prefix - The prefix to look for. If this parameter is
               null, the method will return the default namespace URI
               if any.
null if
         none is found.public java.lang.String lookupPrefix(java.lang.String namespaceURI)
namespaceURI - The namespace URI to look for.
null if none is found. If more than one prefix are
         associated to the namespace prefix, the returned namespace prefix
         is implementation dependent.
public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException
null, setting it
 has no effect. On setting, any possible children this node may have
 are removed and, if it the new string is not empty or
 null, replaced by a single Text node
 containing the string this attribute is set to.
 Text.isElementContentWhitespace). Similarly, on setting,
 no parsing is performed either, the input string is taken as pure
 textual content.
 | Node type | Content | 
|---|---|
| ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the textContentattribute value of every child node, excluding COMMENT_NODE and
 PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the
 node has no children. | 
| TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue | 
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null | 
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.UserDataHandler handler)
getUserData with the
 same key.
key - The key to associate the object to.data - The object to associate to the given key, or
                null to remove any existing association to that key.handler - The handler to associate to that key, or
                null.
DOMUserData previously associated to
         the given key on this node, or null if there was none.public java.lang.String getWholeText()
Text nodes logically-adjacent text
 nodes to this node, concatenated in document order.
 wholeText on the
 Text node that contains "bar" returns "barfoo", while on
 the Text node that contains "foo" it returns "barfoo".
public boolean isElementContentWhitespace()
Document.normalizeDocument().
 The Saxon implementation always returns false.
public org.w3c.dom.Text replaceWholeText(java.lang.String content)
                                  throws org.w3c.dom.DOMException
null, when the replacement text is
 the empty string;
 Text node of the same type (
 Text or CDATASection) as the current node
 inserted at the location of the replacement.
 replaceWholeText on the Text node that
 contains "bar" with "yo" in argument results in the following:
 EntityReference, the EntityReference must
 be removed instead of the read-only nodes. If any
 EntityReference to be removed has descendants that are
 not EntityReference, Text, or
 CDATASection nodes, the replaceWholeText
 method must fail before performing any modification of the document,
 raising a DOMException with the code
 NO_MODIFICATION_ALLOWED_ERR.
 replaceWholeText on the Text node that
 contains "bar" fails, because the EntityReference node
 "ent" contains an Element node which cannot be removed.
content - The content of the replacing Text node.
Text node created with the specified content.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text
                                  nodes being replaced is readonly.
public void setIdAttribute(java.lang.String name,
                           boolean isId)
                    throws org.w3c.dom.DOMException
isId is true, this method
 declares the specified attribute to be a user-determined ID attribute
 . This affects the value of Attr.isId and the behavior
 of Document.getElementById, but does not change any
 schema that may be in use, in particular this does not affect the
 Attr.schemaTypeInfo of the specified Attr
 node. Use the value false for the parameter
 isId to undeclare an attribute for being a
 user-determined ID attribute.
 setIdAttributeNS method.
name - The name of the attribute.isId - Whether the attribute is a of type ID.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
                                  
public void setIdAttributeNode(org.w3c.dom.Attr idAttr,
                               boolean isId)
                        throws org.w3c.dom.DOMException
isId is true, this method
 declares the specified attribute to be a user-determined ID attribute
 . This affects the value of Attr.isId and the behavior
 of Document.getElementById, but does not change any
 schema that may be in use, in particular this does not affect the
 Attr.schemaTypeInfo of the specified Attr
 node. Use the value false for the parameter
 isId to undeclare an attribute for being a
 user-determined ID attribute.
idAttr - The attribute node.isId - Whether the attribute is a of type ID.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
                                  
public void setIdAttributeNS(java.lang.String namespaceURI,
                             java.lang.String localName,
                             boolean isId)
                      throws org.w3c.dom.DOMException
isId is true, this method
 declares the specified attribute to be a user-determined ID attribute
 . This affects the value of Attr.isId and the behavior
 of Document.getElementById, but does not change any
 schema that may be in use, in particular this does not affect the
 Attr.schemaTypeInfo of the specified Attr
 node. Use the value false for the parameter
 isId to undeclare an attribute for being a
 user-determined ID attribute.
namespaceURI - The namespace URI of the attribute.localName - The local name of the attribute.isId - Whether the attribute is a of type ID.
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
                                  | 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||