| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Filter (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: Filter"> |
| <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/Filter.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 Filter" class="title">Interface Filter</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="EachOperation.html" title="interface in org.apache.storm.trident.operation">EachOperation</a></code>, <code><a href="Operation.html" title="interface in org.apache.storm.trident.operation">Operation</a></code>, <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 Implementing Classes:</dt> |
| <dd><code><a href="BaseFilter.html" title="class in org.apache.storm.trident.operation">BaseFilter</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="builtin/FilterNull.html" title="class in org.apache.storm.trident.operation.builtin">FilterNull</a></code>, <code><a href="builtin/Negate.html" title="class in org.apache.storm.trident.operation.builtin">Negate</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></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Filter</span><span class="extends-implements"> |
| extends <a href="EachOperation.html" title="interface in org.apache.storm.trident.operation">EachOperation</a></span></div> |
| <div class="block">Filters take in a tuple as input and decide whether or not to keep that tuple or not. |
| |
| <p>If the `isKeep()` method of a Filter returns `false` for a tuple, that tuple will be filtered out of the Stream |
| |
| |
| <p>### Configuration If your `Filter` implementation has configuration requirements, you will typically want to extend <a href="BaseFilter.html" title="class in org.apache.storm.trident.operation"><code>BaseFilter</code></a> and override the <a href="Operation.html#prepare(java.util.Map,org.apache.storm.trident.operation.TridentOperationContext)"><code>Operation.prepare(Map, TridentOperationContext)</code></a> method to perform your custom initialization.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../Stream.html" title="class in org.apache.storm.trident"><code>Stream</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isKeep(org.apache.storm.trident.tuple.TridentTuple)" class="member-name-link">isKeep</a><wbr>(<a href="../tuple/TridentTuple.html" title="interface in org.apache.storm.trident.tuple">TridentTuple</a> tuple)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Determines if a tuple should be filtered out of a stream.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.trident.operation.Operation">Methods inherited from interface org.apache.storm.trident.operation.<a href="Operation.html" title="interface in org.apache.storm.trident.operation">Operation</a></h3> |
| <code><a href="Operation.html#cleanup()">cleanup</a>, <a href="Operation.html#prepare(java.util.Map,org.apache.storm.trident.operation.TridentOperationContext)">prepare</a></code></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="isKeep(org.apache.storm.trident.tuple.TridentTuple)"> |
| <h3>isKeep</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isKeep</span><wbr><span class="parameters">(<a href="../tuple/TridentTuple.html" title="interface in org.apache.storm.trident.tuple">TridentTuple</a> tuple)</span></div> |
| <div class="block">Determines if a tuple should be filtered out of a stream.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tuple</code> - the tuple being evaluated</dd> |
| <dt>Returns:</dt> |
| <dd>`false` to drop the tuple, `true` to keep the tuple</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> |