| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.icl.saxon.om.AbstractNode
com.icl.saxon.tree.NodeImpl
com.icl.saxon.tree.ParentNodeImpl
com.icl.saxon.tree.DocumentImpl
A node in the XML parse tree representing the Document itself (or equivalently, the root node of the Document).
| Field Summary | |
| protected  int | sequence | 
| Fields inherited from class com.icl.saxon.tree.NodeImpl | 
| emptyArray, parent | 
| Fields inherited from class com.icl.saxon.om.AbstractNode | 
| NODE_LETTER | 
| Fields inherited from interface com.icl.saxon.om.NodeInfo | 
| ATTRIBUTE, COMMENT, ELEMENT, NAMESPACE, NODE, NONE, NUMBER_OF_TYPES, PI, ROOT, TEXT | 
| 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 | 
| Constructor Summary | |
| DocumentImpl() | |
| Method Summary | |
|  void | addChild(NodeImpl node,
         int index)Add a child node to this node. | 
|  org.w3c.dom.Node | adoptNode(org.w3c.dom.Node source)Attempts to adopt a node from another document to this document. | 
|  void | compact(int size)Compact the space used by this node | 
|  void | copy(Outputter out)Copy this node to a given outputter | 
|  void | copyStringValue(Outputter out)Copy the string-value of this node to a given outputter | 
|  void | dropChildren()Drop a branch of the tree. | 
|  AxisEnumeration | enumerateChildren(NodeTest test)Get an enumeration of the children of this node | 
|  java.lang.String | generateId()Get a character string that uniquely identifies this node within the document | 
| protected  AxisEnumeration | getAllElements(int fingerprint)Get a list of all elements with a given name fingerprint | 
|  java.lang.String | getBaseURI()Get the base URI of this root node. | 
|  java.lang.StringBuffer | getCharacterBuffer()Get the character buffer | 
|  org.w3c.dom.NodeList | getChildNodes()Return a NodeListthat contains all children of this node. | 
|  org.w3c.dom.Element | getDocumentElement()Get the root (outermost) element. | 
|  DocumentInfo | getDocumentRoot()Get the root (document) node | 
|  java.lang.String | getDocumentURI()The location of the document or nullif undefined or if
 theDocumentwas created usingDOMImplementation.createDocument. | 
|  org.w3c.dom.DOMConfiguration | getDomConfig()The configuration used when Document.normalizeDocument()is invoked. | 
|  org.w3c.dom.Node | getFirstChild()Get the first child node of the element | 
|  java.lang.String | getInputEncoding()An attribute specifying the encoding used for this document at the time of the parsing. | 
|  java.util.Hashtable | getKeyIndex(KeyManager keymanager,
            int fingerprint)Get the index for a given key | 
|  org.w3c.dom.Node | getLastChild()Get the last child node of the element | 
|  int | getLineNumber()Get the line number of this root node. | 
| protected  int | getLineNumber(int sequence)Get the line number for an element. | 
|  NamePool | getNamePool()Get the name pool used for the names in this document | 
|  org.w3c.dom.Node | getNextSibling()Get next sibling - always null | 
|  NodeFactory | getNodeFactory()Get the node factory that was used to build this document | 
|  short | getNodeType()Return the type of node. | 
|  java.lang.String | getNodeValue()Get the node value as defined in the DOM. | 
| protected  NodeImpl | getNthChild(int n)Get the nth child node of the element (numbering from 0) | 
|  org.w3c.dom.Node | getPreviousSibling()Get previous sibling - always null | 
| protected  long | getSequenceNumber()Get the node sequence number (in document order). | 
|  boolean | getStrictErrorChecking()An attribute specifying whether error checking is enforced or not. | 
|  java.lang.String | getStringValue()Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes. | 
|  java.lang.String | getSystemId()Get the system id of this root node | 
| protected  java.lang.String | getSystemId(int seq)Get the system id of an element in the document | 
|  java.lang.String | getUnparsedEntity(java.lang.String name)Get the unparsed entity with a given name | 
|  java.lang.String | getXmlEncoding()An attribute specifying, as part of the XML declaration, the encoding of this document. | 
|  boolean | getXmlStandalone()An attribute specifying, as part of the XML declaration, whether this document is standalone. | 
|  java.lang.String | getXmlVersion()An attribute specifying, as part of the XML declaration, the version number of this document. | 
|  boolean | hasChildNodes()Determine if the node has any children. | 
|  void | normalizeDocument()This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. | 
|  void | removeChild(int index)Remove node at given index. | 
|  org.w3c.dom.Node | renameNode(org.w3c.dom.Node n,
           java.lang.String namespaceURI,
           java.lang.String qualifiedName)Rename an existing node of type ELEMENT_NODEorATTRIBUTE_NODE. | 
