com.saxonica.ee.stream.adjunct

Class ConditionalBlockAdjunct.ConditionalBlockFeed

java.lang.Object

com.saxonica.ee.stream.feed.ItemFeed

com.saxonica.ee.stream.adjunct.ConditionalBlockAdjunct.ConditionalBlockFeed

All Implemented Interfaces:

Feed

Enclosing class:

ConditionalBlockAdjunct

public static class ConditionalBlockAdjunct.ConditionalBlockFeed
extends ItemFeed

Constructor Summary

Constructors

Constructor and Description
ConditionalBlockFeed(ConditionalBlock exp, int arg, Feed result, XPathContext context)

Method Summary

Modifier and Type	Method and Description
void	addTentativeContent(Item item)
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(Location locationId) Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.
Receiver	getReceiver() Get a receiver to which start and end events for documents and elements can be written.
boolean	isEmpty()
void	open(Terminator terminator) Open the watch.
void	processItem(Item<?> item) Signal that a node (other than a document or element node) that matches the selection has been found, or that a grounded item is being passed to the next expression in the evaluation pipeline.
Receiver	startSelectedParentNode(FleetingParentNode node, Location 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.feed.ItemFeed

dynamicError, getContext, getExpression, getPipelineConfiguration, getResult, getTerminator, hasFailed, processItems, setExpression, setHasFailed, setPipelineConfiguration, setTerminator

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionalBlockFeed

public ConditionalBlockFeed(ConditionalBlock exp,
                            int arg,
                            Feed result,
                            XPathContext context)

Method Detail

isEmpty

public boolean isEmpty()

addTentativeContent

public void addTentativeContent(Item item)

open

public void open(Terminator terminator)
          throws XPathException

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 Feed

Overrides:

open in class ItemFeed

Parameters:

terminator - used for early exit

Throws:

XPathException - if a dynamic error occurs

close

public void close()
           throws XPathException

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 Feed

Overrides:

close in class ItemFeed

Throws:

XPathException - if a dynamic error occurs

processItem

public void processItem(Item<?> item)
                 throws XPathException

Signal that a node (other than a document or element node) that matches the selection has been found, or that a grounded item is being passed to the next expression in the evaluation pipeline.

Specified by:

processItem in interface Feed

Specified by:

processItem in class ItemFeed

Parameters:

item - the node that was matched.

Throws:

XPathException - May be raised if a dynamic error occurs

startSelectedParentNode

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

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.

Specified by:

startSelectedParentNode in interface Feed

Overrides:

startSelectedParentNode in class ItemFeed

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(Location locationId)
                           throws XPathException

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

Specified by:

endSelectedParentNode in interface Feed

Overrides:

endSelectedParentNode in class ItemFeed

Parameters:

locationId - the location of the element

Throws:

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

getReceiver

public Receiver 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.

Specified by:

getReceiver in interface Feed

Overrides:

getReceiver in class ItemFeed

Returns:

the receiver