Home » lucene-3.0.1-src » org.apache » lucene » util » [javadoc | source]
org.apache.lucene.util
public final class: FieldCacheSanityChecker [javadoc | source]
java.lang.Object
   org.apache.lucene.util.FieldCacheSanityChecker
Provides methods for sanity checking that entries in the FieldCache are not wasteful or inconsistent.

Lucene 2.9 Introduced numerous enhancements into how the FieldCache is used by the low levels of Lucene searching (for Sorting and ValueSourceQueries) to improve both the speed for Sorting, as well as reopening of IndexReaders. But these changes have shifted the usage of FieldCache from "top level" IndexReaders (frequently a MultiReader or DirectoryReader) down to the leaf level SegmentReaders. As a result, existing applications that directly access the FieldCache may find RAM usage increase significantly when upgrading to 2.9 or Later. This class provides an API for these applications (or their Unit tests) to check at run time if the FieldCache contains "insane" usages of the FieldCache.

EXPERIMENTAL API: This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of Lucene.

Nested Class Summary:
public static final class  FieldCacheSanityChecker.Insanity  Simple container for a collection of related CacheEntry objects that in conjunction with each other represent some "insane" usage of the FieldCache. 
public static final class  FieldCacheSanityChecker.InsanityType  An Enumeration of the different types of "insane" behavior that may be detected in a FieldCache. 
Constructor:
 public FieldCacheSanityChecker() 
Method from org.apache.lucene.util.FieldCacheSanityChecker Summary:
check,   checkSanity,   checkSanity,   setRamUsageEstimator
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.util.FieldCacheSanityChecker Detail:
 public Insanity[] check(CacheEntry cacheEntries) 
    Tests a CacheEntry[] for indication of "insane" cache usage.

    NOTE:FieldCache CreationPlaceholder objects are ignored. (:TODO: is this a bad idea? are we masking a real problem?)

 public static Insanity[] checkSanity(FieldCache cache) 
    Quick and dirty convenience method
 public static Insanity[] checkSanity(CacheEntry cacheEntries) 
    Quick and dirty convenience method that instantiates an instance with "good defaults" and uses it to test the CacheEntrys
 public  void setRamUsageEstimator(RamUsageEstimator r) 
    If set, will be used to estimate size for all CacheEntry objects dealt with.