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:

Result, Receiver

public class LinkedBuilderMonitor
extends BuilderMonitor

Monitor construction of a TinyTree. 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

Constructor	Description
LinkedBuilderMonitor(LinkedTreeBuilder builder)

Method Summary

Modifier and Type	Method	Description
void	attribute(NodeName name, SimpleType typeCode, CharSequence value, Location locationId, int properties)	Notify an attribute.
void	characters(CharSequence chars, Location locationId, int properties)	Character data
void	comment(CharSequence chars, Location locationId, int properties)	Output a comment
NodeInfo	getMarkedNode()	On completion of tree building, get the node that was marked using markNextNode().
void	markAttributeNode(NodeInfo origin)	Indicate that the most recently written attribute whose name matches that of the supplied node is to act as the marked node
void	markNamespaceNode(NodeInfo origin)	Indicate that the most recently written attribute whose name matches that of the supplied node is to act as the marked node
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	namespace(NamespaceBindingSet namespaceBindings, int properties)	Notify a namespace.
void	processingInstruction(String target, CharSequence data, Location locationId, int properties)	Processing Instruction
void	startContent()	Notify the start of the content, that is, the completion of all attributes and namespaces.
void	startDocument(int properties)	Start of a document node.

Methods inherited from class net.sf.saxon.event.ProxyReceiver

append, close, endDocument, endElement, getNamePool, getNextReceiver, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startElement, usesTypeAnnotations

Methods inherited from class net.sf.saxon.event.SequenceReceiver

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LinkedBuilderMonitor

public LinkedBuilderMonitor(LinkedTreeBuilder builder)

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 class BuilderMonitor

Parameters:

nodeKind - the kind of node that will be created next. This will always be an element, text, comment, or processing-instruction node

markAttributeNode

public void markAttributeNode(NodeInfo origin)

Description copied from class: BuilderMonitor

Indicate that the most recently written attribute whose name matches that of the supplied node is to act as the marked node

Specified by:

markAttributeNode in class BuilderMonitor

Parameters:

origin - the attribute in the input corresponding to the marked node in the output

markNamespaceNode

public void markNamespaceNode(NodeInfo origin)

Description copied from class: BuilderMonitor

Indicate that the most recently written attribute whose name matches that of the supplied node is to act as the marked node

Specified by:

markNamespaceNode in class BuilderMonitor

Parameters:

origin - the attribute in the input corresponding to the marked node in the output

startDocument

public void startDocument(int properties)
                   throws XPathException

Description copied from class: ProxyReceiver

Start of a document node.

Specified by:

startDocument in interface Receiver

Overrides:

startDocument in class ProxyReceiver

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions

Throws:

XPathException - if an error occurs

startContent

public void startContent()
                  throws XPathException

Description copied from class: ProxyReceiver

Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.

Specified by:

startContent in interface Receiver

Overrides:

startContent in class ProxyReceiver

Throws:

XPathException - if an error occurs

characters

public void characters(CharSequence chars,
 Location locationId,
 int properties)
                throws XPathException

Description copied from class: ProxyReceiver

Character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

locationId - 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(CharSequence chars,
 Location locationId,
 int properties)
             throws XPathException

Description copied from class: ProxyReceiver

Output a comment

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

locationId - 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,
 CharSequence data,
 Location locationId,
 int properties)
                           throws XPathException

Description copied from class: ProxyReceiver

Processing Instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyReceiver

Parameters:

target - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

locationId - provides information such as line number and system ID.

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

attribute

public void attribute(NodeName name,
 SimpleType typeCode,
 CharSequence value,
 Location locationId,
 int properties)
               throws XPathException

Description copied from class: ProxyReceiver

Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.

Specified by:

attribute in interface Receiver

Overrides:

attribute in class ProxyReceiver

Parameters:

name - The name of the attribute

typeCode - The type of the attribute

value - the string value of the attribute

locationId - The location of the node

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this attribute

NO_SPECIAL_CHARACTERS

Attribute value contains no special characters

Throws:

XPathException - if an error occurs

namespace

public void namespace(NamespaceBindingSet namespaceBindings,
 int properties)
               throws XPathException

Description copied from class: ProxyReceiver

Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.

Specified by:

namespace in interface Receiver

Overrides:

namespace in class ProxyReceiver

Parameters:

namespaceBindings - the prefix/uri pair representing the namespace binding

properties - any special properties to be passed on this call

Throws:

XPathException - if an error occurs

getMarkedNode

public NodeInfo getMarkedNode()

Description copied from class: BuilderMonitor

On completion of tree building, get the node that was marked using markNextNode().

Specified by:

getMarkedNode in class BuilderMonitor

Returns:

the marked node, or null if none was marked