| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:00 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CacheDistributionPolicy (OpenJPA Parent POM 2.4.3 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CacheDistributionPolicy (OpenJPA Parent POM 2.4.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/CacheDistributionPolicy.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/openjpa/datacache/AbstractQueryCache.EvictPolicy.html" title="enum in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/datacache/CacheDistributionPolicy.html" target="_top">Frames</a></li> |
| <li><a href="CacheDistributionPolicy.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.openjpa.datacache</div> |
| <h2 title="Interface CacheDistributionPolicy" class="title">Interface CacheDistributionPolicy</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/datacache/DefaultCacheDistributionPolicy.html" title="class in org.apache.openjpa.datacache">DefaultCacheDistributionPolicy</a>, <a href="../../../../org/apache/openjpa/datacache/TypeBasedCacheDistributionPolicy.html" title="class in org.apache.openjpa.datacache">TypeBasedCacheDistributionPolicy</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">CacheDistributionPolicy</span> |
| extends <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></pre> |
| <div class="block">A policy determines whether a given entity should be cached and if true, in which named partition of the |
| cache. |
| <br> |
| This policy is activated for each instance if and only if the cache settings specified in metadata |
| such as JPA specification defined <code>@Cacheable</code> annotation or OpenJPA specific |
| <a href="../../../../org/apache/openjpa/persistence/DataCache.html" title="annotation in org.apache.openjpa.persistence"><code>@DataCache</code></a> annotation or configuration property |
| such as <code>javax.persistence.sharedCache.mode</code> determined the type of the instance being cachable. |
| <br> |
| For example, a specific policy will never be active for when <code>javax.persistence.sharedCache.mode</code> |
| is set to <code>NONE</code>. |
| <br> |
| Distribution Policies are configurable. So a specific policy can be configured as |
| <pre> |
| <property name="openjpa.CacheDistributionPolicy" value="com.acme.FooPolicy(param1='xyz',param2=true)"/> |
| </pre> |
| where <code>com.acme.FooPolicy</code> is an implementation of this interface and defines bean style setter and |
| getter methods for String property <code>param1</code> and boolean property <code>param2</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Pinaki Poddar</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/CacheDistributionPolicy.html#selectCache(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">selectCache</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context)</code> |
| <div class="block">Selects the name of the cache where the given managed proxy object state be cached.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.lib.conf.Configurable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.lib.conf.<a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></h3> |
| <code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration()">endConfiguration</a>, <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</a>, <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration()">startConfiguration</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="selectCache(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>selectCache</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> selectCache(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context)</pre> |
| <div class="block">Selects the name of the cache where the given managed proxy object state be cached.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sm</code> - the managed proxy object to be cached. The actual managed instance can be accessed from the proxy |
| instance simply as <code>sm.getManagedInstance()</code>.</dd><dd><code>context</code> - the context of invocation. No specific semantics is attributed currently. Can be null.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>name of the cache or null, implying that that the instance should not be cached.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/CacheDistributionPolicy.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/openjpa/datacache/AbstractQueryCache.EvictPolicy.html" title="enum in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/datacache/CacheDistributionPolicy.html" target="_top">Frames</a></li> |
| <li><a href="CacheDistributionPolicy.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2006–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
