<!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:47:54 GMT 2011 -->
<TITLE>
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="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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/feed/EventFeedMaker.html" title="class in com.saxonica.stream.feed"><B>PREV CLASS</B></A>
<A HREF="../../../../com/saxonica/stream/feed/FeedMaker.html" title="interface in com.saxonica.stream.feed"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/saxonica/stream/feed/Feed.html" target="_top"><B>FRAMES</B></A>
<A HREF="Feed.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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.saxonica.stream.feed</FONT>
<BR>
Interface Feed</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/saxonica/stream/feed/AdjacentTextNodeMergerFeed.html" title="class in com.saxonica.stream.feed">AdjacentTextNodeMergerFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/AtomizerFeed.html" title="class in com.saxonica.stream.feed">AtomizerFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/AvgFeed.html" title="class in com.saxonica.stream.feed">AvgFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/BufferingFeed.html" title="class in com.saxonica.stream.feed">BufferingFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/CardinalityCheckingFeed.html" title="class in com.saxonica.stream.feed">CardinalityCheckingFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/ComplexNodeEventFeed.html" title="class in com.saxonica.stream.feed">ComplexNodeEventFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/CountFeed.html" title="class in com.saxonica.stream.feed">CountFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/DecomposingFeed.html" title="class in com.saxonica.stream.feed">DecomposingFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/DistinctValuesFeed.html" title="class in com.saxonica.stream.feed">DistinctValuesFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/EmptyTextNodeRemoverFeed.html" title="class in com.saxonica.stream.feed">EmptyTextNodeRemoverFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/EventFeed.html" title="class in com.saxonica.stream.feed">EventFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/FilterExpressionFeed.html" title="class in com.saxonica.stream.feed">FilterExpressionFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/ForEachFeed.html" title="class in com.saxonica.stream.feed">ForEachFeed</A>, <A HREF="../../../../com/saxonica/stream/watch/ForkingFeed.html" title="class in com.saxonica.stream.watch">ForkingFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/GeneralComparisonFeed.html" title="class in com.saxonica.stream.feed">GeneralComparisonFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/ItemFeed.html" title="class in com.saxonica.stream.feed">ItemFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/ItemMappingFeed.html" title="class in com.saxonica.stream.feed">ItemMappingFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/MinimaxFeed.html" title="class in com.saxonica.stream.feed">MinimaxFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/NextIterationFeed.html" title="class in com.saxonica.stream.feed">NextIterationFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/SimpleNodeConstructorFeed.html" title="class in com.saxonica.stream.feed">SimpleNodeConstructorFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/StringJoinFeed.html" title="class in com.saxonica.stream.feed">StringJoinFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/SumFeed.html" title="class in com.saxonica.stream.feed">SumFeed</A>, <A HREF="../../../../com/saxonica/stream/feed/WithParamFeed.html" title="class in com.saxonica.stream.feed">WithParamFeed</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Feed</B></DL>
</PRE>
<P>
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.
Typically it computes some result based on this sequence, which is either passed on to another Feed in a pipeline,
or is available through a subclass-specific method on completion.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/feed/Feed.html#append(net.sf.saxon.om.Item)">append</A></B>(<A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A> item)</CODE>
<BR>
Supply an item to the feed</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/feed/Feed.html#close()">close</A></B>()</CODE>
<BR>
Signal the end of the sequence of items</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/feed/Feed.html#getPipelineConfiguration()">getPipelineConfiguration</A></B>()</CODE>
<BR>
Get the pipeline configuration</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/feed/Feed.html#open()">open</A></B>()</CODE>
<BR>
Signal the start of a sequence of items</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getPipelineConfiguration()"><!-- --></A><H3>
getPipelineConfiguration</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A> <B>getPipelineConfiguration</B>()</PRE>
<DL>
<DD>Get the pipeline configuration
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the pipeline configuration</DL>
</DD>
</DL>
<HR>
<A NAME="open()"><!-- --></A><H3>
open</H3>
<PRE>
void <B>open</B>()
throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Signal the start of a sequence of items
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - to report any failure</DL>
</DD>
</DL>
<HR>
<A NAME="append(net.sf.saxon.om.Item)"><!-- --></A><H3>
append</H3>
<PRE>
void <B>append</B>(<A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A> item)
throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Supply an item to the feed
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>item</CODE> - the item being fed
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - to report any failure</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
void <B>close</B>()
throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Signal the end of the sequence of items
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - to report any failure</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/feed/EventFeedMaker.html" title="class in com.saxonica.stream.feed"><B>PREV CLASS</B></A>
<A HREF="../../../../com/saxonica/stream/feed/FeedMaker.html" title="interface in com.saxonica.stream.feed"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/saxonica/stream/feed/Feed.html" target="_top"><B>FRAMES</B></A>
<A HREF="Feed.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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></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>
