Class FilterLeafReader
- java.lang.Object
-
- org.apache.lucene.index.IndexReader
-
- org.apache.lucene.index.LeafReader
-
- org.apache.lucene.index.FilterLeafReader
-
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
ExitableDirectoryReader.ExitableFilterAtomicReader
public abstract class FilterLeafReader extends LeafReader
AFilterLeafReadercontains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The classFilterLeafReaderitself simply implements all abstract methods ofIndexReaderwith versions that pass all requests to the contained index reader. Subclasses ofFilterLeafReadermay further override some of these methods and may also provide additional methods and fields.NOTE: If you override
getLiveDocs(), you will likely need to overridenumDocs()as well and vice-versa.NOTE: If this
FilterLeafReaderdoes not change the content the contained reader, you could consider delegating calls toLeafReader.getCoreCacheHelper()andIndexReader.getReaderCacheHelper().
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFilterLeafReader.FilterFieldsBase class for filteringFieldsimplementations.static classFilterLeafReader.FilterPostingsEnumBase class for filteringPostingsEnumimplementations.static classFilterLeafReader.FilterTermsBase class for filteringTermsimplementations.static classFilterLeafReader.FilterTermsEnumBase class for filteringTermsEnumimplementations.-
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
-
-
Field Summary
Fields Modifier and Type Field Description protected LeafReaderinThe underlying LeafReader.
-
Constructor Summary
Constructors Modifier Constructor Description protectedFilterLeafReader(LeafReader in)Construct a FilterLeafReader based on the specified base reader.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcheckIntegrity()Checks consistency of this reader.protected voiddoClose()Implements close.voiddocument(int docID, StoredFieldVisitor visitor)Expert: visits the fields of a stored document, for custom processing/loading of each field.BinaryDocValuesgetBinaryDocValues(String field)ReturnsBinaryDocValuesfor this field, or null if no binary doc values were indexed for this field.ByteVectorValuesgetByteVectorValues(String field)ReturnsByteVectorValuesfor this field, or null if noByteVectorValueswere indexed.LeafReadergetDelegate()Returns the wrappedLeafReader.FieldInfosgetFieldInfos()Get theFieldInfosdescribing all fields in this reader.FloatVectorValuesgetFloatVectorValues(String field)ReturnsFloatVectorValuesfor this field, or null if noFloatVectorValueswere indexed.BitsgetLiveDocs()Returns theBitsrepresenting live (not deleted) docs.LeafMetaDatagetMetaData()Return metadata about this leaf.NumericDocValuesgetNormValues(String field)ReturnsNumericDocValuesrepresenting norms for this field, or null if noNumericDocValueswere indexed.NumericDocValuesgetNumericDocValues(String field)ReturnsNumericDocValuesfor this field, or null if no numeric doc values were indexed for this field.PointValuesgetPointValues(String field)Returns thePointValuesused for numeric or spatial searches for the given field, or null if there are no point fields.SortedDocValuesgetSortedDocValues(String field)ReturnsSortedDocValuesfor this field, or null if noSortedDocValueswere indexed for this field.SortedNumericDocValuesgetSortedNumericDocValues(String field)ReturnsSortedNumericDocValuesfor this field, or null if noSortedNumericDocValueswere indexed for this field.SortedSetDocValuesgetSortedSetDocValues(String field)ReturnsSortedSetDocValuesfor this field, or null if noSortedSetDocValueswere indexed for this field.FieldsgetTermVectors(int docID)Retrieve term vectors for this document, or null if term vectors were not indexed.intmaxDoc()Returns one greater than the largest possible document number.intnumDocs()Returns the number of documents in this index.voidsearchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.voidsearchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.StoredFieldsstoredFields()Returns aStoredFieldsreader for the stored fields of this index.Termsterms(String field)Returns theTermsindex for this field, or null if it has none.TermVectorstermVectors()Returns aTermVectorsreader for the term vectors of this index.StringtoString()static LeafReaderunwrap(LeafReader reader)Get the wrapped instance byreaderas long as this reader is an instance ofFilterLeafReader.-
Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getCoreCacheHelper, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, searchNearestVectors, searchNearestVectors, totalTermFreq
-
Methods inherited from class org.apache.lucene.index.IndexReader
close, decRef, document, document, ensureOpen, equals, getReaderCacheHelper, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, notifyReaderClosedListeners, numDeletedDocs, registerParentReader, tryIncRef
-
-
-
-
Field Detail
-
in
protected final LeafReader in
The underlying LeafReader.
-
-
Constructor Detail
-
FilterLeafReader
protected FilterLeafReader(LeafReader in)
Construct a FilterLeafReader based on the specified base reader.Note that base reader is closed if this FilterLeafReader is closed.
- Parameters:
in- specified base reader.
-
-
Method Detail
-
unwrap
public static LeafReader unwrap(LeafReader reader)
Get the wrapped instance byreaderas long as this reader is an instance ofFilterLeafReader.
-
getLiveDocs
public Bits getLiveDocs()
Description copied from class:LeafReaderReturns theBitsrepresenting 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:
getLiveDocsin classLeafReader
-
getFieldInfos
public FieldInfos getFieldInfos()
Description copied from class:LeafReaderGet theFieldInfosdescribing 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:
getFieldInfosin classLeafReader
-
getPointValues
public PointValues getPointValues(String field) throws IOException
Description copied from class:LeafReaderReturns thePointValuesused for numeric or spatial searches for the given field, or null if there are no point fields.- Specified by:
getPointValuesin classLeafReader- Throws:
IOException
-
getFloatVectorValues
public FloatVectorValues getFloatVectorValues(String field) throws IOException
Description copied from class:LeafReaderReturnsFloatVectorValuesfor this field, or null if noFloatVectorValueswere indexed. The returned instance should only be used by a single thread.- Specified by:
getFloatVectorValuesin classLeafReader- Throws:
IOException
-
getByteVectorValues
public ByteVectorValues getByteVectorValues(String field) throws IOException
Description copied from class:LeafReaderReturnsByteVectorValuesfor this field, or null if noByteVectorValueswere indexed. The returned instance should only be used by a single thread.- Specified by:
getByteVectorValuesin classLeafReader- Throws:
IOException
-
searchNearestVectors
public void searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs) throws IOException
Description copied from class:LeafReaderReturn the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function. The score of each document is derived from the vector similarity in a way that ensures scores are positive and that a larger score corresponds to a higher ranking.The search is allowed to be approximate, meaning the results are not guaranteed to be the true k closest neighbors. For large values of k (for example when k is close to the total number of documents), the search may also retrieve fewer than k documents.
The returned
TopDocswill contain aScoreDocfor each nearest neighbor, in order of their similarity to the query vector (decreasing scores). TheTotalHitscontains the number of documents visited during the search. If the search stopped early because it hitvisitedLimit, it is indicated through the relationTotalHits.Relation.GREATER_THAN_OR_EQUAL_TO.The behavior is undefined if the given field doesn't have KNN vectors enabled on its
FieldInfo. The return value is nevernull.- Specified by:
searchNearestVectorsin classLeafReader- Parameters:
field- the vector field to searchtarget- the vector-valued queryknnCollector- collector with settings for gathering the vector results.acceptDocs-Bitsthat represents the allowed documents to match, ornullif they are all allowed to match.- Throws:
IOException
-
searchNearestVectors
public void searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs) throws IOException
Description copied from class:LeafReaderReturn the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function. The score of each document is derived from the vector similarity in a way that ensures scores are positive and that a larger score corresponds to a higher ranking.The search is allowed to be approximate, meaning the results are not guaranteed to be the true k closest neighbors. For large values of k (for example when k is close to the total number of documents), the search may also retrieve fewer than k documents.
The returned
TopDocswill contain aScoreDocfor each nearest neighbor, in order of their similarity to the query vector (decreasing scores). TheTotalHitscontains the number of documents visited during the search. If the search stopped early because it hitvisitedLimit, it is indicated through the relationTotalHits.Relation.GREATER_THAN_OR_EQUAL_TO.The behavior is undefined if the given field doesn't have KNN vectors enabled on its
FieldInfo. The return value is nevernull.- Specified by:
searchNearestVectorsin classLeafReader- Parameters:
field- the vector field to searchtarget- the vector-valued queryknnCollector- collector with settings for gathering the vector results.acceptDocs-Bitsthat represents the allowed documents to match, ornullif they are all allowed to match.- Throws:
IOException
-
getTermVectors
public Fields getTermVectors(int docID) throws IOException
Description copied from class:IndexReaderRetrieve 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:
getTermVectorsin classIndexReader- Throws:
IOException
-
termVectors
public TermVectors termVectors() throws IOException
Description copied from class:IndexReaderReturns aTermVectorsreader for the term vectors of this index.This call never returns
null, even if no term vectors were indexed. The returned instance should only be used by a single thread.Example:
TopDocs hits = searcher.search(query, 10); TermVectors termVectors = reader.termVectors(); for (ScoreDoc hit : hits.scoreDocs) { Fields vector = termVectors.get(hit.doc); }- Specified by:
termVectorsin classIndexReader- Throws:
IOException- If there is a low-level IO error
-
numDocs
public int numDocs()
Description copied from class:IndexReaderReturns 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:
numDocsin classIndexReader
-
maxDoc
public int maxDoc()
Description copied from class:IndexReaderReturns 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:
maxDocin classIndexReader
-
storedFields
public StoredFields storedFields() throws IOException
Description copied from class:IndexReaderReturns aStoredFieldsreader for the stored fields of this index.This call never returns
null, even if no stored fields were indexed. The returned instance should only be used by a single thread.Example:
TopDocs hits = searcher.search(query, 10); StoredFields storedFields = reader.storedFields(); for (ScoreDoc hit : hits.scoreDocs) { Document doc = storedFields.document(hit.doc); }- Specified by:
storedFieldsin classIndexReader- Throws:
IOException- If there is a low-level IO error
-
document
public void document(int docID, StoredFieldVisitor visitor) throws IOExceptionDescription copied from class:IndexReaderExpert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, useIndexReader.document(int). If you want to load a subset, useDocumentStoredFieldVisitor.- Specified by:
documentin classIndexReader- Throws:
IOException
-
doClose
protected void doClose() throws IOExceptionDescription copied from class:IndexReaderImplements close.- Specified by:
doClosein classIndexReader- Throws:
IOException
-
terms
public Terms terms(String field) throws IOException
Description copied from class:LeafReaderReturns theTermsindex for this field, or null if it has none.- Specified by:
termsin classLeafReader- Throws:
IOException
-
getNumericDocValues
public NumericDocValues getNumericDocValues(String field) throws IOException
Description copied from class:LeafReaderReturnsNumericDocValuesfor 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:
getNumericDocValuesin classLeafReader- Throws:
IOException
-
getBinaryDocValues
public BinaryDocValues getBinaryDocValues(String field) throws IOException
Description copied from class:LeafReaderReturnsBinaryDocValuesfor 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:
getBinaryDocValuesin classLeafReader- Throws:
IOException
-
getSortedDocValues
public SortedDocValues getSortedDocValues(String field) throws IOException
Description copied from class:LeafReaderReturnsSortedDocValuesfor this field, or null if noSortedDocValueswere indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedDocValuesin classLeafReader- Throws:
IOException
-
getSortedNumericDocValues
public SortedNumericDocValues getSortedNumericDocValues(String field) throws IOException
Description copied from class:LeafReaderReturnsSortedNumericDocValuesfor this field, or null if noSortedNumericDocValueswere indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedNumericDocValuesin classLeafReader- Throws:
IOException
-
getSortedSetDocValues
public SortedSetDocValues getSortedSetDocValues(String field) throws IOException
Description copied from class:LeafReaderReturnsSortedSetDocValuesfor this field, or null if noSortedSetDocValueswere indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedSetDocValuesin classLeafReader- Throws:
IOException
-
getNormValues
public NumericDocValues getNormValues(String field) throws IOException
Description copied from class:LeafReaderReturnsNumericDocValuesrepresenting norms for this field, or null if noNumericDocValueswere indexed. The returned instance should only be used by a single thread.- Specified by:
getNormValuesin classLeafReader- Throws:
IOException
-
getMetaData
public LeafMetaData getMetaData()
Description copied from class:LeafReaderReturn metadata about this leaf.- Specified by:
getMetaDatain classLeafReader
-
checkIntegrity
public void checkIntegrity() throws IOExceptionDescription copied from class:LeafReaderChecks 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:
checkIntegrityin classLeafReader- Throws:
IOException
-
getDelegate
public LeafReader getDelegate()
Returns the wrappedLeafReader.
-
-