|  void | renumberChildren()Renumber the children of a given parent node. | 
|  NodeInfo | selectID(java.lang.String id)Get the element with a given ID. | 
| protected  void | setCharacterBuffer(java.lang.StringBuffer buffer)Set the character buffer | 
| protected  void | setDocumentElement(ElementImpl e)Set the top-level element of the document (variously called the root element or the document element). | 
|  void | setDocumentURI(java.lang.String documentURI)The location of the document or nullif undefined or if
 theDocumentwas created usingDOMImplementation.createDocument. | 
|  void | setKeyIndex(KeyManager keymanager,
            int fingerprint,
            java.util.Hashtable keyindex)Set the index for a given key. | 
| protected  void | setLineNumber(int sequence,
              int line)Set the line number for an element. | 
|  void | setLineNumbering()Set line numbering on | 
|  void | setNamePool(NamePool pool)Set the name pool used for all names in this document | 
|  void | setNodeFactory(NodeFactory factory)Set the node factory that was used to build this document | 
|  void | setStrictErrorChecking(boolean strictErrorChecking)An attribute specifying whether error checking is enforced or not. | 
| protected  void | setSystemId(int seq,
            java.lang.String uri)Set the system id of an element in the document | 
|  void | setSystemId(java.lang.String uri)Set the system id of this node | 
| protected  void | setUnparsedEntity(java.lang.String name,
                  java.lang.String uri)Set an unparsed entity URI associated with this document. | 
|  void | setXmlStandalone(boolean xmlStandalone)An attribute specifying, as part of the XML declaration, whether this document is standalone. | 
|  void | setXmlVersion(java.lang.String xmlVersion)An attribute specifying, as part of the XML declaration, the version number of this document. | 
|  void | useChildrenArray(NodeImpl[] array)Supply an array to be used for the array of children. | 
| Methods inherited from class com.icl.saxon.tree.NodeImpl | 
| compareOrder, getAttributes, getAttributeValue, getAttributeValue, getDisplayName, getEnumeration, getFingerprint, getLocalName, getNameCode, getNextInDocument, getOriginatingNode, getParent, getPrefix, getPreviousInDocument, getURI, hasAttributes, isSameNodeInfo, outputNamespaceNodes, removeNode | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface com.icl.saxon.om.NodeInfo | 
| compareOrder, copyStringValue, getAttributeValue, getAttributeValue, getDisplayName, getEnumeration, getFingerprint, getLocalName, getNameCode, getParent, getPrefix, getStringValue, getURI, hasChildNodes, isSameNodeInfo, outputNamespaceNodes | 
| Methods inherited from interface org.w3c.dom.Document | 
| createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, importNode | 
| Methods inherited from interface org.w3c.dom.Node | 
| appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix | 
| Field Detail | 
protected int sequence
| Constructor Detail | 
public DocumentImpl()
| Method Detail | 
protected void setCharacterBuffer(java.lang.StringBuffer buffer)
public final java.lang.StringBuffer getCharacterBuffer()
public void setNamePool(NamePool pool)
setNamePool in interface DocumentInfopublic NamePool getNamePool()
getNamePool in interface DocumentInfogetNamePool in class NodeImplpublic void setNodeFactory(NodeFactory factory)
public NodeFactory getNodeFactory()
protected void setDocumentElement(ElementImpl e)
e - the top-level elementpublic void setSystemId(java.lang.String uri)
setSystemId in interface SourcesetSystemId in class NodeImplpublic java.lang.String getSystemId()
getSystemId in interface NodeInfogetSystemId in class NodeImplpublic java.lang.String getBaseURI()
getBaseURI in interface NodeInfogetBaseURI in class NodeImpl
protected void setSystemId(int seq,
                           java.lang.String uri)
