Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
com.icl.saxon.om.AbstractNode
com.icl.saxon.tree.NodeImpl
com.icl.saxon.tree.ParentNodeImpl
com.icl.saxon.tree.DocumentImpl
public final class DocumentImpl
extends com.icl.saxon.tree.ParentNodeImpl
implements DocumentInfo, Document
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 | |
Method Summary | |
Node |
|
void | |
String |
|
protected AxisEnumeration |
|
String |
|
StringBuffer |
|
Element |
|
DocumentInfo |
|
String |
|
org.w3c.dom.DOMConfiguration |
|
String |
|
Hashtable |
|
int |
|
protected int |
|
NamePool |
|
Node |
|
NodeFactory |
|
short |
|
Node |
|
boolean |
|
String |
|
protected String |
|
String |
|
String |
|
boolean |
|
String |
|
void |
|
Node |
|
NodeInfo |
|
protected void |
|
protected void |
|
void |
|
void |
|
protected void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
protected void |
|
void |
|
void |
|
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 |
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
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
protected AxisEnumeration getAllElements(int fingerprint)
Get a list of all elements with a given name fingerprint
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
public final StringBuffer getCharacterBuffer()
Get the character buffer
public Element getDocumentElement()
Get the root (outermost) element.
- Overrides:
- getDocumentElement in interface NodeImpl
- Returns:
- the Element node for the outermost element of the document.
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
public String getDocumentURI()
The location of the document ornull
if undefined or if theDocument
was created usingDOMImplementation.createDocument
. No lexical checking is performed when setting this attribute; this could result in anull
value returned when usingNode.baseURI
.
Beware that when theDocument
supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computingNode.baseURI
.
- Since:
- DOM Level 3
public org.w3c.dom.DOMConfiguration getDomConfig()
The configuration used whenDocument.normalizeDocument()
is invoked.
- Since:
- DOM Level 3
public String getInputEncoding()
An attribute specifying the encoding used for this document at the time of the parsing. This isnull
when it is not known, such as when theDocument
was created in memory.
- Since:
- DOM Level 3
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 keyfingerprint
- 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.
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
protected int getLineNumber(int sequence)
Get the line number for an element. Return -1 if line numbering is off.
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
public final Node getNextSibling()
Get next sibling - always null
- Overrides:
- getNextSibling in interface NodeImpl
- Returns:
- null
public NodeFactory getNodeFactory()
Get the node factory that was used to build this document
public final short getNodeType()
Return the type of node.
- Specified by:
- getNodeType in interface NodeInfo
- Returns:
- NodeInfo.ROOT (always)
public final Node getPreviousSibling()
Get previous sibling - always null
- Overrides:
- getPreviousSibling in interface NodeImpl
- Returns:
- null
public boolean getStrictErrorChecking()
An attribute specifying whether error checking is enforced or not. When set tofalse
, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise anyDOMException
on DOM operations or report errors while usingDocument.normalizeDocument()
. In case of error, the behavior is undefined. This attribute istrue
by default.
- Since:
- DOM Level 3
public String getSystemId()
Get the system id of this root node
- Specified by:
- getSystemId in interface NodeInfo
- Overrides:
- getSystemId in interface NodeImpl
protected String getSystemId(int seq)
Get the system id of an element in the document
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
public String getXmlEncoding()
An attribute specifying, as part of the XML declaration, the encoding of this document. This isnull
when unspecified or when it is not known, such as when theDocument
was created in memory.
- Since:
- DOM Level 3
public boolean getXmlStandalone()
An attribute specifying, as part of the XML declaration, whether this document is standalone. This isfalse
when unspecified. Note: No verification is done on the value when setting this attribute. Applications should useDocument.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
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
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
public Node renameNode(Node n, String namespaceURI, String qualifiedName) throws DOMException
Rename an existing node of typeELEMENT_NODE
orATTRIBUTE_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
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.
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). 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
public void setDocumentURI(String documentURI)
The location of the document ornull
if undefined or if theDocument
was created usingDOMImplementation.createDocument
. No lexical checking is performed when setting this attribute; this could result in anull
value returned when usingNode.baseURI
.
Beware that when theDocument
supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computingNode.baseURI
.
- Since:
- DOM Level 3
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 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 setLineNumber(int sequence, int line)
Set the line number for an element. Ignored if line numbering is off.
public void setLineNumbering()
Set line numbering on
public void setNamePool(NamePool pool)
Set the name pool used for all names in this document
- Specified by:
- setNamePool in interface DocumentInfo
public void setNodeFactory(NodeFactory factory)
Set the node factory that was used to build this document
public void setStrictErrorChecking(boolean strictErrorChecking)
An attribute specifying whether error checking is enforced or not. When set tofalse
, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise anyDOMException
on DOM operations or report errors while usingDocument.normalizeDocument()
. In case of error, the behavior is undefined. This attribute istrue
by default.
- Since:
- DOM Level 3
public void setSystemId(String uri)
Set the system id of this node
- Overrides:
- setSystemId in interface NodeImpl
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. For system use only, while building the document.
public void setXmlStandalone(boolean xmlStandalone) throws DOMException
An attribute specifying, as part of the XML declaration, whether this document is standalone. This isfalse
when unspecified. Note: No verification is done on the value when setting this attribute. Applications should useDocument.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
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 alwaysnull
. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invokeDocument.normalizeDocument()
in order to check for invalid characters in theNode
s that are already part of thisDocument
.
DOM applications may use theDOMImplementation.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 aNOT_SUPPORTED_ERR
exception for the same version number when usingDocument.xmlVersion
.
- Since:
- DOM Level 3