<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:48 GMT 2011 --> <TITLE> com.saxonica.stream.watch </TITLE> <META NAME="date" CONTENT="2011-12-09"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="com.saxonica.stream.watch"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/saxonica/stream/om/package-summary.html"><B>PREV PACKAGE</B></A> <A HREF="../../../../com/saxonica/update/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/saxonica/stream/watch/package-summary.html" target="_top"><B>FRAMES</B></A> <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <H2> Package com.saxonica.stream.watch </H2> This package contains defines the two interfaces Watch and WatchMaker, and various implementations of these interfaces. <P> <B>See:</B> <BR> <A HREF="#package_description"><B>Description</B></A> <P> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Interface Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html" title="interface in com.saxonica.stream.watch">Watch</A></B></TD> <TD>A Watch represents a class that is interested in looking at nodes passing down a push pipeline.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/WatchMaker.html" title="interface in com.saxonica.stream.watch">WatchMaker</A></B></TD> <TD>A WatchMaker is a factory class for creating a <A HREF="../../../../com/saxonica/stream/watch/Watch.html" title="interface in com.saxonica.stream.watch"><CODE>Watch</CODE></A>.</TD> </TR> </TABLE> <P> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/ApplyImportsWatch.html" title="class in com.saxonica.stream.watch">ApplyImportsWatch</A></B></TD> <TD>Watch for an xsl:apply-imports instruction.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/ApplyTemplatesWatch.html" title="class in com.saxonica.stream.watch">ApplyTemplatesWatch</A></B></TD> <TD>This watch implements xsl:apply-templates in streaming mode.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/ComposingWatch.html" title="class in com.saxonica.stream.watch">ComposingWatch</A></B></TD> <TD>A ComposingWatch is a Watch that evaluates an expression based on the nodes encountered in a streamed input document, passing the value of that expression as a sequence of items to an ItemFeed.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/CopyOfWatch.html" title="class in com.saxonica.stream.watch">CopyOfWatch</A></B></TD> <TD>This class is used when optimizing a SequentialCopy, that is, when evaluating a construct of the form saxon:stream(doc('a.xml')/a/b/c).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/CountWatch.html" title="class in com.saxonica.stream.watch">CountWatch</A></B></TD> <TD>This class is used when a streamed template requests evaluation of the count() function applied to a streamable pattern</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/EmptyWatch.html" title="class in com.saxonica.stream.watch">EmptyWatch</A></B></TD> <TD>Streaming watch supporting the empty() function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/EventPushingWatch.html" title="class in com.saxonica.stream.watch">EventPushingWatch</A></B></TD> <TD>A EvaluatingWatch is a Watch that evaluates an expression based on the nodes encountered in a streamed input document, appending the value of that expression to the Watch for the next expression in the streaming route.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/ExistsWatch.html" title="class in com.saxonica.stream.watch">ExistsWatch</A></B></TD> <TD>Streaming watch supporting the exists() function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/ForEachComposingWatch.html" title="class in com.saxonica.stream.watch">ForEachComposingWatch</A></B></TD> <TD>This watch implements xsl:for-each in streaming mode, in the case where the select expression is a pattern that selects events from the streamed input, but the body of the for-each does no further downwards navigation, and delivers composed items to an ItemFeed acting as the parent expression of the for-each.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/ForEachWatch.html" title="class in com.saxonica.stream.watch">ForEachWatch</A></B></TD> <TD>This watch implements xsl:for-each in streaming mode.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/ForkingFeed.html" title="class in com.saxonica.stream.watch">ForkingFeed</A></B></TD> <TD>Watch for an xsl:fork instruction.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/IterateWatch.html" title="class in com.saxonica.stream.watch">IterateWatch</A></B></TD> <TD>This watch implements xsl:iterate in streaming mode.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/NextMatchWatch.html" title="class in com.saxonica.stream.watch">NextMatchWatch</A></B></TD> <TD>Watch for an xsl:next-match instruction.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/NonstreamingExpressionWatch.html" title="class in com.saxonica.stream.watch">NonstreamingExpressionWatch</A></B></TD> <TD>This watch is used for a streamed template that makes no access to descendant nodes.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/SimpleContentWatch.html" title="class in com.saxonica.stream.watch">SimpleContentWatch</A></B></TD> <TD>This class is used when a streaming template requests evaluation of a simple content constructor in streaming mode (that is, when it constructs a text, attribute, comment, or PI node based on the contents of the streamed document).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/StringValueAccumulator.html" title="class in com.saxonica.stream.watch">StringValueAccumulator</A></B></TD> <TD>A StringValueAccumulator is a Receiver that computes the string value of an element in streaming mode, by copying all the text nodes to a supplied receiver.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/StringValueWatch.html" title="class in com.saxonica.stream.watch">StringValueWatch</A></B></TD> <TD>This class is used when a streamed template requests evaluation of the string value of the nodes selected by a path expression, typically in response to an xsl:value-of instruction.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/TypedValueWatch.html" title="class in com.saxonica.stream.watch">TypedValueWatch</A></B></TD> <TD>This class is used when a streamed template requests evaluation of the typed value of the nodes selected by a path expression.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/VoidWatch.html" title="class in com.saxonica.stream.watch">VoidWatch</A></B></TD> <TD>This class is a Watch that always returns an empty sequence as its result.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/VoidWatchMaker.html" title="class in com.saxonica.stream.watch">VoidWatchMaker</A></B></TD> <TD>A singleton WatchMaker that returns the singleton <A HREF="../../../../com/saxonica/stream/watch/VoidWatch.html" title="class in com.saxonica.stream.watch"><CODE>VoidWatch</CODE></A></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/watch/WatchManager.html" title="class in com.saxonica.stream.watch">WatchManager</A></B></TD> <TD>This class sits on a push pipeline and evaluates the passing element and attribute nodes.</TD> </TR> </TABLE> <P> <A NAME="package_description"><!-- --></A><H2> Package com.saxonica.stream.watch Description </H2> <P> <p>This package contains defines the two interfaces Watch and WatchMaker, and various implementations of these interfaces.</p> <p>A Watch is used on a streaming pipeline to recognize specific events, such as the start of a selected element, and to take action when these events occur. A WatchMaker is a factory class for creating a particular kind of Watch. The WatchManager is a class that sits on the Receiver pipeline keeping track of which Watches are active, and notifying them of events so that they can decide whether they are of interest.</p> <p align="center"><i>Michael H. Kay<br/> Saxonica Limited<br/> 28 November 2011</i></p> <P> <P> <DL> </DL> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/saxonica/stream/om/package-summary.html"><B>PREV PACKAGE</B></A> <A HREF="../../../../com/saxonica/update/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/saxonica/stream/watch/package-summary.html" target="_top"><B>FRAMES</B></A> <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright (c) 2004-2011 Saxonica Limited. All rights reserved. </BODY> </HTML>