com.icl.saxon.tree

Class DocumentImpl

Implemented Interfaces:
Document, DocumentInfo, DOMLocator, Node, NodeInfo, Source, SourceLocator

public final class DocumentImpl
extends ParentNodeImpl
implements DocumentInfo, Document

A node in the XML parse tree representing the Document itself (or equivalently, the root node of the Document).

Author:
Michael H. Kay

Field Summary

Fields inherited from class com.icl.saxon.tree.ParentNodeImpl

sequence

Fields inherited from class com.icl.saxon.tree.NodeImpl

emptyArray, index, 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

Constructor Summary

DocumentImpl()

Method Summary

Node
adoptNode(Node source)
Attempts to adopt a node from another document to this document.
void
copy(Outputter out)
Copy this node to a given outputter
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
String
getBaseURI()
Get the base URI of this root node.
StringBuffer
getCharacterBuffer()
Get the character buffer
Element
getDocumentElement()
Get the root (outermost) element.
DocumentInfo
getDocumentRoot()
Get the root (document) node
String
getDocumentURI()
The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument.
org.w3c.dom.DOMConfiguration
getDomConfig()
The configuration used when Document.normalizeDocument() is invoked.
String
getInputEncoding()
An attribute specifying the encoding used for this document at the time of the parsing.
Hashtable
getKeyIndex(KeyManager keymanager, int fingerprint)
Get the index for a given key
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
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.
Node
getPreviousSibling()
Get previous sibling - always null
boolean
getStrictErrorChecking()
An attribute specifying whether error checking is enforced or not.
String
getSystemId()
Get the system id of this root node
protected String
getSystemId(int seq)
Get the system id of an element in the document
String
getUnparsedEntity(String name)
Get the unparsed entity with a given name
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.
String
getXmlVersion()
An attribute specifying, as part of the XML declaration, the version number of this document.
void
normalizeDocument()
This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form.
Node
renameNode(Node n, String namespaceURI, String qualifiedName)
Rename an existing node of type ELEMENT_NODE or ATTRIBUTE_NODE.
NodeInfo
selectID(String id)
Get the element with a given ID.
protected void
setCharacterBuffer(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(String documentURI)
The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument.
void
setKeyIndex(KeyManager keymanager, int fingerprint, 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.
void
setSystemId(String uri)
Set the system id of this node
protected void
setSystemId(int seq, String uri)
Set the system id of an element in the document
protected void
setUnparsedEntity(String name, 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(String xmlVersion)
An attribute specifying, as part of the XML declaration, the version number of this document.

Methods inherited from class com.icl.saxon.tree.ParentNodeImpl

addChild, compact, copyStringValue, dropChildren, enumerateChildren, getChildNodes, getFirstChild, getLastChild, getNodeValue, getNthChild, getSequenceNumber, getStringValue, hasChildNodes, removeChild, renumberChildren, useChildrenArray

Methods inherited from class com.icl.saxon.tree.NodeImpl

compareOrder, generateId, getAttributeValue, getAttributeValue, getAttributes, getBaseURI, getChildNodes, getDisplayName, getDocumentElement, getDocumentRoot, getEnumeration, getFingerprint, getFirstChild, getLastChild, getLineNumber, getLocalName, getNameCode, getNamePool, getNextInDocument, getNextSibling, getOriginatingNode, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getSequenceNumber, getSystemId, getURI, hasAttributes, hasChildNodes, isSameNodeInfo, outputNamespaceNodes, removeNode, setSystemId

Methods inherited from class com.icl.saxon.om.AbstractNode

appendChild, appendData, cloneNode, compareDocumentPosition, compareOrder, copyStringValue, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, generateId, getAttribute, getAttributeNS, getAttributeNode, getAttributeNodeNS, getAttributeValue, getAttributeValue, getAttributes, getBaseURI, getChildNodes, getColumnNumber, getData, getDisplayName, getDoctype, getDocumentElement, getDocumentRoot, getElementById, getElementsByTagName, getElementsByTagNameNS, getEnumeration, getFeature, getFingerprint, getFirstChild, getImplementation, getLastChild, getLength, getLineNumber, getLocalName, getName, getNameCode, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOriginatingNode, getOwnerDocument, getOwnerElement, getParent, getParentNode, getPrefix, getPreviousSibling, getPublicId, getSchemaTypeInfo, getSpecified, getSystemId, getTagName, getTextContent, getURI, getUserData, getValue, getWholeText, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, importNode, insertBefore, insertData, isDefaultNamespace, isElementContentWhitespace, isEqualNode, isId, isSameNode, isSameNodeInfo, isSupported, lookupNamespaceURI, lookupPrefix, normalize, outputNamespaceNodes, removeAttribute, removeAttributeNS, removeAttributeNode, removeChild, replaceChild, replaceData, replaceWholeText, setAttributeNS, setAttributeNode, setAttributeNodeNS, setData, setIdAttribute, setIdAttributeNS, setIdAttributeNode, setNodeValue, setPrefix, setTextContent, setUserData, setValue, splitText, substringData, supports

Constructor Details

DocumentImpl

public DocumentImpl()

Method Details

adoptNode

public Node adoptNode(Node source)
            throws DOMException
Attempts to adopt a node from another document to this document.
Parameters:
source - The node to move into this document.
Returns:
The adopted node, or null if this operation fails, such as when the source node comes from a different implementation.
Since:
DOM Level 3

copy

public void copy(Outputter out)
            throws TransformerException
Copy this node to a given outputter
Specified by:
copy in interface NodeInfo

generateId

public String generateId()
Get a character string that uniquely identifies this node within the document
Specified by:
generateId in interface NodeInfo
Overrides:
generateId in interface NodeImpl
Returns:
the empty string

getAllElements

protected AxisEnumeration getAllElements(int fingerprint)
Get a list of all elements with a given name fingerprint

getBaseURI

public String getBaseURI()
Get the base URI of this root node. For a root node the base URI is the same as the System ID.
Specified by:
getBaseURI in interface NodeInfo
Overrides:
getBaseURI in interface NodeImpl

getCharacterBuffer

public final StringBuffer getCharacterBuffer()
Get the character buffer

getDocumentElement

public Element getDocumentElement()
Get the root (outermost) element.
Overrides:
getDocumentElement in interface NodeImpl
Returns:
the Element node for the outermost element of the document.

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root (document) node
Specified by:
getDocumentRoot in interface NodeInfo
Overrides:
getDocumentRoot in interface NodeImpl
Returns:
the DocumentInfo representing this document

getDocumentURI

public String getDocumentURI()
Since:
DOM Level 3

getDomConfig

public org.w3c.dom.DOMConfiguration getDomConfig()
The configuration used when Document.normalizeDocument() is invoked.
Since:
DOM Level 3

getInputEncoding

public String getInputEncoding()
An attribute specifying the encoding used for this document at the time of the parsing. This is null when it is not known, such as when the Document was created in memory.
Since:
DOM Level 3

getKeyIndex

public Hashtable getKeyIndex(KeyManager keymanager,
                             int fingerprint)
Get the index for a given key
Specified by:
getKeyIndex in interface DocumentInfo
Parameters:
keymanager - The key manager managing this key
fingerprint - The fingerprint of the name of the key (unique with the key manager)
Returns:
The index, if one has been built, in the form of a Hashtable that maps the key value to a Vector of nodes having that key value. If no index has been built, returns null.

getLineNumber

public int getLineNumber()
Get the line number of this root node.
Specified by:
getLineNumber in interface NodeInfo
Overrides:
getLineNumber in interface NodeImpl
Returns:
0 always

getLineNumber

protected int getLineNumber(int sequence)
Get the line number for an element. Return -1 if line numbering is off.

getNamePool

public NamePool getNamePool()
Get the name pool used for the names in this document
Specified by:
getNamePool in interface DocumentInfo
Overrides:
getNamePool in interface NodeImpl

getNextSibling

public final Node getNextSibling()
Get next sibling - always null
Overrides:
getNextSibling in interface NodeImpl
Returns:
null

getNodeFactory

public NodeFactory getNodeFactory()
Get the node factory that was used to build this document

getNodeType

public final short getNodeType()
Return the type of node.
Specified by:
getNodeType in interface NodeInfo
Returns:
NodeInfo.ROOT (always)

getPreviousSibling

public final Node getPreviousSibling()
Get previous sibling - always null
Overrides:
getPreviousSibling in interface NodeImpl
Returns:
null

getStrictErrorChecking

public boolean getStrictErrorChecking()
An attribute specifying whether error 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 on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default.
Since:
DOM Level 3

getSystemId

public String getSystemId()
Get the system id of this root node
Specified by:
getSystemId in interface NodeInfo
Overrides:
getSystemId in interface NodeImpl

getSystemId

protected String getSystemId(int seq)
Get the system id of an element in the document

getUnparsedEntity

public String getUnparsedEntity(String name)
Get the unparsed entity with a given name
Specified by:
getUnparsedEntity in interface DocumentInfo
Parameters:
name - the name of the entity
Returns:
the URI of the entity if there is one, or empty string if not

getXmlEncoding

public String getXmlEncoding()
An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified or when it is not known, such as when the Document was created in memory.
Since:
DOM Level 3

getXmlStandalone

public boolean getXmlStandalone()
An attribute specifying, as part of the XML declaration, whether this document is standalone. This is 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].

Since:
DOM Level 3

getXmlVersion

public String getXmlVersion()
An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0".
Since:
DOM Level 3

normalizeDocument

public void normalizeDocument()
This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form.
Since:
DOM Level 3

renameNode

public Node renameNode(Node n,
                       String namespaceURI,
                       String qualifiedName)
            throws DOMException
Rename an existing node of type ELEMENT_NODE or ATTRIBUTE_NODE.
Parameters:
n - The node to rename.
namespaceURI - The new namespace URI.
qualifiedName - The new qualified name.
Returns:
The renamed node. This is either the specified node or the new node that was created to replace the specified node.
Since:
DOM Level 3

selectID

public NodeInfo selectID(String id)
Get the element with a given ID.
Specified by:
selectID in interface DocumentInfo
Parameters:
id - The unique ID of the required element, previously registered using registerID()
Returns:
The NodeInfo for the given ID if one has been registered, otherwise null.

setCharacterBuffer

protected void setCharacterBuffer(StringBuffer buffer)
Set the character buffer

setDocumentElement

protected void setDocumentElement(ElementImpl e)
Set the top-level element of the document (variously called the root element or the document element). Note that a DocumentImpl may represent the root of a result tree fragment, in which case there is no document element.
Parameters:
e - the top-level element

setDocumentURI

public void setDocumentURI(String documentURI)
Since:
DOM Level 3

setKeyIndex

public void setKeyIndex(KeyManager keymanager,
                        int fingerprint,
                        Hashtable keyindex)
Set the index for a given key. The method is synchronized because the same document can be used by several stylesheets at the same time.
Specified by:
setKeyIndex in interface DocumentInfo
Parameters:
keymanager - The key manager managing this key
fingerprint - 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.

setLineNumber

protected void setLineNumber(int sequence,
                             int line)
Set the line number for an element. Ignored if line numbering is off.

setLineNumbering

public void setLineNumbering()
Set line numbering on

setNamePool

public void setNamePool(NamePool pool)
Set the name pool used for all names in this document
Specified by:
setNamePool in interface DocumentInfo

setNodeFactory

public void setNodeFactory(NodeFactory factory)
Set the node factory that was used to build this document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)
An attribute specifying whether error 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 on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default.
Since:
DOM Level 3

setSystemId

public void setSystemId(String uri)
Set the system id of this node
Overrides:
setSystemId in interface NodeImpl

setSystemId

protected void setSystemId(int seq,
                           String uri)
Set the system id of an element in the document

setUnparsedEntity

protected void setUnparsedEntity(String name,
                                 String uri)
Set an unparsed entity URI associated with this document. For system use only, while building the document.

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
            throws DOMException
An attribute specifying, as part of the XML declaration, whether this document is standalone. This is 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].

Since:
DOM Level 3

setXmlVersion

public void setXmlVersion(String xmlVersion)
            throws DOMException
An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "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.
DOM applications may use the 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.
Since:
DOM Level 3