Class FilterLeafReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
ExitableDirectoryReader.ExitableFilterAtomicReader
FilterLeafReader
contains another LeafReader, which it uses as its basic source of
data, possibly transforming the data along the way or providing additional functionality. The
class FilterLeafReader
itself simply implements all abstract methods of
IndexReader
with versions that pass all requests to the contained index reader. Subclasses
of FilterLeafReader
may further override some of these methods and may also provide
additional methods and fields.
NOTE: If you override getLiveDocs()
, you will likely need to override numDocs()
as well and vice-versa.
NOTE: If this FilterLeafReader
does not change the content the contained
reader, you could consider delegating calls to LeafReader.getCoreCacheHelper()
and IndexReader.getReaderCacheHelper()
.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Base class for filteringFields
implementations.static class
Base class for filteringPostingsEnum
implementations.static class
Base class for filteringTerms
implementations.static class
Base class for filteringTermsEnum
implementations.Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
Construct a FilterLeafReader based on the specified base reader. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.getBinaryDocValues
(String field) ReturnsBinaryDocValues
for this field, or null if no binary doc values were indexed for this field.getByteVectorValues
(String field) ReturnsByteVectorValues
for this field, or null if noByteVectorValues
were indexed.Returns the wrappedLeafReader
.Get theFieldInfos
describing all fields in this reader.getFloatVectorValues
(String field) ReturnsFloatVectorValues
for this field, or null if noFloatVectorValues
were indexed.Returns theBits
representing live (not deleted) docs.Return metadata about this leaf.getNormValues
(String field) ReturnsNumericDocValues
representing norms for this field, or null if noNumericDocValues
were indexed.getNumericDocValues
(String field) ReturnsNumericDocValues
for this field, or null if no numeric doc values were indexed for this field.getPointValues
(String field) Returns thePointValues
used for numeric or spatial searches for the given field, or null if there are no point fields.getSortedDocValues
(String field) ReturnsSortedDocValues
for this field, or null if noSortedDocValues
were indexed for this field.getSortedNumericDocValues
(String field) ReturnsSortedNumericDocValues
for this field, or null if noSortedNumericDocValues
were indexed for this field.getSortedSetDocValues
(String field) ReturnsSortedSetDocValues
for this field, or null if noSortedSetDocValues
were indexed for this field.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.void
searchNearestVectors
(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.void
searchNearestVectors
(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.Returns aStoredFields
reader for the stored fields of this index.Returns theTerms
index for this field, or null if it has none.Returns aTermVectors
reader for the term vectors of this index.toString()
static LeafReader
unwrap
(LeafReader reader) Get the wrapped instance byreader
as 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 Details
-
in
The underlying LeafReader.
-
-
Constructor Details
-
FilterLeafReader
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 Details
-
unwrap
Get the wrapped instance byreader
as long as this reader is an instance ofFilterLeafReader
. -
getLiveDocs
Description copied from class:LeafReader
Returns theBits
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 classLeafReader
-
getFieldInfos
Description copied from class:LeafReader
Get theFieldInfos
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 classLeafReader
-
getPointValues
Description copied from class:LeafReader
Returns thePointValues
used for numeric or spatial searches for the given field, or null if there are no point fields.- Specified by:
getPointValues
in classLeafReader
- Throws:
IOException
-
getFloatVectorValues
Description copied from class:LeafReader
ReturnsFloatVectorValues
for this field, or null if noFloatVectorValues
were indexed. The returned instance should only be used by a single thread.- Specified by:
getFloatVectorValues
in classLeafReader
- Throws:
IOException
-
getByteVectorValues
Description copied from class:LeafReader
ReturnsByteVectorValues
for this field, or null if noByteVectorValues
were indexed. The returned instance should only be used by a single thread.- Specified by:
getByteVectorValues
in classLeafReader
- Throws:
IOException
-
searchNearestVectors
public void searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs) throws IOException Description copied from class:LeafReader
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. 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
TopDocs
will contain aScoreDoc
for each nearest neighbor, in order of their similarity to the query vector (decreasing scores). TheTotalHits
contains 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:
searchNearestVectors
in classLeafReader
- Parameters:
field
- the vector field to searchtarget
- the vector-valued queryknnCollector
- collector with settings for gathering the vector results.acceptDocs
-Bits
that represents the allowed documents to match, ornull
if 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:LeafReader
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. 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
TopDocs
will contain aScoreDoc
for each nearest neighbor, in order of their similarity to the query vector (decreasing scores). TheTotalHits
contains 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:
searchNearestVectors
in classLeafReader
- Parameters:
field
- the vector field to searchtarget
- the vector-valued queryknnCollector
- collector with settings for gathering the vector results.acceptDocs
-Bits
that represents the allowed documents to match, ornull
if they are all allowed to match.- Throws:
IOException
-
getTermVectors
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 classIndexReader
- Throws:
IOException
-
termVectors
Description copied from class:IndexReader
Returns aTermVectors
reader 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:
termVectors
in classIndexReader
- Throws:
IOException
- If there is a low-level IO error
-
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 classIndexReader
-
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 classIndexReader
-
storedFields
Description copied from class:IndexReader
Returns aStoredFields
reader 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:
storedFields
in classIndexReader
- Throws:
IOException
- If there is a low-level IO error
-
document
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, useIndexReader.document(int)
. If you want to load a subset, useDocumentStoredFieldVisitor
.- Specified by:
document
in classIndexReader
- Throws:
IOException
-
doClose
Description copied from class:IndexReader
Implements close.- Specified by:
doClose
in classIndexReader
- Throws:
IOException
-
terms
Description copied from class:LeafReader
Returns theTerms
index for this field, or null if it has none.- Specified by:
terms
in classLeafReader
- Throws:
IOException
-
toString
-
getNumericDocValues
Description copied from class:LeafReader
ReturnsNumericDocValues
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 classLeafReader
- Throws:
IOException
-
getBinaryDocValues
Description copied from class:LeafReader
ReturnsBinaryDocValues
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 classLeafReader
- Throws:
IOException
-
getSortedDocValues
Description copied from class:LeafReader
ReturnsSortedDocValues
for this field, or null if noSortedDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedDocValues
in classLeafReader
- Throws:
IOException
-
getSortedNumericDocValues
Description copied from class:LeafReader
ReturnsSortedNumericDocValues
for this field, or null if noSortedNumericDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedNumericDocValues
in classLeafReader
- Throws:
IOException
-
getSortedSetDocValues
Description copied from class:LeafReader
ReturnsSortedSetDocValues
for this field, or null if noSortedSetDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedSetDocValues
in classLeafReader
- Throws:
IOException
-
getNormValues
Description copied from class:LeafReader
ReturnsNumericDocValues
representing norms for this field, or null if noNumericDocValues
were indexed. The returned instance should only be used by a single thread.- Specified by:
getNormValues
in classLeafReader
- Throws:
IOException
-
getMetaData
Description copied from class:LeafReader
Return metadata about this leaf.- Specified by:
getMetaData
in classLeafReader
-
checkIntegrity
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 classLeafReader
- Throws:
IOException
-
getDelegate
Returns the wrappedLeafReader
.
-