Class CodecReader
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
FilterCodecReader,SegmentReader
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidChecks consistency of this reader.protected voiddoClose()Implements close.final BinaryDocValuesgetBinaryDocValues(String field) ReturnsBinaryDocValuesfor this field, or null if no binary doc values were indexed for this field.final ByteVectorValuesgetByteVectorValues(String field) ReturnsByteVectorValuesfor this field, or null if noByteVectorValueswere indexed.abstract DocValuesProducerExpert: retrieve underlying DocValuesProducerfinal DocValuesSkippergetDocValuesSkipper(String field) Returns aDocValuesSkipperallowing skipping ranges of doc IDs that are not of interest, ornullif a skip index was not indexed.abstract StoredFieldsReaderExpert: retrieve underlying StoredFieldsReaderfinal FloatVectorValuesgetFloatVectorValues(String field) ReturnsFloatVectorValuesfor this field, or null if noFloatVectorValueswere indexed.abstract NormsProducerExpert: retrieve underlying NormsProducerfinal NumericDocValuesgetNormValues(String field) ReturnsNumericDocValuesrepresenting norms for this field, or null if noNumericDocValueswere indexed.final NumericDocValuesgetNumericDocValues(String field) ReturnsNumericDocValuesfor this field, or null if no numeric doc values were indexed for this field.abstract PointsReaderExpert: retrieve underlying PointsReaderfinal PointValuesgetPointValues(String field) Returns thePointValuesused for numeric or spatial searches for the given field, or null if there are no point fields.abstract FieldsProducerExpert: retrieve underlying FieldsProducerfinal SortedDocValuesgetSortedDocValues(String field) ReturnsSortedDocValuesfor this field, or null if noSortedDocValueswere indexed for this field.final SortedNumericDocValuesgetSortedNumericDocValues(String field) ReturnsSortedNumericDocValuesfor this field, or null if noSortedNumericDocValueswere indexed for this field.final SortedSetDocValuesgetSortedSetDocValues(String field) ReturnsSortedSetDocValuesfor this field, or null if noSortedSetDocValueswere indexed for this field.abstract TermVectorsReaderExpert: retrieve underlying TermVectorsReaderabstract KnnVectorsReaderExpert: retrieve underlying VectorReaderfinal 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.final 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.final StoredFieldsReturns aStoredFieldsreader for the stored fields of this index.final TermsReturns theTermsindex for this field, or null if it has none.final TermVectorsReturns aTermVectorsreader for the term vectors of this index.Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getCoreCacheHelper, getDocCount, getFieldInfos, getLiveDocs, getMetaData, getSumDocFreq, getSumTotalTermFreq, postings, postings, searchNearestVectors, searchNearestVectors, totalTermFreqMethods inherited from class org.apache.lucene.index.IndexReader
close, decRef, ensureOpen, equals, getReaderCacheHelper, getRefCount, hasDeletions, hashCode, incRef, leaves, maxDoc, notifyReaderClosedListeners, numDeletedDocs, numDocs, registerParentReader, tryIncRef
-
Constructor Details
-
CodecReader
protected CodecReader()Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
getFieldsReader
Expert: retrieve underlying StoredFieldsReader- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getTermVectorsReader
Expert: retrieve underlying TermVectorsReader- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getNormsReader
Expert: retrieve underlying NormsProducer- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getDocValuesReader
Expert: retrieve underlying DocValuesProducer- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getPostingsReader
Expert: retrieve underlying FieldsProducer- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getPointsReader
Expert: retrieve underlying PointsReader- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getVectorReader
Expert: retrieve underlying VectorReader- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
storedFields
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
-
termVectors
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
-
terms
Description copied from class:LeafReaderReturns theTermsindex for this field, or null if it has none.- Specified by:
termsin classLeafReader- Throws:
IOException
-
getNumericDocValues
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
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
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
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
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
-
getDocValuesSkipper
Description copied from class:LeafReaderReturns aDocValuesSkipperallowing skipping ranges of doc IDs that are not of interest, ornullif a skip index was not indexed. The returned instance should be confined to the thread that created it.- Specified by:
getDocValuesSkipperin classLeafReader- Throws:
IOException
-
getNormValues
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
-
getPointValues
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
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
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 final 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 final 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
-
doClose
Description copied from class:IndexReaderImplements close.- Specified by:
doClosein classIndexReader- Throws:
IOException
-
checkIntegrity
Description 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
-