| <!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.6.0_36) on Tue Nov 24 10:06:51 CST 2015 --> |
| <title>CollectionDataSource</title> |
| <meta name="date" content="2015-11-24"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CollectionDataSource"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= 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="../../../../io/gearpump/streaming/dsl/KVStream.html" title="class in io.gearpump.streaming.dsl"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/dsl/CollectionDataSource.html" target="_top">FRAMES</a></li> |
| <li><a href="CollectionDataSource.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) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </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 ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <p class="subTitle">io.gearpump.streaming.dsl</p> |
| <h2 title="Class CollectionDataSource" class="title">Class CollectionDataSource<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>io.gearpump.streaming.dsl.CollectionDataSource<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../io/gearpump/streaming/dsl/TypedDataSource.html" title="interface in io.gearpump.streaming.dsl">TypedDataSource</a><T>, <a href="../../../../io/gearpump/streaming/source/DataSource.html" title="interface in io.gearpump.streaming.source">DataSource</a>, java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <strong>CollectionDataSource<T></strong> |
| extends java.lang.Object |
| implements <a href="../../../../io/gearpump/streaming/dsl/TypedDataSource.html" title="interface in io.gearpump.streaming.dsl">TypedDataSource</a><T></pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#io.gearpump.streaming.dsl.CollectionDataSource">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html#CollectionDataSource(scala.collection.Seq)">CollectionDataSource</a></strong>(scala.collection.Seq<<a href="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html" title="type parameter in CollectionDataSource">T</a>> seq)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html#close()">close</a></strong>()</code> |
| <div class="block">close connection to data source.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html#index()">index</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html#open(io.gearpump.streaming.task.TaskContext, scala.Option)">open</a></strong>(<a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a> context, |
| scala.Option<java.lang.Object> startTime)</code> |
| <div class="block">open connection to data source |
| invoked in onStart() method of <a href="../../../../io/gearpump/streaming/source/DataSourceTask.html" title="class in io.gearpump.streaming.source"><code>DataSourceTask</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>scala.collection.immutable.List<io.gearpump.Message></code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html#read(int)">read</a></strong>(int batchSize)</code> |
| <div class="block">read a number of messages from data source.</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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CollectionDataSource(scala.collection.Seq)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CollectionDataSource</h4> |
| <pre>public CollectionDataSource(scala.collection.Seq<<a href="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html" title="type parameter in CollectionDataSource">T</a>> seq)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="index()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>index</h4> |
| <pre>public int index()</pre> |
| </li> |
| </ul> |
| <a name="read(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>public scala.collection.immutable.List<io.gearpump.Message> read(int batchSize)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../io/gearpump/streaming/source/DataSource.html#read(int)">DataSource</a></code></strong></div> |
| <div class="block">read a number of messages from data source. |
| invoked in each onNext() method of <a href="../../../../io/gearpump/streaming/source/DataSourceTask.html" title="class in io.gearpump.streaming.source"><code>DataSourceTask</code></a></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/source/DataSource.html#read(int)">read</a></code> in interface <code><a href="../../../../io/gearpump/streaming/source/DataSource.html" title="interface in io.gearpump.streaming.source">DataSource</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>batchSize</code> - max number of messages to read</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a list of messages wrapped in <code>Message</code></dd></dl> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../io/gearpump/streaming/source/DataSource.html#close()">DataSource</a></code></strong></div> |
| <div class="block">close connection to data source. |
| invoked in onStop() method of <a href="../../../../io/gearpump/streaming/source/DataSourceTask.html" title="class in io.gearpump.streaming.source"><code>DataSourceTask</code></a></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/source/DataSource.html#close()">close</a></code> in interface <code><a href="../../../../io/gearpump/streaming/source/DataSource.html" title="interface in io.gearpump.streaming.source">DataSource</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="open(io.gearpump.streaming.task.TaskContext, scala.Option)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>public void open(<a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a> context, |
| scala.Option<java.lang.Object> startTime)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../io/gearpump/streaming/source/DataSource.html#open(io.gearpump.streaming.task.TaskContext, scala.Option)">DataSource</a></code></strong></div> |
| <div class="block">open connection to data source |
| invoked in onStart() method of <a href="../../../../io/gearpump/streaming/source/DataSourceTask.html" title="class in io.gearpump.streaming.source"><code>DataSourceTask</code></a></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/source/DataSource.html#open(io.gearpump.streaming.task.TaskContext, scala.Option)">open</a></code> in interface <code><a href="../../../../io/gearpump/streaming/source/DataSource.html" title="interface in io.gearpump.streaming.source">DataSource</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - is the task context at runtime</dd><dd><code>startTime</code> - is the start time of system</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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="../../../../io/gearpump/streaming/dsl/KVStream.html" title="class in io.gearpump.streaming.dsl"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/dsl/CollectionDataSource.html" target="_top">FRAMES</a></li> |
| <li><a href="CollectionDataSource.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) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </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 ======= --> |
| </body> |
| </html> |
