| <!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_152) on Mon Apr 02 22:39:42 UTC 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>StreamBuilder (streams-core 0.5.2-SNAPSHOT API)</title> |
| <meta name="date" content="2018-04-02"> |
| <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="StreamBuilder (streams-core 0.5.2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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="class-use/StreamBuilder.html">Use</a></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/streams/core/DatumStatusCounter.html" title="class in org.apache.streams.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/streams/core/StreamsDatum.html" title="class in org.apache.streams.core"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/streams/core/StreamBuilder.html" target="_top">Frames</a></li> |
| <li><a href="StreamBuilder.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.streams.core</div> |
| <h2 title="Interface StreamBuilder" class="title">Interface StreamBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">StreamBuilder</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">Interface for building data streams. |
| |
| <pre> |
| StreamBuilder builder = ... |
| builder.newReadCurrentStream(. . .) |
| .addStreamsProcessor(. . .) |
| ... |
| .addStreamsPersistWriter(. . .) |
| builder.run(); |
| </pre></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><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#addStreamsPersistWriter-java.lang.String-org.apache.streams.core.StreamsPersistWriter-int-java.lang.String...-">addStreamsPersistWriter</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> persistWriterId, |
| <a href="../../../../org/apache/streams/core/StreamsPersistWriter.html" title="interface in org.apache.streams.core">StreamsPersistWriter</a> writer, |
| int numTasks, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... connectToIds)</code> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsPersistWriter.html" title="interface in org.apache.streams.core"><code>StreamsPersistWriter</code></a> to the data processing stream.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#addStreamsProcessor-java.lang.String-org.apache.streams.core.StreamsProcessor-int-java.lang.String...-">addStreamsProcessor</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> processorId, |
| <a href="../../../../org/apache/streams/core/StreamsProcessor.html" title="interface in org.apache.streams.core">StreamsProcessor</a> processor, |
| int numTasks, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... connectToIds)</code> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProcessor.html" title="interface in org.apache.streams.core"><code>StreamsProcessor</code></a> to the data processing stream.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://github.com/apache/streams/streams-config/apidocs/org/apache/streams/config/StreamsConfiguration.html?is-external=true" title="class or interface in org.apache.streams.config">StreamsConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#getStreamsConfiguration--">getStreamsConfiguration</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#newPerpetualStream-java.lang.String-org.apache.streams.core.StreamsProvider-">newPerpetualStream</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core">StreamsProvider</a> provider)</code> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core"><code>StreamsProvider</code></a> to the data processing stream.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#newReadCurrentStream-java.lang.String-org.apache.streams.core.StreamsProvider-">newReadCurrentStream</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core">StreamsProvider</a> provider)</code> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core"><code>StreamsProvider</code></a> to the data processing stream.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#newReadNewStream-java.lang.String-org.apache.streams.core.StreamsProvider-java.math.BigInteger-">newReadNewStream</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core">StreamsProvider</a> provider, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> sequence)</code> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core"><code>StreamsProvider</code></a> to the data processing stream.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#newReadRangeStream-java.lang.String-org.apache.streams.core.StreamsProvider-org.joda.time.DateTime-org.joda.time.DateTime-">newReadRangeStream</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core">StreamsProvider</a> provider, |
| org.joda.time.DateTime start, |
| org.joda.time.DateTime end)</code> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core"><code>StreamsProvider</code></a> to the data processing stream.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#setStreamsConfiguration-org.apache.streams.config.StreamsConfiguration-">setStreamsConfiguration</a></span>(<a href="https://github.com/apache/streams/streams-config/apidocs/org/apache/streams/config/StreamsConfiguration.html?is-external=true" title="class or interface in org.apache.streams.config">StreamsConfiguration</a> configuration)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#start--">start</a></span>()</code> |
| <div class="block">Builds the stream, and starts it or submits it based on implementation.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/streams/core/StreamBuilder.html#stop--">stop</a></span>()</code> |
| <div class="block">Stops the streams processing.</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="setStreamsConfiguration-org.apache.streams.config.StreamsConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStreamsConfiguration</h4> |
| <pre><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a> setStreamsConfiguration(<a href="https://github.com/apache/streams/streams-config/apidocs/org/apache/streams/config/StreamsConfiguration.html?is-external=true" title="class or interface in org.apache.streams.config">StreamsConfiguration</a> configuration)</pre> |
| </li> |
| </ul> |
| <a name="getStreamsConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamsConfiguration</h4> |
| <pre><a href="https://github.com/apache/streams/streams-config/apidocs/org/apache/streams/config/StreamsConfiguration.html?is-external=true" title="class or interface in org.apache.streams.config">StreamsConfiguration</a> getStreamsConfiguration()</pre> |
| </li> |
| </ul> |
| <a name="addStreamsProcessor-java.lang.String-org.apache.streams.core.StreamsProcessor-int-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addStreamsProcessor</h4> |
| <pre><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a> addStreamsProcessor(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> processorId, |
| <a href="../../../../org/apache/streams/core/StreamsProcessor.html" title="interface in org.apache.streams.core">StreamsProcessor</a> processor, |
| int numTasks, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... connectToIds)</pre> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProcessor.html" title="interface in org.apache.streams.core"><code>StreamsProcessor</code></a> to the data processing stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>processorId</code> - unique id for this processor - must be unique across the entire stream</dd> |
| <dd><code>processor</code> - the processor to execute</dd> |
| <dd><code>numTasks</code> - the number of instances of this processor to run concurrently</dd> |
| <dd><code>connectToIds</code> - the ids of the <a href="../../../../org/apache/streams/core/StreamsOperation.html" title="interface in org.apache.streams.core"><code>StreamsOperation</code></a> that this process will |
| receive data from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addStreamsPersistWriter-java.lang.String-org.apache.streams.core.StreamsPersistWriter-int-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addStreamsPersistWriter</h4> |
| <pre><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a> addStreamsPersistWriter(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> persistWriterId, |
| <a href="../../../../org/apache/streams/core/StreamsPersistWriter.html" title="interface in org.apache.streams.core">StreamsPersistWriter</a> writer, |
| int numTasks, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... connectToIds)</pre> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsPersistWriter.html" title="interface in org.apache.streams.core"><code>StreamsPersistWriter</code></a> to the data processing stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>persistWriterId</code> - unique id for this processor - must be unique across the entire stream</dd> |
| <dd><code>writer</code> - the writer to execute</dd> |
| <dd><code>numTasks</code> - the number of instances of this writer to run concurrently</dd> |
| <dd><code>connectToIds</code> - the ids of the <a href="../../../../org/apache/streams/core/StreamsOperation.html" title="interface in org.apache.streams.core"><code>StreamsOperation</code></a> that this process will |
| receive data from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newPerpetualStream-java.lang.String-org.apache.streams.core.StreamsProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newPerpetualStream</h4> |
| <pre><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a> newPerpetualStream(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core">StreamsProvider</a> provider)</pre> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core"><code>StreamsProvider</code></a> to the data processing stream. The provider will execute |
| <code>org.apache.streams.core.StreamsProvider:readCurrent()</code> to produce data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamId</code> - unique if for this provider - must be unique across the entire stream.</dd> |
| <dd><code>provider</code> - provider to execute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newReadCurrentStream-java.lang.String-org.apache.streams.core.StreamsProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newReadCurrentStream</h4> |
| <pre><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a> newReadCurrentStream(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core">StreamsProvider</a> provider)</pre> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core"><code>StreamsProvider</code></a> to the data processing stream. The provider will execute |
| <code>org.apache.streams.core.StreamsProvider:readCurrent()</code> to produce data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamId</code> - unique if for this provider - must be unique across the entire stream.</dd> |
| <dd><code>provider</code> - provider to execute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newReadNewStream-java.lang.String-org.apache.streams.core.StreamsProvider-java.math.BigInteger-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newReadNewStream</h4> |
| <pre><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a> newReadNewStream(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core">StreamsProvider</a> provider, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> sequence)</pre> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core"><code>StreamsProvider</code></a> to the data processing stream. The provider will execute |
| <code>org.apache.streams.core.StreamsProvider:readNext(BigInteger)</code> to produce data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamId</code> - unique if for this provider - must be unique across the entire stream.</dd> |
| <dd><code>provider</code> - provider to execute</dd> |
| <dd><code>sequence</code> - sequence to pass to <code>org.apache.streams.core.StreamsProvider:readNext(BigInteger)</code> method</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newReadRangeStream-java.lang.String-org.apache.streams.core.StreamsProvider-org.joda.time.DateTime-org.joda.time.DateTime-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newReadRangeStream</h4> |
| <pre><a href="../../../../org/apache/streams/core/StreamBuilder.html" title="interface in org.apache.streams.core">StreamBuilder</a> newReadRangeStream(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core">StreamsProvider</a> provider, |
| org.joda.time.DateTime start, |
| org.joda.time.DateTime end)</pre> |
| <div class="block">Add a <a href="../../../../org/apache/streams/core/StreamsProvider.html" title="interface in org.apache.streams.core"><code>StreamsProvider</code></a> to the data processing stream. The provider will execute |
| <code>org.apache.streams.core.StreamsProvider:readRange(DateTime, DateTime)</code> to produce data. Whether the start |
| and end dates are inclusive or exclusive is up to the implementation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamId</code> - unique if for this provider - must be unique across the entire stream.</dd> |
| <dd><code>provider</code> - provider to execute</dd> |
| <dd><code>start</code> - start date</dd> |
| <dd><code>end</code> - end date</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start()</pre> |
| <div class="block">Builds the stream, and starts it or submits it based on implementation.</div> |
| </li> |
| </ul> |
| <a name="stop--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void stop()</pre> |
| <div class="block">Stops the streams processing. No guarantee on a smooth shutdown. Optional method, may not be implemented in |
| all cases.</div> |
| </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="class-use/StreamBuilder.html">Use</a></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/streams/core/DatumStatusCounter.html" title="class in org.apache.streams.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/streams/core/StreamsDatum.html" title="class in org.apache.streams.core"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/streams/core/StreamBuilder.html" target="_top">Frames</a></li> |
| <li><a href="StreamBuilder.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
