Package net.sf.saxon.tree
Class DocumentImpl
- java.lang.Object
-
- net.sf.saxon.tree.NodeImpl
-
- net.sf.saxon.tree.ParentNodeImpl
-
- net.sf.saxon.tree.DocumentImpl
-
- All Implemented Interfaces:
javax.xml.transform.Source
,javax.xml.transform.SourceLocator
,DocumentInfo
,FingerprintedNode
,Item
,NodeInfo
,ValueRepresentation
public final class DocumentImpl extends ParentNodeImpl implements DocumentInfo
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 net.sf.saxon.tree.ParentNodeImpl
sequence
-
Fields inherited from class net.sf.saxon.tree.NodeImpl
index, NODE_LETTER, parent
-
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
-
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
-
Constructor Summary
Constructors Constructor Description DocumentImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputtervoid
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node(package private) AxisIterator
getAllElements(int fingerprint)
Get a list of all elements with a given name fingerprintjava.lang.String
getBaseURI()
Get the base URI of this root node.Configuration
getConfiguration()
Get the configuration previously set using setConfigurationElementImpl
getDocumentElement()
Get the root (outermost) element.int
getDocumentNumber()
Get the unique document numberDocumentInfo
getDocumentRoot()
Get the root (document) nodeint
getLineNumber()
Get the line number of this root node.(package private) int
getLineNumber(int sequence)
Get the line number for an element.NamePool
getNamePool()
Get the name pool used for the names in this documentNodeInfo
getNextSibling()
Get next sibling - always nullint
getNodeKind()
Return the type of node.NodeInfo
getPreviousSibling()
Get previous sibling - always nullNodeInfo
getRoot()
Get the root nodejava.lang.String
getSystemId()
Get the system id of this root node(package private) java.lang.String
getSystemId(int seq)
Get the system id of an element in the documentjava.lang.String[]
getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given nameNodeInfo
selectID(java.lang.String id)
Get the element with a given ID.void
setBaseURI(java.lang.String uri)
Set the base URI of this document nodevoid
setConfiguration(Configuration config)
Set the Configuration that contains this document(package private) void
setDocumentElement(ElementImpl e)
Set the top-level element of the document (variously called the root element or the document element).(package private) void
setLineNumber(int sequence, int line)
Set the line number for an element.void
setLineNumbering()
Set line numbering on(package private) void
setSystemId(int seq, java.lang.String uri)
Set the system id of an element in the documentvoid
setSystemId(java.lang.String uri)
Set the system id of this node(package private) void
setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)
Set an unparsed entity URI associated with this document.-
Methods inherited from class net.sf.saxon.tree.ParentNodeImpl
addChild, compact, enumerateChildren, getFirstChild, getLastChild, getNthChild, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, useChildrenArray
-
Methods inherited from class net.sf.saxon.tree.NodeImpl
atomize, compareOrder, equals, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getDisplayName, getFingerprint, getLocalPart, getNameCode, getNextInDocument, getParent, getPrefix, getPreviousInDocument, getPublicId, getTypeAnnotation, getTypedValue, getURI, hashCode, isSameNodeInfo, iterateAxis, iterateAxis, sendNamespaceDeclarations
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.om.Item
getStringValueCS, getTypedValue
-
Methods inherited from interface net.sf.saxon.om.NodeInfo
atomize, compareOrder, equals, getAttributeValue, getDeclaredNamespaces, getDisplayName, getFingerprint, getLocalPart, getNameCode, getParent, getPrefix, getStringValue, getTypeAnnotation, getURI, hasChildNodes, hashCode, isSameNodeInfo, iterateAxis, iterateAxis, sendNamespaceDeclarations
-
-
-
-
Method Detail
-
setConfiguration
public void setConfiguration(Configuration config)
Set the Configuration that contains this document
-
getConfiguration
public Configuration getConfiguration()
Get the configuration previously set using setConfiguration- Specified by:
getConfiguration
in interfaceNodeInfo
- Overrides:
getConfiguration
in classNodeImpl
- Returns:
- the Configuration
-
getNamePool
public NamePool getNamePool()
Get the name pool used for the names in this document- Specified by:
getNamePool
in interfaceNodeInfo
- Overrides:
getNamePool
in classNodeImpl
- Returns:
- the namepool
-
getDocumentNumber
public int getDocumentNumber()
Get the unique document number- Specified by:
getDocumentNumber
in interfaceNodeInfo
- Overrides:
getDocumentNumber
in classNodeImpl
-
setDocumentElement
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
-
setSystemId
public void setSystemId(java.lang.String uri)
Set the system id of this node- Specified by:
setSystemId
in interfacejavax.xml.transform.Source
- Overrides:
setSystemId
in classNodeImpl
-
getSystemId
public java.lang.String getSystemId()
Get the system id of this root node- Specified by:
getSystemId
in interfaceNodeInfo
- Specified by:
getSystemId
in interfacejavax.xml.transform.Source
- Specified by:
getSystemId
in interfacejavax.xml.transform.SourceLocator
- Overrides:
getSystemId
in classNodeImpl
- Returns:
- the System Identifier of the entity in the source document containing the node, or null if not known or not applicable.
-
setBaseURI
public void setBaseURI(java.lang.String uri)
Set the base URI of this document node
-
getBaseURI
public java.lang.String getBaseURI()
Get the base URI of this root node.- Specified by:
getBaseURI
in interfaceNodeInfo
- Overrides:
getBaseURI
in classNodeImpl
- Returns:
- the base URI of the node. This may be null if the base URI is unknown.
-
setSystemId
void setSystemId(int seq, java.lang.String uri)
Set the system id of an element in the document
-
getSystemId
java.lang.String getSystemId(int seq)
Get the system id of an element in the document
-
setLineNumbering
public void setLineNumbering()
Set line numbering on
-
setLineNumber
void setLineNumber(int sequence, int line)
Set the line number for an element. Ignored if line numbering is off.
-
getLineNumber
int getLineNumber(int sequence)
Get the line number for an element. Return -1 if line numbering is off.
-
getLineNumber
public int getLineNumber()
Get the line number of this root node.- Specified by:
getLineNumber
in interfaceNodeInfo
- Specified by:
getLineNumber
in interfacejavax.xml.transform.SourceLocator
- Overrides:
getLineNumber
in classNodeImpl
- Returns:
- 0 always
-
getNodeKind
public final int getNodeKind()
Return the type of node.- Specified by:
getNodeKind
in interfaceNodeInfo
- Returns:
- Type.DOCUMENT (always)
- See Also:
Type
-
getNextSibling
public final NodeInfo getNextSibling()
Get next sibling - always null- Overrides:
getNextSibling
in classNodeImpl
- Returns:
- null
-
getPreviousSibling
public final NodeInfo getPreviousSibling()
Get previous sibling - always null- Overrides:
getPreviousSibling
in classNodeImpl
- Returns:
- null
-
getDocumentElement
public ElementImpl getDocumentElement()
Get the root (outermost) element.- Returns:
- the Element node for the outermost element of the document.
-
getRoot
public NodeInfo getRoot()
Get the root node
-
getDocumentRoot
public DocumentInfo getDocumentRoot()
Get the root (document) node- Specified by:
getDocumentRoot
in interfaceNodeInfo
- Overrides:
getDocumentRoot
in classNodeImpl
- Returns:
- the DocumentInfo representing this document
-
generateId
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node- Specified by:
generateId
in interfaceNodeInfo
- Overrides:
generateId
in classNodeImpl
- Parameters:
buffer
- a buffer into which will be placed a string based on the document number
-
getAllElements
AxisIterator getAllElements(int fingerprint)
Get a list of all elements with a given name fingerprint
-
selectID
public NodeInfo selectID(java.lang.String id)
Get the element with a given ID.- Specified by:
selectID
in interfaceDocumentInfo
- 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.
-
setUnparsedEntity
void setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)
Set an unparsed entity URI associated with this document. For system use only, while building the document.
-
getUnparsedEntity
public java.lang.String[] getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given name- Specified by:
getUnparsedEntity
in interfaceDocumentInfo
- Parameters:
name
- the name of the entity- Returns:
- if the entity exists, return an array of two Strings, the first holding the system ID of the entity, the second holding the public ID if there is one, or null if not. If the entity does not exist, return null. * @return the URI of the entity if there is one, or empty string if not
-
copy
public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException
Copy this node to a given outputter- Specified by:
copy
in interfaceNodeInfo
- Parameters:
out
- the Receiver to which the node should be copiedwhichNamespaces
- in the case of an element, controls which namespace nodes should be copied. Values areNodeInfo.NO_NAMESPACES
,NodeInfo.LOCAL_NAMESPACES
,NodeInfo.ALL_NAMESPACES
copyAnnotations
- indicates whether the type annotations of element and attribute nodes should be copiedlocationId
- If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information for the original node is to be copied; in this case the Receiver must be a LocationCopier- Throws:
XPathException
-
-