org.apache.lucene.index.memory

Class MemoryIndex.MemoryIndexReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.LeafReader

org.apache.lucene.index.memory.MemoryIndex.MemoryIndexReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

MemoryIndex

private final class MemoryIndex.MemoryIndexReader
extends LeafReader

Search support for Lucene framework integration; implements all methods required by the Lucene IndexReader contracts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	MemoryIndex.MemoryIndexReader.MemoryFields
private class	MemoryIndex.MemoryIndexReader.MemoryIndexPointValues
private class	MemoryIndex.MemoryIndexReader.MemoryPostingsEnum
private class	MemoryIndex.MemoryIndexReader.MemoryTermsEnum

Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader

IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener

Field Summary

Fields

Modifier and Type	Field and Description
private FieldInfos	fieldInfos
private MemoryIndex.MemoryIndexReader.MemoryFields	memoryFields

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MemoryIndexReader()

Method Summary

Modifier and Type	Method and Description
void	checkIntegrity() Checks consistency of this reader.
protected void	doClose() Implements close.
void	document(int docID, StoredFieldVisitor visitor) Expert: visits the fields of a stored document, for custom processing/loading of each field.
BinaryDocValues	getBinaryDocValues(java.lang.String field) Returns BinaryDocValues for this field, or null if no binary doc values were indexed for this field.
IndexReader.CacheHelper	getCoreCacheHelper() Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this leaf regardless of deletions.
FieldInfos	getFieldInfos() Get the FieldInfos describing all fields in this reader.
private MemoryIndex.Info	getInfoForExpectedDocValuesType(java.lang.String fieldName, DocValuesType expectedType)
Bits	getLiveDocs() Returns the Bits representing live (not deleted) docs.
LeafMetaData	getMetaData() Return metadata about this leaf.
NumericDocValues	getNormValues(java.lang.String field) Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed.
NumericDocValues	getNumericDocValues(java.lang.String field) Returns NumericDocValues for this field, or null if no numeric doc values were indexed for this field.
PointValues	getPointValues(java.lang.String fieldName) Returns the PointValues used for numeric or spatial searches for the given field, or null if there are no point fields.
IndexReader.CacheHelper	getReaderCacheHelper() Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this reader.
SortedDocValues	getSortedDocValues(java.lang.String field) Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field.
private SortedDocValues	getSortedDocValues(java.lang.String field, DocValuesType docValuesType)
SortedNumericDocValues	getSortedNumericDocValues(java.lang.String field) Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field.
SortedSetDocValues	getSortedSetDocValues(java.lang.String field) Returns SortedSetDocValues for this field, or null if no SortedSetDocValues were indexed for this field.
Fields	getTermVectors(int docID) Retrieve term vectors for this document, or null if term vectors were not indexed.
int	maxDoc() Returns one greater than the largest possible document number.
int	numDocs() Returns the number of documents in this index.
Terms	terms(java.lang.String field) Returns the Terms index for this field, or null if it has none.

Methods inherited from class org.apache.lucene.index.LeafReader

docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, totalTermFreq

Methods inherited from class org.apache.lucene.index.IndexReader

close, decRef, document, document, ensureOpen, equals, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, numDeletedDocs, registerParentReader, tryIncRef

Methods inherited from class java.lang.Object

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

Field Detail

memoryFields

private final MemoryIndex.MemoryIndexReader.MemoryFields memoryFields

fieldInfos

private final FieldInfos fieldInfos

Constructor Detail

MemoryIndexReader

private MemoryIndexReader()

Method Detail

getInfoForExpectedDocValuesType

private MemoryIndex.Info getInfoForExpectedDocValuesType(java.lang.String fieldName,
                                                         DocValuesType expectedType)

getLiveDocs

public Bits getLiveDocs()

Description copied from class: LeafReader

Returns the Bits representing live (not deleted) docs. A set bit indicates the doc ID has not been deleted. If this method returns null it means there are no deleted documents (all documents are live). The returned instance has been safely published for use by multiple threads without additional synchronization.

Specified by:

getLiveDocs in class LeafReader

getFieldInfos

public FieldInfos getFieldInfos()

Description copied from class: LeafReader

Get the FieldInfos describing all fields in this reader. Note: Implementations should cache the FieldInfos instance returned by this method such that subsequent calls to this method return the same instance.

Specified by:

getFieldInfos in class LeafReader

getNumericDocValues

