## 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.

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

    Subclasses of SortedSetDocValues in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FilterSortedSetDocValues` Delegates all methods to a wrapped `SortedSetDocValues`.
    `static class` | `MultiDocValues.MultiSortedSetDocValues` Implements MultiSortedSetDocValues over n subs, using an OrdinalMap

    Fields in org.apache.lucene.index declared as SortedSetDocValues
    Modifier and Type | Field and Description
    --- | ---
    `protected SortedSetDocValues` | FilterSortedSetDocValues.`in` Wrapped values
    `SortedSetDocValues[]` | MultiDocValues.MultiSortedSetDocValues.`values` leaf values

    Methods in org.apache.lucene.index that return SortedSetDocValues
    Modifier and Type | Method and Description
    --- | ---
    `static SortedSetDocValues` | DocValues.`emptySortedSet()` An empty SortedDocValues which returns `BytesRef.EMPTY_BYTES` for every document
    `SortedSetDocValues` | EmptyDocValuesProducer.`getSortedSet(FieldInfo field)`
    `static SortedSetDocValues` | DocValues.`getSortedSet(LeafReader reader, String field)` Returns SortedSetDocValues for the field, or `DocValues.emptySortedSet()` if it has none.
    `SortedSetDocValues` | ParallelLeafReader.`getSortedSetDocValues(String field)`
    `SortedSetDocValues` | CodecReader.`getSortedSetDocValues(String field)`
    `SortedSetDocValues` | ExitableDirectoryReader.ExitableFilterAtomicReader.`getSortedSetDocValues(String field)`
    `abstract SortedSetDocValues` | LeafReader.`getSortedSetDocValues(String field)` Returns `SortedSetDocValues` for this field, or null if no `SortedSetDocValues` were indexed for this field.
    `SortedSetDocValues` | FilterLeafReader.`getSortedSetDocValues(String field)`
    `static SortedSetDocValues` | MultiDocValues.`getSortedSetValues(IndexReader r, String field)` Returns a SortedSetDocValues for a reader's docvalues (potentially doing extremely slow things).
    `static SortedSetDocValues` | DocValues.`singleton(SortedDocValues dv)` Returns a multi-valued view over the provided SortedDocValues

    Methods in org.apache.lucene.index with parameters of type SortedSetDocValues
    Modifier and Type | Method and Description
    --- | ---
    `static OrdinalMap` | OrdinalMap.`build(IndexReader.CacheKey owner, SortedSetDocValues[] values, float acceptableOverheadRatio)` Create an ordinal map that uses the number of unique values of each `SortedSetDocValues` instance as a weight.
    `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.

    Constructors in org.apache.lucene.index with parameters of type SortedSetDocValues
    Constructor and Description
    `FilterSortedSetDocValues(SortedSetDocValues in)` Initializes delegate
    `MultiSortedSetDocValues(SortedSetDocValues[] values, int[] docStarts, OrdinalMap mapping, long totalCost)` Creates a new MultiSortedSetDocValues over `values`

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

    Methods in org.apache.lucene.search with parameters of type SortedSetDocValues
    Modifier and Type | Method and Description
    --- | ---
    `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-2022 Apache Software Foundation. All Rights Reserved.