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

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

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

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

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

    Subclasses of BinaryDocValues in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `MultiDocValues.MultiSortedDocValues` Implements SortedDocValues over n subs, using an OrdinalMap
    `class` | `SortedDocValues` A per-document byte[] with presorted values.

    Fields in org.apache.lucene.index declared as BinaryDocValues
    Modifier and Type | Field and Description
    --- | ---
    `static BinaryDocValues` | BinaryDocValues.`EMPTY` An empty BinaryDocValues which returns `MISSING` for every document

    Methods in org.apache.lucene.index that return BinaryDocValues
    Modifier and Type | Method and Description
    --- | ---
    `BinaryDocValues` | SlowCompositeReaderWrapper.`getBinaryDocValues(String field)`
    `BinaryDocValues` | SegmentReader.`getBinaryDocValues(String field)`
    `BinaryDocValues` | ParallelAtomicReader.`getBinaryDocValues(String field)`
    `BinaryDocValues` | FilterAtomicReader.`getBinaryDocValues(String field)`
    `abstract BinaryDocValues` | AtomicReader.`getBinaryDocValues(String field)` Returns `BinaryDocValues` for this field, or null if no `BinaryDocValues` were indexed for this field.
    `static BinaryDocValues` | MultiDocValues.`getBinaryValues(IndexReader r, String field)` Returns a BinaryDocValues for a reader's docvalues (potentially merging on-the-fly)

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

    Methods in org.apache.lucene.search that return BinaryDocValues
    Modifier and Type | Method and Description
    --- | ---
    `BinaryDocValues` | FieldCache.`getTerms(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 `BinaryDocValues` instance, providing a method to retrieve the term (as a BytesRef) per document.
    `BinaryDocValues` | FieldCache.`getTerms(AtomicReader reader, String field, float acceptableOverheadRatio)` Expert: just like `FieldCache.getTerms(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.