blob: 51134fa907a307f13c375e6145e9b0a4980e38f9 [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 -->
<title>FixedPartitionResolver (Apache Geode 1.15.1)</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="FixedPartitionResolver (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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="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/geode/cache/FixedPartitionAttributes.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/GatewayConfigurationException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/cache/FixedPartitionResolver.html" target="_top">Frames</a></li>
<li><a href="FixedPartitionResolver.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.geode.cache</div>
<h2 title="Interface FixedPartitionResolver" class="title">Interface FixedPartitionResolver&lt;K,V&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/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a>, <a href="../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache">Declarable</a>, <a href="../../../../org/apache/geode/cache/PartitionResolver.html" title="interface in org.apache.geode.cache">PartitionResolver</a>&lt;K,V&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">FixedPartitionResolver&lt;K,V&gt;</span>
extends <a href="../../../../org/apache/geode/cache/PartitionResolver.html" title="interface in org.apache.geode.cache">PartitionResolver</a>&lt;K,V&gt;</pre>
<div class="block">Implementers of interface <code>FixedPartitionResolver</code> helps to achieve explicit mapping
of a "user defined" partition to a data member node.
<p>
GemFire uses the partition name returned by
<a href="../../../../org/apache/geode/cache/FixedPartitionResolver.html#getPartitionName-org.apache.geode.cache.EntryOperation-java.util.Set-"><code>getPartitionName(EntryOperation, Set)</code></a> to determine on which member
the data is being managed. Say, for example, you want to partition all Trades according to
quarters. You can implement FixedPartitionResolver to get the name of the quarter based on the
date given as part of <a href="../../../../org/apache/geode/cache/EntryOperation.html" title="interface in org.apache.geode.cache"><code>EntryOperation</code></a>.
<p>
public class QuarterPartitionResolver implements FixedPartitionResolver{<br>
&nbsp; &nbsp; public String getPartitionName(EntryOperation opDetails, Set
allAvailablePartitions)
{<br>
&nbsp; &nbsp; Date date = sdf.parse((String)opDetails.getKey());<br>
&nbsp; &nbsp; Calendar cal = Calendar.getInstance();<br>
&nbsp; &nbsp; cal.setTime(date);<br>
&nbsp; &nbsp; int month = cal.get(Calendar.MONTH);<br>
&nbsp; &nbsp; if (month == 0 || month == 1 || month == 2) {<br>
&nbsp; &nbsp; &nbsp; return "Quarter1";<br>
&nbsp; &nbsp; }<br>
&nbsp; &nbsp; else if (month == 3 || month == 4 || month == 5) {<br>
&nbsp; &nbsp; &nbsp; return "Quarter2";<br>
&nbsp; &nbsp; }<br>
&nbsp; &nbsp; else if (month == 6 || month == 7 || month == 8) {<br>
&nbsp; &nbsp; &nbsp; return "Quarter3";<br>
&nbsp; &nbsp; }<br>
&nbsp; &nbsp; else if (month == 9 || month == 10 || month == 11) {<br>
&nbsp; &nbsp; &nbsp; return "Quarter4";<br>
&nbsp; &nbsp; }<br>
&nbsp; &nbsp; else {<br>
&nbsp; &nbsp; &nbsp; return "Invalid Quarter";<br>
&nbsp; &nbsp; }<br>
&nbsp; }<br></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/PartitionResolver.html" title="interface in org.apache.geode.cache"><code>PartitionResolver</code></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="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/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/FixedPartitionResolver.html#getPartitionName-org.apache.geode.cache.EntryOperation-java.util.Set-">getPartitionName</a></span>(<a href="../../../../org/apache/geode/cache/EntryOperation.html" title="interface in org.apache.geode.cache">EntryOperation</a>&lt;<a href="../../../../org/apache/geode/cache/FixedPartitionResolver.html" title="type parameter in FixedPartitionResolver">K</a>,<a href="../../../../org/apache/geode/cache/FixedPartitionResolver.html" title="type parameter in FixedPartitionResolver">V</a>&gt;&nbsp;opDetails,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>&gt;&nbsp;targetPartitions)</code>
<div class="block">This method is used to get the name of the partition for the given entry operation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.PartitionResolver">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/PartitionResolver.html" title="interface in org.apache.geode.cache">PartitionResolver</a></h3>
<code><a href="../../../../org/apache/geode/cache/PartitionResolver.html#getName--">getName</a>, <a href="../../../../org/apache/geode/cache/PartitionResolver.html#getRoutingObject-org.apache.geode.cache.EntryOperation-">getRoutingObject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.CacheCallback">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a></h3>
<code><a href="../../../../org/apache/geode/cache/CacheCallback.html#close--">close</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.Declarable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache">Declarable</a></h3>
<code><a href="../../../../org/apache/geode/cache/Declarable.html#init-java.util.Properties-">init</a>, <a href="../../../../org/apache/geode/cache/Declarable.html#initialize-org.apache.geode.cache.Cache-java.util.Properties-">initialize</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="getPartitionName-org.apache.geode.cache.EntryOperation-java.util.Set-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPartitionName</h4>
<pre><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>&nbsp;getPartitionName(<a href="../../../../org/apache/geode/cache/EntryOperation.html" title="interface in org.apache.geode.cache">EntryOperation</a>&lt;<a href="../../../../org/apache/geode/cache/FixedPartitionResolver.html" title="type parameter in FixedPartitionResolver">K</a>,<a href="../../../../org/apache/geode/cache/FixedPartitionResolver.html" title="type parameter in FixedPartitionResolver">V</a>&gt;&nbsp;opDetails,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>&gt;&nbsp;targetPartitions)</pre>
<div class="block">This method is used to get the name of the partition for the given entry operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>opDetails</code> - the details of the entry operation e.g. <a href="../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a></dd>
<dd><code>targetPartitions</code> - Avoid using this parameter.This set is deprecated from 8.0 and same
will be removed in future release. Represents all the available primary partitions on
the nodes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>partition-name associated with node which allows mapping of given data to user defined
partition</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="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/geode/cache/FixedPartitionAttributes.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/GatewayConfigurationException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/cache/FixedPartitionResolver.html" target="_top">Frames</a></li>
<li><a href="FixedPartitionResolver.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 ======= -->
</body>
</html>