Class ForEachAction

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver
    Direct Known Subclasses:
    ForEachGroupParallelAction, IterateAction

    public class ForEachAction
    extends ItemFeed
    This watch implements xsl:for-each in streaming mode. It is informed of the nodes or other items selected by the xsl:for-each instruction; when such an item is encountered, it locates the relevant (inverted) action representing the body of the for-each, and activates it.
    • Method Detail

      • setInversion

        public void setInversion​(Inversion inversion)
        Set the inversion of the for-each action (the body of the loop)
        Parameters:
        inversion - the inverted code implementing the body of the for-each
      • getInversion

        protected Inversion getInversion()
      • getWatchManager

        protected WatchManager getWatchManager()
      • isActionConsuming

        protected boolean isActionConsuming()
      • open

        public void open​(Terminator terminator)
                  throws XPathException
        Description copied from class: ItemFeed
        Start evaluating the expression. The default implementation does nothing.
        Overrides:
        open in class ItemFeed
        Parameters:
        terminator - used to achieve early exit
        Throws:
        XPathException - if a dynamic error occurs
      • makeBodyContext

        protected void makeBodyContext()
      • 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:
        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:
        always null for this method, but may be non-null in subclasses
        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 it
        XPathException - May be raised if a dynamic error occurs
      • append

        public void append​(Item it)
                    throws XPathException
        Method called by the feed for a subexpression to supply a grounded item from the streamed input.
        Specified by:
        append in interface Receiver
        Specified by:
        append in class ItemFeed
        Parameters:
        it - the grounded item.
        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:
        endSelectedParentNode in class ItemFeed
        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 it
        XPathException - May be raised if a constraint implemented by this Watch is violated