Package com.saxonica.ee.stream.om
Class FleetingDocumentNode
java.lang.Object
com.saxonica.ee.stream.om.FleetingNode
com.saxonica.ee.stream.om.FleetingParentNode
com.saxonica.ee.stream.om.FleetingDocumentNode
- All Implemented Interfaces:
Source
,SourceLocator
,ActiveSource
,GroundedValue
,Item
,NodeInfo
,Sequence
,TreeInfo
,Location
,Locator
A Fleeting node (that is a transient node in a streamed document) that represents a document node
-
Field Summary
Fields inherited from class com.saxonica.ee.stream.om.FleetingNode
root
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected int
atomize()
Get the typed value.void
Buffer a comment or processing instruction appearing before the first element start tagvoid
Copy this node to a given Receiver.void
Copy any saved initial comments or processing instructions to a specified Receiver; and remove them to release any memory that they occupyGet the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.Get the configuration used to build the tree containing this node.long
Get the document number, which identifies this tree uniquely within a ConfigurationGet the durability: always FLEETINGGet the NamePool that holds the namecode for this nodeGet the NodeInfo object representing the document node at the root of the treeGet details of space stripping action that was applied to this document during construction.Get the System ID for the node.Get information about the tree to which this NodeInfo belongsString[]
getUnparsedEntity
(String name) Get the unparsed entity with a given nameGet the list of unparsed entities defined in this documentgetUserData
(String key) Get user data held in the document node.void
Notify the event to a ReceiverGet the element with a given ID, if anyvoid
setConfiguration
(Configuration config) Set the configurationvoid
setMultiAccumulatorWatch
(MultiAccumulatorWatch multiWatch) void
Set details of space stripping action that was applied to this document during construction.void
setSystemId
(String systemId) Set the system identifier for this Source.void
setUnparsedEntity
(String name, String systemID, String publicID) Notify an unparsed entity URI.void
setUserData
(String key, Object value) Set user data on the document node.Methods inherited from class com.saxonica.ee.stream.om.FleetingParentNode
equals, hasChildNodes, hashCode, setHasChildren
Methods inherited from class com.saxonica.ee.stream.om.FleetingNode
compareOrder, generateId, getAllNamespaces, getAttributeValue, getDeclaredNamespaces, getDepth, getDisplayName, getFingerprint, getInScopeNamespaces, getLocalPart, getNamespaceUri, getNodeKind, getNodeName, getNodeNumber, getParent, getPrefix, getRoot, getSchemaType, getUnicodeStringValue, hasFingerprint, head, isStreamed, iterateAxis, saveLocation, setNodeKind, setNodeName, setParent, setStringValue, setTypeAnnotation
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
Methods inherited from interface net.sf.saxon.om.Item
getLength, getStringValue, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.om.NodeInfo
asActiveSource, attributes, children, children, deliver, getAttributeValue, getColumnNumber, getGenre, getLineNumber, getPublicId, getURI, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, toShortString
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
FleetingDocumentNode
public FleetingDocumentNode(long docNr)
-
-
Method Details
-
getRootNode
Get the NodeInfo object representing the document node at the root of the tree- Specified by:
getRootNode
in interfaceTreeInfo
- Returns:
- the document node
-
getTreeInfo
Description copied from class:FleetingNode
Get information about the tree to which this NodeInfo belongs- Specified by:
getTreeInfo
in interfaceNodeInfo
- Overrides:
getTreeInfo
in classFleetingNode
- Returns:
- the TreeInfo
-
allocateNodeNumber
protected int allocateNodeNumber() -
getDocumentNumber
public long getDocumentNumber()Get the document number, which identifies this tree uniquely within a Configuration- Specified by:
getDocumentNumber
in interfaceTreeInfo
- Returns:
- the document number
-
getDurability
Get the durability: always FLEETING- Specified by:
getDurability
in interfaceTreeInfo
- Returns:
Durability.FLEETING
-
setConfiguration
Set the configuration- Parameters:
config
- the configuration to which this document belongs
-
setUnparsedEntity
Notify an unparsed entity URI.- Parameters:
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity- Throws:
XPathException
-
captureInitialCommentOrProcessingInstruction
Buffer a comment or processing instruction appearing before the first element start tag- Parameters:
node
- a comment or processing instruction node
-
copyInitialCommentsAndProcessingInstructions
Copy any saved initial comments or processing instructions to a specified Receiver; and remove them to release any memory that they occupy- Throws:
XPathException
-
selectID
Get the element with a given ID, if any- Specified by:
selectID
in interfaceTreeInfo
- Parameters:
id
- the required ID valuegetParent
- true if the element required is the parent of the element whose type is xs:ID- Returns:
- the element with the given ID, or null if there is no such ID present (or if the parser has not notified attributes as being of type ID)
-
atomize
Get the typed value.- Specified by:
atomize
in interfaceItem
- Specified by:
atomize
in interfaceNodeInfo
- Overrides:
atomize
in classFleetingNode
- Returns:
- the typed value. This will either be a single AtomicValue or a Value whose items are atomic values.
- Throws:
XPathException
- if the node has no typed value, for example if it is an element node with element-only content
-
getUnparsedEntityNames
Get the list of unparsed entities defined in this document- Specified by:
getUnparsedEntityNames
in 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
Get the unparsed entity with a given name- Specified by:
getUnparsedEntity
in 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 (as an absolute URI if possible), the second holding the public ID if there is one, or null if not. If the entity does not exist, the method returns null. Applications should be written on the assumption that this array may be extended in the future to provide additional information.
- Since:
- 8.4
-
setSystemId
Set the system identifier for this Source.The system identifier is optional if the source does not get its data from a URL, but it may still be useful to provide one. The application can use a system identifier, for example, to resolve relative URIs and to include in error messages and warnings.
- Specified by:
setSystemId
in interfaceNodeInfo
- Specified by:
setSystemId
in interfaceSource
- Overrides:
setSystemId
in classFleetingNode
- Parameters:
systemId
- The system identifier as a URL string.
-
getConfiguration
Get the configuration used to build the tree containing this node.- Specified by:
getConfiguration
in interfaceNodeInfo
- Specified by:
getConfiguration
in interfaceTreeInfo
- Overrides:
getConfiguration
in classFleetingNode
- Returns:
- the Configuration
- Since:
- 8.4
-
getNamePool
Get the NamePool that holds the namecode for this node- Overrides:
getNamePool
in classFleetingNode
- Returns:
- the namepool
- Since:
- 8.4
-
copy
Copy this node to a given Receiver.This method is primarily for internal use. It should not be considered a stable part of the Saxon API.
- 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.copyOptions
- Define how namespaces are handledlocationId
- If non-zero, identifies the location of the instruction- Throws:
XPathException
- if any downstream error occurs
-
getSystemId
Get the System ID for the node. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot. The base URI is used primarily for resolving relative URIs within the content of the document. The system ID is used primarily in conjunction with a line number, for identifying the location of elements within the source XML, in particular when errors are found. For a document node, the System ID represents the value of the document-uri property as defined in the XDM data model.- Specified by:
getSystemId
in interfaceLocation
- Specified by:
getSystemId
in interfaceLocator
- Specified by:
getSystemId
in interfaceNodeInfo
- Specified by:
getSystemId
in interfaceSource
- Specified by:
getSystemId
in interfaceSourceLocator
- Overrides:
getSystemId
in classFleetingNode
- Returns:
- the System Identifier of the entity in the source document containing the node, or null if not known or not applicable.
- Since:
- 8.4
-
getBaseURI
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node. This will be the same as the System ID unless xml:base has been used. Where the node does not have a base URI of its own, the base URI of its parent node is returned.- Specified by:
getBaseURI
in interfaceNodeInfo
- Overrides:
getBaseURI
in classFleetingNode
- Returns:
- the base URI of the node. This may be null if the base URI is unknown.
- Since:
- 8.4
-
setMultiAccumulatorWatch
-
getMultiAccumulatorWatch
-
setSpaceStrippingRule
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:
setSpaceStrippingRule
in interfaceTreeInfo
- Parameters:
rule
- details of the space stripping rules that have been applied to this document during its construction.- Since:
- 9.9
-
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:
getSpaceStrippingRule
in 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
Set user data on the document node. The user data can be retrieved subsequently usinggetUserData(java.lang.String)
- Specified by:
setUserData
in 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
Get user data held in the document node. This retrieves properties previously set usingsetUserData(java.lang.String, java.lang.Object)
- Specified by:
getUserData
in 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.
-
notify
Notify the event to a Receiver- Specified by:
notify
in classFleetingParentNode
- Parameters:
out
- the receiver to be notified- Throws:
XPathException
-