Package net.sf.saxon.tree
Class DocumentImpl
- java.lang.Object
-
- net.sf.saxon.tree.NodeImpl
-
- net.sf.saxon.tree.DocumentImpl
-
- All Implemented Interfaces:
javax.xml.transform.Source
,javax.xml.transform.SourceLocator
,PullEvent
,DocumentInfo
,FingerprintedNode
,Item
,MutableNodeInfo
,NodeInfo
,SiblingCountingNode
,ValueRepresentation
public final class DocumentImpl extends NodeImpl implements DocumentInfo
A node in the XML parse tree representing the Document itself (or equivalently, the root node of the Document).A DocumentImpl object may either represent a real document node, or it may represent an imaginary container for a parentless element.
- Author:
- Michael H. Kay
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.Object
children
protected int
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()
Create a DocumentImpl
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChild(NodeImpl node, int index)
Add a child node to this node.void
compact(int size)
Compact the space used by this nodevoid
copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputtervoid
deIndex(NodeImpl node)
Remove a node from any indexes when it is detached from the treeprotected void
deregisterID(java.lang.String id)
Remove the entry for a given ID (when nodes are deleted).protected AxisIterator
enumerateChildren(NodeTest test)
Get an enumeration of the children of this nodevoid
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this nodejava.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) nodeNodeInfo
getFirstChild()
Get the first child node of the elementNodeInfo
getLastChild()
Get the last child node of the elementint
getLineNumber()
Get the line number of this root node.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.protected NodeImpl
getNthChild(int n)
Get the nth child node of the element (numbering from 0)int
getNumberOfChildren()
Determine how many children the node hasDocumentImpl
getPhysicalRoot()
Get the physical root of the tree.NodeInfo
getPreviousSibling()
Get previous sibling - always nullNodeInfo
getRoot()
Get the root nodeprotected long
getSequenceNumber()
Get the node sequence number (in document order).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.CharSequence
getStringValueCS()
Get the value of the item as a CharSequence.java.lang.String
getSystemId()
Get the system id of this root nodejava.lang.String[]
getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given namejava.util.Iterator
getUnparsedEntityNames()
Get the list of unparsed entities defined in this documentvoid
graftLocationMap(DocumentImpl original)
Copy the system ID and line number map from another document (used when grafting a simplified stylesheet)boolean
hasChildNodes()
Determine if the node has any children.void
insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
Insert copies of a sequence of nodes as children of this node.protected void
insertChildrenAt(NodeInfo[] source, int index, boolean inherit)
Insert children before or after a given existing childboolean
isImaginary()
Ask whether this is an imaginary document nodeBuilder
newBuilder()
Get a Builder suitable for building nodes that can be attached to this document.protected void
registerID(NodeInfo e, java.lang.String id)
Register a unique element ID.protected void
removeChild(NodeImpl child)
Remove a given childprotected void
replaceChildrenAt(NodeInfo[] source, int index, boolean inherit)
Replace child at a given index by new childrenvoid
replaceStringValue(java.lang.CharSequence stringValue)
Replace the string-value of this nodeNodeInfo
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 documentvoid
setImaginary(boolean imaginary)
Set whether this is an imaginary document nodevoid
setLineNumbering()
Set line numbering onvoid
setSystemId(java.lang.String uri)
Set the system id (base URI) of this nodeprotected void
useChildrenArray(NodeImpl[] array)
Supply an array to be used for the array of children.-
Methods inherited from class net.sf.saxon.tree.NodeImpl
addNamespace, atomize, compareOrder, delete, equals, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getDisplayName, getFingerprint, getLocalPart, getNameCode, getNextInDocument, getParent, getPrefix, getPreviousInDocument, getPublicId, getSiblingPosition, getTypeAnnotation, getTypedValue, getURI, insertSiblings, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis, putAttribute, removeAttribute, removeTypeAnnotation, rename, replace, setTypeAnnotation
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, 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, getColumnNumber, getDeclaredNamespaces, getDisplayName, getFingerprint, getLocalPart, getNameCode, getParent, getPrefix, getStringValue, getTypeAnnotation, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis
-
-
-
-
Method Detail
-
setConfiguration
public void setConfiguration(Configuration config)
Set the Configuration that contains this document- Parameters:
config
- the Saxon configuration
-
getConfiguration
public Configuration getConfiguration()
Get the configuration previously set using setConfiguration- Specified by:
getConfiguration
in interfaceNodeInfo
- Overrides:
getConfiguration
in classNodeImpl
- Returns:
- the Saxon 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
-
newBuilder
public Builder newBuilder()
Get a Builder suitable for building nodes that can be attached to this document.- Specified by:
newBuilder
in interfaceMutableNodeInfo
- Overrides:
newBuilder
in classNodeImpl
- Returns:
- a new TreeBuilder
-
setImaginary
public void setImaginary(boolean imaginary)
Set whether this is an imaginary document node- Parameters:
imaginary
- if true, this is an imaginary node - the tree is really rooted at the topmost element
-
isImaginary
public boolean isImaginary()
Ask whether this is an imaginary document node- Returns:
- true if this is an imaginary node - the tree is really rooted at the topmost element
-
getDocumentNumber
public int getDocumentNumber()
Get the unique document number- Specified by:
getDocumentNumber
in interfaceNodeInfo
- Overrides:
getDocumentNumber
in classNodeImpl
- Returns:
- the document number of the document containing this node
-
graftLocationMap
public void graftLocationMap(DocumentImpl original)
Copy the system ID and line number map from another document (used when grafting a simplified stylesheet)- Parameters:
original
- the document whose system ID and line number maps are to be grafted onto this tree
-
setSystemId
public void setSystemId(java.lang.String uri)
Set the system id (base URI) 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- Parameters:
uri
- the new base URI
-
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
-
setLineNumbering
public void setLineNumbering()
Set line numbering on
-
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
-
getPhysicalRoot
public DocumentImpl getPhysicalRoot()
Get the physical root of the tree. This may be an imaginary document node: this method should be used only when control information held at the physical root is required- Overrides:
getPhysicalRoot
in classNodeImpl
- Returns:
- the document node, which may be imaginary
-
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
-
deIndex
public void deIndex(NodeImpl node)
Remove a node from any indexes when it is detached from the tree- Parameters:
node
- the node to be removed from all indexes
-
registerID
protected void registerID(NodeInfo e, java.lang.String id)
Register a unique element ID. Does nothing if there is already an element with that ID.- Parameters:
e
- The Element having a particular unique ID valueid
- The unique ID value
-
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.
-
deregisterID
protected void deregisterID(java.lang.String id)
Remove the entry for a given ID (when nodes are deleted). Does nothing if the id value is not present in the index.- Parameters:
id
- The id value
-
getUnparsedEntityNames
public java.util.Iterator getUnparsedEntityNames()
Get the list of unparsed entities defined in this document- Specified by:
getUnparsedEntityNames
in interfaceDocumentInfo
- Returns:
- an Iterator, whose items are of type String, containing the names of all unparsed entities defined in this document. If there are no unparsed entities or if the information is not available then an empty iterator is returned
-
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 copied. It is the caller's responsibility to ensure that this Receiver is open before the method is called (or that it is self-opening), and that it is closed after use.whichNamespaces
- 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
-
replaceStringValue
public void replaceStringValue(java.lang.CharSequence stringValue)
Replace the string-value of this node- Specified by:
replaceStringValue
in interfaceMutableNodeInfo
- Parameters:
stringValue
- the new string value
-
getSequenceNumber
protected final long getSequenceNumber()
Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and document nodes) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position. For nodes added by XQUery Update, the sequence number is -1L- Overrides:
getSequenceNumber
in classNodeImpl
- Returns:
- the sequence number if there is one, or -1L otherwise.
-
hasChildNodes
public final boolean hasChildNodes()
Determine if the node has any children.- Specified by:
hasChildNodes
in interfaceNodeInfo
- Overrides:
hasChildNodes
in classNodeImpl
- Returns:
true
if the node has any children,false
if the node has no children.
-
getNumberOfChildren
public int getNumberOfChildren()
Determine how many children the node has- Returns:
- the number of children of this parent node
-
enumerateChildren
protected final AxisIterator enumerateChildren(NodeTest test)
Get an enumeration of the children of this node- Parameters:
test
- A NodeTest to be satisfied by the child nodes, or null if all child node are to be returned- Returns:
- an iterator over the children of this node
-
getFirstChild
public final NodeInfo getFirstChild()
Get the first child node of the element- Overrides:
getFirstChild
in classNodeImpl
- Returns:
- the first child node of the required type, or null if there are no children
-
getLastChild
public final NodeInfo getLastChild()
Get the last child node of the element- Overrides:
getLastChild
in classNodeImpl
- Returns:
- the last child of the element, or null if there are no children
-
getNthChild
protected final NodeImpl getNthChild(int n)
Get the nth child node of the element (numbering from 0)- Parameters:
n
- identifies the required child- Returns:
- the last child of the element, or null if there is no n'th child
-
removeChild
protected void removeChild(NodeImpl child)
Remove a given child- Parameters:
child
- the child to be removed
-
getStringValue
public 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.- Returns:
- the accumulated character content of the element, including descendant elements.
- See Also:
Item.getStringValueCS()
-
getStringValueCS
public java.lang.CharSequence getStringValueCS()
Description copied from class:NodeImpl
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.- Specified by:
getStringValueCS
in interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Overrides:
getStringValueCS
in classNodeImpl
- Returns:
- the string value of the item
- See Also:
Item.getStringValue()
-
useChildrenArray
protected void useChildrenArray(NodeImpl[] array)
Supply an array to be used for the array of children. For system use only.- Parameters:
array
- the array to be used
-
addChild
public void addChild(NodeImpl node, int index)
Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.- Parameters:
node
- the node to be added as a child of this nodeindex
- the position where the child is to be added
-
insertChildren
public void insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
Insert copies of a sequence of nodes as children of this node.This method takes no action unless the target node is a document node or element node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes will be copied to form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed.
- Specified by:
insertChildren
in interfaceMutableNodeInfo
- Overrides:
insertChildren
in classNodeImpl
- Parameters:
source
- the nodes to be insertedatStart
- true if the new nodes are to be inserted before existing children; false if they areinherit
- true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children
-
insertChildrenAt
protected void insertChildrenAt(NodeInfo[] source, int index, boolean inherit)
Insert children before or after a given existing child- Parameters:
source
- the children to be insertedindex
- the position before which they are to be inserted: 0 indicates insertion before the first child, 1 insertion before the second child, and so on.inherit
- true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children
-
replaceChildrenAt
protected void replaceChildrenAt(NodeInfo[] source, int index, boolean inherit)
Replace child at a given index by new children- Parameters:
source
- the children to be insertedindex
- the position at which they are to be inserted: 0 indicates replacement of the first child, replacement of the second child, and so on. The effect is undefined if index is out of rangeinherit
- set to true if the new child elements are to inherit the in-scope namespaces of their new parent- Throws:
java.lang.IllegalArgumentException
- if any of the replacement nodes is not an element, text, comment, or processing instruction node
-
compact
public void compact(int size)
Compact the space used by this node- Parameters:
size
- the number of actual children
-
-