Package net.sf.saxon.tree.linked
Class DocumentImpl
- java.lang.Object
-
- net.sf.saxon.tree.linked.NodeImpl
-
- net.sf.saxon.tree.linked.ParentNodeImpl
-
- net.sf.saxon.tree.linked.DocumentImpl
-
- All Implemented Interfaces:
javax.xml.transform.Source,javax.xml.transform.SourceLocator,GroundedValue,Item,MutableDocumentInfo,MutableNodeInfo,NodeInfo,Sequence,TreeInfo,Location,SteppingNode<NodeImpl>,SiblingCountingNode,org.xml.sax.Locator
public final class DocumentImpl extends ParentNodeImpl implements TreeInfo, MutableDocumentInfo
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.
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.tree.linked.NodeImpl
NODE_LETTER
-
Fields inherited from interface net.sf.saxon.om.NodeInfo
IS_DTD_TYPE, IS_NILLED
-
-
Constructor Summary
Constructors Constructor Description DocumentImpl()Create a DocumentImpl
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddNilledElement(ElementImpl element)Add a nilled element.voidcopy(Receiver out, int copyOptions, Location locationId)Copy this node to a given outputtervoiddeIndex(NodeImpl node)Remove a node from any indexes when it is detached from the treeprotected voidderegisterID(java.lang.String id)Remove the entry for a given ID (when nodes are deleted).voidgenerateId(FastStringBuffer buffer)Get a character string that uniquely identifies this nodejava.lang.StringgetBaseURI()Get the base URI of this root node.ConfigurationgetConfiguration()Get the configuration previously set using setConfigurationElementImplgetDocumentElement()Get the root (outermost) element.longgetDocumentNumber()Get the unique document numberintgetLineNumber()Get the line number of this root node.NamePoolgetNamePool()Get the name pool used for the names in this documentNodeImplgetNextSibling()Get next sibling - always nullintgetNodeKind()Return the type of node.DocumentImplgetPhysicalRoot()Get the physical root of the tree.NodeImplgetPreviousSibling()Get previous sibling - always nullNodeInfogetRoot()Get the root nodeNodeInfogetRootNode()Get the NodeInfo object representing the document node at the root of the treeSchemaTypegetSchemaType()Get the type annotationSpaceStrippingRulegetSpaceStrippingRule()Get details of space stripping action that was applied to this document during construction.java.lang.StringgetSystemId()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<java.lang.String>getUnparsedEntityNames()Get the list of unparsed entities defined in this documentjava.lang.ObjectgetUserData(java.lang.String key)Get user data held in the document node.voidgraftLocationMap(DocumentImpl original)Copy the system ID and line number map from another document (used when grafting a simplified stylesheet)booleanisImaginary()Ask whether this is an imaginary document nodebooleanisMutable()Ask whether the tree is mutable.booleanisTopWithinEntity(ElementImpl element)booleanisTyped()Ask whether the document contains any nodes whose type annotation is anything other than UNTYPEDvoidmarkTopWithinEntity(ElementImpl element)BuildernewBuilder()Get a Builder suitable for building nodes that can be attached to this document.protected voidregisterID(NodeInfo e, java.lang.String id)Register a unique element ID.voidreplaceStringValue(java.lang.CharSequence stringValue)Replace the string-value of this nodevoidresetIndexes()This method is called before performing a batch of updates; it allows all cached data that might be invalidated by such updates to be clearedNodeInfoselectID(java.lang.String id, boolean getParent)Get the element with a given ID.voidsetBaseURI(java.lang.String uri)Set the base URI of this document nodevoidsetConfiguration(Configuration config)Set the Configuration that contains this documentvoidsetDocumentElement(ElementImpl e)Set the top-level element of the document (variously called the root element or the document element).voidsetImaginary(boolean imaginary)Set whether this is an imaginary document nodevoidsetLineNumbering()Set line numbering onvoidsetMutable(boolean mutable)Say whether the tree is mutable.voidsetSpaceStrippingRule(SpaceStrippingRule rule)Set details of space stripping action that was applied to this document during construction.voidsetSystemId(java.lang.String uri)Set the system id (base URI) of this nodevoidsetUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)Set an unparsed entity URI associated with this document.voidsetUserData(java.lang.String key, java.lang.Object value)Set user data on the document node.-
Methods inherited from class net.sf.saxon.tree.linked.ParentNodeImpl
addChild, children, compact, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, iterateChildren, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumber
-
Methods inherited from class net.sf.saxon.tree.linked.NodeImpl
addAttribute, addNamespace, atomize, attributes, compareOrder, delete, effectiveBooleanValue, equals, getAllNamespaces, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getDisplayName, getFingerprint, getLocalPart, getNextInDocument, getNodeName, getParent, getPrefix, getPreviousInDocument, getRawParent, getSiblingPosition, getSuccessorElement, getTreeInfo, getURI, hasFingerprint, head, insertSiblings, isDeleted, iterateAxis, iterateAxis, removeAttribute, removeTypeAnnotation, rename, replace, saveLocation, setAttributes, setRawParent, setSiblingPosition, setTypeAnnotation
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
-
Methods inherited from interface net.sf.saxon.om.Item
getLength, itemAt, iterate, reduce, subsequence
-
Methods inherited from interface net.sf.saxon.om.MutableNodeInfo
addNamespace, removeNamespace
-
Methods inherited from interface net.sf.saxon.om.NodeInfo
children, equals, getGenre, getPublicId, hashCode, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, toShortString
-
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
-
-
-
Method Detail
-
getRootNode
public NodeInfo getRootNode()
Get the NodeInfo object representing the document node at the root of the tree- Specified by:
getRootNodein interfaceTreeInfo- Returns:
- the document node
-
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:
getConfigurationin interfaceNodeInfo- Specified by:
getConfigurationin interfaceTreeInfo- Overrides:
getConfigurationin classNodeImpl- Returns:
- the Saxon configuration
-
isMutable
public boolean isMutable()
Ask whether the tree is mutable. This is true only ifhas been called supplying the value {@code true}
-
setMutable
public void setMutable(boolean mutable)
Say whether the tree is mutable. This is true only ifhas been called supplying the value {@code true}- Parameters:
mutable- true if and only if the tree is to be marked as mutable
-
getNamePool
public NamePool getNamePool()
Get the name pool used for the names in this document- Overrides:
getNamePoolin classNodeImpl
-
newBuilder
public Builder newBuilder()
Get a Builder suitable for building nodes that can be attached to this document.- Specified by:
newBuilderin interfaceMutableNodeInfo- Overrides:
newBuilderin 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
-
isTyped
public boolean isTyped()
Ask whether the document contains any nodes whose type annotation is anything other than UNTYPED
-
getDocumentNumber
public long getDocumentNumber()
Get the unique document number- Specified by:
getDocumentNumberin interfaceTreeInfo- Returns:
- the document number
-
setDocumentElement
public 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
-
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:
setSystemIdin interfacejavax.xml.transform.Source- Overrides:
setSystemIdin classNodeImpl
-
getSystemId
public java.lang.String getSystemId()
Get the system id of this root node- Specified by:
getSystemIdin interfaceLocation- Specified by:
getSystemIdin interfaceorg.xml.sax.Locator- Specified by:
getSystemIdin interfaceNodeInfo- Specified by:
getSystemIdin interfacejavax.xml.transform.Source- Specified by:
getSystemIdin interfacejavax.xml.transform.SourceLocator- Overrides:
getSystemIdin 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:
getBaseURIin interfaceNodeInfo- Overrides:
getBaseURIin classNodeImpl- Returns:
- the base URI
-
setLineNumbering
public void setLineNumbering()
Set line numbering on
-
addNilledElement
public void addNilledElement(ElementImpl element)
Add a nilled element. Nilled elements are unusual, so we avoid allocating a boolean in the element node; instead we keep a list of nilled elements at the document level- Parameters:
element- a nilled element
-
markTopWithinEntity
public void markTopWithinEntity(ElementImpl element)
-
isTopWithinEntity
public boolean isTopWithinEntity(ElementImpl element)
-
getLineNumber
public int getLineNumber()
Get the line number of this root node.- Specified by:
getLineNumberin interfaceLocation- Specified by:
getLineNumberin interfaceorg.xml.sax.Locator- Specified by:
getLineNumberin interfaceNodeInfo- Specified by:
getLineNumberin interfacejavax.xml.transform.SourceLocator- Overrides:
getLineNumberin classNodeImpl- Returns:
- 0 always
-
getNodeKind
public final int getNodeKind()
Return the type of node.- Specified by:
getNodeKindin interfaceNodeInfo- Returns:
- Type.DOCUMENT (always)
- See Also:
Type
-
getNextSibling
public final NodeImpl getNextSibling()
Get next sibling - always null- Specified by:
getNextSiblingin interfaceSteppingNode<NodeImpl>- Overrides:
getNextSiblingin classNodeImpl- Returns:
- null
-
getPreviousSibling
public final NodeImpl getPreviousSibling()
Get previous sibling - always null- Specified by:
getPreviousSiblingin interfaceSteppingNode<NodeImpl>- Overrides:
getPreviousSiblingin classNodeImpl- Returns:
- null
-
getDocumentElement
public ElementImpl getDocumentElement()
Get the root (outermost) element.- Returns:
- the Element node for the outermost element of the document. May return null if the document node contains no element node.
-
getRoot
public NodeInfo getRoot()
Get the root node
-
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:
getPhysicalRootin 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:
generateIdin interfaceNodeInfo- Overrides:
generateIdin 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, boolean getParent)
Get the element with a given ID.- Specified by:
selectIDin interfaceTreeInfo- Parameters:
id- The unique ID of the required element, previously registered using registerID()getParent- true if the requirement is for the parent of the node with the given ID, not the node itself.- 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
-
setUnparsedEntity
public 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.- Parameters:
name- the entity nameuri- the system identifier of the unparsed entitypublicId- the public identifier of the unparsed entity
-
getUnparsedEntityNames
public java.util.Iterator<java.lang.String> getUnparsedEntityNames()
Get the list of unparsed entities defined in this document- Specified by:
getUnparsedEntityNamesin interfaceTreeInfo- 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:
getUnparsedEntityin interfaceTreeInfo- 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.
-
getSchemaType
public SchemaType getSchemaType()
Get the type annotation- Specified by:
getSchemaTypein interfaceNodeInfo- Overrides:
getSchemaTypein classNodeImpl- Returns:
- the type annotation of the base node
-
copy
public void copy(Receiver out, int copyOptions, Location locationId) throws XPathException
Copy this node to a given outputter- Specified by:
copyin 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.copyOptions- a selection of the options defined inCopyOptionslocationId- If non-null, identifies the location of the instruction that requested this copy. If zero, indicates that the location information is not available- Throws:
XPathException- if any downstream error occurs
-
replaceStringValue
public void replaceStringValue(java.lang.CharSequence stringValue)
Replace the string-value of this node- Specified by:
replaceStringValuein interfaceMutableNodeInfo- Parameters:
stringValue- the new string value
-
resetIndexes
public void resetIndexes()
This method is called before performing a batch of updates; it allows all cached data that might be invalidated by such updates to be cleared- Specified by:
resetIndexesin interfaceMutableDocumentInfo
-
setSpaceStrippingRule
public void setSpaceStrippingRule(SpaceStrippingRule rule)
Set details of space stripping action that was applied to this document during construction. This ensures that space stripping is not applied twice to the same document.- Specified by:
setSpaceStrippingRulein interfaceTreeInfo- Parameters:
rule- details of the space stripping rules that have been applied to this document during its construction.- Since:
- 9.9
-
getSpaceStrippingRule
public SpaceStrippingRule getSpaceStrippingRule()
Get details of space stripping action that was applied to this document during construction. This ensures that space stripping is not applied twice to the same document.- Specified by:
getSpaceStrippingRulein interfaceTreeInfo- Returns:
- details of the space stripping rules that have been applied to this
document during its construction. By default, returns
NoElementsSpaceStrippingRule, indicating that no space stripping has been applied - Since:
- 9.9
-
setUserData
public void setUserData(java.lang.String key, java.lang.Object value)Set user data on the document node. The user data can be retrieved subsequently usinggetUserData(java.lang.String)- Specified by:
setUserDatain interfaceTreeInfo- Parameters:
key- A string giving the name of the property to be set. Clients are responsible for choosing a key that is likely to be unique. Must not be null. Keys used internally by Saxon are prefixed "saxon:".value- The value to be set for the property. May be null, which effectively removes the existing value for the property.
-
getUserData
public java.lang.Object getUserData(java.lang.String key)
Get user data held in the document node. This retrieves properties previously set usingsetUserData(java.lang.String, java.lang.Object)- Specified by:
getUserDatain interfaceTreeInfo- Parameters:
key- A string giving the name of the property to be retrieved.- Returns:
- the value of the property, or null if the property has not been defined.
-
-