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

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

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

    Subclasses of CodecReader in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `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` | `SegmentReader` IndexReader implementation over a single segment.
    `class` | `SortingCodecReader` An `CodecReader` which supports sorting documents by a given `Sort`.

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

    Methods in org.apache.lucene.index that return CodecReader
    Modifier and Type | Method and Description
    --- | ---
    `CodecReader` | FilterCodecReader.`getDelegate()` Returns the wrapped `CodecReader`.
    `static CodecReader` | FilterCodecReader.`unwrap(CodecReader reader)` Get the wrapped instance by `reader` as long as this reader is an instance of `FilterCodecReader`.
    `static CodecReader` | SortingCodecReader.`wrap(CodecReader reader, Sort sort)` Return a sorted view of `reader` according to the order defined by `sort`.
    `static CodecReader` | SlowCodecReaderWrapper.`wrap(LeafReader reader)` Returns a `CodecReader` view of reader.
    `CodecReader` | MergePolicy.OneMerge.`wrapForMerge(CodecReader reader)` Wrap the reader in order to add/remove information to the merged segment.

    Methods in org.apache.lucene.index with parameters of type CodecReader
    Modifier and Type | Method and Description
    --- | ---
    `long` | IndexWriter.`addIndexes(CodecReader... readers)` Merges the provided indexes into this index.
    `static CheckIndex.Status.DocValuesStatus` | CheckIndex.`testDocValues(CodecReader reader, PrintStream infoStream, boolean failFast)` Test docvalues.
    `static CheckIndex.Status.FieldInfoStatus` | CheckIndex.`testFieldInfos(CodecReader reader, PrintStream infoStream, boolean failFast)` Test field infos.
    `static CheckIndex.Status.FieldNormStatus` | CheckIndex.`testFieldNorms(CodecReader reader, PrintStream infoStream, boolean failFast)` Test field norms.
    `static CheckIndex.Status.LiveDocStatus` | CheckIndex.`testLiveDocs(CodecReader reader, PrintStream infoStream, boolean failFast)` Test live docs.
    `static CheckIndex.Status.PointsStatus` | CheckIndex.`testPoints(CodecReader reader, PrintStream infoStream, boolean failFast)` Test the points index
    `static CheckIndex.Status.TermIndexStatus` | CheckIndex.`testPostings(CodecReader reader, PrintStream infoStream)` Test the term index.
    `static CheckIndex.Status.TermIndexStatus` | CheckIndex.`testPostings(CodecReader reader, PrintStream infoStream, boolean verbose, boolean doSlowChecks, boolean failFast)` Test the term index.
    `static CheckIndex.Status.IndexSortStatus` | CheckIndex.`testSort(CodecReader reader, Sort sort, PrintStream infoStream, boolean failFast)` Tests index sort order.
    `static CheckIndex.Status.StoredFieldStatus` | CheckIndex.`testStoredFields(CodecReader reader, PrintStream infoStream, boolean failFast)` Test stored fields.
    `static CheckIndex.Status.TermVectorStatus` | CheckIndex.`testTermVectors(CodecReader reader, PrintStream infoStream)` Test term vectors.
    `static CheckIndex.Status.TermVectorStatus` | CheckIndex.`testTermVectors(CodecReader reader, PrintStream infoStream, boolean verbose, boolean doSlowChecks, boolean failFast)` Test term vectors.
    `static CodecReader` | FilterCodecReader.`unwrap(CodecReader reader)` Get the wrapped instance by `reader` as long as this reader is an instance of `FilterCodecReader`.
    `static CodecReader` | SortingCodecReader.`wrap(CodecReader reader, Sort sort)` Return a sorted view of `reader` according to the order defined by `sort`.
    `CodecReader` | MergePolicy.OneMerge.`wrapForMerge(CodecReader reader)` Wrap the reader in order to add/remove information to the merged segment.

    Method parameters in org.apache.lucene.index with type arguments of type CodecReader
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | MergePolicy.`keepFullyDeletedSegment(IOSupplier<CodecReader> readerIOSupplier)` Returns true if the segment represented by the given CodecReader should be keep even if it's fully deleted.
    `boolean` | SoftDeletesRetentionMergePolicy.`keepFullyDeletedSegment(IOSupplier<CodecReader> readerIOSupplier)`
    `boolean` | FilterMergePolicy.`keepFullyDeletedSegment(IOSupplier<CodecReader> readerIOSupplier)`
    `boolean` | NoMergePolicy.`keepFullyDeletedSegment(IOSupplier<CodecReader> readerIOSupplier)`
    `int` | MergePolicy.`numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)` Returns the number of deletes that a merge would claim on the given segment.
    `int` | SoftDeletesRetentionMergePolicy.`numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)`
    `int` | FilterMergePolicy.`numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)`
    `int` | NoMergePolicy.`numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)`

    Constructors in org.apache.lucene.index with parameters of type CodecReader
    Constructor and Description
    `FilterCodecReader(CodecReader in)` Creates a new FilterCodecReader.

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