Package org.apache.lucene.index
Class IndexSorter.StringSorter
java.lang.Object
org.apache.lucene.index.IndexSorter.StringSorter
- All Implemented Interfaces:
IndexSorter
- Enclosing interface:
IndexSorter
Sorts documents based on terms from a SortedDocValues instance
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.lucene.index.IndexSorter
IndexSorter.ComparableProvider, IndexSorter.DocComparator, IndexSorter.DoubleSorter, IndexSorter.FloatSorter, IndexSorter.IntSorter, IndexSorter.LongSorter, IndexSorter.NumericDocValuesProvider, IndexSorter.SortedDocValuesProvider, IndexSorter.StringSorter -
Constructor Summary
ConstructorsConstructorDescriptionStringSorter(String providerName, Object missingValue, boolean reverse, IndexSorter.SortedDocValuesProvider valuesProvider) Creates a new StringSorter -
Method Summary
Modifier and TypeMethodDescriptiongetComparableProviders(List<? extends LeafReader> readers) Get an array ofIndexSorter.ComparableProvider, one per segment, for merge sorting documents in different segmentsgetDocComparator(LeafReader reader, int maxDoc) Get a comparator that determines the sort order of docs within a single Reader.The SPI-registered name of aSortFieldProviderthat will deserialize the parent SortField
-
Constructor Details
-
StringSorter
public StringSorter(String providerName, Object missingValue, boolean reverse, IndexSorter.SortedDocValuesProvider valuesProvider) Creates a new StringSorter
-
-
Method Details
-
getComparableProviders
public IndexSorter.ComparableProvider[] getComparableProviders(List<? extends LeafReader> readers) throws IOException Description copied from interface:IndexSorterGet an array ofIndexSorter.ComparableProvider, one per segment, for merge sorting documents in different segments- Specified by:
getComparableProvidersin interfaceIndexSorter- Parameters:
readers- the readers to be merged- Throws:
IOException
-
getDocComparator
Description copied from interface:IndexSorterGet a comparator that determines the sort order of docs within a single Reader.NB We cannot simply use the
FieldComparatorAPI because it requires docIDs to be sent in-order. The default implementations allocate array[maxDoc] to hold native values for comparison, but 1) they are transient (only alive while sorting this one segment) and 2) in the typical index sorting case, they are only used to sort newly flushed segments, which will be smaller than merged segments- Specified by:
getDocComparatorin interfaceIndexSorter- Parameters:
reader- the Reader to sortmaxDoc- the number of documents in the Reader- Throws:
IOException
-
getProviderName
Description copied from interface:IndexSorterThe SPI-registered name of aSortFieldProviderthat will deserialize the parent SortField- Specified by:
getProviderNamein interfaceIndexSorter
-