Class CodecReader

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    Direct Known Subclasses:
    FilterCodecReader, SegmentReader

    public abstract class CodecReader
    extends LeafReader
    LeafReader implemented by codec APIs.
    • Constructor Detail

      • CodecReader

        protected CodecReader()
        Sole constructor. (For invocation by subclass constructors, typically implicit.)
    • Method Detail

      • getFieldsReader

        public abstract StoredFieldsReader getFieldsReader()
        Expert: retrieve thread-private StoredFieldsReader
      • getTermVectorsReader

        public abstract TermVectorsReader getTermVectorsReader()
        Expert: retrieve thread-private TermVectorsReader
      • getNormsReader

        public abstract NormsProducer getNormsReader()
        Expert: retrieve underlying NormsProducer
      • getDocValuesReader

        public abstract DocValuesProducer getDocValuesReader()
        Expert: retrieve underlying DocValuesProducer
      • getPostingsReader

        public abstract FieldsProducer getPostingsReader()
        Expert: retrieve underlying FieldsProducer
      • getPointsReader

        public abstract PointsReader getPointsReader()
        Expert: retrieve underlying PointsReader
      • getVectorReader

        public abstract KnnVectorsReader getVectorReader()
        Expert: retrieve underlying VectorReader
      • getTermVectors

        public final Fields getTermVectors​(int docID)
                                    throws java.io.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:
        java.io.IOException
      • checkBounds

        private void checkBounds​(int docID)
      • terms

        public final Terms terms​(java.lang.String field)
                          throws java.io.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:
        java.io.IOException
      • getNumericDocValues

        public final NumericDocValues getNumericDocValues​(java.lang.String field)
                                                   throws java.io.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:
        java.io.IOException
      • getBinaryDocValues

        public final BinaryDocValues getBinaryDocValues​(java.lang.String field)
                                                 throws java.io.IOException
        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
        Throws:
        java.io.IOException
      • getPointValues

        public final PointValues getPointValues​(java.lang.String field)
                                         throws java.io.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:
        java.io.IOException
      • getVectorValues

        public final VectorValues getVectorValues​(java.lang.String field)
                                           throws java.io.IOException
        Description copied from class: LeafReader
        Returns VectorValues for this field, or null if no VectorValues were indexed. The returned instance should only be used by a single thread.
        Specified by:
        getVectorValues in class LeafReader
        Throws:
        java.io.IOException
      • searchNearestVectors

        public final TopDocs searchNearestVectors​(java.lang.String field,
                                                  float[] target,
                                                  int k,
                                                  Bits acceptDocs,
                                                  int visitedLimit)
                                           throws java.io.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, sorted 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.

        Specified by:
        searchNearestVectors in class LeafReader
        Parameters:
        field - the vector field to search
        target - the vector-valued query
        k - the number of docs to return
        acceptDocs - Bits that represents the allowed documents to match, or null if they are all allowed to match.
        visitedLimit - the maximum number of nodes that the search is allowed to visit
        Returns:
        the k nearest neighbor documents, along with their (searchStrategy-specific) scores.
        Throws:
        java.io.IOException
      • doClose

        protected void doClose()
                        throws java.io.IOException
        Description copied from class: IndexReader
        Implements close.
        Specified by:
        doClose in class IndexReader
        Throws:
        java.io.IOException
      • checkIntegrity

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