protected java.lang.String getSystemId(int seq)
public void setLineNumbering()
protected void setLineNumber(int sequence,
                             int line)
protected int getLineNumber(int sequence)
public int getLineNumber()
getLineNumber in interface NodeInfogetLineNumber in class NodeImplpublic final short getNodeType()
getNodeType in interface NodeInfopublic final org.w3c.dom.Node getNextSibling()
getNextSibling in interface org.w3c.dom.NodegetNextSibling in class NodeImplpublic final org.w3c.dom.Node getPreviousSibling()
getPreviousSibling in interface org.w3c.dom.NodegetPreviousSibling in class NodeImplpublic org.w3c.dom.Element getDocumentElement()
getDocumentElement in interface org.w3c.dom.DocumentgetDocumentElement in class NodeImplpublic DocumentInfo getDocumentRoot()
getDocumentRoot in interface NodeInfogetDocumentRoot in class NodeImplpublic java.lang.String generateId()
generateId in interface NodeInfogenerateId in class NodeImplprotected AxisEnumeration getAllElements(int fingerprint)
public NodeInfo selectID(java.lang.String id)
selectID in interface DocumentInfoid - The unique ID of the required element, previously registered using registerID()
public java.util.Hashtable getKeyIndex(KeyManager keymanager,
                                       int fingerprint)
getKeyIndex in interface DocumentInfokeymanager - The key manager managing this keyfingerprint - The fingerprint of the name of the key (unique with the key manager)
public void setKeyIndex(KeyManager keymanager,
                        int fingerprint,
                        java.util.Hashtable keyindex)
setKeyIndex in interface DocumentInfokeymanager - The key manager managing this keyfingerprint - The fingerprint of the name of the key (unique with the key manager)keyindex - the index, in the form of a Hashtable that
 maps the key value to a Vector of nodes having that key value. Or the String
 "under construction", indicating that the index is being built.
protected void setUnparsedEntity(java.lang.String name,
                                 java.lang.String uri)
public java.lang.String getUnparsedEntity(java.lang.String name)
getUnparsedEntity in interface DocumentInfoname - the name of the entity
public void copy(Outputter out)
          throws TransformerException
copy in interface NodeInfoTransformerException
public org.w3c.dom.Node adoptNode(org.w3c.dom.Node source)
                           throws org.w3c.dom.DOMException
source - The node to move into this document.
null if this operation
         fails, such as when the source node comes from a different
         implementation.
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the source node is of type
                                  DOCUMENT, DOCUMENT_TYPE.
                                  public java.lang.String getDocumentURI()
null if undefined or if
 the Document was created using
 DOMImplementation.createDocument. No lexical checking is
 performed when setting this attribute; this could result in a
 null value returned when using Node.baseURI
 .
 Document supports the feature
 "HTML" [DOM Level 2 HTML]
 , the href attribute of the HTML BASE element takes precedence over
 this attribute when computing Node.baseURI.
public org.w3c.dom.DOMConfiguration getDomConfig()
Document.normalizeDocument()
 is invoked.
public java.lang.String getInputEncoding()
null when it is not known, such
 as when the Document was created in memory.
public boolean getStrictErrorChecking()
false, the implementation is free to not test
 every possible error case normally defined on DOM operations, and not
 raise any DOMException on DOM operations or report
 errors while using Document.normalizeDocument(). In case
 of error, the behavior is undefined. This attribute is
 true by default.
public java.lang.String getXmlEncoding()
null when
 unspecified or when it is not known, such as when the
 Document was created in memory.
public boolean getXmlStandalone()
false when
 unspecified.
 Note:  No verification is done on the value when setting
 this attribute. Applications should use
 Document.normalizeDocument() with the "validate"
 parameter to verify if the value matches the validity
 constraint for standalone document declaration as defined in [XML 1.0].
public java.lang.String getXmlVersion()
"1.0".
public void normalizeDocument()
public org.w3c.dom.Node renameNode(org.w3c.dom.Node n,
                                   java.lang.String namespaceURI,
                                   java.lang.String qualifiedName)
                            throws org.w3c.dom.DOMException
ELEMENT_NODE or
 ATTRIBUTE_NODE.
