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

- Packages that use LeafReader
  Package | Description
  --- | ---
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.

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

    Subclasses of LeafReader in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CodecReader` LeafReader implemented by codec APIs.
    `static class` | `ExitableDirectoryReader.ExitableFilterAtomicReader` Wrapper class for another FilterAtomicReader.
    `class` | `FilterCodecReader` A `FilterCodecReader` contains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
    `class` | `FilterLeafReader` A `FilterLeafReader` contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
    `class` | `ParallelLeafReader` An `LeafReader` which reads multiple, parallel indexes.
    `class` | `SegmentReader` IndexReader implementation over a single segment.

    Fields in org.apache.lucene.index declared as LeafReader
    Modifier and Type | Field and Description
    --- | ---
    `protected LeafReader` | FilterLeafReader.`in` The underlying LeafReader.

    Methods in org.apache.lucene.index that return LeafReader
    Modifier and Type | Method and Description
    --- | ---
    `LeafReader` | FilterLeafReader.`getDelegate()` Returns the wrapped `LeafReader`.
    `LeafReader[]` | ParallelLeafReader.`getParallelReaders()` Returns the `LeafReader`s that were passed on init.
    `LeafReader` | LeafReaderContext.`reader()`
    `static LeafReader` | FilterLeafReader.`unwrap(LeafReader reader)` Get the wrapped instance by `reader` as long as this reader is an instance of `FilterLeafReader`.
    `abstract LeafReader` | FilterDirectoryReader.SubReaderWrapper.`wrap(LeafReader reader)` Wrap one of the parent DirectoryReader's subreaders
    `LeafReader` | ExitableDirectoryReader.ExitableSubReaderWrapper.`wrap(LeafReader reader)`
    `protected LeafReader[]` | FilterDirectoryReader.SubReaderWrapper.`wrap(List<? extends LeafReader> readers)` Wraps a list of LeafReaders

    Methods in org.apache.lucene.index with parameters of type LeafReader
    Modifier and Type | Method and Description
    --- | ---
    `static BinaryDocValues` | DocValues.`getBinary(LeafReader reader, String field)` Returns BinaryDocValues for the field, or `DocValues.emptyBinary()` if it has none.
    `static NumericDocValues` | DocValues.`getNumeric(LeafReader reader, String field)` Returns NumericDocValues for the field, or `DocValues.emptyNumeric()` if it has none.
    `static SortedDocValues` | DocValues.`getSorted(LeafReader reader, String field)` Returns SortedDocValues for the field, or `DocValues.emptySorted()` if it has none.
    `static SortedNumericDocValues` | DocValues.`getSortedNumeric(LeafReader reader, String field)` Returns SortedNumericDocValues for the field, or `DocValues.emptySortedNumeric(int)` if it has none.
    `static SortedSetDocValues` | DocValues.`getSortedSet(LeafReader reader, String field)` Returns SortedSetDocValues for the field, or `DocValues.emptySortedSet()` if it has none.
    `static LeafReader` | FilterLeafReader.`unwrap(LeafReader reader)` Get the wrapped instance by `reader` as long as this reader is an instance of `FilterLeafReader`.
    `void` | SimpleMergedSegmentWarmer.`warm(LeafReader reader)`
    `void` | IndexWriter.IndexReaderWarmer.`warm(LeafReader reader)` Invoked on the `LeafReader` for the newly merged segment, before that segment is made visible to near-real-time readers.
    `abstract LeafReader` | FilterDirectoryReader.SubReaderWrapper.`wrap(LeafReader reader)` Wrap one of the parent DirectoryReader's subreaders
    `static CodecReader` | SlowCodecReaderWrapper.`wrap(LeafReader reader)` Returns a `CodecReader` view of reader.
    `LeafReader` | ExitableDirectoryReader.ExitableSubReaderWrapper.`wrap(LeafReader reader)`

    Method parameters in org.apache.lucene.index with type arguments of type LeafReader
    Modifier and Type | Method and Description
    --- | ---
    `static DirectoryReader` | StandardDirectoryReader.`open(Directory directory, SegmentInfos infos, List<? extends LeafReader> oldReaders)` This constructor is only used for `StandardDirectoryReader.doOpenIfChanged(SegmentInfos)`, as well as NRT replication.
    `protected LeafReader[]` | FilterDirectoryReader.SubReaderWrapper.`wrap(List<? extends LeafReader> readers)` Wraps a list of LeafReaders

    Constructors in org.apache.lucene.index with parameters of type LeafReader
    Constructor and Description
    `DirectoryReader(Directory directory, LeafReader[] segmentReaders)` Expert: Constructs a `DirectoryReader` on the given subReaders.
    `ExitableFilterAtomicReader(LeafReader in, QueryTimeout queryTimeout)` Constructor
    `FilterLeafReader(LeafReader in)` Construct a FilterLeafReader based on the specified base reader.
    `ParallelLeafReader(boolean closeSubReaders, LeafReader... readers)` Create a ParallelLeafReader based on the provided readers.
    `ParallelLeafReader(boolean closeSubReaders, LeafReader[] readers, LeafReader[] storedFieldsReaders)` Expert: create a ParallelLeafReader based on the provided readers and storedFieldReaders; when a document is loaded, only storedFieldsReaders will be used.
    `ParallelLeafReader(boolean closeSubReaders, LeafReader[] readers, LeafReader[] storedFieldsReaders)` Expert: create a ParallelLeafReader based on the provided readers and storedFieldReaders; when a document is loaded, only storedFieldsReaders will be used.
    `ParallelLeafReader(LeafReader... readers)` Create a ParallelLeafReader based on the provided readers; auto-closes the given readers on `IndexReader.close()`.

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

    Methods in org.apache.lucene.search with parameters of type LeafReader
    Modifier and Type | Method and Description
    --- | ---
    `static DocIdSetIterator` | DocValuesFieldExistsQuery.`getDocValuesDocIdSetIterator(String field, LeafReader reader)` Returns a `DocIdSetIterator` from the given field or null if the field doesn't exist in the reader or if the reader has no doc values for the field.

    Constructors in org.apache.lucene.search with parameters of type LeafReader
    Constructor and Description
    `LeafSimScorer(Similarity.SimScorer scorer, LeafReader reader, String field, boolean needsScores)` Sole constructor: Score documents of `reader` with `scorer`.

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