openjpa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mik...@apache.org
Subject svn commit: r905842 - in /openjpa/branches/1.0.x: ./ openjpa-kernel/src/main/java/org/apache/openjpa/datacache/ openjpa-kernel/src/main/java/org/apache/openjpa/meta/ openjpa-persistence/src/main/java/org/apache/openjpa/persistence/
Date Tue, 02 Feb 2010 23:52:59 GMT
Author: mikedd
Date: Tue Feb  2 23:52:58 2010
New Revision: 905842

URL: http://svn.apache.org/viewvc?rev=905842&view=rev
Log:
OPENJPA-1328:
Check cacheability in ClassMetaData instead of AbstractDataCache.
Based on patch for 1.2.x by Jody Grassel

Modified:
    openjpa/branches/1.0.x/   (props changed)
    openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/datacache/AbstractDataCache.java
    openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ClassMetaData.java
    openjpa/branches/1.0.x/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/AnnotationPersistenceMetaDataParser.java

Propchange: openjpa/branches/1.0.x/
------------------------------------------------------------------------------
    svn:mergeinfo = /openjpa/branches/1.2.x:821449

Modified: openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/datacache/AbstractDataCache.java
URL: http://svn.apache.org/viewvc/openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/datacache/AbstractDataCache.java?rev=905842&r1=905841&r2=905842&view=diff
==============================================================================
--- openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/datacache/AbstractDataCache.java
(original)
+++ openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/datacache/AbstractDataCache.java
Tue Feb  2 23:52:58 2010
@@ -489,42 +489,4 @@
             StringUtils.isEmpty(types) ? null : new HashSet(Arrays
                 .asList(Strings.split(types, ";", 0)));
     }
-
-    /**
-     * Determine whether a provided class can be applied to this cache.
-     * 
-     * <P>
-     * The algorithm used to determine which types apply is as follows:
-     * <UL>
-     * <LI>If neither included nor excluded types are found all types will be
-     * used.</LI>
-     * <LI>If included types are specified and excluded types are not specified
-     * <b>only</b> the included types will be used.</LI>
-     * <LI>If included types are not specified and excluded types are specified
-     * all types will be used <b>except</b> those which are explicitly excluded.
-     * </LI>
-     * <LI>If both included types and excluded types are specified then
-     * <b>only</b> the included types will be used. If an included type is also
-     * an excluded type the <b>excluded</b> setting will take precedence (ie

-     * the type will not be used).</LI>
-     * </UL>
-     * 
-     * @param className
-     *            A class which may be used by this plugin.
-     * @return True if the type should be used, otherwise false.
-     */
-    public boolean isCacheableType(String classname) {
-        boolean rval = true;
-        if (_includedTypes != null && ! _includedTypes.isEmpty()) { 
-            if(!_includedTypes.contains(classname)) {
-                rval = false;
-            }
-        }
-        if (_excludedTypes != null && ! _excludedTypes.isEmpty()) { 
-            if(_excludedTypes.contains(classname)) {
-                rval = false;
-            }
-        }
-        return rval;
-    }
 }

Modified: openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ClassMetaData.java
URL: http://svn.apache.org/viewvc/openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ClassMetaData.java?rev=905842&r1=905841&r2=905842&view=diff
==============================================================================
--- openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ClassMetaData.java
(original)
+++ openjpa/branches/1.0.x/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ClassMetaData.java
Tue Feb  2 23:52:58 2010
@@ -37,7 +37,6 @@
 
 import org.apache.commons.lang.StringUtils;
 import org.apache.openjpa.conf.OpenJPAConfiguration;
-import org.apache.openjpa.datacache.AbstractDataCache;
 import org.apache.openjpa.datacache.DataCache;
 import org.apache.openjpa.enhance.PCRegistry;
 import org.apache.openjpa.enhance.Reflection;
@@ -46,6 +45,7 @@
 import org.apache.openjpa.lib.meta.SourceTracker;
 import org.apache.openjpa.lib.util.J2DoPrivHelper;
 import org.apache.openjpa.lib.util.Localizer;
+import org.apache.openjpa.lib.util.Options;
 import org.apache.openjpa.lib.xml.Commentable;
 import org.apache.openjpa.util.BigDecimalId;
 import org.apache.openjpa.util.BigIntegerId;
@@ -67,6 +67,8 @@
 import org.apache.openjpa.util.ImplHelper;
 import serp.util.Strings;
 
+import org.apache.openjpa.lib.conf.Configurations;
+
 /**
  * Contains metadata about a persistent type.
  * This metadata is available both at enhancement time and runtime.
@@ -190,6 +192,8 @@
     private FetchGroup[] _customFGs = null;
     private boolean _intercepting = false;
 
+    private Boolean _isCacheable = null; 
+
     /**
      * Constructor. Supply described type and repository.
      */
@@ -1342,7 +1346,7 @@
             else {
                 _cacheName = DataCache.NAME_DEFAULT;
             }
-            if(!isCacheable(_cacheName)) { 
+            if(!isCacheable()) { 
                _cacheName = null; 
             }
         }
