Package org.apache.lucene.index

Class DocValuesLeafReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.LeafReader

org.apache.lucene.index.DocValuesLeafReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

abstract class DocValuesLeafReader
extends LeafReader

Nested Class Summary

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

IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener

Constructor Summary

Constructors

Constructor	Description
DocValuesLeafReader()

Method Summary

Modifier and Type	Method	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.
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.
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.
PointValues	getPointValues(java.lang.String field)	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.
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, getBinaryDocValues, getContext, getDocCount, getFieldInfos, getNumericDocValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, 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, notifyReaderClosedListeners, numDeletedDocs, registerParentReader, tryIncRef

Methods inherited from class java.lang.Object

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

Constructor Detail

DocValuesLeafReader

DocValuesLeafReader()

Method Detail

getCoreCacheHelper

public final 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

terms

public final 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

getNormValues

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

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

Throws:

java.io.IOException

getLiveDocs

public final 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

getPointValues

public final PointValues getPointValues(java.lang.String field)
                                 throws java.io.IOException

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

Throws:

java.io.IOException

checkIntegrity

public final 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

getMetaData

public final LeafMetaData getMetaData()

Description copied from class: LeafReader

Return metadata about this leaf.

Specified by:

getMetaData in class LeafReader

getTermVectors

public final Fields getTermVectors(int docID)
                            throws java.io.IOException

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

Throws:

java.io.IOException

numDocs

public final 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 final 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 final void document(int docID,
                           StoredFieldVisitor visitor)
                    throws java.io.IOException

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

Throws:

java.io.IOException

doClose

protected final void doClose()
                      throws java.io.IOException

Description copied from class: IndexReader

Implements close.

Specified by:

doClose in class IndexReader

Throws:

java.io.IOException

getReaderCacheHelper

public final 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