| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractRedisStateUpdater (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.redis.trident.state, class: AbstractRedisStateUpdater"> |
| <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/AbstractRedisStateUpdater.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><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.redis.trident.state</a></div> |
| <h1 title="Class AbstractRedisStateUpdater" class="title">Class AbstractRedisStateUpdater<T extends <a href="../../../trident/state/State.html" title="interface in org.apache.storm.trident.state">State</a>></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="../../../trident/operation/BaseOperation.html" title="class in org.apache.storm.trident.operation">org.apache.storm.trident.operation.BaseOperation</a> |
| <div class="inheritance"><a href="../../../trident/state/BaseStateUpdater.html" title="class in org.apache.storm.trident.state">org.apache.storm.trident.state.BaseStateUpdater</a><T> |
| <div class="inheritance">org.apache.storm.redis.trident.state.AbstractRedisStateUpdater<T></div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - type of State</dd> |
| </dl> |
| <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="../../../trident/operation/Operation.html" title="interface in org.apache.storm.trident.operation">Operation</a></code>, <code><a href="../../../trident/state/StateUpdater.html" title="interface in org.apache.storm.trident.state">StateUpdater</a><T></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="RedisClusterStateUpdater.html" title="class in org.apache.storm.redis.trident.state">RedisClusterStateUpdater</a></code>, <code><a href="RedisStateUpdater.html" title="class in org.apache.storm.redis.trident.state">RedisStateUpdater</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractRedisStateUpdater<T extends <a href="../../../trident/state/State.html" title="interface in org.apache.storm.trident.state">State</a>></span> |
| <span class="extends-implements">extends <a href="../../../trident/state/BaseStateUpdater.html" title="class in org.apache.storm.trident.state">BaseStateUpdater</a><T></span></div> |
| <div class="block">AbstractRedisStateUpdater is base class of any RedisStateUpdater, which implements BaseStateUpdater. |
| |
| <p>Derived classes should provide how to update (key, value) pairs to Redis, |
| and AbstractRedisStateUpdater takes care of rest things.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../serialized-form.html#org.apache.storm.redis.trident.state.AbstractRedisStateUpdater">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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 final <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="#additionalKey" class="member-name-link">additionalKey</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="../../common/mapper/RedisDataTypeDescription.RedisDataType.html" title="enum in org.apache.storm.redis.common.mapper">RedisDataTypeDescription.RedisDataType</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#dataType" class="member-name-link">dataType</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected int</code></div> |
| <div class="col-second even-row-color"><code><a href="#expireIntervalSec" class="member-name-link">expireIntervalSec</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </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(org.apache.storm.redis.common.mapper.RedisStoreMapper)" class="member-name-link">AbstractRedisStateUpdater</a><wbr>(<a href="../../common/mapper/RedisStoreMapper.html" title="interface in org.apache.storm.redis.common.mapper">RedisStoreMapper</a> storeMapper)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructor.</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-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><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="#setExpireInterval(int)" class="member-name-link">setExpireInterval</a><wbr>(int expireIntervalSec)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets expire (time to live) if needed.</div> |
| </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="#updateState(T,java.util.List,org.apache.storm.trident.operation.TridentCollector)" class="member-name-link">updateState</a><wbr>(<a href="AbstractRedisStateUpdater.html" title="type parameter in AbstractRedisStateUpdater">T</a> state, |
| <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="../../../trident/tuple/TridentTuple.html" title="interface in org.apache.storm.trident.tuple">TridentTuple</a>> inputs, |
| <a href="../../../trident/operation/TridentCollector.html" title="interface in org.apache.storm.trident.operation">TridentCollector</a> collector)</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-tab3"><code>protected abstract void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#updateStatesToRedis(T,java.util.Map)" class="member-name-link">updateStatesToRedis</a><wbr>(<a href="AbstractRedisStateUpdater.html" title="type parameter in AbstractRedisStateUpdater">T</a> state, |
| <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/String.html" title="class or interface in java.lang" class="external-link">String</a>> keyToValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Updates (key, value) pairs to Redis.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.trident.operation.BaseOperation">Methods inherited from class org.apache.storm.trident.operation.<a href="../../../trident/operation/BaseOperation.html" title="class in org.apache.storm.trident.operation">BaseOperation</a></h3> |
| <code><a href="../../../trident/operation/BaseOperation.html#cleanup()">cleanup</a>, <a href="../../../trident/operation/BaseOperation.html#prepare(java.util.Map,org.apache.storm.trident.operation.TridentOperationContext)">prepare</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> |
| <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="../../../trident/operation/Operation.html" title="interface in org.apache.storm.trident.operation">Operation</a></h3> |
| <code><a href="../../../trident/operation/Operation.html#cleanup()">cleanup</a>, <a href="../../../trident/operation/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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="dataType"> |
| <h3>dataType</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../common/mapper/RedisDataTypeDescription.RedisDataType.html" title="enum in org.apache.storm.redis.common.mapper">RedisDataTypeDescription.RedisDataType</a></span> <span class="element-name">dataType</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="additionalKey"> |
| <h3>additionalKey</h3> |
| <div class="member-signature"><span class="modifiers">protected final</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">additionalKey</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="expireIntervalSec"> |
| <h3>expireIntervalSec</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">int</span> <span class="element-name">expireIntervalSec</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>(org.apache.storm.redis.common.mapper.RedisStoreMapper)"> |
| <h3>AbstractRedisStateUpdater</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbstractRedisStateUpdater</span><wbr><span class="parameters">(<a href="../../common/mapper/RedisStoreMapper.html" title="interface in org.apache.storm.redis.common.mapper">RedisStoreMapper</a> storeMapper)</span></div> |
| <div class="block">Constructor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>storeMapper</code> - mapper for storing</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="setExpireInterval(int)"> |
| <h3>setExpireInterval</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setExpireInterval</span><wbr><span class="parameters">(int expireIntervalSec)</span></div> |
| <div class="block">Sets expire (time to live) if needed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>expireIntervalSec</code> - time to live in seconds</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateState(T,java.util.List,org.apache.storm.trident.operation.TridentCollector)"> |
| <h3 id="updateState(org.apache.storm.trident.state.State,java.util.List,org.apache.storm.trident.operation.TridentCollector)">updateState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateState</span><wbr><span class="parameters">(<a href="AbstractRedisStateUpdater.html" title="type parameter in AbstractRedisStateUpdater">T</a> state, |
| <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="../../../trident/tuple/TridentTuple.html" title="interface in org.apache.storm.trident.tuple">TridentTuple</a>> inputs, |
| <a href="../../../trident/operation/TridentCollector.html" title="interface in org.apache.storm.trident.operation">TridentCollector</a> collector)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateStatesToRedis(T,java.util.Map)"> |
| <h3 id="updateStatesToRedis(org.apache.storm.trident.state.State,java.util.Map)">updateStatesToRedis</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">void</span> <span class="element-name">updateStatesToRedis</span><wbr><span class="parameters">(<a href="AbstractRedisStateUpdater.html" title="type parameter in AbstractRedisStateUpdater">T</a> state, |
| <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/String.html" title="class or interface in java.lang" class="external-link">String</a>> keyToValue)</span></div> |
| <div class="block">Updates (key, value) pairs to Redis.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>state</code> - State for handling query</dd> |
| <dd><code>keyToValue</code> - (key, value) pairs</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> |