@@ -2363,16 +2367,93 @@
      * 
      * @return true if the DataCache will accept this type, otherwise false.
      */
-    private boolean isCacheable(String candidateCacheName) {
-        boolean rval = true;
-        DataCache cache =
-            getRepository().getConfiguration().getDataCacheManagerInstance()
-                .getDataCache(candidateCacheName);
-        if (cache != null && (cache instanceof AbstractDataCache)) {
-            AbstractDataCache adc = (AbstractDataCache) cache;
-            if (!adc.isCacheableType(getDescribedType().getName()))
-                rval = false;
+    private boolean isCacheable() {
+        if (_isCacheable != null) {
+            return _isCacheable.booleanValue();
         }
-        return rval;
+        setIsCacheable(true, false);
+        return _isCacheable.booleanValue();
+    }
+    
+    /**
+     * <p>
+     * Set whether or not the class represented by this ClassMetaData object should be included
in the datacache. The
+     * arguments provided are *hints* as to whether the class should be included in the datacache,
and can be overridden
+     * by the configuration set in openjpa.Datacache.
+     * </p>
+     * 
+     * <p>
+     * Rules for this determination are:
+     * </p>
+     * <ol>
+     * <li>If the class shows up in the list of excluded types, it does not get cached,
period.</li>
+     * <li>If the class does not show up in the excluded types, but the included types
field is set (ie, has at least
+     * one class), then:
+     * <ol>
+     * <li>If the class is listed in the include list, then it gets cached</li>
+     * <li>If the class is set as cacheable by the @Datacache annotation, it gets cached</li>
+     * <li>If neither a or b are true, then the class does not get cached</li>
+     * </ol>
+     * </li>
+     * <li>If neither the include or exclude lists are defined, then go along with
the value passed into the argument,
+     * which is either the default value (true) or whatever was set with the @Datacache annotation</li>
+     * </ol>
+     * 
+     * @param isCacheable
+     *            Hint whether this class should be included in the datacache. Default behavior
is yes, though the
+     *            @Datacache annotation can specify if it should not be cached.
+     * @param annotationOverride
+     *            Whether this hint originated from the @Datacache annotation or whether
this is the default "yes" hint.
+     *            The origination of the hint influences the decision making process in rule
#2b.
+     * 
+     */
+    public void setIsCacheable(boolean isCacheable, boolean annotationOverride) {
+       Options dataCacheOptions = getDataCacheOptions();
+       Set excludedTypes = extractDataCacheClassListing(dataCacheOptions.getProperty("ExcludedTypes",
null));
+       Set types = extractDataCacheClassListing(dataCacheOptions.getProperty("Types", null));
+       
+       String className = getDescribedType().getName();
+       if (excludedTypes != null && excludedTypes.contains(className)) {
+           // Rule #1
+           _isCacheable = Boolean.FALSE;
+       } else if (types != null) {
+           // Rule #2
+           if ((annotationOverride && isCacheable) || (types.contains(className)))
{
+               _isCacheable = Boolean.TRUE;
+           } else {
+               _isCacheable = Boolean.FALSE;
+           }
+       } else {
+           // Rule #3
+           _isCacheable = isCacheable ? Boolean.TRUE : Boolean.FALSE;
+       }
+    }
+    
+    /**
+     * Extract all of the DataCache plugin options from the configuration
+     * 
+     */
+    private Options getDataCacheOptions() {
+       String dataCacheConfig = getRepository().getConfiguration().getDataCache();
+        Options dataCacheOptions = Configurations.parseProperties(Configurations.getProperties(dataCacheConfig));
+        return dataCacheOptions;
+    }
+    
+    /**
+     * Tool to extract classes defined in the datacache include and exclude list into
+     * individual entries in a Set.
+     * 
+     */
+    private final Set extractDataCacheClassListing(String classList) {
+       if (classList == null || classList.length() == 0) {
+           return null;
+       }
+       
+       HashSet returnSet = new HashSet();
+       String[] entries = classList.split(";");
+       for (int index = 0; index < entries.length; index++) {
+           returnSet.add(entries[index]);
+       }
+       return returnSet;
     }
 }

Modified: openjpa/branches/1.0.x/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/AnnotationPersistenceMetaDataParser.java
URL: http://svn.apache.org/viewvc/openjpa/branches/1.0.x/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/AnnotationPersistenceMetaDataParser.java?rev=905842&r1=905841&r2=905842&view=diff
==============================================================================
--- openjpa/branches/1.0.x/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/AnnotationPersistenceMetaDataParser.java
(original)
+++ openjpa/branches/1.0.x/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/AnnotationPersistenceMetaDataParser.java
Tue Feb  2 23:52:58 2010
@@ -748,6 +748,8 @@
                 org.apache.openjpa.datacache.DataCache.NAME_DEFAULT);
         else
             meta.setDataCacheName(null);
+        
+        meta.setIsCacheable(cache.enabled(), true);
     }
 
     /**



Mime
View raw message