Interface IFieldCache
Expert: Maintains caches of term values.
Created: May 19, 2004 11:13:14 AM
@lucene.internal
@since lucene 1.4
Assembly: DistributedLucene.Net.dll
Syntax
public interface IFieldCache
Properties
Name | Description |
---|---|
InfoStream | If non-null, Lucene.Net.Search.FieldCacheImpl will warn whenever entries are created that are not sane according to FieldCacheSanityChecker. |
Methods
Name | Description |
---|---|
GetBytes(AtomicReader, String, FieldCache.IByteParser, Boolean) | Checks the internal cache for an appropriate entry, and if none is found,
reads the terms in |
GetBytes(AtomicReader, String, Boolean) | Checks the internal cache for an appropriate entry, and if none is
found, reads the terms in |
GetCacheEntries() | EXPERT: Generates an array of FieldCache.CacheEntry objects representing all items currently in the IFieldCache.
NOTE: These FieldCache.CacheEntry objects maintain a strong reference to the
Cached Values. Maintaining references to a FieldCache.CacheEntry the AtomicReader
associated with it has garbage collected will prevent the Value itself
from being garbage collected when the Cache drops the |
GetDocsWithField(AtomicReader, String) | Checks the internal cache for an appropriate entry, and if none is found,
reads the terms in |
GetDocTermOrds(AtomicReader, String) | Checks the internal cache for an appropriate entry, and if none is found, reads the term values
in |
GetDoubles(AtomicReader, String, FieldCache.IDoubleParser, Boolean) | Returns a FieldCache.Doubles over the values found in documents in the given
field. If the field was indexed as NumericDocValuesField, it simply
uses GetNumericDocValues(String) to read the values.
Otherwise, it checks the internal cache for an appropriate entry, and if
none is found, reads the terms in |
GetDoubles(AtomicReader, String, Boolean) | Returns a FieldCache.Doubles over the values found in documents in the given field. |
GetInt16s(AtomicReader, String, FieldCache.IInt16Parser, Boolean) | Checks the internal cache for an appropriate entry, and if none is found,
reads the terms in NOTE: this was getShorts() in Lucene |
GetInt16s(AtomicReader, String, Boolean) | Checks the internal cache for an appropriate entry, and if none is
found, reads the terms in NOTE: this was getShorts() in Lucene |
GetInt32s(AtomicReader, String, FieldCache.IInt32Parser, Boolean) | Returns an FieldCache.Int32s over the values found in documents in the given
field. If the field was indexed as NumericDocValuesField, it simply
uses GetNumericDocValues(String) to read the values.
Otherwise, it checks the internal cache for an appropriate entry, and if
none is found, reads the terms in NOTE: this was getInts() in Lucene |
GetInt32s(AtomicReader, String, Boolean) | Returns an FieldCache.Int32s over the values found in documents in the given field. NOTE: this was getInts() in Lucene |
GetInt64s(AtomicReader, String, FieldCache.IInt64Parser, Boolean) | Returns a FieldCache.Int64s over the values found in documents in the given
field. If the field was indexed as NumericDocValuesField, it simply
uses GetNumericDocValues(String) to read the values.
Otherwise, it checks the internal cache for an appropriate entry, and if
none is found, reads the terms in NOTE: this was getLongs() in Lucene |
GetInt64s(AtomicReader, String, Boolean) | Returns a FieldCache.Int64s over the values found in documents in the given field. NOTE: this was getLongs() in Lucene |
GetSingles(AtomicReader, String, FieldCache.ISingleParser, Boolean) | Returns a FieldCache.Singles over the values found in documents in the given
field. If the field was indexed as NumericDocValuesField, it simply
uses GetNumericDocValues(String) to read the values.
Otherwise, it checks the internal cache for an appropriate entry, and if
none is found, reads the terms in NOTE: this was getFloats() in Lucene |
GetSingles(AtomicReader, String, Boolean) | Returns a FieldCache.Singles over the values found in documents in the given field. NOTE: this was getFloats() in Lucene |
GetTerms(AtomicReader, String, Boolean) | Checks the internal cache for an appropriate entry, and if none
is found, reads the term values in |
GetTerms(AtomicReader, String, Boolean, Single) | Expert: just like GetTerms(AtomicReader, String, Boolean), but you can specify whether more RAM should be consumed in exchange for faster lookups (default is "true"). Note that the first call for a given reader and field "wins", subsequent calls will share the same cache entry. |
GetTermsIndex(AtomicReader, String) | Checks the internal cache for an appropriate entry, and if none
is found, reads the term values in |
GetTermsIndex(AtomicReader, String, Single) | Expert: just like GetTermsIndex(AtomicReader, String), but you can specify whether more RAM should be consumed in exchange for faster lookups (default is "true"). Note that the first call for a given reader and field "wins", subsequent calls will share the same cache entry. |
PurgeAllCaches() |
EXPERT: Instructs the FieldCache to forcibly expunge all entries
from the underlying caches. This is intended only to be used for
test methods as a way to ensure a known base state of the Cache
(with out needing to rely on GC to free |
PurgeByCacheKey(Object) | Expert: drops all cache entries associated with this reader CoreCacheKey. NOTE: this cache key must precisely match the reader that the cache entry is keyed on. If you pass a top-level reader, it usually will have no effect as Lucene now caches at the segment reader level. |