<!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.feed
</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.feed";
}
}
</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/adjunct/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../com/saxonica/stream/om/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/feed/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.feed
</H2>
This package contains classes used to support streaming.
<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/feed/Feed.html" title="interface in com.saxonica.stream.feed">Feed</A></B></TD>
<TD>A Feed is a SequenceReceiver that accepts a sequence of items in composed form: it rejects
events such as startElement and endElement that represent "decomposed" nodes in the data model.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/FeedMaker.html" title="interface in com.saxonica.stream.feed">FeedMaker</A></B></TD>
<TD>An expression that can be evaluated in streaming mode is represented at compile time
by a list of FeedMaker objects.</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/feed/AdjacentTextNodeMergerFeed.html" title="class in com.saxonica.stream.feed">AdjacentTextNodeMergerFeed</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/feed/AtomizerFeed.html" title="class in com.saxonica.stream.feed">AtomizerFeed</A></B></TD>
<TD>This class is used when a streaming template requests atomization of nodes that don't
come directly from the streamed document, but rather are constructed in the course of the push pipeline</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/AvgFeed.html" title="class in com.saxonica.stream.feed">AvgFeed</A></B></TD>
<TD>This class computes the result of the avg() function in push streaming mode</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/BufferingFeed.html" title="class in com.saxonica.stream.feed">BufferingFeed</A></B></TD>
<TD>A BufferingFeed is used to wrap an expression that does not have intrinsic capability
to accept streamed input.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/CardinalityCheckingFeed.html" title="class in com.saxonica.stream.feed">CardinalityCheckingFeed</A></B></TD>
<TD>A Feed which checks the cardinality of the streamed sequence of items.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/ComplexNodeEventFeed.html" title="class in com.saxonica.stream.feed">ComplexNodeEventFeed</A></B></TD>
<TD>This event feed supports instructions that create a document or element node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/CountFeed.html" title="class in com.saxonica.stream.feed">CountFeed</A></B></TD>
<TD>This class is used when counting items (other than nodes delivered by a Watch)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/DecomposingFeed.html" title="class in com.saxonica.stream.feed">DecomposingFeed</A></B></TD>
<TD>Appends the output of an ItemFeed to a SequenceReceiver</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/DistinctValuesFeed.html" title="class in com.saxonica.stream.feed">DistinctValuesFeed</A></B></TD>
<TD>This class is used when a streaming template requests evaluation of the distinct-values()
of the nodes selected by a path expression</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/EmptyTextNodeRemoverFeed.html" title="class in com.saxonica.stream.feed">EmptyTextNodeRemoverFeed</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/feed/EventFeed.html" title="class in com.saxonica.stream.feed">EventFeed</A></B></TD>
<TD>An EventFeed evaluates an expression in "decomposed push" mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/EventFeedMaker.html" title="class in com.saxonica.stream.feed">EventFeedMaker</A></B></TD>
<TD>Abstract FeedMaker acting for an Expression class that prefers to output decomposed events</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/FilterExpressionFeed.html" title="class in com.saxonica.stream.feed">FilterExpressionFeed</A></B></TD>
<TD>This class is used when a streaming template requests filtering of items that don't
come directly from the streamed document, but rather are constructed in the course of the push pipeline</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/ForEachFeed.html" title="class in com.saxonica.stream.feed">ForEachFeed</A></B></TD>
<TD>This class is used when a streaming template applies xsl:for-each to items that don't
come directly from the streamed document, but rather are constructed in the course of the push pipeline</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/GeneralComparisonFeed.html" title="class in com.saxonica.stream.feed">GeneralComparisonFeed</A></B></TD>
<TD>This class is used when a streaming template requests a general comparison with one operand
being pushed from the streamed input document</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/ItemFeed.html" title="class in com.saxonica.stream.feed">ItemFeed</A></B></TD>
<TD>An ItemFeed evaluates an expression in "composed push" mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/ItemFeedMaker.html" title="class in com.saxonica.stream.feed">ItemFeedMaker</A></B></TD>
<TD>Abstract FeedMaker acting for an Expression class that prefers to output composed items</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/ItemMappingFeed.html" title="class in com.saxonica.stream.feed">ItemMappingFeed</A></B></TD>
<TD>A Feed which applies an DummyItemMappingFunction to each supplied item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/MinimaxFeed.html" title="class in com.saxonica.stream.feed">MinimaxFeed</A></B></TD>
<TD>This class is used when a streaming template requests evaluation of the sum()
of the nodes selected by a path expression</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/NextIterationFeed.html" title="class in com.saxonica.stream.feed">NextIterationFeed</A></B></TD>
<TD>This class is used when one of the xsl:with-param elements within an xsl:next-iteration
of an xsl:iterate consumes the streamed input</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/SimpleNodeConstructorFeed.html" title="class in com.saxonica.stream.feed">SimpleNodeConstructorFeed</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/feed/StringJoinFeed.html" title="class in com.saxonica.stream.feed">StringJoinFeed</A></B></TD>
<TD>This class is used when a streamed template requests evaluation of the string-join
function streamed with respect to its first argument</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/SumFeed.html" title="class in com.saxonica.stream.feed">SumFeed</A></B></TD>
<TD>This class is used when a streaming template requests evaluation of the sum()
of the nodes selected by a path expression, with the streamed input being the
value of the first argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/feed/WithParamFeed.html" title="class in com.saxonica.stream.feed">WithParamFeed</A></B></TD>
<TD>A WithParamFeed is used to handle a WithParam element (for example, in xsl:next-iteration)
whose select expression is evaluated in push mode.</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package com.saxonica.stream.feed Description
</H2>
<P>
<p>This package contains classes used to support streaming. For many kinds of expression
that support streaming, there is a <code>Feed</code>class in this
package that evaluates the expression in composed push mode, one item at a time.</p>
<p>None of these classes will be used directly by typical user applications.</p>
<p>These classes generally implement the interface <A HREF="../../../../com/saxonica/stream/feed/ItemFeed.html" title="class in com.saxonica.stream.feed"><CODE>ItemFeed</CODE></A>,
whose main methods are <code>open()</code>, <code>append(item)</code>, and <code>close()</code>.
These methods are called to supply the sequence of items representing the streamed operand of the
expression. The feed class can either deliver the result incrementally during calls of the
<code>append(item)</code> method, or it can deliver the entire result during the <code>close()</code>
method. (It is the responsibility of the class, however, to minimize the amount of data that it buffers).
</p>
<p>The <code>Feed</code> class for evaluating an expression is created by calling the <code>FeedMaker</code>,
which in turn is returned by the streaming adjunct class for the particular kind of expression.</p>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
30 July 2010</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/adjunct/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../com/saxonica/stream/om/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/feed/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>
