| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Operation (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.trident.operation, interface: Operation"> |
| <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/Operation.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.trident.operation</a></div> |
| <h1 title="Interface Operation" class="title">Interface Operation</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</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></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="Aggregator.html" title="interface in org.apache.storm.trident.operation">Aggregator</a><T></code>, <code><a href="EachOperation.html" title="interface in org.apache.storm.trident.operation">EachOperation</a></code>, <code><a href="Filter.html" title="interface in org.apache.storm.trident.operation">Filter</a></code>, <code><a href="Function.html" title="interface in org.apache.storm.trident.operation">Function</a></code>, <code><a href="OperationAwareFlatMapFunction.html" title="interface in org.apache.storm.trident.operation">OperationAwareFlatMapFunction</a></code>, <code><a href="OperationAwareMapFunction.html" title="interface in org.apache.storm.trident.operation">OperationAwareMapFunction</a></code>, <code><a href="../state/QueryFunction.html" title="interface in org.apache.storm.trident.state">QueryFunction</a><S,<wbr>T></code>, <code><a href="../state/StateUpdater.html" title="interface in org.apache.storm.trident.state">StateUpdater</a><S></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../redis/trident/state/AbstractRedisStateQuerier.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisStateQuerier</a></code>, <code><a href="../../redis/trident/state/AbstractRedisStateUpdater.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisStateUpdater</a></code>, <code><a href="BaseAggregator.html" title="class in org.apache.storm.trident.operation">BaseAggregator</a></code>, <code><a href="BaseFilter.html" title="class in org.apache.storm.trident.operation">BaseFilter</a></code>, <code><a href="BaseFunction.html" title="class in org.apache.storm.trident.operation">BaseFunction</a></code>, <code><a href="BaseOperation.html" title="class in org.apache.storm.trident.operation">BaseOperation</a></code>, <code><a href="../state/BaseQueryFunction.html" title="class in org.apache.storm.trident.state">BaseQueryFunction</a></code>, <code><a href="../state/BaseStateUpdater.html" title="class in org.apache.storm.trident.state">BaseStateUpdater</a></code>, <code><a href="impl/ChainedAggregatorImpl.html" title="class in org.apache.storm.trident.operation.impl">ChainedAggregatorImpl</a></code>, <code><a href="impl/CombinerAggregatorCombineImpl.html" title="class in org.apache.storm.trident.operation.impl">CombinerAggregatorCombineImpl</a></code>, <code><a href="impl/CombinerAggregatorInitImpl.html" title="class in org.apache.storm.trident.operation.impl">CombinerAggregatorInitImpl</a></code>, <code><a href="impl/CombinerAggStateUpdater.html" title="class in org.apache.storm.trident.operation.impl">CombinerAggStateUpdater</a></code>, <code><a href="builtin/ComparisonAggregator.html" title="class in org.apache.storm.trident.operation.builtin">ComparisonAggregator</a></code>, <code><a href="impl/ConsumerExecutor.html" title="class in org.apache.storm.trident.operation.impl">ConsumerExecutor</a></code>, <code><a href="../testing/CountAsAggregator.html" title="class in org.apache.storm.trident.testing">CountAsAggregator</a></code>, <code><a href="builtin/Debug.html" title="class in org.apache.storm.trident.operation.builtin">Debug</a></code>, <code><a href="builtin/Equals.html" title="class in org.apache.storm.trident.operation.builtin">Equals</a></code>, <code><a href="../../elasticsearch/trident/EsUpdater.html" title="class in org.apache.storm.elasticsearch.trident">EsUpdater</a></code>, <code><a href="impl/FilterExecutor.html" title="class in org.apache.storm.trident.operation.impl">FilterExecutor</a></code>, <code><a href="builtin/FilterNull.html" title="class in org.apache.storm.trident.operation.builtin">FilterNull</a></code>, <code><a href="builtin/FirstN.FirstNAgg.html" title="class in org.apache.storm.trident.operation.builtin">FirstN.FirstNAgg</a></code>, <code><a href="builtin/FirstN.FirstNSortedAgg.html" title="class in org.apache.storm.trident.operation.builtin">FirstN.FirstNSortedAgg</a></code>, <code><a href="impl/FlatMapFunctionExecutor.html" title="class in org.apache.storm.trident.operation.impl">FlatMapFunctionExecutor</a></code>, <code><a href="impl/GroupedAggregator.html" title="class in org.apache.storm.trident.operation.impl">GroupedAggregator</a></code>, <code><a href="../../hdfs/trident/HdfsUpdater.html" title="class in org.apache.storm.hdfs.trident">HdfsUpdater</a></code>, <code><a href="../../hive/trident/HiveUpdater.html" title="class in org.apache.storm.hive.trident">HiveUpdater</a></code>, <code><a href="../../jdbc/trident/state/JdbcQuery.html" title="class in org.apache.storm.jdbc.trident.state">JdbcQuery</a></code>, <code><a href="../../jdbc/trident/state/JdbcUpdater.html" title="class in org.apache.storm.jdbc.trident.state">JdbcUpdater</a></code>, <code><a href="../../jms/trident/JmsUpdater.html" title="class in org.apache.storm.jms.trident">JmsUpdater</a></code>, <code><a href="../state/map/MapCombinerAggStateUpdater.html" title="class in org.apache.storm.trident.state.map">MapCombinerAggStateUpdater</a></code>, <code><a href="impl/MapFunctionExecutor.html" title="class in org.apache.storm.trident.operation.impl">MapFunctionExecutor</a></code>, <code><a href="builtin/MapGet.html" title="class in org.apache.storm.trident.operation.builtin">MapGet</a></code>, <code><a href="../state/map/MapReducerAggStateUpdater.html" title="class in org.apache.storm.trident.state.map">MapReducerAggStateUpdater</a></code>, <code><a href="builtin/Max.html" title="class in org.apache.storm.trident.operation.builtin">Max</a></code>, <code><a href="builtin/MaxWithComparator.html" title="class in org.apache.storm.trident.operation.builtin">MaxWithComparator</a></code>, <code><a href="builtin/Min.html" title="class in org.apache.storm.trident.operation.builtin">Min</a></code>, <code><a href="builtin/MinWithComparator.html" title="class in org.apache.storm.trident.operation.builtin">MinWithComparator</a></code>, <code><a href="builtin/Negate.html" title="class in org.apache.storm.trident.operation.builtin">Negate</a></code>, <code><a href="../../redis/trident/PrintFunction.html" title="class in org.apache.storm.redis.trident">PrintFunction</a></code>, <code><a href="../../redis/trident/state/RedisClusterStateQuerier.html" title="class in org.apache.storm.redis.trident.state">RedisClusterStateQuerier</a></code>, <code><a href="../../redis/trident/state/RedisClusterStateUpdater.html" title="class in org.apache.storm.redis.trident.state">RedisClusterStateUpdater</a></code>, <code><a href="../../redis/trident/state/RedisStateQuerier.html" title="class in org.apache.storm.redis.trident.state">RedisStateQuerier</a></code>, <code><a href="../../redis/trident/state/RedisStateUpdater.html" title="class in org.apache.storm.redis.trident.state">RedisStateUpdater</a></code>, <code><a href="impl/ReducerAggregatorImpl.html" title="class in org.apache.storm.trident.operation.impl">ReducerAggregatorImpl</a></code>, <code><a href="impl/ReducerAggStateUpdater.html" title="class in org.apache.storm.trident.operation.impl">ReducerAggStateUpdater</a></code>, <code><a href="impl/SingleEmitAggregator.html" title="class in org.apache.storm.trident.operation.impl">SingleEmitAggregator</a></code>, <code><a href="builtin/SnapshotGet.html" title="class in org.apache.storm.trident.operation.builtin">SnapshotGet</a></code>, <code><a href="../testing/Split.html" title="class in org.apache.storm.trident.testing">Split</a></code>, <code><a href="../testing/StringLength.html" title="class in org.apache.storm.trident.testing">StringLength</a></code>, <code><a href="../../kafka/trident/TridentKafkaStateUpdater.html" title="class in org.apache.storm.kafka.trident">TridentKafkaStateUpdater</a></code>, <code><a href="../../starter/trident/TridentReach.ExpandList.html" title="class in org.apache.storm.starter.trident">TridentReach.ExpandList</a></code>, <code><a href="../../starter/trident/TridentWordCount.Split.html" title="class in org.apache.storm.starter.trident">TridentWordCount.Split</a></code>, <code><a href="impl/TrueFilter.html" title="class in org.apache.storm.trident.operation.impl">TrueFilter</a></code>, <code><a href="../testing/TrueFilter.html" title="class in org.apache.storm.trident.testing">TrueFilter</a></code>, <code><a href="builtin/TupleCollectionGet.html" title="class in org.apache.storm.trident.operation.builtin">TupleCollectionGet</a></code>, <code><a href="../testing/TuplifyArgs.html" title="class in org.apache.storm.trident.testing">TuplifyArgs</a></code>, <code><a href="../windowing/WindowsStateUpdater.html" title="class in org.apache.storm.trident.windowing">WindowsStateUpdater</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Operation</span><span class="extends-implements"> |
| extends <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></span></div> |
| <div class="block">Parent interface for Trident `Filter`s and `Function`s. |
| |
| <p>`Operation` defines two lifecycle methods for Trident components. The `prepare()` method is called once when the `Operation` is first |
| initialized. The `cleanup()` method is called in local mode when the local cluster is being shut down. In distributed mode, the |
| `cleanup()` method is not guaranteed to be called in every situation, but Storm will make a best effort call `cleanup()` whenever |
| possible.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#cleanup()" class="member-name-link">cleanup</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">When running in local mode, called when the local cluster is being shut down.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#prepare(java.util.Map,org.apache.storm.trident.operation.TridentOperationContext)" 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>> conf, |
| <a href="TridentOperationContext.html" title="class in org.apache.storm.trident.operation">TridentOperationContext</a> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when the `Operation` is first initialized.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="prepare(java.util.Map,org.apache.storm.trident.operation.TridentOperationContext)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><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>> conf, |
| <a href="TridentOperationContext.html" title="class in org.apache.storm.trident.operation">TridentOperationContext</a> context)</span></div> |
| <div class="block">Called when the `Operation` is first initialized.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - the Storm configuration map</dd> |
| <dd><code>context</code> - the operation context which provides information such as the number of partitions in the stream, and the current |
| partition index. It also provides methods for registering operation-specific metrics.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="TridentOperationContext.html" title="class in org.apache.storm.trident.operation"><code>TridentOperationContext</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanup()"> |
| <h3>cleanup</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">cleanup</span>()</div> |
| <div class="block">When running in local mode, called when the local cluster is being shut down.</div> |
| </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> |
