You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by cr...@apache.org on 2015/01/25 00:00:16 UTC
svn commit: r1654593 [25/33] - in /samza/site: ./ contribute/
learn/documentation/latest/api/javadocs/
learn/documentation/latest/api/javadocs/org/apache/samza/
learn/documentation/latest/api/javadocs/org/apache/samza/checkpoint/
learn/documentation/la...
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html?rev=1654593&r1=1654592&r2=1654593&view=diff
==============================================================================
--- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html (original)
+++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html Sat Jan 24 23:00:15 2015
@@ -1,334 +1,347 @@
<!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_65) on Tue Dec 09 16:53:23 PST 2014 -->
-<TITLE>
-BaseMessageChooser (samza-api 0.9.0-SNAPSHOT API)
-</TITLE>
-
-<META NAME="date" CONTENT="2014-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="BaseMessageChooser (samza-api 0.9.0-SNAPSHOT API)";
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_31) on Fri Jan 23 11:05:49 PST 2015 -->
+<title>BaseMessageChooser (samza-api 0.9.0-SNAPSHOT API)</title>
+<meta name="date" content="2015-01-23">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="BaseMessageChooser (samza-api 0.9.0-SNAPSHOT API)";
+ }
}
-}
-</SCRIPT>
-<NOSCRIPT>
-</NOSCRIPT>
-
-</HEAD>
-
-<BODY BGCOLOR="white" onload="windowTitle();">
-<HR>
-
-
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
<!-- ========= 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">
- PREV CLASS
- <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><B>NEXT CLASS</B></A></FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/apache/samza/system/chooser/BaseMessageChooser.html" target="_top"><B>FRAMES</B></A>
- <A HREF="BaseMessageChooser.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev Class</li>
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/BaseMessageChooser.html" target="_top">Frames</a></li>
+<li><a href="BaseMessageChooser.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
- document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_top"></A>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
-
-<HR>
<!-- ======== START OF CLASS DATA ======== -->
-<H2>
-<FONT SIZE="-1">
-org.apache.samza.system.chooser</FONT>
-<BR>
-Class BaseMessageChooser</H2>
-<PRE>
-java.lang.Object
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.samza.system.chooser.BaseMessageChooser</B>
-</PRE>
-<DL>
-<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</A></DD>
-</DL>
-<HR>
-<DL>
-<DT><PRE>public abstract class <B>BaseMessageChooser</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</A></DL>
-</PRE>
-
-<P>
-An abstract MessageChooser that implements start/stop/register for choosers
- that don't use them.
-<P>
-
-<P>
-<HR>
-
-<P>
-
+<div class="header">
+<div class="subTitle">org.apache.samza.system.chooser</div>
+<h2 title="Class BaseMessageChooser" class="title">Class BaseMessageChooser</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.system.chooser.BaseMessageChooser</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="typeNameLabel">BaseMessageChooser</span>
+extends java.lang.Object
+implements <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></pre>
+<div class="block">An abstract MessageChooser that implements start/stop/register for choosers
+ that don't use them.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
-
-<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><B><A HREF="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#BaseMessageChooser()">BaseMessageChooser</A></B>()</CODE>
-
-<BR>
- </TD>
-</TR>
-</TABLE>
-
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#BaseMessageChooser--">BaseMessageChooser</a></span>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
<!-- ========== 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="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">register</A></B>(<A HREF="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> systemStreamPartition,
- java.lang.String offset)</CODE>
-
-<BR>
- Called before start, to let the chooser know that it will be handling
- envelopes from the given SystemStreamPartition.</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="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#start()">start</A></B>()</CODE>
-
-<BR>
- Called after all SystemStreamPartitions have been registered.</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="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#stop()">stop</A></B>()</CODE>
-
-<BR>
- Called when the chooser is about to be discarded.</TD>
-</TR>
-</TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
-</TR>
-</TABLE>
- <A NAME="methods_inherited_from_class_org.apache.samza.system.chooser.MessageChooser"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TH ALIGN="left"><B>Methods inherited from interface org.apache.samza.system.chooser.<A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</A></B></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()">choose</A>, <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)">update</A></CODE></TD>
-</TR>
-</TABLE>
-
-<P>
-
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">register</a></span>(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</code>
+<div class="block">Called before start, to let the chooser know that it will be handling
+ envelopes from the given SystemStreamPartition.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#start--">start</a></span>()</code>
+<div class="block">Called after all SystemStreamPartitions have been registered.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#stop--">stop</a></span>()</code>
+<div class="block">Called when the chooser is about to be discarded.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.system.chooser.MessageChooser">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.samza.system.chooser.<a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></h3>
+<code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose--">choose</a>, <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update-org.apache.samza.system.IncomingMessageEnvelope-">update</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
-
-<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="BaseMessageChooser()"><!-- --></A><H3>
-BaseMessageChooser</H3>
-<PRE>
-public <B>BaseMessageChooser</B>()</PRE>
-<DL>
-</DL>
-
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="BaseMessageChooser--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>BaseMessageChooser</h4>
+<pre>public BaseMessageChooser()</pre>
+</li>
+</ul>
+</li>
+</ul>
<!-- ============ 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="start()"><!-- --></A><H3>
-start</H3>
-<PRE>
-public void <B>start</B>()</PRE>
-<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start()">MessageChooser</A></CODE></B></DD>
-<DD>Called after all SystemStreamPartitions have been registered. Start is used
- to notify the chooser that it will start receiving update and choose calls.
-<P>
-<DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start()">start</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</A></CODE></DL>
-</DD>
-<DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="stop()"><!-- --></A><H3>
-stop</H3>
-<PRE>
-public void <B>stop</B>()</PRE>
-<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop()">MessageChooser</A></CODE></B></DD>
-<DD>Called when the chooser is about to be discarded. No more messages will be
- given to the chooser after it is stopped.
-<P>
-<DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop()">stop</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</A></CODE></DL>
-</DD>
-<DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="register(org.apache.samza.system.SystemStreamPartition, java.lang.String)"><!-- --></A><H3>
-register</H3>
-<PRE>
-public void <B>register</B>(<A HREF="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> systemStreamPartition,
- java.lang.String offset)</PRE>
-<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">MessageChooser</A></CODE></B></DD>
-<DD>Called before start, to let the chooser know that it will be handling
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="start--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start</h4>
+<pre>public void start()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start--">MessageChooser</a></code></span></div>
+<div class="block">Called after all SystemStreamPartitions have been registered. Start is used
+ to notify the chooser that it will start receiving update and choose calls.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start--">start</a></code> in interface <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="stop--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>stop</h4>
+<pre>public void stop()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop--">MessageChooser</a></code></span></div>
+<div class="block">Called when the chooser is about to be discarded. No more messages will be
+ given to the chooser after it is stopped.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop--">stop</a></code> in interface <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>register</h4>
+<pre>public void register(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">MessageChooser</a></code></span></div>
+<div class="block">Called before start, to let the chooser know that it will be handling
envelopes from the given SystemStreamPartition. Register will only be
- called before start.
-<P>
-<DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">register</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</A></CODE></DL>
-</DD>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>systemStreamPartition</CODE> - A SystemStreamPartition that envelopes will be coming from.<DD><CODE>offset</CODE> - The offset of the first message expected for the
+ called before start.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">register</a></code> in interface <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>systemStreamPartition</code> - A SystemStreamPartition that envelopes will be coming from.</dd>
+<dd><code>offset</code> - The offset of the first message expected for the
system/stream/partition that's being registered. If "7" were
supplied as the offset, then the MessageChooser can expect the
first message it is updated with for the system/stream/partition
- will have an offset of "7".</DL>
-</DD>
-</DL>
+ will have an offset of "7".</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
<!-- ========= 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">
- PREV CLASS
- <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><B>NEXT CLASS</B></A></FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/apache/samza/system/chooser/BaseMessageChooser.html" target="_top"><B>FRAMES</B></A>
- <A HREF="BaseMessageChooser.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev Class</li>
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/BaseMessageChooser.html" target="_top">Frames</a></li>
+<li><a href="BaseMessageChooser.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
- document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_bottom"></A>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-
-<HR>
-
-</BODY>
-</HTML>
+</body>
+</html>
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html?rev=1654593&r1=1654592&r2=1654593&view=diff
==============================================================================
--- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html (original)
+++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html Sat Jan 24 23:00:15 2015
@@ -1,105 +1,111 @@
<!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_65) on Tue Dec 09 16:53:23 PST 2014 -->
-<TITLE>
-MessageChooser (samza-api 0.9.0-SNAPSHOT API)
-</TITLE>
-
-<META NAME="date" CONTENT="2014-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="MessageChooser (samza-api 0.9.0-SNAPSHOT API)";
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_31) on Fri Jan 23 11:05:49 PST 2015 -->
+<title>MessageChooser (samza-api 0.9.0-SNAPSHOT API)</title>
+<meta name="date" content="2015-01-23">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="MessageChooser (samza-api 0.9.0-SNAPSHOT API)";
+ }
}
-}
-</SCRIPT>
-<NOSCRIPT>
-</NOSCRIPT>
-
-</HEAD>
-
-<BODY BGCOLOR="white" onload="windowTitle();">
-<HR>
-
-
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
<!-- ========= 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="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><B>NEXT CLASS</B></A></FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/apache/samza/system/chooser/MessageChooser.html" target="_top"><B>FRAMES</B></A>
- <A HREF="MessageChooser.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/MessageChooser.html" target="_top">Frames</a></li>
+<li><a href="MessageChooser.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
- document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</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>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
-
-<HR>
<!-- ======== START OF CLASS DATA ======== -->
-<H2>
-<FONT SIZE="-1">
-org.apache.samza.system.chooser</FONT>
-<BR>
-Interface MessageChooser</H2>
-<DL>
-<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser">BaseMessageChooser</A></DD>
-</DL>
-<HR>
-<DL>
-<DT><PRE>public interface <B>MessageChooser</B></DL>
-</PRE>
-
-<P>
-MessageChooser is an interface for programmatic fine-grain control over
+<div class="header">
+<div class="subTitle">org.apache.samza.system.chooser</div>
+<h2 title="Interface MessageChooser" class="title">Interface MessageChooser</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser">BaseMessageChooser</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">MessageChooser</span></pre>
+<div class="block">MessageChooser is an interface for programmatic fine-grain control over
stream consumption.
<p>Consider the case of a Samza task consuming multiple streams, where some
@@ -123,11 +129,11 @@ MessageChooser is an interface for progr
a SystemConsumer has a message in its buffer for the SystemStreamPartition,
the MessageChooser will be updated once with the next message in the buffer.</li>
<li>When SamzaContainer is ready to process another message, it calls
- SystemConsumers.choose, which in turn calls <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><CODE>choose()</CODE></A>.</li>
+ SystemConsumers.choose, which in turn calls <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose--"><code>choose()</code></a>.</li>
</ul>
<p>Since the MessageChooser only receives one message at a time per
- <A HREF="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><CODE>SystemStreamPartition</CODE></A>, it can be used to order messages between different
+ <a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>, it can be used to order messages between different
SystemStreamPartitions, but it can't be used to re-order messages within a
single SystemStreamPartition (a buffered sort). This must be done within a
StreamTask.
@@ -135,11 +141,11 @@ MessageChooser is an interface for progr
<p>The contract between the MessageChooser and the SystemConsumers is:
<ul>
- <li><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)"><CODE>update(IncomingMessageEnvelope)</CODE></A> can be called multiple times
- before <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><CODE>choose()</CODE></A> is called.</li>
- <li>If <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><CODE>choose()</CODE></A> returns null, that means no envelopes should be
+ <li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update-org.apache.samza.system.IncomingMessageEnvelope-"><code>update(IncomingMessageEnvelope)</code></a> can be called multiple times
+ before <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose--"><code>choose()</code></a> is called.</li>
+ <li>If <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose--"><code>choose()</code></a> returns null, that means no envelopes should be
processed at the moment.</li>
- <li>A MessageChooser may elect to return null when <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><CODE>choose()</CODE></A> is
+ <li>A MessageChooser may elect to return null when <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose--"><code>choose()</code></a> is
called, even if unprocessed messages have been given by the update method.</li>
<li>A MessageChooser will not have any of its in-memory state restored in the
event of a failure.</li>
@@ -148,222 +154,222 @@ MessageChooser is an interface for progr
<li>A MessageChooser should never return the same envelope more than once.</li>
<li>Non-deterministic (e.g. time-based) MessageChoosers are allowed.</li>
<li>A MessageChooser does not need to be thread-safe.</li>
- </ul>
-<P>
-
-<P>
-<HR>
-
-<P>
-
+ </ul></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
<!-- ========== 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> <A HREF="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()">choose</A></B>()</CODE>
-
-<BR>
- The choose method is invoked when the SamzaContainer is ready to process a
- new message.</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="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">register</A></B>(<A HREF="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> systemStreamPartition,
- java.lang.String offset)</CODE>
-
-<BR>
- Called before start, to let the chooser know that it will be handling
- envelopes from the given SystemStreamPartition.</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="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start()">start</A></B>()</CODE>
-
-<BR>
- Called after all SystemStreamPartitions have been registered.</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="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop()">stop</A></B>()</CODE>
-
-<BR>
- Called when the chooser is about to be discarded.</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="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)">update</A></B>(<A HREF="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</A> envelope)</CODE>
-
-<BR>
- Notify the chooser that a new envelope is available for a processing.</TD>
-</TR>
-</TABLE>
-
-<P>
-
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose--">choose</a></span>()</code>
+<div class="block">The choose method is invoked when the SamzaContainer is ready to process a
+ new message.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">register</a></span>(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</code>
+<div class="block">Called before start, to let the chooser know that it will be handling
+ envelopes from the given SystemStreamPartition.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start--">start</a></span>()</code>
+<div class="block">Called after all SystemStreamPartitions have been registered.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop--">stop</a></span>()</code>
+<div class="block">Called when the chooser is about to be discarded.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update-org.apache.samza.system.IncomingMessageEnvelope-">update</a></span>(<a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</code>
+<div class="block">Notify the chooser that a new envelope is available for a processing.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
<!-- ============ 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="start()"><!-- --></A><H3>
-start</H3>
-<PRE>
-void <B>start</B>()</PRE>
-<DL>
-<DD>Called after all SystemStreamPartitions have been registered. Start is used
- to notify the chooser that it will start receiving update and choose calls.
-<P>
-<DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="stop()"><!-- --></A><H3>
-stop</H3>
-<PRE>
-void <B>stop</B>()</PRE>
-<DL>
-<DD>Called when the chooser is about to be discarded. No more messages will be
- given to the chooser after it is stopped.
-<P>
-<DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="register(org.apache.samza.system.SystemStreamPartition, java.lang.String)"><!-- --></A><H3>
-register</H3>
-<PRE>
-void <B>register</B>(<A HREF="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> systemStreamPartition,
- java.lang.String offset)</PRE>
-<DL>
-<DD>Called before start, to let the chooser know that it will be handling
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="start--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start</h4>
+<pre>void start()</pre>
+<div class="block">Called after all SystemStreamPartitions have been registered. Start is used
+ to notify the chooser that it will start receiving update and choose calls.</div>
+</li>
+</ul>
+<a name="stop--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>stop</h4>
+<pre>void stop()</pre>
+<div class="block">Called when the chooser is about to be discarded. No more messages will be
+ given to the chooser after it is stopped.</div>
+</li>
+</ul>
+<a name="register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>register</h4>
+<pre>void register(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</pre>
+<div class="block">Called before start, to let the chooser know that it will be handling
envelopes from the given SystemStreamPartition. Register will only be
- called before start.
-<P>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>systemStreamPartition</CODE> - A SystemStreamPartition that envelopes will be coming from.<DD><CODE>offset</CODE> - The offset of the first message expected for the
+ called before start.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>systemStreamPartition</code> - A SystemStreamPartition that envelopes will be coming from.</dd>
+<dd><code>offset</code> - The offset of the first message expected for the
system/stream/partition that's being registered. If "7" were
supplied as the offset, then the MessageChooser can expect the
first message it is updated with for the system/stream/partition
- will have an offset of "7".</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="update(org.apache.samza.system.IncomingMessageEnvelope)"><!-- --></A><H3>
-update</H3>
-<PRE>
-void <B>update</B>(<A HREF="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</A> envelope)</PRE>
-<DL>
-<DD>Notify the chooser that a new envelope is available for a processing. A
+ will have an offset of "7".</dd>
+</dl>
+</li>
+</ul>
+<a name="update-org.apache.samza.system.IncomingMessageEnvelope-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>update</h4>
+<pre>void update(<a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</pre>
+<div class="block">Notify the chooser that a new envelope is available for a processing. A
MessageChooser will receive, at most, one outstanding envelope per
system/stream/partition combination. For example, if update is called for
partition 7 of kafka.mystream, then update will not be called with an
envelope from partition 7 of kafka.mystream until the previous envelope has
been returned via the choose method. Update will only be invoked after the
- chooser has been started.
-<P>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>envelope</CODE> - An unprocessed envelope.</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="choose()"><!-- --></A><H3>
-choose</H3>
-<PRE>
-<A HREF="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</A> <B>choose</B>()</PRE>
-<DL>
-<DD>The choose method is invoked when the SamzaContainer is ready to process a
+ chooser has been started.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>envelope</code> - An unprocessed envelope.</dd>
+</dl>
+</li>
+</ul>
+<a name="choose--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>choose</h4>
+<pre><a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> choose()</pre>
+<div class="block">The choose method is invoked when the SamzaContainer is ready to process a
new message. The chooser may elect to return any envelope that it's been
given via the update method, which hasn't yet been returned. Choose will
- only be called after the chooser has been started.
-<P>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>The next envelope to process, or null if the chooser has no
- messages or doesn't want to process any at the moment.</DL>
-</DD>
-</DL>
+ only be called after the chooser has been started.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The next envelope to process, or null if the chooser has no
+ messages or doesn't want to process any at the moment.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
<!-- ========= 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="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><B>NEXT CLASS</B></A></FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/apache/samza/system/chooser/MessageChooser.html" target="_top"><B>FRAMES</B></A>
- <A HREF="MessageChooser.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/MessageChooser.html" target="_top">Frames</a></li>
+<li><a href="MessageChooser.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
- document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</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>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-
-<HR>
-
-</BODY>
-</HTML>
+</body>
+</html>
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html?rev=1654593&r1=1654592&r2=1654593&view=diff
==============================================================================
--- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html (original)
+++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html Sat Jan 24 23:00:15 2015
@@ -1,210 +1,222 @@
<!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_65) on Tue Dec 09 16:53:23 PST 2014 -->
-<TITLE>
-MessageChooserFactory (samza-api 0.9.0-SNAPSHOT API)
-</TITLE>
-
-<META NAME="date" CONTENT="2014-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="MessageChooserFactory (samza-api 0.9.0-SNAPSHOT API)";
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_31) on Fri Jan 23 11:05:49 PST 2015 -->
+<title>MessageChooserFactory (samza-api 0.9.0-SNAPSHOT API)</title>
+<meta name="date" content="2015-01-23">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="MessageChooserFactory (samza-api 0.9.0-SNAPSHOT API)";
+ }
}
-}
-</SCRIPT>
-<NOSCRIPT>
-</NOSCRIPT>
-
-</HEAD>
-
-<BODY BGCOLOR="white" onload="windowTitle();">
-<HR>
-
-
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
<!-- ========= 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="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/apache/samza/system/chooser/MessageChooserFactory.html" target="_top"><B>FRAMES</B></A>
- <A HREF="MessageChooserFactory.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="typeNameLink">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/MessageChooserFactory.html" target="_top">Frames</a></li>
+<li><a href="MessageChooserFactory.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
- document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</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>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
-
-<HR>
<!-- ======== START OF CLASS DATA ======== -->
-<H2>
-<FONT SIZE="-1">
-org.apache.samza.system.chooser</FONT>
-<BR>
-Interface MessageChooserFactory</H2>
-<HR>
-<DL>
-<DT><PRE>public interface <B>MessageChooserFactory</B></DL>
-</PRE>
-
-<P>
-Build an instance of a <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><CODE>MessageChooser</CODE></A>
-<P>
-
-<P>
-<HR>
-
-<P>
-
+<div class="header">
+<div class="subTitle">org.apache.samza.system.chooser</div>
+<h2 title="Interface MessageChooserFactory" class="title">Interface MessageChooserFactory</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">MessageChooserFactory</span></pre>
+<div class="block">Build an instance of a <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><code>MessageChooser</code></a></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
<!-- ========== 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> <A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html#getChooser(org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)">getChooser</A></B>(<A HREF="../../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</A> config,
- <A HREF="../../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</A> registry)</CODE>
-
-<BR>
- </TD>
-</TR>
-</TABLE>
-
-<P>
-
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html#getChooser-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getChooser</a></span>(<a href="../../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config,
+ <a href="../../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
<!-- ============ 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="getChooser(org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)"><!-- --></A><H3>
-getChooser</H3>
-<PRE>
-<A HREF="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</A> <B>getChooser</B>(<A HREF="../../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</A> config,
- <A HREF="../../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</A> registry)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-</DL>
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getChooser-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getChooser</h4>
+<pre><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a> getChooser(<a href="../../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config,
+ <a href="../../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</pre>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
<!-- ========= 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="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/apache/samza/system/chooser/MessageChooserFactory.html" target="_top"><B>FRAMES</B></A>
- <A HREF="MessageChooserFactory.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="typeNameLink">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/MessageChooserFactory.html" target="_top">Frames</a></li>
+<li><a href="MessageChooserFactory.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
- document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</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>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-
-<HR>
-
-</BODY>
-</HTML>
+</body>
+</html>
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/package-frame.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/package-frame.html?rev=1654593&r1=1654592&r2=1654593&view=diff
==============================================================================
--- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/package-frame.html (original)
+++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/chooser/package-frame.html Sat Jan 24 23:00:15 2015
@@ -1,45 +1,25 @@
<!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_65) on Tue Dec 09 16:53:24 PST 2014 -->
-<TITLE>
-org.apache.samza.system.chooser (samza-api 0.9.0-SNAPSHOT API)
-</TITLE>
-
-<META NAME="date" CONTENT="2014-12-09">
-
-<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
-
-
-</HEAD>
-
-<BODY BGCOLOR="white">
-<FONT size="+1" CLASS="FrameTitleFont">
-<A HREF="../../../../../org/apache/samza/system/chooser/package-summary.html" target="classFrame">org.apache.samza.system.chooser</A></FONT>
-<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
-<TR>
-<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
-Interfaces</FONT>
-<FONT CLASS="FrameItemFont">
-<BR>
-<A HREF="MessageChooser.html" title="interface in org.apache.samza.system.chooser" target="classFrame"><I>MessageChooser</I></A>
-<BR>
-<A HREF="MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser" target="classFrame"><I>MessageChooserFactory</I></A></FONT></TD>
-</TR>
-</TABLE>
-
-
-<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
-<TR>
-<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
-Classes</FONT>
-<FONT CLASS="FrameItemFont">
-<BR>
-<A HREF="BaseMessageChooser.html" title="class in org.apache.samza.system.chooser" target="classFrame">BaseMessageChooser</A></FONT></TD>
-</TR>
-</TABLE>
-
-
-</BODY>
-</HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_31) on Fri Jan 23 11:05:49 PST 2015 -->
+<title>org.apache.samza.system.chooser (samza-api 0.9.0-SNAPSHOT API)</title>
+<meta name="date" content="2015-01-23">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<h1 class="bar"><a href="../../../../../org/apache/samza/system/chooser/package-summary.html" target="classFrame">org.apache.samza.system.chooser</a></h1>
+<div class="indexContainer">
+<h2 title="Interfaces">Interfaces</h2>
+<ul title="Interfaces">
+<li><a href="MessageChooser.html" title="interface in org.apache.samza.system.chooser" target="classFrame"><span class="interfaceName">MessageChooser</span></a></li>
+<li><a href="MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser" target="classFrame"><span class="interfaceName">MessageChooserFactory</span></a></li>
+</ul>
+<h2 title="Classes">Classes</h2>
+<ul title="Classes">
+<li><a href="BaseMessageChooser.html" title="class in org.apache.samza.system.chooser" target="classFrame">BaseMessageChooser</a></li>
+</ul>
+</div>
+</body>
+</html>