Package org.apache.lucene.index

Class CodecReader

    • Constructor Detail

      • CodecReader

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

    • Method Detail

      • getFieldsReader

        public abstract StoredFieldsReader getFieldsReader()
        Expert: retrieve underlying StoredFieldsReader
        NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

      • getTermVectorsReader

        public abstract TermVectorsReader getTermVectorsReader()
        Expert: retrieve underlying TermVectorsReader
        NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

      • getNormsReader

        public abstract NormsProducer getNormsReader()
        Expert: retrieve underlying NormsProducer
        NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

      • getDocValuesReader

        public abstract DocValuesProducer getDocValuesReader()
        Expert: retrieve underlying DocValuesProducer
        NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

      • getPostingsReader

        public abstract FieldsProducer getPostingsReader()
        Expert: retrieve underlying FieldsProducer
        NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

      • getPointsReader

        public abstract PointsReader getPointsReader()
        Expert: retrieve underlying PointsReader
        NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

      • getVectorReader

        public abstract KnnVectorsReader getVectorReader()
        Expert: retrieve underlying VectorReader
        NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

      • getTermVectors

        @Deprecated
public Fields getTermVectors​(int docID)
                      throws IOException
        Deprecated.
        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

      • 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

      • 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

      • searchNearestVectors

        public final TopDocs searchNearestVectors​(String field,
                                          float[] target,
                                          int k,
                                          Bits acceptDocs,
                                          int visitedLimit)
                                   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, 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:
        IOException

      • searchNearestVectors

        public final TopDocs searchNearestVectors​(String field,
                                          byte[] target,
                                          int k,
                                          Bits acceptDocs,
                                          int visitedLimit)
                                   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, 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:
        IOException

      • 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