Class MemoryIndex.MemoryIndexReader

java.lang.Object
org.apache.lucene.index.IndexReader
org.apache.lucene.index.LeafReader
org.apache.lucene.index.memory.MemoryIndex.MemoryIndexReader
All Implemented Interfaces:
Closeable, AutoCloseable
Enclosing class:
MemoryIndex

private final class MemoryIndex.MemoryIndexReader extends LeafReader
Search support for Lucene framework integration; implements all methods required by the Lucene IndexReader contracts.
  • Field Details

  • Constructor Details

    • MemoryIndexReader

      private MemoryIndexReader()
  • Method Details

    • getInfoForExpectedDocValuesType

      private MemoryIndex.Info getInfoForExpectedDocValuesType(String fieldName, DocValuesType expectedType)
    • getLiveDocs

      public 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
    • getFieldInfos

      public FieldInfos getFieldInfos()
      Description copied from class: LeafReader
      Get the FieldInfos 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 class LeafReader
    • getNumericDocValues

      public NumericDocValues getNumericDocValues(String field) throws IOException
      Description copied from class: LeafReader
      Returns NumericDocValues 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 class LeafReader
      Throws:
      IOException
    • getBinaryDocValues

      public BinaryDocValues getBinaryDocValues(String field)
      Description copied from class: LeafReader
      Returns BinaryDocValues 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 class LeafReader
    • getSortedDocValues

      public SortedDocValues getSortedDocValues(String field)
      Description copied from class: LeafReader
      Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field. The returned instance should only be used by a single thread.
      Specified by:
      getSortedDocValues in class LeafReader
    • getSortedDocValues

      private SortedDocValues getSortedDocValues(String field, DocValuesType docValuesType)
    • getSortedNumericDocValues

      public SortedNumericDocValues getSortedNumericDocValues(String field)
      Description copied from class: LeafReader
      Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field. The returned instance should only be used by a single thread.
      Specified by:
      getSortedNumericDocValues in class LeafReader
    • getSortedSetDocValues

      public SortedSetDocValues getSortedSetDocValues(String field)
      Description copied from class: LeafReader
      Returns SortedSetDocValues for this field, or null if no SortedSetDocValues were indexed for this field. The returned instance should only be used by a single thread.
      Specified by:
      getSortedSetDocValues in class LeafReader
    • getDocValuesSkipper

      public DocValuesSkipper getDocValuesSkipper(String field) throws IOException
      Description copied from class: LeafReader
      Returns a DocValuesSkipper allowing skipping ranges of doc IDs that are not of interest, or null if a skip index was not indexed. The returned instance should be confined to the thread that created it.
      Specified by:
      getDocValuesSkipper in class LeafReader
      Throws:
      IOException
    • getPointValues

      public PointValues getPointValues(String fieldName)
      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
    • getFloatVectorValues

      public FloatVectorValues getFloatVectorValues(String fieldName)
      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
    • getByteVectorValues

      public ByteVectorValues getByteVectorValues(String fieldName)
      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
    • searchNearestVectors

      public void searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)
      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.
    • searchNearestVectors

      public void searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
      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.
    • checkIntegrity

      public 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
    • terms

      public 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
    • termVectors

      public TermVectors termVectors()
      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
    • 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 class IndexReader
    • 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 class IndexReader
    • storedFields

      public StoredFields storedFields()
      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
    • doClose

      protected void doClose()
      Description copied from class: IndexReader
      Implements close.
      Specified by:
      doClose in class IndexReader
    • getNormValues

      public NumericDocValues getNormValues(String field)
      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
    • getMetaData

      public LeafMetaData getMetaData()
      Description copied from class: LeafReader
      Return metadata about this leaf.
      Specified by:
      getMetaData in class LeafReader
    • getCoreCacheHelper

      public 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
    • getReaderCacheHelper

      public 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