| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JoinBolt (Storm 1.2.0 API)</title> |
| <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="JoinBolt (Storm 1.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <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/JoinBolt.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>Prev Class</li> |
| <li><a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/bolt/JoinBolt.html" target="_top">Frames</a></li> |
| <li><a href="JoinBolt.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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"> |
| <div class="subTitle">org.apache.storm.bolt</div> |
| <h2 title="Class JoinBolt" class="title">Class JoinBolt</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseWindowedBolt</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.storm.bolt.JoinBolt</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a>, <a href="../../../../org/apache/storm/topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JoinBolt</span> |
| extends <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.storm.bolt.JoinBolt">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a></span></code> |
| <div class="block">Describes how to join the other stream with the current stream</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.JoinType.html" title="enum in org.apache.storm.bolt">JoinBolt.JoinType</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.ResultRecord.html" title="class in org.apache.storm.bolt">JoinBolt.ResultRecord</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.storm.topology.base.<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3> |
| <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>, <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#joinCriteria">joinCriteria</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#outputFields">outputFields</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#outputStreamName">outputStreamName</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#selectorType">selectorType</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.storm.topology.base.<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3> |
| <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#timestampExtractor">timestampExtractor</a>, <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#windowConfiguration">windowConfiguration</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#JoinBolt-org.apache.storm.bolt.JoinBolt.Selector-java.lang.String-java.lang.String-">JoinBolt</a></span>(<a href="../../../../org/apache/storm/bolt/JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a> type, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> srcOrStreamId, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</code> |
| <div class="block">Introduces the first stream to start the join with.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#JoinBolt-java.lang.String-java.lang.String-">JoinBolt</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sourceId, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</code> |
| <div class="block">Calls JoinBolt(Selector.SOURCE, sourceId, fieldName)</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-">declareOutputFields</a></span>(<a href="../../../../org/apache/storm/topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> declarer)</code> |
| <div class="block">Declare the output schema for all the streams of this topology.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#doInnerJoin-org.apache.storm.bolt.JoinBolt.JoinAccumulator-java.util.Map-org.apache.storm.bolt.JoinBolt.JoinInfo-boolean-">doInnerJoin</a></span>(<a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#doJoin-org.apache.storm.bolt.JoinBolt.JoinAccumulator-java.util.HashMap-org.apache.storm.bolt.JoinBolt.JoinInfo-boolean-">doJoin</a></span>(<a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#doLeftJoin-org.apache.storm.bolt.JoinBolt.JoinAccumulator-java.util.Map-org.apache.storm.bolt.JoinBolt.JoinInfo-boolean-">doLeftJoin</a></span>(<a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#doProjection-java.util.ArrayList-org.apache.storm.bolt.JoinBolt.FieldSelector:A-">doProjection</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> tuples, |
| <a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a>[] projectionFields)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#execute-org.apache.storm.windowing.TupleWindow-">execute</a></span>(<a href="../../../../org/apache/storm/windowing/TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a> inputWindow)</code> |
| <div class="block">Process the tuple window and optionally emit new tuples based on the tuples in the input window.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#hashJoin-java.util.List-">hashJoin</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> tuples)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#join-java.lang.String-java.lang.String-java.lang.String-">join</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newStream, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> priorStream)</code> |
| <div class="block">Performs inner Join with the newStream.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#leftJoin-java.lang.String-java.lang.String-java.lang.String-">leftJoin</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newStream, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> priorStream)</code> |
| <div class="block">Performs left Join with the newStream.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#lookupField-org.apache.storm.bolt.JoinBolt.FieldSelector-org.apache.storm.tuple.Tuple-">lookupField</a></span>(<a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a> fieldSelector, |
| <a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-">prepare</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> stormConf, |
| <a href="../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../../../../org/apache/storm/task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</code> |
| <div class="block">This is similar to the <a href="../../../../org/apache/storm/task/IBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a> except that while emitting, the tuples are automatically anchored to the tuples in the inputWindow.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#select-java.lang.String-">select</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> commaSeparatedKeys)</code> |
| <div class="block">Specify projection fields.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withLag-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withLag</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</code> |
| <div class="block">Specify the maximum time lag of the tuple timestamp in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withLateTupleStream-java.lang.String-">withLateTupleStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">Specify a stream id on which late tuples are going to be emitted.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withOutputStream-java.lang.String-">withOutputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamName)</code> |
| <div class="block">Optional.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withTimestampExtractor-org.apache.storm.windowing.TimestampExtractor-">withTimestampExtractor</a></span>(<a href="../../../../org/apache/storm/windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a> timestampExtractor)</code> |
| <div class="block">Specify the timestamp extractor implementation.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withTimestampField-java.lang.String-">withTimestampField</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</code> |
| <div class="block">Specify a field in the tuple that represents the timestamp as a long value.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withTumblingWindow</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> count)</code> |
| <div class="block">A count based tumbling window.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withTumblingWindow</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</code> |
| <div class="block">A time duration based tumbling window.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withWatermarkInterval-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWatermarkInterval</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> interval)</code> |
| <div class="block">Specify the watermark event generation interval.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength)</code> |
| <div class="block">A tuple count based window that slides with every incoming tuple.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</code> |
| <div class="block">Tuple count based sliding window configuration.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</code> |
| <div class="block">Tuple count and time duration based sliding window configuration.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength)</code> |
| <div class="block">A time duration based window that slides with every incoming tuple.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</code> |
| <div class="block">Time duration and count based sliding window configuration.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/bolt/JoinBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></span>(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</code> |
| <div class="block">Time duration based sliding window configuration.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.storm.topology.base.<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3> |
| <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#cleanup--">cleanup</a>, <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#getComponentConfiguration--">getComponentConfiguration</a>, <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#getTimestampExtractor--">getTimestampExtractor</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="joinCriteria"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>joinCriteria</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a>> joinCriteria</pre> |
| </li> |
| </ul> |
| <a name="outputFields"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputFields</h4> |
| <pre>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a>[] outputFields</pre> |
| </li> |
| </ul> |
| <a name="outputStreamName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputStreamName</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> outputStreamName</pre> |
| </li> |
| </ul> |
| <a name="selectorType"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>selectorType</h4> |
| <pre>protected final <a href="../../../../org/apache/storm/bolt/JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a> selectorType</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JoinBolt-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JoinBolt</h4> |
| <pre>public JoinBolt(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sourceId, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</pre> |
| <div class="block"><p>Calls JoinBolt(Selector.SOURCE, sourceId, fieldName)</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourceId</code> - Id of source component (spout/bolt) from which this bolt is receiving data</dd> |
| <dd><code>fieldName</code> - the field to use for joining the stream (x.y.z format)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JoinBolt-org.apache.storm.bolt.JoinBolt.Selector-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JoinBolt</h4> |
| <pre>public JoinBolt(<a href="../../../../org/apache/storm/bolt/JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a> type, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> srcOrStreamId, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</pre> |
| <div class="block"><p>Introduces the first stream to start the join with. Equivalent SQL … select …. from srcOrStreamId …</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - Specifies whether ‘srcOrStreamId’ refers to stream name/source component</dd> |
| <dd><code>srcOrStreamId</code> - name of stream OR source component</dd> |
| <dd><code>fieldName</code> - the field to use for joining the stream (x.y.z format)</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withOutputStream-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withOutputStream</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withOutputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamName)</pre> |
| <div class="block"><p>Optional. Allows naming the output stream of this bolt. If not specified, the emits will happen on ‘default’ stream.</p></div> |
| </li> |
| </ul> |
| <a name="join-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>join</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> join(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newStream, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> priorStream)</pre> |
| <div class="block"><p>Performs inner Join with the newStream. SQL : from priorStream inner join newStream on newStream.field = priorStream.field1 same as: new WindowedQueryBolt(priorStream,field1). join(newStream, field, priorStream);</p><p>Note: priorStream must be previously joined. Valid ex: new WindowedQueryBolt(s1,k1). join(s2,k2, s1). join(s3,k3, s2); Invalid ex: new WindowedQueryBolt(s1,k1). join(s3,k3, s2). join(s2,k2, s1);</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newStream</code> - Either stream name or name of upstream component</dd> |
| <dd><code>field</code> - the field on which to perform the join</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="leftJoin-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>leftJoin</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> leftJoin(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newStream, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> priorStream)</pre> |
| <div class="block"><p>Performs left Join with the newStream. SQL : from stream1 left join stream2 on stream2.field = stream1.field1 same as: new WindowedQueryBolt(stream1, field1). leftJoin(stream2, field, stream1);</p><p>Note: priorStream must be previously joined Valid ex: new WindowedQueryBolt(s1,k1). leftJoin(s2,k2, s1). leftJoin(s3,k3, s2); Invalid ex: new WindowedQueryBolt(s1,k1). leftJoin(s3,k3, s2). leftJoin(s2,k2, s1);</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newStream</code> - Either a name of a stream or an upstream component</dd> |
| <dd><code>field</code> - the field on which to perform the join</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> select(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> commaSeparatedKeys)</pre> |
| <div class="block"><p>Specify projection fields. i.e. Specifies the fields to include in the output. e.g: .select(“field1, stream2:field2, field3”) Nested Key names are supported for nested types: e.g: .select(“outerKey1.innerKey1, outerKey1.innerKey2, stream3:outerKey2.innerKey3)” Inner types (non leaf) must be Map<> in order to support nested lookup using this dot notation This selected fields implicitly declare the output fieldNames for the bolt based.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>commaSeparatedKeys</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>declareOutputFields</h4> |
| <pre>public void declareOutputFields(<a href="../../../../org/apache/storm/topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> declarer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/storm/topology/IComponent.html#declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-">IComponent</a></code></span></div> |
| <div class="block"><p>Declare the output schema for all the streams of this topology.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/IComponent.html#declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-">declareOutputFields</a></code> in interface <code><a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-">declareOutputFields</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>declarer</code> - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>public void prepare(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> stormConf, |
| <a href="../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../../../../org/apache/storm/task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/storm/topology/IWindowedBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-">IWindowedBolt</a></code></span></div> |
| <div class="block"><p>This is similar to the <a href="../../../../org/apache/storm/task/IBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a> except that while emitting, the tuples are automatically anchored to the tuples in the inputWindow.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/IWindowedBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-">prepare</a></code> in interface <code><a href="../../../../org/apache/storm/topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-">prepare</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-org.apache.storm.windowing.TupleWindow-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public void execute(<a href="../../../../org/apache/storm/windowing/TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a> inputWindow)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/storm/topology/IWindowedBolt.html#execute-org.apache.storm.windowing.TupleWindow-">IWindowedBolt</a></code></span></div> |
| <div class="block"><p>Process the tuple window and optionally emit new tuples based on the tuples in the input window.</p></div> |
| </li> |
| </ul> |
| <a name="hashJoin-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashJoin</h4> |
| <pre>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> hashJoin(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> tuples)</pre> |
| </li> |
| </ul> |
| <a name="doJoin-org.apache.storm.bolt.JoinBolt.JoinAccumulator-java.util.HashMap-org.apache.storm.bolt.JoinBolt.JoinInfo-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doJoin</h4> |
| <pre>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> doJoin(<a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</pre> |
| </li> |
| </ul> |
| <a name="doInnerJoin-org.apache.storm.bolt.JoinBolt.JoinAccumulator-java.util.Map-org.apache.storm.bolt.JoinBolt.JoinInfo-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doInnerJoin</h4> |
| <pre>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> doInnerJoin(<a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</pre> |
| </li> |
| </ul> |
| <a name="doLeftJoin-org.apache.storm.bolt.JoinBolt.JoinAccumulator-java.util.Map-org.apache.storm.bolt.JoinBolt.JoinInfo-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doLeftJoin</h4> |
| <pre>protected <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> doLeftJoin(<a href="../../../../org/apache/storm/bolt/JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="../../../../org/apache/storm/bolt/JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</pre> |
| </li> |
| </ul> |
| <a name="doProjection-java.util.ArrayList-org.apache.storm.bolt.JoinBolt.FieldSelector:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doProjection</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> doProjection(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> tuples, |
| <a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a>[] projectionFields)</pre> |
| </li> |
| </ul> |
| <a name="lookupField-org.apache.storm.bolt.JoinBolt.FieldSelector-org.apache.storm.tuple.Tuple-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lookupField</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> lookupField(<a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a> fieldSelector, |
| <a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</pre> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Count-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withWindow(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Count-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Tuple count based sliding window configuration.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the number of tuples in the window</dd> |
| <dd><code>slidingInterval</code> - the number of tuples after which the window slides</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withWindow(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Tuple count and time duration based sliding window configuration.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the number of tuples in the window</dd> |
| <dd><code>slidingInterval</code> - the time duration after which the window slides</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Count-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withWindow(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Count-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Time duration and count based sliding window configuration.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the time duration of the window</dd> |
| <dd><code>slidingInterval</code> - the number of tuples after which the window slides</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withWindow(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Time duration based sliding window configuration.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the time duration of the window</dd> |
| <dd><code>slidingInterval</code> - the time duration after which the window slides</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withWindow(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>A tuple count based window that slides with every incoming tuple.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the number of tuples in the window</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withWindow(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>A time duration based window that slides with every incoming tuple.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the time duration of the window</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTumblingWindow</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withTumblingWindow(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> count)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>A count based tumbling window.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withTumblingWindow</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>count</code> - the number of tuples after which the window tumbles</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTumblingWindow</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withTumblingWindow(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>A time duration based tumbling window.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withTumblingWindow</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>duration</code> - the time duration after which the window tumbles</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTimestampField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTimestampField</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withTimestampField(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTimestampField-java.lang.String-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Specify a field in the tuple that represents the timestamp as a long value. If this field is not present in the incoming tuple, an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTimestampField-java.lang.String-">withTimestampField</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field that contains the timestamp</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTimestampExtractor-org.apache.storm.windowing.TimestampExtractor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTimestampExtractor</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withTimestampExtractor(<a href="../../../../org/apache/storm/windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a> timestampExtractor)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTimestampExtractor-org.apache.storm.windowing.TimestampExtractor-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Specify the timestamp extractor implementation.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTimestampExtractor-org.apache.storm.windowing.TimestampExtractor-">withTimestampExtractor</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timestampExtractor</code> - the <a href="../../../../org/apache/storm/windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withLateTupleStream-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withLateTupleStream</h4> |
| <pre>public <a href="../../../../org/apache/storm/bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a> withLateTupleStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withLateTupleStream-java.lang.String-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Specify a stream id on which late tuples are going to be emitted. They are going to be accessible via the <a href="../../../../org/apache/storm/topology/WindowedBoltExecutor.html#LATE_TUPLE_FIELD"><code>WindowedBoltExecutor.LATE_TUPLE_FIELD</code></a> field. It must be defined on a per-component basis, and in conjunction with the <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTimestampField-java.lang.String-"><code>BaseWindowedBolt.withTimestampField(java.lang.String)</code></a>, otherwise <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withLateTupleStream-java.lang.String-">withLateTupleStream</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamId</code> - the name of the stream used to emit late tuples on</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withLag-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withLag</h4> |
| <pre>public <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a> withLag(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withLag-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Specify the maximum time lag of the tuple timestamp in milliseconds. It means that the tuple timestamps cannot be out of order by more than this amount.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withLag-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withLag</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>duration</code> - the max lag duration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWatermarkInterval-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>withWatermarkInterval</h4> |
| <pre>public <a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a> withWatermarkInterval(<a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> interval)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWatermarkInterval-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">BaseWindowedBolt</a></code></span></div> |
| <div class="block"><p>Specify the watermark event generation interval. For tuple based timestamps, watermark events are used to track the progress of time</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWatermarkInterval-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWatermarkInterval</a></code> in class <code><a href="../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interval</code> - the interval at which watermark events are generated</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="class-use/JoinBolt.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 class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../org/apache/storm/bolt/JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/bolt/JoinBolt.html" target="_top">Frames</a></li> |
| <li><a href="JoinBolt.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |