| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>JoinBolt (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.bolt, class: JoinBolt"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <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> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.bolt</a></div> |
| <h1 title="Class JoinBolt" class="title">Class JoinBolt</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseWindowedBolt</a> |
| <div class="inheritance">org.apache.storm.bolt.JoinBolt</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JoinBolt</span> |
| <span class="extends-implements">extends <a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../serialized-form.html#org.apache.storm.bolt.JoinBolt">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected static class </code></div> |
| <div class="col-second even-row-color"><code><a href="JoinBolt.FieldSelector.html" class="type-name-link" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected class </code></div> |
| <div class="col-second odd-row-color"><code><a href="JoinBolt.JoinAccumulator.html" class="type-name-link" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static class </code></div> |
| <div class="col-second even-row-color"><code><a href="JoinBolt.JoinInfo.html" class="type-name-link" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Describes how to join the other stream with the current stream.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="JoinBolt.JoinType.html" class="type-name-link" title="enum in org.apache.storm.bolt">JoinBolt.JoinType</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected class </code></div> |
| <div class="col-second even-row-color"><code><a href="JoinBolt.ResultRecord.html" class="type-name-link" title="class in org.apache.storm.bolt">JoinBolt.ResultRecord</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="JoinBolt.Selector.html" class="type-name-link" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.storm.topology.base.BaseWindowedBolt">Nested classes/interfaces inherited from class org.apache.storm.topology.base.<a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h2> |
| <code><a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>, <a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/LinkedHashMap.html" title="class or interface in java.util" class="external-link">LinkedHashMap</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#joinCriteria" class="member-name-link">joinCriteria</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a>[]</code></div> |
| <div class="col-second odd-row-color"><code><a href="#outputFields" class="member-name-link">outputFields</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#outputStreamName" class="member-name-link">outputStreamName</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#selectorType" class="member-name-link">selectorType</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.topology.base.BaseWindowedBolt">Fields inherited from class org.apache.storm.topology.base.<a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3> |
| <code><a href="../topology/base/BaseWindowedBolt.html#timestampExtractor">timestampExtractor</a>, <a href="../topology/base/BaseWindowedBolt.html#windowConfiguration">windowConfiguration</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">JoinBolt</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sourceId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Calls JoinBolt(Selector.SOURCE, sourceId, fieldName)</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.bolt.JoinBolt.Selector,java.lang.String,java.lang.String)" class="member-name-link">JoinBolt</a><wbr>(<a href="JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> srcOrStreamId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Introduces the first stream to start the join with.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)" class="member-name-link">declareOutputFields</a><wbr>(<a href="../topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> declarer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Declare the output schema for all the streams of this topology.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doInnerJoin(org.apache.storm.bolt.JoinBolt.JoinAccumulator,java.util.Map,org.apache.storm.bolt.JoinBolt.JoinInfo,boolean)" class="member-name-link">doInnerJoin</a><wbr>(<a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doJoin(org.apache.storm.bolt.JoinBolt.JoinAccumulator,java.util.HashMap,org.apache.storm.bolt.JoinBolt.JoinInfo,boolean)" class="member-name-link">doJoin</a><wbr>(<a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link">HashMap</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doLeftJoin(org.apache.storm.bolt.JoinBolt.JoinAccumulator,java.util.Map,org.apache.storm.bolt.JoinBolt.JoinInfo,boolean)" class="member-name-link">doLeftJoin</a><wbr>(<a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doProjection(java.util.ArrayList,org.apache.storm.bolt.JoinBolt.FieldSelector%5B%5D)" class="member-name-link">doProjection</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> tuples, |
| <a href="JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a>[] projectionFields)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(org.apache.storm.windowing.TupleWindow)" class="member-name-link">execute</a><wbr>(<a href="../windowing/TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a> inputWindow)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Process the tuple window and optionally emit new tuples based on the tuples in the input window.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashJoin(java.util.List)" class="member-name-link">hashJoin</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> tuples)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#join(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">join</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> newStream, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> field, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> priorStream)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Performs inner Join with the newStream.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#leftJoin(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">leftJoin</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> newStream, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> field, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> priorStream)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Performs left Join with the newStream.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#lookupField(org.apache.storm.bolt.JoinBolt.FieldSelector,org.apache.storm.tuple.Tuple)" class="member-name-link">lookupField</a><wbr>(<a href="JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a> fieldSelector, |
| <a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)" class="member-name-link">prepare</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> topoConf, |
| <a href="../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is similar to the <a href="../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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#select(java.lang.String)" class="member-name-link">select</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> commaSeparatedKeys)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify projection fields. i.e.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withLag</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify the maximum time lag of the tuple timestamp in milliseconds.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withLateTupleStream(java.lang.String)" class="member-name-link">withLateTupleStream</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify a stream id on which late tuples are going to be emitted.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withOutputStream(java.lang.String)" class="member-name-link">withOutputStream</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Optional.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)" class="member-name-link">withTimestampExtractor</a><wbr>(<a href="../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a> timestampExtractor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify the timestamp extractor implementation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTimestampField(java.lang.String)" class="member-name-link">withTimestampField</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify a field in the tuple that represents the timestamp as a long value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">withTumblingWindow</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> count)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A count based tumbling window.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withTumblingWindow</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A time duration based tumbling window.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withWatermarkInterval</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> interval)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify the watermark event generation interval.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">withWindow</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A tuple count based window that slides with every incoming tuple.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">withWindow</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tuple count based sliding window configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withWindow</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tuple count and time duration based sliding window configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withWindow</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A time duration based window that slides with every incoming tuple.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">withWindow</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Time duration and count based sliding window configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withWindow</a><wbr>(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Time duration based sliding window configuration.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.base.BaseWindowedBolt">Methods inherited from class org.apache.storm.topology.base.<a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3> |
| <code><a href="../topology/base/BaseWindowedBolt.html#cleanup()">cleanup</a>, <a href="../topology/base/BaseWindowedBolt.html#getComponentConfiguration()">getComponentConfiguration</a>, <a href="../topology/base/BaseWindowedBolt.html#getTimestampExtractor()">getTimestampExtractor</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="selectorType"> |
| <h3>selectorType</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a></span> <span class="element-name">selectorType</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="joinCriteria"> |
| <h3>joinCriteria</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/LinkedHashMap.html" title="class or interface in java.util" class="external-link">LinkedHashMap</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a>></span> <span class="element-name">joinCriteria</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="outputFields"> |
| <h3>outputFields</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a>[]</span> <span class="element-name">outputFields</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="outputStreamName"> |
| <h3>outputStreamName</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">outputStreamName</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.String)"> |
| <h3>JoinBolt</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JoinBolt</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sourceId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName)</span></div> |
| <div class="block">Calls JoinBolt(Selector.SOURCE, sourceId, fieldName)</div> |
| <dl class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.bolt.JoinBolt.Selector,java.lang.String,java.lang.String)"> |
| <h3>JoinBolt</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JoinBolt</span><wbr><span class="parameters">(<a href="JoinBolt.Selector.html" title="enum in org.apache.storm.bolt">JoinBolt.Selector</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> srcOrStreamId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName)</span></div> |
| <div class="block">Introduces the first stream to start the join with. Equivalent SQL ... select .... from srcOrStreamId ...</div> |
| <dl class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="withOutputStream(java.lang.String)"> |
| <h3>withOutputStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withOutputStream</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamName)</span></div> |
| <div class="block">Optional. Allows naming the output stream of this bolt. If not specified, the emits will happen on 'default' stream.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="join(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>join</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">join</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> newStream, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> field, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> priorStream)</span></div> |
| <div class="block">Performs inner Join with the newStream. |
| SQL: |
| <code>from priorStream inner join newStream on newStream.field = priorStream.field1</code> |
| same as: |
| <code>new WindowedQueryBolt(priorStream,field1). join(newStream, field, priorStream);</code> |
| Note: priorStream must be previously joined. Valid ex: |
| <code>new WindowedQueryBolt(s1,k1). join(s2,k2, s1). join(s3,k3, s2);</code> |
| Invalid ex: |
| <code>new WindowedQueryBolt(s1,k1). join(s3,k3, s2). join(s2,k2, s1);</code></div> |
| <dl class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="leftJoin(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>leftJoin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">leftJoin</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> newStream, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> field, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> priorStream)</span></div> |
| <div class="block">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>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);</div> |
| <dl class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="select(java.lang.String)"> |
| <h3>select</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">select</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> commaSeparatedKeys)</span></div> |
| <div class="block">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.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)"> |
| <h3>declareOutputFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">declareOutputFields</span><wbr><span class="parameters">(<a href="../topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> declarer)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../topology/IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">IComponent</a></code></span></div> |
| <div class="block">Declare the output schema for all the streams of this topology.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../topology/IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></code> in interface <code><a href="../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> topoConf, |
| <a href="../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../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">This is similar to the <a href="../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> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../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="../topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../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="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute(org.apache.storm.windowing.TupleWindow)"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="../windowing/TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a> inputWindow)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../topology/IWindowedBolt.html#execute(org.apache.storm.windowing.TupleWindow)">IWindowedBolt</a></code></span></div> |
| <div class="block">Process the tuple window and optionally emit new tuples based on the tuples in the input window.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashJoin(java.util.List)"> |
| <h3>hashJoin</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></span> <span class="element-name">hashJoin</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> tuples)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doJoin(org.apache.storm.bolt.JoinBolt.JoinAccumulator,java.util.HashMap,org.apache.storm.bolt.JoinBolt.JoinInfo,boolean)"> |
| <h3>doJoin</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></span> <span class="element-name">doJoin</span><wbr><span class="parameters">(<a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link">HashMap</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doInnerJoin(org.apache.storm.bolt.JoinBolt.JoinAccumulator,java.util.Map,org.apache.storm.bolt.JoinBolt.JoinInfo,boolean)"> |
| <h3>doInnerJoin</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></span> <span class="element-name">doInnerJoin</span><wbr><span class="parameters">(<a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doLeftJoin(org.apache.storm.bolt.JoinBolt.JoinAccumulator,java.util.Map,org.apache.storm.bolt.JoinBolt.JoinInfo,boolean)"> |
| <h3>doLeftJoin</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a></span> <span class="element-name">doLeftJoin</span><wbr><span class="parameters">(<a href="JoinBolt.JoinAccumulator.html" title="class in org.apache.storm.bolt">JoinBolt.JoinAccumulator</a> probe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>>> buildInput, |
| <a href="JoinBolt.JoinInfo.html" title="class in org.apache.storm.bolt">JoinBolt.JoinInfo</a> joinInfo, |
| boolean finalJoin)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doProjection(java.util.ArrayList,org.apache.storm.bolt.JoinBolt.FieldSelector[])"> |
| <h3>doProjection</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">doProjection</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> tuples, |
| <a href="JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a>[] projectionFields)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lookupField(org.apache.storm.bolt.JoinBolt.FieldSelector,org.apache.storm.tuple.Tuple)"> |
| <h3>lookupField</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">lookupField</span><wbr><span class="parameters">(<a href="JoinBolt.FieldSelector.html" title="class in org.apache.storm.bolt">JoinBolt.FieldSelector</a> fieldSelector, |
| <a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../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">Tuple count based sliding window configuration.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../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="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../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">Tuple count and time duration based sliding window configuration.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../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="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../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">Time duration and count based sliding window configuration.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../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="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../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">Time duration based sliding window configuration.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../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="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">A tuple count based window that slides with every incoming tuple.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">withWindow</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the number of tuples in the window</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">A time duration based window that slides with every incoming tuple.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWindow</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the time duration of the window</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>withTumblingWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withTumblingWindow</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> count)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">A count based tumbling window.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">withTumblingWindow</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>count</code> - the number of tuples after which the window tumbles</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withTumblingWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withTumblingWindow</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">A time duration based tumbling window.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withTumblingWindow</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>duration</code> - the time duration after which the window tumbles</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTimestampField(java.lang.String)"> |
| <h3>withTimestampField</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withTimestampField</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withTimestampField(java.lang.String)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will be thrown. The field MUST contain a timestamp in milliseconds</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withTimestampField(java.lang.String)">withTimestampField</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>fieldName</code> - the name of the field that contains the timestamp</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)"> |
| <h3>withTimestampExtractor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withTimestampExtractor</span><wbr><span class="parameters">(<a href="../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a> timestampExtractor)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">Specify the timestamp extractor implementation.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)">withTimestampExtractor</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>timestampExtractor</code> - the <a href="../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> implementation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withLateTupleStream(java.lang.String)"> |
| <h3>withLateTupleStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></span> <span class="element-name">withLateTupleStream</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withLateTupleStream(java.lang.String)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">Specify a stream id on which late tuples are going to be emitted. They are going to be accessible via the <a href="../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="../topology/base/BaseWindowedBolt.html#withTimestampField(java.lang.String)"><code>BaseWindowedBolt.withTimestampField(java.lang.String)</code></a>, otherwise <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withLateTupleStream(java.lang.String)">withLateTupleStream</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>streamId</code> - the name of the stream used to emit late tuples on</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withLag</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withLag</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withLag</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>duration</code> - the max lag duration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withWatermarkInterval</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withWatermarkInterval</span><wbr><span class="parameters">(<a href="../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> interval)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../topology/base/BaseWindowedBolt.html#withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">BaseWindowedBolt</a></code></span></div> |
| <div class="block">Specify the watermark event generation interval. For tuple based timestamps, watermark events are used to track the progress of time</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../topology/base/BaseWindowedBolt.html#withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWatermarkInterval</a></code> in class <code><a href="../topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>interval</code> - the interval at which watermark events are generated</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