public NumericDocValues getNumericDocValues(java.lang.String field)
                                     throws java.io.IOException

Description copied from class: LeafReader

Returns NumericDocValues for this field, or null if no numeric doc values were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getNumericDocValues in class LeafReader

Throws:

java.io.IOException

getBinaryDocValues

public BinaryDocValues getBinaryDocValues(java.lang.String field)

Description copied from class: LeafReader

Returns BinaryDocValues for this field, or null if no binary doc values were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getBinaryDocValues in class LeafReader

getSortedDocValues

public SortedDocValues getSortedDocValues(java.lang.String field)

Description copied from class: LeafReader

Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getSortedDocValues in class LeafReader

getSortedDocValues

private SortedDocValues getSortedDocValues(java.lang.String field,
                                           DocValuesType docValuesType)

getSortedNumericDocValues

public SortedNumericDocValues getSortedNumericDocValues(java.lang.String field)

Description copied from class: LeafReader

Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getSortedNumericDocValues in class LeafReader

getSortedSetDocValues

public SortedSetDocValues getSortedSetDocValues(java.lang.String field)

Description copied from class: LeafReader

Returns SortedSetDocValues for this field, or null if no SortedSetDocValues were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getSortedSetDocValues in class LeafReader

getPointValues

public PointValues getPointValues(java.lang.String fieldName)

Description copied from class: LeafReader

Returns the PointValues used for numeric or spatial searches for the given field, or null if there are no point fields.

Specified by:

getPointValues in class LeafReader

checkIntegrity

public void checkIntegrity()
                    throws java.io.IOException

Description copied from class: LeafReader

Checks consistency of this reader.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Specified by:

checkIntegrity in class LeafReader

Throws:

java.io.IOException

terms

public Terms terms(java.lang.String field)
            throws java.io.IOException

Description copied from class: LeafReader

Returns the Terms index for this field, or null if it has none.

Specified by:

terms in class LeafReader

Throws:

java.io.IOException

getTermVectors

public Fields getTermVectors(int docID)

Description copied from class: IndexReader

Retrieve term vectors for this document, or null if term vectors were not indexed. The returned Fields instance acts like a single-document inverted index (the docID will be 0).

Specified by:

getTermVectors in class IndexReader

numDocs

public int numDocs()

Description copied from class: IndexReader

Returns the number of documents in this index.

NOTE: This operation may run in O(maxDoc). Implementations that can't return this number in constant-time should cache it.

Specified by:

numDocs in class IndexReader

maxDoc

public int maxDoc()

Description copied from class: IndexReader

Returns one greater than the largest possible document number. This may be used to, e.g., determine how big to allocate an array which will have an element for every document number in an index.

Specified by:

maxDoc in class IndexReader

document

public void document(int docID,
                     StoredFieldVisitor visitor)

Description copied from class: IndexReader

Expert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, use IndexReader.document(int). If you want to load a subset, use DocumentStoredFieldVisitor.

Specified by:

document in class IndexReader

doClose

protected void doClose()

Description copied from class: IndexReader

Implements close.

Specified by:

doClose in class IndexReader

getNormValues

public NumericDocValues getNormValues(java.lang.String field)

Description copied from class: LeafReader

Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed. The returned instance should only be used by a single thread.

Specified by:

getNormValues in class LeafReader

getMetaData

public LeafMetaData getMetaData()

Description copied from class: LeafReader

Return metadata about this leaf.

Specified by:

getMetaData in class LeafReader

getCoreCacheHelper

public IndexReader.CacheHelper getCoreCacheHelper()

Description copied from class: LeafReader

Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this leaf regardless of deletions. Two readers that have the same data but different sets of deleted documents or doc values updates may be considered equal. Consider using IndexReader.getReaderCacheHelper() if you need deletions or dv updates to be taken into account.

A return value of null indicates that this reader is not suited for caching, which is typically the case for short-lived wrappers that alter the content of the wrapped leaf reader.

Specified by:

getCoreCacheHelper in class LeafReader

getReaderCacheHelper

public IndexReader.CacheHelper getReaderCacheHelper()

Description copied from class: IndexReader

Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this reader. Two readers that have different data or different sets of deleted documents will be considered different.

A return value of null indicates that this reader is not suited for caching, which is typically the case for short-lived wrappers that alter the content of the wrapped reader.

Specified by:

getReaderCacheHelper in class IndexReader