org.apache.lucene.uninverting

Class FieldCacheImpl

java.lang.Object

org.apache.lucene.uninverting.FieldCacheImpl

All Implemented Interfaces:

FieldCache

class FieldCacheImpl
extends java.lang.Object
implements FieldCache

Expert: The default cache implementation, storing all values in memory. A WeakHashMap is used for storage.

Since:

lucene 1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	FieldCacheImpl.BinaryDocValuesCache
private static class	FieldCacheImpl.BinaryDocValuesImpl
(package private) static class	FieldCacheImpl.BitsEntry
(package private) static class	FieldCacheImpl.Cache Expert: Internal cache.
(package private) static class	FieldCacheImpl.CacheKey Expert: Every composite-key in the internal cache is of this type.
(package private) static class	FieldCacheImpl.DocsWithFieldCache
(package private) static class	FieldCacheImpl.DocTermOrdsCache
private static class	FieldCacheImpl.GrowableWriterAndMinValue
private static class	FieldCacheImpl.HoldsOneThing<T>
(package private) static class	FieldCacheImpl.LongCache
(package private) static class	FieldCacheImpl.LongsFromArray
(package private) static class	FieldCacheImpl.SortedDocValuesCache
static class	FieldCacheImpl.SortedDocValuesImpl
private static class	FieldCacheImpl.Uninvert

Nested classes/interfaces inherited from interface org.apache.lucene.uninverting.FieldCache

FieldCache.CacheEntry, FieldCache.CreationPlaceholder, FieldCache.Parser, FieldCache.PointParser

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.Class<?>,FieldCacheImpl.Cache>	caches
private java.io.PrintStream	infoStream
(package private) LeafReader.CoreClosedListener	purgeCore

Fields inherited from interface org.apache.lucene.uninverting.FieldCache

DEFAULT, DOUBLE_POINT_PARSER, FLOAT_POINT_PARSER, INT_POINT_PARSER, INT32_TERM_PREFIX, INT64_TERM_PREFIX, LEGACY_DOUBLE_PARSER, LEGACY_FLOAT_PARSER, LEGACY_INT_PARSER, LEGACY_LONG_PARSER, LONG_POINT_PARSER

Constructor Summary

Constructors

Constructor and Description
FieldCacheImpl()

Method Summary

Modifier and Type	Method and Description
FieldCache.CacheEntry[]	getCacheEntries() EXPERT: Generates an array of CacheEntry objects representing all items currently in the FieldCache.
Bits	getDocsWithField(LeafReader reader, java.lang.String field, FieldCache.Parser parser) Checks the internal cache for an appropriate entry, and if none is found, reads the terms/points in field and returns a bit set at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field.
SortedSetDocValues	getDocTermOrds(LeafReader reader, java.lang.String field, BytesRef prefix) Checks the internal cache for an appropriate entry, and if none is found, reads the term values in field and returns a DocTermOrds instance, providing a method to retrieve the terms (as ords) per document.
java.io.PrintStream	getInfoStream() counterpart of FieldCache.setInfoStream(PrintStream)
NumericDocValues	getNumerics(LeafReader reader, java.lang.String field, FieldCache.Parser parser, boolean setDocsWithField) Returns a NumericDocValues over the values found in documents in the given field.
BinaryDocValues	getTerms(LeafReader reader, java.lang.String field, boolean setDocsWithField) Checks the internal cache for an appropriate entry, and if none is found, reads the term values in field and returns a BinaryDocValues instance, providing a method to retrieve the term (as a BytesRef) per document.
BinaryDocValues	getTerms(LeafReader reader, java.lang.String field, boolean setDocsWithField, float acceptableOverheadRatio) Expert: just like FieldCache.getTerms(org.apache.lucene.index.LeafReader,String,boolean), but you can specify whether more RAM should be consumed in exchange for faster lookups (default is "true").
SortedDocValues	getTermsIndex(LeafReader reader, java.lang.String field) Checks the internal cache for an appropriate entry, and if none is found, reads the term values in field and returns a SortedDocValues instance, providing methods to retrieve sort ordinals and terms (as a ByteRef) per document.
SortedDocValues	getTermsIndex(LeafReader reader, java.lang.String field, float acceptableOverheadRatio) Expert: just like FieldCache.getTermsIndex(org.apache.lucene.index.LeafReader,String), but you can specify whether more RAM should be consumed in exchange for faster lookups (default is "true").
private void	init()
private void	initReader(LeafReader reader)
void	purgeAllCaches() EXPERT: Instructs the FieldCache to forcibly expunge all entries from the underlying caches.
void	purgeByCacheKey(java.lang.Object coreCacheKey) Expert: drops all cache entries associated with this reader IndexReader.getCoreCacheKey().
(package private) void	setDocsWithField(LeafReader reader, java.lang.String field, Bits docsWithField, FieldCache.Parser parser)
void	setInfoStream(java.io.PrintStream stream) If non-null, FieldCacheImpl will warn whenever entries are created that are not sane according to FieldCacheSanityChecker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

