Package net.sf.saxon.tree.linked
Class LinkedBuilderMonitor
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.event.BuilderMonitor
net.sf.saxon.tree.linked.LinkedBuilderMonitor
Monitor construction of a document tree. This allows a marker to be set during tree construction, in such a way
that the node corresponding to the marker can be retrieved at the end of tree construction. This is used in the
implementation of the XSLT 3.0 snapshot function.
-
Field Summary
Fields inherited from class net.sf.saxon.event.ProxyReceiver
nextReceiver
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(UnicodeString chars, Location locationId, int properties) Character datavoid
comment
(UnicodeString chars, Location locationId, int properties) Output a commentOn completion of tree building, get the node that was marked using marknext().void
markNextNode
(int nodeKind) Indicate that the next node to be created will be of a given type, and request the monitor to remember the identity of this node.void
processingInstruction
(String target, UnicodeString data, Location locationId, int properties) Processing Instructionvoid
startDocument
(int properties) Start of a document node.void
startElement
(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Notify the start of an elementMethods inherited from class net.sf.saxon.event.ProxyReceiver
append, close, endDocument, endElement, getNamePool, getNextReceiver, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, usesTypeAnnotations
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend
-
Constructor Details
-
LinkedBuilderMonitor
-
-
Method Details
-
markNextNode
public void markNextNode(int nodeKind) Description copied from class:BuilderMonitor
Indicate that the next node to be created will be of a given type, and request the monitor to remember the identity of this node.- Specified by:
markNextNode
in classBuilderMonitor
- Parameters:
nodeKind
- the kind of node that will be created next. This will always be an element, text, comment, or processing-instruction node
-
startDocument
Description copied from class:ProxyReceiver
Start of a document node.- Specified by:
startDocument
in interfaceReceiver
- Overrides:
startDocument
in classProxyReceiver
- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException Description copied from class:ProxyReceiver
Notify the start of an element- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- Parameters:
elemName
- the name of the element.type
- the type annotation of the element.attributes
- the attributes of this elementnamespaces
- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation
- an object providing information about the module, line, and column where the node originatedproperties
- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-
characters
public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException Description copied from class:ProxyReceiver
Character data- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this text node
- USE_CDATA
- Output as a CDATA section
- Throws:
XPathException
- if an error occurs
-
comment
Description copied from class:ProxyReceiver
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- provides information such as line number and system ID.properties
- Additional information about the comment.- Throws:
XPathException
- if an error occurs
-
processingInstruction
public void processingInstruction(String target, UnicodeString data, Location locationId, int properties) throws XPathException Description copied from class:ProxyReceiver
Processing Instruction- Specified by:
processingInstruction
in interfaceReceiver
- Overrides:
processingInstruction
in classProxyReceiver
- Parameters:
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- provides information such as line number and system ID.properties
- Additional information about the PI.- Throws:
XPathException
- if an error occurs
-
getMarkedNode
Description copied from class:BuilderMonitor
On completion of tree building, get the node that was marked using marknext().- Specified by:
getMarkedNode
in classBuilderMonitor
- Returns:
- the marked node, or null if none was marked
-