## 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
    --- | ---
    `static SortedDocValues` | SortedDocValues.`EMPTY` An empty SortedDocValues which returns `BinaryDocValues.MISSING` for every document
    `SortedDocValues[]` | MultiDocValues.MultiSortedDocValues.`values` leaf values

    Methods in org.apache.lucene.index that return SortedDocValues
    Modifier and Type | Method and Description
    --- | ---
    `SortedDocValues` | SlowCompositeReaderWrapper.`getSortedDocValues(String field)`
    `SortedDocValues` | SegmentReader.`getSortedDocValues(String field)`
    `SortedDocValues` | ParallelAtomicReader.`getSortedDocValues(String field)`
    `SortedDocValues` | FilterAtomicReader.`getSortedDocValues(String field)`
    `abstract SortedDocValues` | AtomicReader.`getSortedDocValues(String field)` Returns `SortedDocValues` for this field, or null if no `SortedDocValues` were indexed for this field.
    `static SortedDocValues` | MultiDocValues.`getSortedValues(IndexReader r, String field)` Returns a SortedDocValues for a reader's docvalues (potentially doing extremely slow things).

    Constructors in org.apache.lucene.index with parameters of type SortedDocValues
    Constructor and Description
    `SingletonSortedSetDocValues(SortedDocValues in)` Creates a multi-valued view over the provided SortedDocValues
    `SortedDocValuesTermsEnum(SortedDocValues values)` Creates a new TermsEnum over the provided values

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

    Fields in org.apache.lucene.search declared as SortedDocValues
    Modifier and Type | Field and Description
    --- | ---
    `static SortedDocValues` | FieldCache.`EMPTY_TERMSINDEX` Returns MISSING/-1 ordinal for every document

    Methods in org.apache.lucene.search that return SortedDocValues
    Modifier and Type | Method and Description
    --- | ---
    `SortedDocValues` | FieldCache.`getTermsIndex(AtomicReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the term values in `field` and returns a `SortedDocValues` instance, providing methods to retrieve sort ordinals and terms (as a ByteRef) per document.
    `SortedDocValues` | FieldCache.`getTermsIndex(AtomicReader reader, String field, float acceptableOverheadRatio)` Expert: just like `FieldCache.getTermsIndex(AtomicReader,String)`, but you can specify whether more RAM should be consumed in exchange for faster lookups (default is "true").

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