Class ExitableDirectoryReader.ExitableFilterAtomicReader
- java.lang.Object
-
- org.apache.lucene.index.IndexReader
-
- org.apache.lucene.index.LeafReader
-
- org.apache.lucene.index.FilterLeafReader
-
- org.apache.lucene.index.ExitableDirectoryReader.ExitableFilterAtomicReader
-
- All Implemented Interfaces:
Closeable,AutoCloseable
- Enclosing class:
- ExitableDirectoryReader
public static class ExitableDirectoryReader.ExitableFilterAtomicReader extends FilterLeafReader
Wrapper class for another FilterAtomicReader. This is used by ExitableSubReaderWrapper.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.FilterLeafReader
FilterLeafReader.FilterFields, FilterLeafReader.FilterPostingsEnum, FilterLeafReader.FilterTerms, FilterLeafReader.FilterTermsEnum
-
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.index.FilterLeafReader
in
-
-
Constructor Summary
Constructors Constructor Description ExitableFilterAtomicReader(LeafReader in, QueryTimeout queryTimeout)Constructor *
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.IndexReader.CacheHelpergetCoreCacheHelper()Optional method: Return aIndexReader.CacheHelperthat can be used to cache based on the content of this leaf regardless of deletions.FloatVectorValuesgetFloatVectorValues(String field)ReturnsFloatVectorValuesfor this field, or null if noFloatVectorValueswere 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.IndexReader.CacheHelpergetReaderCacheHelper()Optional method: Return aIndexReader.CacheHelperthat can be used to cache based on the content of this reader.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.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.Termsterms(String field)Returns theTermsindex for this field, or null if it has none.-
Methods inherited from class org.apache.lucene.index.FilterLeafReader
checkIntegrity, doClose, document, getDelegate, getFieldInfos, getLiveDocs, getMetaData, getNormValues, getTermVectors, maxDoc, numDocs, storedFields, termVectors, toString, unwrap
-
Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, searchNearestVectors, searchNearestVectors, 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
-
-
-
-
Constructor Detail
-
ExitableFilterAtomicReader
public ExitableFilterAtomicReader(LeafReader in, QueryTimeout queryTimeout)
Constructor *
-
-
Method Detail
-
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.- Overrides:
getPointValuesin classFilterLeafReader- 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.- Overrides:
termsin classFilterLeafReader- Throws:
IOException
-
getReaderCacheHelper
public IndexReader.CacheHelper getReaderCacheHelper()
Description copied from class:IndexReaderOptional method: Return aIndexReader.CacheHelperthat 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
nullindicates 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:
getReaderCacheHelperin classIndexReader
-
getCoreCacheHelper
public IndexReader.CacheHelper getCoreCacheHelper()
Description copied from class:LeafReaderOptional method: Return aIndexReader.CacheHelperthat 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 usingIndexReader.getReaderCacheHelper()if you need deletions or dv updates to be taken into account.A return value of
nullindicates 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:
getCoreCacheHelperin classLeafReader
-
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.- Overrides:
getNumericDocValuesin classFilterLeafReader- 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.- Overrides:
getBinaryDocValuesin classFilterLeafReader- 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.- Overrides:
getSortedDocValuesin classFilterLeafReader- 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.- Overrides:
getSortedNumericDocValuesin classFilterLeafReader- 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.- Overrides:
getSortedSetDocValuesin classFilterLeafReader- 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.- Overrides:
getFloatVectorValuesin classFilterLeafReader- 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.- Overrides:
getByteVectorValuesin classFilterLeafReader- 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.- Overrides:
searchNearestVectorsin classFilterLeafReader- 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.- Overrides:
searchNearestVectorsin classFilterLeafReader- 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
-
-