Package com.saxonica.ee.stream.watch
Class IterateAction
- java.lang.Object
-
- net.sf.saxon.event.Outputter
-
- net.sf.saxon.event.ProxyOutputter
-
- com.saxonica.ee.stream.feed.ItemFeed
-
- com.saxonica.ee.stream.watch.ForEachAction
-
- com.saxonica.ee.stream.watch.IterateAction
-
- All Implemented Interfaces:
javax.xml.transform.Result,Receiver
public class IterateAction extends ForEachAction
This watch implements xsl:iterate in streaming mode. It watches for the nodes selected by the xsl:iterate instruction; when such a node is encountered, it locates the relevant (inverted) template, and activates it.The watch is capable of handling a select expression that selects non-peer nodes (that is, one selected node that is a descendant of another). A top-level selected node is processed directly to the output receiver; a nested node is processed to create a temporary result tree, which is then appended to the output sequence when the processing of the outer selected node is complete.
-
-
Field Summary
-
Fields inherited from class com.saxonica.ee.stream.watch.ForEachAction
bodyContext
-
Fields inherited from class net.sf.saxon.event.Outputter
pipelineConfiguration, systemId
-
-
Constructor Summary
Constructors Constructor Description IterateAction(WatchManager watchManager, Expression expression, ItemFeed result, XPathContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidappend(Item it)Signal that a node (other than an element) that matches the selection has been found.voidclose()Finish evaluating the expression.voidendSelectedParentNode(Location locationId)Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.voidopen(Terminator terminator)Start evaluating the expression.ReceiverstartSelectedParentNode(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.ForEachAction
getAction, getBodyContext, getInversion, getWatchManager, isActionConsuming, makeBodyContext, setInversion
-
Methods inherited from class com.saxonica.ee.stream.feed.ItemFeed
append, dynamicError, getContext, getExpression, getResult, getTerminator, hasFailed, processItems, setExpression, setHasFailed, setTerminator
-
Methods inherited from class net.sf.saxon.event.ProxyOutputter
attribute, characters, comment, endDocument, endElement, getNextOutputter, namespace, open, processingInstruction, setLocation, setUnparsedEntity, startContent, startDocument, startElement, startElement, usesTypeAnnotations
-
Methods inherited from class net.sf.saxon.event.Outputter
getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.event.Receiver
handlesAppend
-
-
-
-
Constructor Detail
-
IterateAction
public IterateAction(WatchManager watchManager, Expression expression, ItemFeed result, XPathContext context)
-
-
Method Detail
-
open
public void open(Terminator terminator) throws XPathException
Description copied from class:ItemFeedStart evaluating the expression. The default implementation does nothing.- Overrides:
openin classForEachAction- Parameters:
terminator- used to achieve early exit- Throws:
XPathException- if a dynamic error occurs
-
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- Overrides:
startSelectedParentNodein classForEachAction- Parameters:
node- the element or document node whose start event has been matchedlocationId- the location associated with the element or document node (may be the location of the instruction that created it)- Returns:
- a receiver that collects the contents of the selected node, or null
- Throws:
ValidationException- May be raised if the constraint implemented by this Watch is violated @param locationId the location of the node in the source, or of the instruction that created itXPathException- May be raised if a dynamic error occurs
-
append
public void append(Item it) throws XPathException
Signal that a node (other than an element) that matches the selection has been found.- Specified by:
appendin interfaceReceiver- Overrides:
appendin classForEachAction- Parameters:
it- the node that was matched.- Throws:
XPathException- if the operation fails
-
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.- Overrides:
endSelectedParentNodein classForEachAction- Parameters:
locationId- the location of the node in the source, or of the instruction that created it- Throws:
ValidationException- May be raised if the constraint implemented by this Watch is violated @param locationId the location of the node in the source, or of the instruction that created itXPathException- May be raised if a constraint implemented by this Watch is violated
-
close
public void close() throws XPathExceptionDescription copied from class:ItemFeedFinish evaluating the expression.- Specified by:
closein interfaceReceiver- Overrides:
closein classForEachAction- Throws:
XPathException- if a dynamic error occurs
-
-