## Uses of Class
org.apache.lucene.index.SortedDocValues

- Packages that use SortedDocValues
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.

- - ### Uses of SortedDocValues in org.apache.lucene.codecs

    Methods in org.apache.lucene.codecs that return SortedDocValues
    Modifier and Type | Method and Description
    --- | ---
    `abstract SortedDocValues` | DocValuesProducer.`getSorted(FieldInfo field)` Returns `SortedDocValues` for this field.

    Method parameters in org.apache.lucene.codecs with type arguments of type SortedDocValues
    Modifier and Type | Method and Description
    --- | ---
    `void` | DocValuesConsumer.`mergeSortedField(FieldInfo fieldInfo, MergeState mergeState, List<SortedDocValues> toMerge)` Merges the sorted docvalues from `toMerge`.

  - ### Uses of SortedDocValues in org.apache.lucene.index

    Subclasses of SortedDocValues in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `MultiDocValues.MultiSortedDocValues` Implements SortedDocValues over n subs, using an OrdinalMap

    Fields in org.apache.lucene.index declared as SortedDocValues
    Modifier and Type | Field and Description
    --- | ---
    `SortedDocValues[]` | MultiDocValues.MultiSortedDocValues.`values` leaf values

    Methods in org.apache.lucene.index that return SortedDocValues
    Modifier and Type | Method and Description
    --- | ---
    `static SortedDocValues` | DocValues.`emptySorted()` An empty SortedDocValues which returns `BytesRef.EMPTY_BYTES` for every document
    `static SortedDocValues` | DocValues.`getSorted(LeafReader reader, String field)` Returns SortedDocValues for the field, or `DocValues.emptySorted()` if it has none.
    `abstract SortedDocValues` | LeafReader.`getSortedDocValues(String field)` Returns `SortedDocValues` for this field, or null if no `SortedDocValues` were indexed for this field.
    `SortedDocValues` | FilterLeafReader.`getSortedDocValues(String field)`
    `SortedDocValues` | CodecReader.`getSortedDocValues(String field)`
    `SortedDocValues` | ParallelLeafReader.`getSortedDocValues(String field)`
    `static SortedDocValues` | MultiDocValues.`getSortedValues(IndexReader r, SortedDocValues[] leafValues, int[] docStarts)` Expert: returns a SortedDocValues from an array of leaf reader's sorted doc values (potentially doing extremely slow things).
    `static SortedDocValues` | MultiDocValues.`getSortedValues(IndexReader r, String field)` Returns a SortedDocValues for a reader's docvalues (potentially doing extremely slow things).
    `static SortedDocValues` | DocValues.`unwrapSingleton(SortedSetDocValues dv)` Returns a single-valued view of the SortedSetDocValues, if it was previously wrapped with `DocValues.singleton(SortedDocValues)`, or null.

    Methods in org.apache.lucene.index with parameters of type SortedDocValues
    Modifier and Type | Method and Description
    --- | ---
    `static MultiDocValues.OrdinalMap` | MultiDocValues.OrdinalMap.`build(Object owner, SortedDocValues[] values, float acceptableOverheadRatio)` Create an ordinal map that uses the number of unique values of each `SortedDocValues` instance as a weight.
    `static Bits` | DocValues.`docsWithValue(SortedDocValues dv, int maxDoc)` Returns a Bits representing all documents from `dv` that have a value.
    `static SortedDocValues` | MultiDocValues.`getSortedValues(IndexReader r, SortedDocValues[] leafValues, int[] docStarts)` Expert: returns a SortedDocValues from an array of leaf reader's sorted doc values (potentially doing extremely slow things).
    `static RandomAccessOrds` | DocValues.`singleton(SortedDocValues dv)` Returns a multi-valued view over the provided SortedDocValues

    Constructors in org.apache.lucene.index with parameters of type SortedDocValues
    Constructor and Description
    `MultiSortedDocValues(SortedDocValues[] values, int[] docStarts, MultiDocValues.OrdinalMap mapping)` Creates a new MultiSortedDocValues over `values`

  - ### Uses of SortedDocValues in org.apache.lucene.search

    Methods in org.apache.lucene.search that return SortedDocValues
    Modifier and Type | Method and Description
    --- | ---
    `protected SortedDocValues` | FieldComparator.TermOrdValComparator.`getSortedDocValues(LeafReaderContext context, String field)` Retrieves the SortedDocValues for the field in this segment
    `static SortedDocValues` | SortedSetSelector.`wrap(SortedSetDocValues sortedSet, SortedSetSelector.Type selector)` Wraps a multi-valued SortedSetDocValues as a single-valued view, using the specified selector

Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.