caches

private java.util.Map<java.lang.Class<?>,FieldCacheImpl.Cache> caches

purgeCore

final LeafReader.CoreClosedListener purgeCore

infoStream

private volatile java.io.PrintStream infoStream

Constructor Detail

FieldCacheImpl

FieldCacheImpl()

Method Detail

init

private void init()

purgeAllCaches

public void purgeAllCaches()

Description copied from interface: FieldCache

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 WeakReferences). It should not be relied on for "Cache maintenance" in general application code.

Specified by:

purgeAllCaches in interface FieldCache

purgeByCacheKey

public void purgeByCacheKey(java.lang.Object coreCacheKey)

Description copied from interface: FieldCache

Expert: drops all cache entries associated with this reader IndexReader.getCoreCacheKey(). 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.

Specified by:

purgeByCacheKey in interface FieldCache

getCacheEntries

public FieldCache.CacheEntry[] getCacheEntries()

Description copied from interface: FieldCache

EXPERT: Generates an array of CacheEntry objects representing all items currently in the FieldCache.

NOTE: These CacheEntry objects maintain a strong reference to the Cached Values. Maintaining references to a CacheEntry the AtomicIndexReader associated with it has garbage collected will prevent the Value itself from being garbage collected when the Cache drops the WeakReference.

Specified by:

getCacheEntries in interface FieldCache

initReader

private void initReader(LeafReader reader)

setDocsWithField

void setDocsWithField(LeafReader reader,
                      java.lang.String field,
                      Bits docsWithField,
                      FieldCache.Parser parser)

getDocsWithField

public Bits getDocsWithField(LeafReader reader,
                             java.lang.String field,
                             FieldCache.Parser parser)
                      throws java.io.IOException

Description copied from interface: FieldCache

Checks the internal cache for an appropriate entry, and if none is found, reads the terms/points in field and returns a bit set at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field.

Specified by:

getDocsWithField in interface FieldCache

parser - May be null if coming from the inverted index, otherwise can be a FieldCache.PointParser to compute from point values.

Throws:

java.io.IOException

getNumerics

public NumericDocValues getNumerics(LeafReader reader,
                                    java.lang.String field,
                                    FieldCache.Parser parser,
                                    boolean setDocsWithField)
                             throws java.io.IOException

Description copied from interface: FieldCache

Returns a NumericDocValues over the values found in documents in the given field. If the field was indexed as NumericDocValuesField, it simply uses LeafReader.getNumericDocValues(String) to read the values. Otherwise, it checks the internal cache for an appropriate entry, and if none is found, reads the terms/points in field as longs and returns an array of size reader.maxDoc() of the value each document has in the given field.

Specified by:

getNumerics in interface FieldCache

Parameters:

reader - Used to get field values.

field - Which field contains the longs.

