Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html Wed Dec 10 00:54:42 2014 @@ -1,225 +1,226 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Fri Dec 05 10:56:59 PST 2014 --> -<title>StorageEngineFactory (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +StorageEngineFactory (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="StorageEngineFactory (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="StorageEngineFactory (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><span class="strong">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/StorageEngineFactory.html" target="_top">Frames</a></li> -<li><a href="StorageEngineFactory.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"); +<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/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/storage/StorageEngineFactory.html" target="_top"><B>FRAMES</B></A> + <A HREF="StorageEngineFactory.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></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> +</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 ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.storage</div> -<h2 title="Interface StorageEngineFactory" class="title">Interface StorageEngineFactory<K,V></h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">StorageEngineFactory<K,V></span></pre> -<div class="block">An object provided by the storage engine implementation to create instances - of the given storage engine type.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> +<H2> +<FONT SIZE="-1"> +org.apache.samza.storage</FONT> +<BR> +Interface StorageEngineFactory<K,V></H2> +<HR> +<DL> +<DT><PRE>public interface <B>StorageEngineFactory<K,V></B></DL> +</PRE> + +<P> +An object provided by the storage engine implementation to create instances + of the given storage engine type. +<P> + +<P> +<HR> + +<P> + <!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StorageEngineFactory.html#getStorageEngine(java.lang.String,%20java.io.File,%20org.apache.samza.serializers.Serde,%20org.apache.samza.serializers.Serde,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.container.SamzaContainerContext)">getStorageEngine</a></strong>(java.lang.String storeName, - java.io.File storeDir, - <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">K</a>> keySerde, - <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">V</a>> msgSerde, - <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, - <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry, - <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> changeLogSystemStreamPartition, - <a href="../../../../org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a> containerContext)</code> -<div class="block">Create an instance of the given storage engine.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> + +<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/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/storage/StorageEngineFactory.html#getStorageEngine(java.lang.String, java.io.File, org.apache.samza.serializers.Serde, org.apache.samza.serializers.Serde, org.apache.samza.task.MessageCollector, org.apache.samza.metrics.MetricsRegistry, org.apache.samza.system.SystemStreamPartition, org.apache.samza.container.SamzaContainerContext)">getStorageEngine</A></B>(java.lang.String storeName, + java.io.File storeDir, + <A HREF="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</A><<A HREF="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">K</A>> keySerde, + <A HREF="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</A><<A HREF="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">V</A>> msgSerde, + <A HREF="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</A> collector, + <A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</A> registry, + <A HREF="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> changeLogSystemStreamPartition, + <A HREF="../../../../org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</A> containerContext)</CODE> + +<BR> + Create an instance of the given storage engine.</TD> +</TR> +</TABLE> + +<P> + <!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getStorageEngine(java.lang.String, java.io.File, org.apache.samza.serializers.Serde, org.apache.samza.serializers.Serde, org.apache.samza.task.MessageCollector, org.apache.samza.metrics.MetricsRegistry, org.apache.samza.system.SystemStreamPartition, org.apache.samza.container.SamzaContainerContext)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getStorageEngine</h4> -<pre><a href="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</a> getStorageEngine(java.lang.String storeName, - java.io.File storeDir, - <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">K</a>> keySerde, - <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">V</a>> msgSerde, - <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, - <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry, - <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> changeLogSystemStreamPartition, - <a href="../../../../org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a> containerContext)</pre> -<div class="block">Create an instance of the given storage engine.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storeName</code> - The name of the storage engine.</dd><dd><code>storeDir</code> - The directory of the storage engine.</dd><dd><code>keySerde</code> - The serializer to use for serializing keys when reading or writing to the store.</dd><dd><code>msgSerde</code> - The serializer to use for serializing messages when reading or writing to the store.</dd><dd><code>collector</code> - MessageCollector the storage engine uses to persist changes.</dd><dd><code>registry</code> - MetricsRegistry to which to publish storage-engine specific metrics.</dd><dd><code>changeLogSystemStreamPartition</code> - Samza stream partition from which to receive the changelog.</dd><dd><code>containerContext</code> - Information about the container in which the task is executing.</dd> -<dt><span class="strong">Returns:</span></dt><dd>The storage engine instance.</dd></dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> + +<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="getStorageEngine(java.lang.String, java.io.File, org.apache.samza.serializers.Serde, org.apache.samza.serializers.Serde, org.apache.samza.task.MessageCollector, org.apache.samza.metrics.MetricsRegistry, org.apache.samza.system.SystemStreamPartition, org.apache.samza.container.SamzaContainerContext)"><!-- --></A><H3> +getStorageEngine</H3> +<PRE> +<A HREF="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</A> <B>getStorageEngine</B>(java.lang.String storeName, + java.io.File storeDir, + <A HREF="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</A><<A HREF="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">K</A>> keySerde, + <A HREF="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</A><<A HREF="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="type parameter in StorageEngineFactory">V</A>> msgSerde, + <A HREF="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</A> collector, + <A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</A> registry, + <A HREF="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> changeLogSystemStreamPartition, + <A HREF="../../../../org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</A> containerContext)</PRE> +<DL> +<DD>Create an instance of the given storage engine. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>storeName</CODE> - The name of the storage engine.<DD><CODE>storeDir</CODE> - The directory of the storage engine.<DD><CODE>keySerde</CODE> - The serializer to use for serializing keys when reading or writing to the store.<DD><CODE>msgSerde</CODE> - The serializer to use for serializing messages when reading or writing to the store.<DD><CODE>collector</CODE> - MessageCollector the storage engine uses to persist changes.<DD><CODE>registry</CODE> - MetricsRegistry to which to publish storage-engine specific metrics.<DD><CODE>changeLogSystemStreamPartition</CODE> - Samza stream partition from which to receive the changelog.<DD><CODE>containerContext</CODE> - Information about the container in which the task is executing. +<DT><B>Returns:</B><DD>The storage engine instance.</DL> +</DD> +</DL> <!-- ========= END OF CLASS DATA ========= --> +<HR> + + <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><span class="strong">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/StorageEngineFactory.html" target="_top">Frames</a></li> -<li><a href="StorageEngineFactory.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"); +<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/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/storage/StorageEngineFactory.html" target="_top"><B>FRAMES</B></A> + <A HREF="StorageEngineFactory.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></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> +</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 ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML>
Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-frame.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-frame.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-frame.html Wed Dec 10 00:54:42 2014 @@ -1,20 +1,34 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Fri Dec 05 10:56:59 PST 2014 --> -<title>org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<h1 class="bar"><a href="../../../../org/apache/samza/storage/package-summary.html" target="classFrame">org.apache.samza.storage</a></h1> -<div class="indexContainer"> -<h2 title="Interfaces">Interfaces</h2> -<ul title="Interfaces"> -<li><a href="StorageEngine.html" title="interface in org.apache.samza.storage" target="classFrame"><i>StorageEngine</i></a></li> -<li><a href="StorageEngineFactory.html" title="interface in org.apache.samza.storage" target="classFrame"><i>StorageEngineFactory</i></a></li> -</ul> -</div> -</body> -</html> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +org.apache.samza.storage (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/storage/package-summary.html" target="classFrame">org.apache.samza.storage</A></FONT> +<TABLE BORDER="0" WIDTH="100%" SUMMARY=""> +<TR> +<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont"> +Interfaces</FONT> +<FONT CLASS="FrameItemFont"> +<BR> +<A HREF="StorageEngine.html" title="interface in org.apache.samza.storage" target="classFrame"><I>StorageEngine</I></A> +<BR> +<A HREF="StorageEngineFactory.html" title="interface in org.apache.samza.storage" target="classFrame"><I>StorageEngineFactory</I></A></FONT></TD> +</TR> +</TABLE> + + +</BODY> +</HTML> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-summary.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-summary.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-summary.html Wed Dec 10 00:54:42 2014 @@ -1,140 +1,160 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Fri Dec 05 10:56:59 PST 2014 --> -<title>org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +org.apache.samza.storage (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="org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="org.apache.samza.storage (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li class="navBarCell1Rev">Package</li> -<li>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/serializers/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/system/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.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"); +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/serializers/package-summary.html"><B>PREV PACKAGE</B></A> + <A HREF="../../../../org/apache/samza/system/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/storage/package-summary.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 title="Package" class="title">Package org.apache.samza.storage</h1> -</div> -<div class="contentContainer"> -<ul class="blockList"> -<li class="blockList"> -<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> -<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Interface</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</a></td> -<td class="colLast"> -<div class="block">A storage engine for managing state maintained by a stream processor.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage">StorageEngineFactory</a><K,V></td> -<td class="colLast"> -<div class="block">An object provided by the storage engine implementation to create instances - of the given storage engine type.</div> -</td> -</tr> -</tbody> -</table> -</li> -</ul> -</div> + +<HR> +<H2> +Package org.apache.samza.storage +</H2> + +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Interface Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</A></B></TD> +<TD>A storage engine for managing state maintained by a stream processor.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage">StorageEngineFactory<K,V></A></B></TD> +<TD>An object provided by the storage engine implementation to create instances + of the given storage engine type.</TD> +</TR> +</TABLE> + + +<P> +<DL> +</DL> +<HR> + + <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li class="navBarCell1Rev">Package</li> -<li>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/serializers/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/system/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.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"); +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/serializers/package-summary.html"><B>PREV PACKAGE</B></A> + <A HREF="../../../../org/apache/samza/system/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/storage/package-summary.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-tree.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-tree.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-tree.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/storage/package-tree.html Wed Dec 10 00:54:42 2014 @@ -1,123 +1,149 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Fri Dec 05 10:56:59 PST 2014 --> -<title>org.apache.samza.storage Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +org.apache.samza.storage Class Hierarchy (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="org.apache.samza.storage Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="org.apache.samza.storage Class Hierarchy (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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</li> -<li class="navBarCell1Rev">Tree</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/serializers/package-tree.html">Prev</a></li> -<li><a href="../../../../org/apache/samza/system/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/package-tree.html" target="_top">Frames</a></li> -<li><a href="package-tree.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"); +<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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT> </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/serializers/package-tree.html"><B>PREV</B></A> + <A HREF="../../../../org/apache/samza/system/package-tree.html"><B>NEXT</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/storage/package-tree.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 class="title">Hierarchy For Package org.apache.samza.storage</h1> -<span class="strong">Package Hierarchies:</span> -<ul class="horizontal"> -<li><a href="../../../../overview-tree.html">All Packages</a></li> -</ul> -</div> -<div class="contentContainer"> -<h2 title="Interface Hierarchy">Interface Hierarchy</h2> -<ul> -<li type="circle">org.apache.samza.storage.<a href="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><span class="strong">StorageEngine</span></a></li> -<li type="circle">org.apache.samza.storage.<a href="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage"><span class="strong">StorageEngineFactory</span></a><K,V></li> -</ul> -</div> + +<HR> +<CENTER> +<H2> +Hierarchy For Package org.apache.samza.storage +</H2> +</CENTER> +<DL> +<DT><B>Package Hierarchies:</B><DD><A HREF="../../../../overview-tree.html">All Packages</A></DL> +<HR> +<H2> +Interface Hierarchy +</H2> +<UL> +<LI TYPE="circle">org.apache.samza.storage.<A HREF="../../../../org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><B>StorageEngine</B></A><LI TYPE="circle">org.apache.samza.storage.<A HREF="../../../../org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage"><B>StorageEngineFactory</B></A><K,V></UL> +<HR> + + <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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</li> -<li class="navBarCell1Rev">Tree</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/serializers/package-tree.html">Prev</a></li> -<li><a href="../../../../org/apache/samza/system/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/storage/package-tree.html" target="_top">Frames</a></li> -<li><a href="package-tree.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"); +<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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT> </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/serializers/package-tree.html"><B>PREV</B></A> + <A HREF="../../../../org/apache/samza/system/package-tree.html"><B>NEXT</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/storage/package-tree.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html Wed Dec 10 00:54:42 2014 @@ -1,357 +1,389 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Fri Dec 05 10:56:59 PST 2014 --> -<title>IncomingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +IncomingMessageEnvelope (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="IncomingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="IncomingMessageEnvelope (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/system/IncomingMessageEnvelope.html" target="_top">Frames</a></li> -<li><a href="IncomingMessageEnvelope.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"); +<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/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/system/IncomingMessageEnvelope.html" target="_top"><B>FRAMES</B></A> + <A HREF="IncomingMessageEnvelope.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></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> +</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> <!-- ========= END OF TOP NAVBAR ========= --> + +<HR> <!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.system</div> -<h2 title="Class IncomingMessageEnvelope" class="title">Class IncomingMessageEnvelope</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>org.apache.samza.system.IncomingMessageEnvelope</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public class <span class="strong">IncomingMessageEnvelope</span> -extends java.lang.Object</pre> -<div class="block">This class represents a message envelope that is received by a StreamTask for each message that is received from a - partition of a specific input stream.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> +<H2> +<FONT SIZE="-1"> +org.apache.samza.system</FONT> +<BR> +Class IncomingMessageEnvelope</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.samza.system.IncomingMessageEnvelope</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>IncomingMessageEnvelope</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +This class represents a message envelope that is received by a StreamTask for each message that is received from a + partition of a specific input stream. +<P> + +<P> +<HR> + +<P> + <!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="overviewSummary" 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><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#IncomingMessageEnvelope(org.apache.samza.system.SystemStreamPartition,%20java.lang.String,%20java.lang.Object,%20java.lang.Object)">IncomingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.lang.String offset, - java.lang.Object key, - java.lang.Object message)</code> -<div class="block">Constructs a new IncomingMessageEnvelope from specified components.</div> -</td> -</tr> -</table> -</li> -</ul> + +<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/IncomingMessageEnvelope.html#IncomingMessageEnvelope(org.apache.samza.system.SystemStreamPartition, java.lang.String, java.lang.Object, java.lang.Object)">IncomingMessageEnvelope</A></B>(<A HREF="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> systemStreamPartition, + java.lang.String offset, + java.lang.Object key, + java.lang.Object message)</CODE> + +<BR> + Constructs a new IncomingMessageEnvelope from specified components.</TD> +</TR> +</TABLE> + <!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getKey()">getKey</a></strong>()</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getMessage()">getMessage</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getOffset()">getOffset</a></strong>()</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getSystemStreamPartition()">getSystemStreamPartition</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#hashCode()">hashCode</a></strong>()</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#toString()">toString</a></strong>()</code> </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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> + +<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> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getKey()">getKey</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getMessage()">getMessage</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getOffset()">getOffset</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#getSystemStreamPartition()">getSystemStreamPartition</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#hashCode()">hashCode</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html#toString()">toString</A></B>()</CODE> + +<BR> + </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, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + <!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="IncomingMessageEnvelope(org.apache.samza.system.SystemStreamPartition, java.lang.String, java.lang.Object, java.lang.Object)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>IncomingMessageEnvelope</h4> -<pre>public IncomingMessageEnvelope(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.lang.String offset, - java.lang.Object key, - java.lang.Object message)</pre> -<div class="block">Constructs a new IncomingMessageEnvelope from specified components.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - The aggregate object representing the incoming stream name, the name of the cluster - from which the stream came, and the partition of the stream from which the message was received.</dd><dd><code>offset</code> - The offset in the partition that the message was received from.</dd><dd><code>key</code> - A deserialized key received from the partition offset.</dd><dd><code>message</code> - A deserialized message received from the partition offset.</dd></dl> -</li> -</ul> -</li> -</ul> + +<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="IncomingMessageEnvelope(org.apache.samza.system.SystemStreamPartition, java.lang.String, java.lang.Object, java.lang.Object)"><!-- --></A><H3> +IncomingMessageEnvelope</H3> +<PRE> +public <B>IncomingMessageEnvelope</B>(<A HREF="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> systemStreamPartition, + java.lang.String offset, + java.lang.Object key, + java.lang.Object message)</PRE> +<DL> +<DD>Constructs a new IncomingMessageEnvelope from specified components. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>systemStreamPartition</CODE> - The aggregate object representing the incoming stream name, the name of the cluster + from which the stream came, and the partition of the stream from which the message was received.<DD><CODE>offset</CODE> - The offset in the partition that the message was received from.<DD><CODE>key</CODE> - A deserialized key received from the partition offset.<DD><CODE>message</CODE> - A deserialized message received from the partition offset.</DL> +</DL> + <!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getSystemStreamPartition()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSystemStreamPartition</h4> -<pre>public <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> getSystemStreamPartition()</pre> -</li> -</ul> -<a name="getOffset()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getOffset</h4> -<pre>public java.lang.String getOffset()</pre> -</li> -</ul> -<a name="getKey()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getKey</h4> -<pre>public java.lang.Object getKey()</pre> -</li> -</ul> -<a name="getMessage()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMessage</h4> -<pre>public java.lang.Object getMessage()</pre> -</li> -</ul> -<a name="hashCode()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hashCode</h4> -<pre>public int hashCode()</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="equals(java.lang.Object)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>equals</h4> -<pre>public boolean equals(java.lang.Object obj)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>equals</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> + +<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="getSystemStreamPartition()"><!-- --></A><H3> +getSystemStreamPartition</H3> +<PRE> +public <A HREF="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A> <B>getSystemStreamPartition</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getOffset()"><!-- --></A><H3> +getOffset</H3> +<PRE> +public java.lang.String <B>getOffset</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getKey()"><!-- --></A><H3> +getKey</H3> +<PRE> +public java.lang.Object <B>getKey</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getMessage()"><!-- --></A><H3> +getMessage</H3> +<PRE> +public java.lang.Object <B>getMessage</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="hashCode()"><!-- --></A><H3> +hashCode</H3> +<PRE> +public int <B>hashCode</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="equals(java.lang.Object)"><!-- --></A><H3> +equals</H3> +<PRE> +public boolean <B>equals</B>(java.lang.Object obj)</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public java.lang.String <B>toString</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> <!-- ========= END OF CLASS DATA ========= --> +<HR> + + <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/system/IncomingMessageEnvelope.html" target="_top">Frames</a></li> -<li><a href="IncomingMessageEnvelope.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"); +<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/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/system/IncomingMessageEnvelope.html" target="_top"><B>FRAMES</B></A> + <A HREF="IncomingMessageEnvelope.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></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> +</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> <!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML>