n - The node to rename.namespaceURI - The new namespace URI.qualifiedName - The new qualified name.
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised when the type of the specified node is
                                  neither ELEMENT_NODE nor ATTRIBUTE_NODE,
                                  or if the implementation does not support the renaming of the
                                  document element.
                                  Document.xmlVersion attribute.
                                  qualifiedName is a
                                  malformed qualified name, if the qualifiedName has a
                                  prefix and the namespaceURI is null, or
                                  if the qualifiedName has a prefix that is "xml" and
                                  the namespaceURI is different from "
                                  http://www.w3.org/XML/1998/namespace" [XML Namespaces]
                                  . Also raised, when the node being renamed is an attribute, if the
                                  qualifiedName, or its prefix, is "xmlns" and the
                                  namespaceURI is different from "http://www.w3.org/2000/xmlns/".public void setDocumentURI(java.lang.String documentURI)
null if undefined or if
 the Document was created using
 DOMImplementation.createDocument. No lexical checking is
 performed when setting this attribute; this could result in a
 null value returned when using Node.baseURI
 .
 Document supports the feature
 "HTML" [DOM Level 2 HTML]
 , the href attribute of the HTML BASE element takes precedence over
 this attribute when computing Node.baseURI.
public void setStrictErrorChecking(boolean strictErrorChecking)
false, the implementation is free to not test
 every possible error case normally defined on DOM operations, and not
 raise any DOMException on DOM operations or report
 errors while using Document.normalizeDocument(). In case
 of error, the behavior is undefined. This attribute is
 true by default.
public void setXmlStandalone(boolean xmlStandalone)
                      throws org.w3c.dom.DOMException
false when
 unspecified.
 Note:  No verification is done on the value when setting
 this attribute. Applications should use
 Document.normalizeDocument() with the "validate"
 parameter to verify if the value matches the validity
 constraint for standalone document declaration as defined in [XML 1.0].
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if this document does not support the
                                  "XML" feature.
public void setXmlVersion(java.lang.String xmlVersion)
                   throws org.w3c.dom.DOMException
"1.0". If this document does not support the "XML"
 feature, the value is always null. Changing this
 attribute will affect methods that check for invalid characters in
 XML names. Application should invoke
 Document.normalizeDocument() in order to check for
 invalid characters in the Nodes that are already part of
 this Document.
 DOMImplementation.hasFeature(feature, version) method
 with parameter values "XMLVersion" and "1.0" (respectively) to
 determine if an implementation supports [XML 1.0]. DOM
 applications may use the same method with parameter values
 "XMLVersion" and "1.1" (respectively) to determine if an
 implementation supports [XML 1.1]. In both
 cases, in order to support XML, an implementation must also support
 the "XML" feature defined in this specification. Document
 objects supporting a version of the "XMLVersion" feature must not
 raise a NOT_SUPPORTED_ERR exception for the same version
 number when using Document.xmlVersion.
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the version is set to a value that is
                                  not supported by this Document or if this document
                                  does not support the "XML" feature.protected final long getSequenceNumber()
getSequenceNumber in class NodeImplpublic final boolean hasChildNodes()
hasChildNodes in interface org.w3c.dom.NodehasChildNodes in class NodeImpltrue if the node has any children,
   false if the node has no children.public final AxisEnumeration enumerateChildren(NodeTest test)
public final org.w3c.dom.Node getFirstChild()
getFirstChild in interface org.w3c.dom.NodegetFirstChild in class NodeImplpublic final org.w3c.dom.Node getLastChild()
getLastChild in interface org.w3c.dom.NodegetLastChild in class NodeImplpublic final 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.
getChildNodes in interface org.w3c.dom.NodegetChildNodes in class NodeImplprotected final NodeImpl getNthChild(int n)
public java.lang.String getStringValue()
public void copyStringValue(Outputter out)
                     throws TransformerException
copyStringValue in interface NodeInfocopyStringValue in class AbstractNodeTransformerExceptionpublic void useChildrenArray(NodeImpl[] array)
public void addChild(NodeImpl node,
                     int index)
public void removeChild(int index)
public void renumberChildren()
public void dropChildren()
public void compact(int size)
public java.lang.String getNodeValue()
getNodeValue in interface org.w3c.dom.NodegetNodeValue in class AbstractNode| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||