parser - Computes long for string values. May be null if the requested field was indexed as NumericDocValuesField or LegacyLongField.

setDocsWithField - If true then FieldCache.getDocsWithField(org.apache.lucene.index.LeafReader, java.lang.String, org.apache.lucene.uninverting.FieldCache.Parser) will also be computed and stored in the FieldCache.

Returns:

The values in the given field for each document.

Throws:

java.io.IOException - If any error occurs.

getTermsIndex

public SortedDocValues getTermsIndex(LeafReader reader,
                                     java.lang.String field)
                              throws java.io.IOException

Description copied from interface: FieldCache

Checks the internal cache for an appropriate entry, and if none is found, reads the term values in field and returns a SortedDocValues instance, providing methods to retrieve sort ordinals and terms (as a ByteRef) per document.

Specified by:

getTermsIndex in interface FieldCache

Parameters:

reader - Used to get field values.

field - Which field contains the strings.

Returns:

The values in the given field for each document.

Throws:

java.io.IOException - If any error occurs.

getTermsIndex

public SortedDocValues getTermsIndex(LeafReader reader,
                                     java.lang.String field,
                                     float acceptableOverheadRatio)
                              throws java.io.IOException

Description copied from interface: FieldCache

Expert: just like FieldCache.getTermsIndex(org.apache.lucene.index.LeafReader,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.

Specified by:

getTermsIndex in interface FieldCache

Throws:

java.io.IOException

getTerms

public BinaryDocValues getTerms(LeafReader reader,
                                java.lang.String field,
                                boolean setDocsWithField)
                         throws java.io.IOException

Description copied from interface: FieldCache

Checks the internal cache for an appropriate entry, and if none is found, reads the term values in field and returns a BinaryDocValues instance, providing a method to retrieve the term (as a BytesRef) per document.

Specified by:

getTerms in interface FieldCache

Parameters:

reader - Used to get field values.

field - Which field contains the strings.

setDocsWithField - If true then FieldCache.getDocsWithField(org.apache.lucene.index.LeafReader, java.lang.String, org.apache.lucene.uninverting.FieldCache.Parser) will also be computed and stored in the FieldCache.

Returns:

The values in the given field for each document.

Throws:

java.io.IOException - If any error occurs.

getTerms

public BinaryDocValues getTerms(LeafReader reader,
                                java.lang.String field,
                                boolean setDocsWithField,
                                float acceptableOverheadRatio)
                         throws java.io.IOException

Description copied from interface: FieldCache

Expert: just like FieldCache.getTerms(org.apache.lucene.index.LeafReader,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.

Specified by:

getTerms in interface FieldCache

Throws:

java.io.IOException

getDocTermOrds

public SortedSetDocValues getDocTermOrds(LeafReader reader,
                                         java.lang.String field,
                                         BytesRef prefix)
                                  throws java.io.IOException

Description copied from interface: FieldCache

Checks the internal cache for an appropriate entry, and if none is found, reads the term values in field and returns a DocTermOrds instance, providing a method to retrieve the terms (as ords) per document.

Specified by:

getDocTermOrds in interface FieldCache

Parameters:

reader - Used to build a DocTermOrds instance

field - Which field contains the strings.

prefix - prefix for a subset of the terms which should be uninverted. Can be null or FieldCache.INT32_TERM_PREFIX or FieldCache.INT64_TERM_PREFIX

Returns:

a DocTermOrds instance

Throws:

java.io.IOException - If any error occurs.

setInfoStream

public void setInfoStream(java.io.PrintStream stream)

Description copied from interface: FieldCache

If non-null, FieldCacheImpl will warn whenever entries are created that are not sane according to FieldCacheSanityChecker.

Specified by:

setInfoStream in interface FieldCache

getInfoStream

public java.io.PrintStream getInfoStream()

Description copied from interface: FieldCache

counterpart of FieldCache.setInfoStream(PrintStream)

Specified by:

getInfoStream in interface FieldCache