Module org.apache.lucene.core
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:
Closeable, AutoCloseable
abstract class DocValuesLeafReader extends LeafReader

  • Constructor Details

    • DocValuesLeafReader

      DocValuesLeafReader()

  • Method Details

    • 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(String field) throws 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:
      IOException

    • getNormValues

      public final NumericDocValues getNormValues(String field) throws 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:
      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(String field) throws 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:
      IOException

    • getFloatVectorValues

      public final FloatVectorValues getFloatVectorValues(String field) throws IOException
      Description copied from class: LeafReader
      Returns FloatVectorValues for this field, or null if no FloatVectorValues were indexed. The returned instance should only be used by a single thread.
      Specified by:
      getFloatVectorValues in class LeafReader
      Throws:
      IOException

    • getByteVectorValues

      public final ByteVectorValues getByteVectorValues(String field) throws IOException
      Description copied from class: LeafReader
      Returns ByteVectorValues for this field, or null if no ByteVectorValues were indexed. The returned instance should only be used by a single thread.
      Specified by:
      getByteVectorValues in class LeafReader
      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 a ScoreDoc for each nearest neighbor, in order of their similarity to the query vector (decreasing scores). The TotalHits contains the number of documents visited during the search. If the search stopped early because it hit visitedLimit, it is indicated through the relation TotalHits.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 never null.

      Specified by:
      searchNearestVectors in class LeafReader
      Parameters:
      field - the vector field to search
      target - the vector-valued query
      knnCollector - collector with settings for gathering the vector results.
      acceptDocs - Bits that represents the allowed documents to match, or null 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 a ScoreDoc for each nearest neighbor, in order of their similarity to the query vector (decreasing scores). The TotalHits contains the number of documents visited during the search. If the search stopped early because it hit visitedLimit, it is indicated through the relation TotalHits.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 never null.

      Specified by:
      searchNearestVectors in class LeafReader
      Parameters:
      field - the vector field to search
      target - the vector-valued query
      knnCollector - collector with settings for gathering the vector results.
      acceptDocs - Bits that represents the allowed documents to match, or null if they are all allowed to match.
      Throws:
      IOException

    • checkIntegrity

      public final void checkIntegrity() throws 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:
      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 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:
      IOException

    • termVectors

      public final TermVectors termVectors() throws IOException
      Description copied from class: IndexReader
      Returns a TermVectors 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 class IndexReader
      Throws:
      IOException - If there is a low-level IO error

    • 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 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:
      IOException

    • storedFields

      public final StoredFields storedFields() throws IOException
      Description copied from class: IndexReader
      Returns a StoredFields 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 class IndexReader
      Throws:
      IOException - If there is a low-level IO error

    • doClose

      protected final void doClose() throws IOException
      Description copied from class: IndexReader
      Implements close.
      Specified by:
      doClose in class IndexReader
      Throws:
      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