com.saxonica.ee.stream.watch

Class ForkingWatch

java.lang.Object

com.saxonica.ee.stream.watch.AbstractWatch

com.saxonica.ee.stream.watch.ForkingWatch

All Implemented Interfaces:

Watch

public class ForkingWatch
extends AbstractWatch

Process an xsl:fork instruction, by feeding events to each of multiple destinations.

Constructor Summary

Constructors

Constructor and Description
ForkingWatch(WatchManager watchManager, Watch[] children, Feed[] buffers, Feed destination)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() The close() method is called immediately before the Watch is destroyed, that is, when the element whose declaration scopes the constraint implemented by this Watch goes out of scope.
void	endSelectedParentNode(int locationId) Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.
FleetingParentNode	getAnchorNode() Get the anchor node for the watch.
SequenceReceiver	getReceiver() Get a receiver to which start and end events for documents and elements can be written.
boolean	matchesNode(FleetingNode node, XPathContext context) Determine whether the watch matches a given node
boolean	matchesNodesOfKind(int kind) Ask whether the Watch is capable of matching nodes of a particular kind
void	open(Terminator terminator) Open the watch.
void	processItem(Item item) Signal that a node (other than an element) that matches the selection has been found.
void	setAnchorNode(FleetingParentNode anchor) Set the anchor node for the watch.
Receiver	startSelectedParentNode(FleetingParentNode node, int locationId) Signal that an element or document node has been found that matches the selection that this Watch is looking for.

Methods inherited from class com.saxonica.ee.stream.watch.AbstractWatch

getNamespaceResolver, getPipelineConfiguration, setNamespaceResolver, setPipelineConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

ForkingWatch

public ForkingWatch(WatchManager watchManager,
            Watch[] children,
            Feed[] buffers,
            Feed destination)
             throws XPathException

Throws:

XPathException

Method Detail

matchesNode

public boolean matchesNode(FleetingNode node,
                  XPathContext context)
                    throws XPathException

Determine whether the watch matches a given node

Parameters:

node - the node to be tested

context - the XPath dynamic context

Returns:

true if the node is one of those the Watch is looking out for

Throws:

XPathException - if a dynamic error occurs

matchesNodesOfKind

public boolean matchesNodesOfKind(int kind)

Ask whether the Watch is capable of matching nodes of a particular kind

Parameters:

kind - the node kind

setAnchorNode

public void setAnchorNode(FleetingParentNode anchor)

Description copied from interface: Watch

Set the anchor node for the watch. This is the node to which the watch is scoped, typically the context node for the streamable path expression that defines the root of the subtree within which nodes are being sought.

Parameters:

anchor - The anchor node within which the watch is scoped

getAnchorNode

public FleetingParentNode getAnchorNode()

Get the anchor node for the watch. This is the node to which the watch is scoped, typically the context node for the streamable path expression that defines the root of the subtree within which nodes are being sought.

Returns:

The anchor node within which the watch is scoped

open

public void open(Terminator terminator)
          throws XPathException

Description copied from class: AbstractWatch

Open the watch. This is done at the point where it first starts watching for nodes that match the selection.

Specified by:

open in interface Watch

Overrides:

open in class AbstractWatch

Throws:

XPathException - May be raised if a dynamic error occurs

processItem

public void processItem(Item item)
                 throws XPathException

Description copied from class: AbstractWatch

Signal that a node (other than an element) that matches the selection has been found.

Specified by:

processItem in interface Watch

Overrides:

processItem in class AbstractWatch

Parameters:

item - the node that was matched.

Throws:

XPathException - May be raised if a dynamic error occurs

close

public void close()
           throws XPathException

Description copied from class: AbstractWatch

The close() method is called immediately before the Watch is destroyed, that is, when the element whose declaration scopes the constraint implemented by this Watch goes out of scope. The default implementation does nothing.

Specified by:

close in interface Watch

Overrides:

close in class AbstractWatch

Throws:

XPathException - May be raised if a dynamic error occurs

getReceiver

public SequenceReceiver getReceiver()

Get a receiver to which start and end events for documents and elements can be written. By default this will be the same as the receiver for the result feed, because very few XSLT constructs (specifically, variables and functions) allow the results of document and element constructors to be captured for further processing. A construct that does need to process these events will intercept them by providing its own receiver, typically a SequenceOutputter.

Overrides:

getReceiver in class AbstractWatch

startSelectedParentNode

public Receiver startSelectedParentNode(FleetingParentNode node,
                               int locationId)
                                 throws XPathException

Description copied from interface: Watch

Signal that an element or document node has been found that matches the selection that this Watch is looking for. This method is called by the WatchManager while processing the startElement or startDocument event that matches the selection.

Parameters:

node - the element or document node whose start event has been matched

locationId - the location associated with the element or document node (may be the location of the instruction that created it)

Returns:

a Receiver to be notified of all events starting with the startElement/startDocument event for the matched element, and ending with the endElement event for that element; or null if this feature is not required.

Throws:

XPathException - May be raised if a dynamic error occurs

endSelectedParentNode

public void endSelectedParentNode(int locationId)
                           throws XPathException

Description copied from interface: Watch

Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.

Parameters:

locationId - the location of the element

Throws:

XPathException - May be raised if a constraint implemented by this Watch is violated