com.saxonica.ee.stream.feed

Class DecomposingFeed

java.lang.Object

com.saxonica.ee.stream.feed.DecomposingFeed

All Implemented Interfaces:

Feed

public class DecomposingFeed
extends Object
implements Feed

Appends the output of an ItemFeed to a SequenceReceiver

Constructor Summary

Constructors

Constructor and Description
DecomposingFeed(SequenceReceiver receiver)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Signal the end of the sequence of items
void	endSelectedParentNode(int locationId) Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.
PipelineConfiguration	getPipelineConfiguration() Get the pipeline configuration
SequenceReceiver	getReceiver() Get the destination receiver
void	open(Terminator terminator) Signal the start of a sequence of items
void	processItem(Item item) Supply an item to the feed
void	setReceiver(SequenceReceiver out) Set the destination receiver
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 java.lang.Object

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

Constructor Detail

DecomposingFeed

public DecomposingFeed(SequenceReceiver receiver)

Method Detail

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()

Get the pipeline configuration

Specified by:

getPipelineConfiguration in interface Feed

Returns:

the pipeline configuration

getReceiver

public SequenceReceiver getReceiver()

Get the destination receiver

Specified by:

getReceiver in interface Feed

Returns:

the receiver to which events are being written to represent the results of this instruction

setReceiver

public void setReceiver(SequenceReceiver out)

Set the destination receiver

Parameters:

out - the receiver to which events should henceforth be written

open

public void open(Terminator terminator)
          throws XPathException

Signal the start of a sequence of items

Specified by:

open in interface Feed

Parameters:

terminator -

Throws:

XPathException - to report any failure

startSelectedParentNode

public Receiver startSelectedParentNode(FleetingParentNode node,
                               int 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

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

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

Parameters:

locationId - the location of the element

Throws:

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

processItem

public void processItem(Item item)
                 throws XPathException

Supply an item to the feed

Specified by:

processItem in interface Feed

Parameters:

item - the item being fed

Throws:

XPathException - to report any failure

close

public void close()
           throws XPathException

Signal the end of the sequence of items

Specified by:

close in interface Feed

Throws:

XPathException - to report any failure