blob: 5f3dbe16a306d7ec4f438787e25b60a1baaa40ec [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>CassandraMapStateFactory (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="CassandraMapStateFactory (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/CassandraMapStateFactory.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/cassandra/trident/state/CassandraBackingMap.Options.html" title="class in org.apache.storm.cassandra.trident.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraQuery.html" title="class in org.apache.storm.cassandra.trident.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" target="_top">Frames</a></li>
<li><a href="CassandraMapStateFactory.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.cassandra.trident.state</div>
<h2 title="Class CassandraMapStateFactory" class="title">Class CassandraMapStateFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.storm.cassandra.trident.state.CassandraMapStateFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><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>, <a href="../../../../../../org/apache/storm/trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CassandraMapStateFactory</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../org/apache/storm/trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></pre>
<div class="block"><p>A StateFactory implementation that creates a MapState backed by CassandraBackingMap.</p><p><p>The statefactory supports opaque, transactional and non-transactional configurations. Optionally, the backing map can be wrapped in a <a href="../../../../../../org/apache/storm/trident/state/map/CachedMap.html" title="class in org.apache.storm.trident.state.map"><code>CachedMap</code></a> by specifying <a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html#withCache-int-"><code>withCache(int)</code></a> (off by default).</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.storm.cassandra.trident.state.CassandraMapStateFactory">Serialized Form</a></dd>
</dl>
</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="../../../../../../org/apache/storm/trident/state/State.html" title="interface in org.apache.storm.trident.state">State</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html#makeState-java.util.Map-org.apache.storm.task.IMetricsContext-int-int-">makeState</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;conf,
<a href="../../../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a>&nbsp;metrics,
int&nbsp;partitionIndex,
int&nbsp;numPartitions)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" title="class in org.apache.storm.cassandra.trident.state">CassandraMapStateFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html#nonTransactional-org.apache.storm.cassandra.trident.state.CassandraBackingMap.Options-java.util.Map-">nonTransactional</a></span>(<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraBackingMap.Options.html" title="class in org.apache.storm.cassandra.trident.state">CassandraBackingMap.Options</a>&nbsp;options,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;cassandraConfig)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" title="class in org.apache.storm.cassandra.trident.state">CassandraMapStateFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html#opaque-org.apache.storm.cassandra.trident.state.CassandraBackingMap.Options-java.util.Map-">opaque</a></span>(<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraBackingMap.Options.html" title="class in org.apache.storm.cassandra.trident.state">CassandraBackingMap.Options</a>&nbsp;options,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;cassandraConfig)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" title="class in org.apache.storm.cassandra.trident.state">CassandraMapStateFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html#transactional-org.apache.storm.cassandra.trident.state.CassandraBackingMap.Options-java.util.Map-">transactional</a></span>(<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraBackingMap.Options.html" title="class in org.apache.storm.cassandra.trident.state">CassandraBackingMap.Options</a>&nbsp;options,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;cassandraConfig)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" title="class in org.apache.storm.cassandra.trident.state">CassandraMapStateFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html#withCache-int-">withCache</a></span>(int&nbsp;cacheSize)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</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="opaque-org.apache.storm.cassandra.trident.state.CassandraBackingMap.Options-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>opaque</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" title="class in org.apache.storm.cassandra.trident.state">CassandraMapStateFactory</a>&nbsp;opaque(<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraBackingMap.Options.html" title="class in org.apache.storm.cassandra.trident.state">CassandraBackingMap.Options</a>&nbsp;options,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;cassandraConfig)</pre>
</li>
</ul>
<a name="transactional-org.apache.storm.cassandra.trident.state.CassandraBackingMap.Options-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transactional</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" title="class in org.apache.storm.cassandra.trident.state">CassandraMapStateFactory</a>&nbsp;transactional(<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraBackingMap.Options.html" title="class in org.apache.storm.cassandra.trident.state">CassandraBackingMap.Options</a>&nbsp;options,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;cassandraConfig)</pre>
</li>
</ul>
<a name="nonTransactional-org.apache.storm.cassandra.trident.state.CassandraBackingMap.Options-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nonTransactional</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" title="class in org.apache.storm.cassandra.trident.state">CassandraMapStateFactory</a>&nbsp;nonTransactional(<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraBackingMap.Options.html" title="class in org.apache.storm.cassandra.trident.state">CassandraBackingMap.Options</a>&nbsp;options,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;cassandraConfig)</pre>
</li>
</ul>
<a name="withCache-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withCache</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" title="class in org.apache.storm.cassandra.trident.state">CassandraMapStateFactory</a>&nbsp;withCache(int&nbsp;cacheSize)</pre>
</li>
</ul>
<a name="makeState-java.util.Map-org.apache.storm.task.IMetricsContext-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>makeState</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/storm/trident/state/State.html" title="interface in org.apache.storm.trident.state">State</a>&nbsp;makeState(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;conf,
<a href="../../../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a>&nbsp;metrics,
int&nbsp;partitionIndex,
int&nbsp;numPartitions)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/storm/trident/state/StateFactory.html#makeState-java.util.Map-org.apache.storm.task.IMetricsContext-int-int-">makeState</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/storm/trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></dd>
</dl>
</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/CassandraMapStateFactory.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/cassandra/trident/state/CassandraBackingMap.Options.html" title="class in org.apache.storm.cassandra.trident.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/storm/cassandra/trident/state/CassandraQuery.html" title="class in org.apache.storm.cassandra.trident.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/storm/cassandra/trident/state/CassandraMapStateFactory.html" target="_top">Frames</a></li>
<li><a href="CassandraMapStateFactory.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>