com.saxonica.ee.stream.watch

Class AccumulatorWatch

java.lang.Object

com.saxonica.ee.stream.watch.AbstractWatch

com.saxonica.ee.stream.watch.PatternWatch

com.saxonica.ee.stream.watch.AccumulatorWatch

All Implemented Interfaces:

Watch

public class AccumulatorWatch
extends PatternWatch

This watch implements a single accumulator in streaming mode. Unlike other watches, it is called to process every node in the stream; it then checks whether the accumulator has any rule that matches this node, and if so applies the next-value expression associated with that accumulator rule.

Constructor Summary

Constructors

Constructor and Description
AccumulatorWatch(Accumulator accumulator)

Method Summary

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(Location locationId) Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.
Accumulator	getAccumulator()
XPathContext	getContext()
FleetingNode	getCurrentPredescentNode()
FleetingNode	getLastPredescentNode()
Sequence	getPostDescentValue()
Sequence	getPreDescentValue(FleetingNode node)
Sequence	getPreDescentValueAtDepth(int depth)
boolean	isDonePostDescent()
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	setWatchManager(WatchManager watchManager)
Receiver	startSelectedParentNode(FleetingParentNode node, Location locationId) Signal that an element has been found that matches the selection that this Watch is looking for.

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

getAnchorNode, getSelection, matchesNode, matchesNodesOfKind, setAnchorNode, setSelection

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

getNamespaceResolver, getPipelineConfiguration, getReceiver, setNamespaceResolver, setPipelineConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

AccumulatorWatch

public AccumulatorWatch(Accumulator accumulator)

Method Detail

getAccumulator

public Accumulator getAccumulator()

getContext

public XPathContext getContext()

getLastPredescentNode

public FleetingNode getLastPredescentNode()

open

public void open(Terminator terminator)
          throws XPathException

Description copied from class: PatternWatch

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 PatternWatch

Throws:

XPathException - May be raised if a dynamic error occurs

setWatchManager

public void setWatchManager(WatchManager watchManager)

startSelectedParentNode

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

Signal that an element has been found that matches the selection that this Watch is looking for. This method is called by the WatchManager while processing the startElement event that matches the selection. For this purpose, any attributes selected by the last step in the selection are ignored

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:

ValidationException - May be raised if the constraint implemented by this Watch is violated @param locationId

XPathException - May be raised if a dynamic error occurs

getCurrentPredescentNode

public FleetingNode getCurrentPredescentNode()

processItem

public void processItem(Item item)
                 throws XPathException

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 PatternWatch

Parameters:

item - the node that was matched.

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.

Parameters:

locationId -

Throws:

ValidationException - May be raised if the constraint implemented by this Watch is violated @param locationId

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

close

public void close()
           throws XPathException

Description copied from class: PatternWatch

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 PatternWatch

Throws:

XPathException - May be raised if a dynamic error occurs

getPreDescentValue

public Sequence getPreDescentValue(FleetingNode node)
                            throws XPathException

Throws:

XPathException

getPreDescentValueAtDepth

public Sequence getPreDescentValueAtDepth(int depth)
                                   throws XPathException

Throws:

XPathException

getPostDescentValue

public Sequence getPostDescentValue()
                             throws XPathException

Throws:

XPathException

isDonePostDescent

public boolean isDonePostDescent()