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
-
- All Implemented Interfaces:
javax.xml.transform.Result,Receiver
public class LinkedBuilderMonitor extends BuilderMonitor
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
-
-
Constructor Summary
Constructors Constructor Description LinkedBuilderMonitor(LinkedTreeBuilder builder)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Character datavoidcomment(java.lang.CharSequence chars, Location locationId, int properties)Output a commentNodeInfogetMarkedNode()On completion of tree building, get the node that was marked using markNextNode().voidmarkNextNode(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.voidprocessingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties)Processing InstructionvoidstartDocument(int properties)Start of a document node.voidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an element-
Methods 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 Detail
-
LinkedBuilderMonitor
public LinkedBuilderMonitor(LinkedTreeBuilder builder)
-
-
Method Detail
-
markNextNode
public void markNextNode(int nodeKind)
Description copied from class:BuilderMonitorIndicate 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:
markNextNodein 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
public void startDocument(int properties) throws XPathExceptionDescription copied from class:ProxyReceiverStart of a document node.- Specified by:
startDocumentin interfaceReceiver- Overrides:
startDocumentin 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:ProxyReceiverNotify the start of an element- Specified by:
startElementin interfaceReceiver- Overrides:
startElementin 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(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionDescription copied from class:ProxyReceiverCharacter data- Specified by:
charactersin interfaceReceiver- Overrides:
charactersin 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
public void comment(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionDescription copied from class:ProxyReceiverOutput a comment- Specified by:
commentin interfaceReceiver- Overrides:
commentin 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(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) throws XPathExceptionDescription copied from class:ProxyReceiverProcessing Instruction- Specified by:
processingInstructionin interfaceReceiver- Overrides:
processingInstructionin 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
public NodeInfo getMarkedNode()
Description copied from class:BuilderMonitorOn completion of tree building, get the node that was marked using markNextNode().- Specified by:
getMarkedNodein classBuilderMonitor- Returns:
- the marked node, or null if none was marked
-
-