Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / trident / state / QueryFunction.html
blob: f6f2252ac82415fc957645f6b18cde85e282a472 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>QueryFunction (Storm 2.4.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="QueryFunction (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/QueryFunction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/storm/trident/state/OpaqueValue.html" title="class in org.apache.storm.trident.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/trident/state/ReadOnlyState.html" title="class in org.apache.storm.trident.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/trident/state/QueryFunction.html" target="_top">Frames</a></li>
<li><a href="QueryFunction.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.storm.trident.state</div>
<h2 title="Interface QueryFunction" class="title">Interface QueryFunction&lt;S extends <a href="../../../../../org/apache/storm/trident/state/State.html" title="interface in org.apache.storm.trident.state">State</a>,T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/storm/trident/operation/EachOperation.html" title="interface in org.apache.storm.trident.operation">EachOperation</a>, <a href="../../../../../org/apache/storm/trident/operation/Operation.html" title="interface in org.apache.storm.trident.operation">Operation</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/storm/redis/trident/state/AbstractRedisStateQuerier.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisStateQuerier</a>, <a href="../../../../../org/apache/storm/trident/state/BaseQueryFunction.html" title="class in org.apache.storm.trident.state">BaseQueryFunction</a>, <a href="../../../../../org/apache/storm/cassandra/trident/state/CassandraQuery.html" title="class in org.apache.storm.cassandra.trident.state">CassandraQuery</a>, <a href="../../../../../org/apache/storm/hbase/trident/state/HBaseQuery.html" title="class in org.apache.storm.hbase.trident.state">HBaseQuery</a>, <a href="../../../../../org/apache/storm/jdbc/trident/state/JdbcQuery.html" title="class in org.apache.storm.jdbc.trident.state">JdbcQuery</a>, <a href="../../../../../org/apache/storm/trident/operation/builtin/MapGet.html" title="class in org.apache.storm.trident.operation.builtin">MapGet</a>, <a href="../../../../../org/apache/storm/mongodb/trident/state/MongoStateQuery.html" title="class in org.apache.storm.mongodb.trident.state">MongoStateQuery</a>, <a href="../../../../../org/apache/storm/redis/trident/state/RedisClusterStateQuerier.html" title="class in org.apache.storm.redis.trident.state">RedisClusterStateQuerier</a>, <a href="../../../../../org/apache/storm/redis/trident/state/RedisStateQuerier.html" title="class in org.apache.storm.redis.trident.state">RedisStateQuerier</a>, <a href="../../../../../org/apache/storm/trident/operation/builtin/SnapshotGet.html" title="class in org.apache.storm.trident.operation.builtin">SnapshotGet</a>, <a href="../../../../../org/apache/storm/trident/operation/builtin/TupleCollectionGet.html" title="class in org.apache.storm.trident.operation.builtin">TupleCollectionGet</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">QueryFunction&lt;S extends <a href="../../../../../org/apache/storm/trident/state/State.html" title="interface in org.apache.storm.trident.state">State</a>,T&gt;</span>
extends <a href="../../../../../org/apache/storm/trident/operation/EachOperation.html" title="interface in org.apache.storm.trident.operation">EachOperation</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/storm/trident/state/QueryFunction.html" title="type parameter in QueryFunction">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/state/QueryFunction.html#batchRetrieve-S-java.util.List-">batchRetrieve</a></span>(<a href="../../../../../org/apache/storm/trident/state/QueryFunction.html" title="type parameter in QueryFunction">S</a>&nbsp;state,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/storm/trident/tuple/TridentTuple.html" title="interface in org.apache.storm.trident.tuple">TridentTuple</a>&gt;&nbsp;args)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/state/QueryFunction.html#execute-org.apache.storm.trident.tuple.TridentTuple-T-org.apache.storm.trident.operation.TridentCollector-">execute</a></span>(<a href="../../../../../org/apache/storm/trident/tuple/TridentTuple.html" title="interface in org.apache.storm.trident.tuple">TridentTuple</a>&nbsp;tuple,
<a href="../../../../../org/apache/storm/trident/state/QueryFunction.html" title="type parameter in QueryFunction">T</a>&nbsp;result,
<a href="../../../../../org/apache/storm/trident/operation/TridentCollector.html" title="interface in org.apache.storm.trident.operation">TridentCollector</a>&nbsp;collector)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.trident.operation.Operation">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.trident.operation.<a href="../../../../../org/apache/storm/trident/operation/Operation.html" title="interface in org.apache.storm.trident.operation">Operation</a></h3>
<code><a href="../../../../../org/apache/storm/trident/operation/Operation.html#cleanup--">cleanup</a>, <a href="../../../../../org/apache/storm/trident/operation/Operation.html#prepare-java.util.Map-org.apache.storm.trident.operation.TridentOperationContext-">prepare</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="batchRetrieve-org.apache.storm.trident.state.State-java.util.List-">
<!-- -->
</a><a name="batchRetrieve-S-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batchRetrieve</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/storm/trident/state/QueryFunction.html" title="type parameter in QueryFunction">T</a>&gt;&nbsp;batchRetrieve(<a href="../../../../../org/apache/storm/trident/state/QueryFunction.html" title="type parameter in QueryFunction">S</a>&nbsp;state,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/storm/trident/tuple/TridentTuple.html" title="interface in org.apache.storm.trident.tuple">TridentTuple</a>&gt;&nbsp;args)</pre>
</li>
</ul>
<a name="execute-org.apache.storm.trident.tuple.TridentTuple-java.lang.Object-org.apache.storm.trident.operation.TridentCollector-">
<!-- -->
</a><a name="execute-org.apache.storm.trident.tuple.TridentTuple-T-org.apache.storm.trident.operation.TridentCollector-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>void&nbsp;execute(<a href="../../../../../org/apache/storm/trident/tuple/TridentTuple.html" title="interface in org.apache.storm.trident.tuple">TridentTuple</a>&nbsp;tuple,
<a href="../../../../../org/apache/storm/trident/state/QueryFunction.html" title="type parameter in QueryFunction">T</a>&nbsp;result,
<a href="../../../../../org/apache/storm/trident/operation/TridentCollector.html" title="interface in org.apache.storm.trident.operation">TridentCollector</a>&nbsp;collector)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/QueryFunction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/storm/trident/state/OpaqueValue.html" title="class in org.apache.storm.trident.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/trident/state/ReadOnlyState.html" title="class in org.apache.storm.trident.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/trident/state/QueryFunction.html" target="_top">Frames</a></li>
<li><a href="QueryFunction.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>