| <!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 (1.8.0_121) on Sun Jul 09 07:41:26 CEST 2017 --> |
| <title>DataSource</title> |
| <meta name="date" content="2017-07-09"> |
| <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="DataSource"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":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 ======= --> |
| <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/gearpump/streaming/source/DataSourceConfig.html" title="class in org.apache.gearpump.streaming.source"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/gearpump/streaming/source/DataSource.html" target="_top">Frames</a></li> |
| <li><a href="DataSource.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>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 ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.gearpump.streaming.source</div> |
| <h2 title="Interface DataSource" class="title">Interface DataSource</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/gearpump/streaming/transaction/api/TimeReplayableSource.html" title="interface in org.apache.gearpump.streaming.transaction.api">TimeReplayableSource</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/gearpump/streaming/kafka/lib/source/AbstractKafkaSource.html" title="class in org.apache.gearpump.streaming.kafka.lib.source">AbstractKafkaSource</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/scalaapi/CollectionDataSource.html" title="class in org.apache.gearpump.streaming.dsl.scalaapi">CollectionDataSource</a>, <a href="../../../../../org/apache/gearpump/streaming/kafka/KafkaSource.html" title="class in org.apache.gearpump.streaming.kafka">KafkaSource</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/plan/OpSpec.AnySource.html" title="class in org.apache.gearpump.streaming.dsl.plan">OpSpec.AnySource</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/plan/PlannerSpec.AnySource.html" title="class in org.apache.gearpump.streaming.dsl.plan">PlannerSpec.AnySource</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">DataSource</span> |
| extends java.io.Serializable</pre> |
| <div class="block">Interface to implement custom source where data is read into the system. |
| a DataSource could be a message queue like kafka or simply data generation source. |
| <p> |
| An example would be like |
| <pre><code> |
| GenMsgSource extends DataSource { |
| |
| def open(context: TaskContext, startTime: TimeStamp): Unit = {} |
| |
| def read(context: TaskContext): Message = { |
| Message("message") |
| } |
| |
| def close(): Unit = {} |
| } |
| </code></pre> |
| <p> |
| subclass is required to be serializable</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/source/DataSource.html#close--">close</a></span>()</code> |
| <div class="block">Closes connection to data source.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.time.Instant</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/source/DataSource.html#getWatermark--">getWatermark</a></span>()</code> |
| <div class="block">Returns a watermark such that no timestamp earlier than the watermark should enter the system |
| Watermark.MAX mark the end of source data</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/gearpump/streaming/source/DataSource.html#open-org.apache.gearpump.streaming.task.TaskContext-java.time.Instant-">open</a></span>(<a href="../../../../../org/apache/gearpump/streaming/task/TaskContext.html" title="interface in org.apache.gearpump.streaming.task">TaskContext</a> context, |
| java.time.Instant startTime)</code> |
| <div class="block">Opens connection to data source |
| invoked in onStart() method of <a href="../../../../../org/apache/gearpump/streaming/source/DataSourceTask.html" title="class in org.apache.gearpump.streaming.source"><code>DataSourceTask</code></a></div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/gearpump/Message.html" title="interface in org.apache.gearpump">Message</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/source/DataSource.html#read--">read</a></span>()</code> |
| <div class="block">Reads next message from data source and |
| returns null if no message is available</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="open-org.apache.gearpump.streaming.task.TaskContext-java.time.Instant-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>void open(<a href="../../../../../org/apache/gearpump/streaming/task/TaskContext.html" title="interface in org.apache.gearpump.streaming.task">TaskContext</a> context, |
| java.time.Instant startTime)</pre> |
| <div class="block">Opens connection to data source |
| invoked in onStart() method of <a href="../../../../../org/apache/gearpump/streaming/source/DataSourceTask.html" title="class in org.apache.gearpump.streaming.source"><code>DataSourceTask</code></a> |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">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> |
| <a name="read--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre><a href="../../../../../org/apache/gearpump/Message.html" title="interface in org.apache.gearpump">Message</a> read()</pre> |
| <div class="block">Reads next message from data source and |
| returns null if no message is available |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../../org/apache/gearpump/Message.html" title="interface in org.apache.gearpump"><code>Message</code></a> or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Closes connection to data source. |
| invoked in onStop() method of <a href="../../../../../org/apache/gearpump/streaming/source/DataSourceTask.html" title="class in org.apache.gearpump.streaming.source"><code>DataSourceTask</code></a></div> |
| </li> |
| </ul> |
| <a name="getWatermark--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getWatermark</h4> |
| <pre>java.time.Instant getWatermark()</pre> |
| <div class="block">Returns a watermark such that no timestamp earlier than the watermark should enter the system |
| Watermark.MAX mark the end of source data</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</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> |
| <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/gearpump/streaming/source/DataSourceConfig.html" title="class in org.apache.gearpump.streaming.source"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/gearpump/streaming/source/DataSource.html" target="_top">Frames</a></li> |
| <li><a href="DataSource.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>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 ======= --> |
| </body> |
| </html> |