| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native C++ Reference: apache::geode::client::FixedPartitionResolver Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native C++ Reference |
|  <span id="projectnumber">1.13.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00735.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">apache::geode::client::FixedPartitionResolver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Implementers of interface <code><a class="el" href="a00735.html" title="Implementers of interface FixedPartitionResolver helps to achieve explicit mapping of a "user defined...">FixedPartitionResolver</a></code> helps to achieve explicit mapping of a "user defined" partition to a data member node. |
| <a href="a00735.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="a00747.html">apache::geode::client::PartitionResolver</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a68793ed428ca0d18ed5aad5bb8e00bf3"><td class="memItemLeft" align="right" valign="top">virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00747.html#a68793ed428ca0d18ed5aad5bb8e00bf3">getName</a> ()</td></tr> |
| <tr class="memdesc:a68793ed428ca0d18ed5aad5bb8e00bf3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the <a class="el" href="a00747.html" title="Implement the PartitionResolver interface to enable custom partitioning on the PartitionedRegion.">PartitionResolver</a>. <a href="#a68793ed428ca0d18ed5aad5bb8e00bf3">More...</a><br /></td></tr> |
| <tr class="separator:a68793ed428ca0d18ed5aad5bb8e00bf3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16b169d39ebfd1254b98e4c05945707c"><td class="memItemLeft" align="right" valign="top">virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00735.html#a16b169d39ebfd1254b98e4c05945707c">getPartitionName</a> (const <a class="el" href="a00459.html">EntryEvent</a> &opDetails)=0</td></tr> |
| <tr class="memdesc:a16b169d39ebfd1254b98e4c05945707c"><td class="mdescLeft"> </td><td class="mdescRight">public methods <a href="#a16b169d39ebfd1254b98e4c05945707c">More...</a><br /></td></tr> |
| <tr class="separator:a16b169d39ebfd1254b98e4c05945707c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6492385156922aca28af866905e5f554"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="a00339.html">CacheableKey</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00747.html#a6492385156922aca28af866905e5f554">getRoutingObject</a> (const <a class="el" href="a00459.html">EntryEvent</a> &opDetails)=0</td></tr> |
| <tr class="separator:a6492385156922aca28af866905e5f554"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Implementers of interface <code><a class="el" href="a00735.html" title="Implementers of interface FixedPartitionResolver helps to achieve explicit mapping of a "user defined...">FixedPartitionResolver</a></code> helps to achieve explicit mapping of a "user defined" partition to a data member node. </p> |
| <p>Geode uses the partition name returned by <a class="el" href="">std::shared_ptr<CacheableHashSet>)</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 <a class="el" href="a00735.html" title="Implementers of interface FixedPartitionResolver helps to achieve explicit mapping of a "user defined...">FixedPartitionResolver</a> to get the name of the quarter based on the date given as part of <a class="el" href="a00459.html">EntryEvent</a>. </p> |
| <p>public class QuarterPartitionResolver implements <a class="el" href="a00735.html" title="Implementers of interface FixedPartitionResolver helps to achieve explicit mapping of a "user defined...">FixedPartitionResolver</a>{<br /> |
| &nbsp &nbsp public const char* getPartitionName(<a class="el" href="a00459.html" title="Represents an entry event affecting an entry, including its identity and the the circumstances of the...">EntryEvent</a> event, std::shared_ptr<CacheableHashSet> 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 /> |
| </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00747.html" title="Implement the PartitionResolver interface to enable custom partitioning on the PartitionedRegion.">PartitionResolver</a> </dd></dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a68793ed428ca0d18ed5aad5bb8e00bf3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a68793ed428ca0d18ed5aad5bb8e00bf3">◆ </a></span>getName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual const std::string& apache::geode::client::PartitionResolver::getName </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the name of the <a class="el" href="a00747.html" title="Implement the PartitionResolver interface to enable custom partitioning on the PartitionedRegion.">PartitionResolver</a>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>String name </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a16b169d39ebfd1254b98e4c05945707c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a16b169d39ebfd1254b98e4c05945707c">◆ </a></span>getPartitionName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual const std::string& apache::geode::client::FixedPartitionResolver::getPartitionName </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="a00459.html">EntryEvent</a> & </td> |
| <td class="paramname"><em>opDetails</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>public methods </p> |
| <p>This method is used to get the name of the partition for the given entry operation.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opDetails</td><td>the details of the entry event e.g. <a class="el" href="">Region#get(Object)</a></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>partition-name associated with node which allows mapping of given data to user defined partition </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a6492385156922aca28af866905e5f554"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6492385156922aca28af866905e5f554">◆ </a></span>getRoutingObject()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::shared_ptr<<a class="el" href="a00339.html">CacheableKey</a>> apache::geode::client::PartitionResolver::getRoutingObject </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="a00459.html">EntryEvent</a> & </td> |
| <td class="paramname"><em>opDetails</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opDetails</td><td>the detail of the entry event </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">RuntimeException</td><td>- any exception thrown will terminate the operation and the exception will be passed to the calling thread. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>object associated with entry event which allows the Partitioned <a class="el" href="a00815.html" title="This class manages subregions and cached data.">Region</a> to store associated data together </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache API Documentation</small></address> |
