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

- Packages that use SortedSetDocValues
  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 SortedSetDocValues in org.apache.lucene.codecs

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

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

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

    Subclasses of SortedSetDocValues in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `MultiDocValues.MultiSortedSetDocValues` Implements MultiSortedSetDocValues over n subs, using an OrdinalMap
    `class` | `SingletonSortedSetDocValues` Exposes multi-valued view over a single-valued instance.

    Fields in org.apache.lucene.index declared as SortedSetDocValues
    Modifier and Type | Field and Description
    --- | ---
    `static SortedSetDocValues` | SortedSetDocValues.`EMPTY` An empty SortedDocValues which returns `NO_MORE_ORDS` for every document
    `SortedSetDocValues[]` | MultiDocValues.MultiSortedSetDocValues.`values` leaf values

    Methods in org.apache.lucene.index that return SortedSetDocValues
    Modifier and Type | Method and Description
    --- | ---
    `SortedSetDocValues` | SlowCompositeReaderWrapper.`getSortedSetDocValues(String field)`
    `SortedSetDocValues` | SegmentReader.`getSortedSetDocValues(String field)`
    `SortedSetDocValues` | ParallelAtomicReader.`getSortedSetDocValues(String field)`
    `SortedSetDocValues` | FilterAtomicReader.`getSortedSetDocValues(String field)`
    `abstract SortedSetDocValues` | AtomicReader.`getSortedSetDocValues(String field)` Returns `SortedSetDocValues` for this field, or null if no `SortedSetDocValues` were indexed for this field.
    `static SortedSetDocValues` | MultiDocValues.`getSortedSetValues(IndexReader r, String field)` Returns a SortedSetDocValues for a reader's docvalues (potentially doing extremely slow things).
    `SortedSetDocValues` | DocTermOrds.`iterator(TermsEnum termsEnum)` Returns a SortedSetDocValues view of this instance

    Constructors in org.apache.lucene.index with parameters of type SortedSetDocValues
    Constructor and Description
    `SortedSetDocValuesTermsEnum(SortedSetDocValues values)` Creates a new TermsEnum over the provided values

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

    Methods in org.apache.lucene.search that return SortedSetDocValues
    Modifier and Type | Method and Description
    --- | ---
    `SortedSetDocValues` | FieldCache.`getDocTermOrds(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 `DocTermOrds` instance, providing a method to retrieve the terms (as ords) per document.

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