Package org.apache.lucene.index

Class SortingLeafReader

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    class SortingLeafReader
extends FilterLeafReader
    An LeafReader which supports sorting documents by a given Sort. This is package private and is only used by Lucene for BWC when it needs to merge an unsorted flushed segment built by an older version (newly flushed segments are sorted since version 7.0).

    • Field Detail

      • cachedSortedDVs

        private final java.util.Map<java.lang.String,​int[]> cachedSortedDVs

      • cachedSortedSetDVs

        private final java.util.Map<java.lang.String,​long[][]> cachedSortedSetDVs

      • cachedSortedNumericDVs

        private final java.util.Map<java.lang.String,​long[][]> cachedSortedNumericDVs

    • Method Detail

      • wrap

        public static LeafReader wrap​(LeafReader reader,
                              Sort sort)
                       throws java.io.IOException
        Return a sorted view of reader according to the order defined by sort. If the reader is already sorted, this method might return the reader as-is.
        Throws:
        java.io.IOException

      • terms

        public 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.
        Overrides:
        terms in class FilterLeafReader
        Throws:
        java.io.IOException

      • getBinaryDocValues

        public 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.
        Overrides:
        getBinaryDocValues in class FilterLeafReader
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        getLiveDocs in class FilterLeafReader

      • getPointValues

        public PointValues getPointValues​(java.lang.String fieldName)
                           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.
        Overrides:
        getPointValues in class FilterLeafReader
        Throws:
        java.io.IOException

      • getNumericDocValues

        public 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.
        Overrides:
        getNumericDocValues in class FilterLeafReader
        Throws:
        java.io.IOException

      • getTermVectors

        public 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).
        Overrides:
        getTermVectors in class FilterLeafReader
        Throws:
        java.io.IOException

      • 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