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

- Packages that use LeafReaderContext
  Package | Description
  --- | ---
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.search.comparators | Comparators, used to compare hits so as to determine their sort order when collecting the top results with `TopFieldCollector`.
  org.apache.lucene.search.spans | The calculus of spans.

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

    Methods in org.apache.lucene.index that return LeafReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `LeafReaderContext` | LeafReader.`getContext()`

    Methods in org.apache.lucene.index that return types with arguments of type LeafReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `List<LeafReaderContext>` | LeafReaderContext.`leaves()`
    `List<LeafReaderContext>` | CompositeReaderContext.`leaves()`
    `abstract List<LeafReaderContext>` | IndexReaderContext.`leaves()` Returns the context's leaves if this context is a top-level context.
    `List<LeafReaderContext>` | IndexReader.`leaves()` Returns the reader's leaves, or itself if this reader is atomic.

    Methods in org.apache.lucene.index with parameters of type LeafReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `TermState` | TermStates.`get(LeafReaderContext ctx)` Returns the `TermState` for a leaf reader context or `null` if no `TermState` for the context was registered.
    `static boolean` | DocValues.`isCacheable(LeafReaderContext ctx, String... fields)` Returns `true` if the specified docvalues fields have not been updated

    Method parameters in org.apache.lucene.index with type arguments of type LeafReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `static int` | ReaderUtil.`subIndex(int n, List<LeafReaderContext> leaves)` Returns index of the searcher/reader for document `n` in the array used to construct this searcher/reader.

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

    Fields in org.apache.lucene.search declared as LeafReaderContext
    Modifier and Type | Field and Description
    --- | ---
    `LeafReaderContext[]` | IndexSearcher.LeafSlice.`leaves` The leaves that make up this slice.

    Fields in org.apache.lucene.search with type parameters of type LeafReaderContext
    Modifier and Type | Field and Description
    --- | ---
    `protected List<LeafReaderContext>` | IndexSearcher.`leafContexts`

    Methods in org.apache.lucene.search with parameters of type LeafReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `BulkScorer` | Weight.`bulkScorer(LeafReaderContext context)` Optional method, to return a `BulkScorer` to score the query and send hits to a `Collector`.
    `static MatchesIterator` | MatchesUtils.`disjunction(LeafReaderContext context, int doc, Query query, String field, BytesRefIterator terms)` Create a MatchesIterator that is a disjunction over a list of terms extracted from a `BytesRefIterator`.
    `protected void` | SimpleCollector.`doSetNextReader(LeafReaderContext context)` This method is called before collecting `context`.
    `protected abstract void` | SimpleFieldComparator.`doSetNextReader(LeafReaderContext context)` This method is called before collecting `context`.
    `abstract Explanation` | Weight.`explain(LeafReaderContext context, int doc)` An explanation of the score computation for the named document.
    `Explanation` | FilterWeight.`explain(LeafReaderContext context, int doc)`
    `Explanation` | ConstantScoreWeight.`explain(LeafReaderContext context, int doc)`
    `Explanation` | DisjunctionMaxQuery.DisjunctionMaxWeight.`explain(LeafReaderContext context, int doc)` Explain the score we computed for doc
    `Explanation` | DoubleValuesSource.`explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)` An explanation of the value for the named document.
    `protected BinaryDocValues` | FieldComparator.TermValComparator.`getBinaryDocValues(LeafReaderContext context, String field)` Retrieves the BinaryDocValues for the field in this segment
    `LeafFieldComparator[]` | FieldValueHitQueue.`getComparators(LeafReaderContext context)`
    `LeafCollector` | MultiCollectorManager.Collectors.`getLeafCollector(LeafReaderContext context)`
    `LeafCollector` | SimpleCollector.`getLeafCollector(LeafReaderContext context)`
    `LeafCollector` | Collector.`getLeafCollector(LeafReaderContext context)` Create a new `collector` to collect the given context.
    `LeafCollector` | PositiveScoresOnlyCollector.`getLeafCollector(LeafReaderContext context)`
    `LeafCollector` | MultiCollector.`getLeafCollector(LeafReaderContext context)`
    `LeafCollector` | TimeLimitingCollector.`getLeafCollector(LeafReaderContext context)`
    `LeafCollector` | FilterCollector.`getLeafCollector(LeafReaderContext context)`
    `abstract LeafFieldComparator` | FieldComparator.`getLeafComparator(LeafReaderContext context)` Get a per-segment `LeafFieldComparator` to collect the given `LeafReaderContext`.
    `LeafFieldComparator` | FieldComparator.RelevanceComparator.`getLeafComparator(LeafReaderContext context)`
    `LeafFieldComparator` | FieldComparator.TermOrdValComparator.`getLeafComparator(LeafReaderContext context)`
    `LeafFieldComparator` | FieldComparator.TermValComparator.`getLeafComparator(LeafReaderContext context)`
    `LeafFieldComparator` | SimpleFieldComparator.`getLeafComparator(LeafReaderContext context)`
    `protected SortedDocValues` | FieldComparator.TermOrdValComparator.`getSortedDocValues(LeafReaderContext context, String field)` Retrieves the SortedDocValues for the field in this segment
    `abstract DoubleValues` | DoubleValuesSource.`getValues(LeafReaderContext ctx, DoubleValues scores)` Returns a `DoubleValues` instance for the passed-in LeafReaderContext and scores If scores are not needed to calculate the values (ie `returns false`, callers may safely pass `null` for the `scores` parameter.
    `abstract LongValues` | LongValuesSource.`getValues(LeafReaderContext ctx, DoubleValues scores)` Returns a `LongValues` instance for the passed-in LeafReaderContext and scores If scores are not needed to calculate the values (ie `returns false`, callers may safely pass `null` for the `scores` parameter.
    `boolean` | SegmentCacheable.`isCacheable(LeafReaderContext ctx)`
    `boolean` | FilterWeight.`isCacheable(LeafReaderContext ctx)`
    `boolean` | DisjunctionMaxQuery.DisjunctionMaxWeight.`isCacheable(LeafReaderContext ctx)`
    `Matches` | Weight.`matches(LeafReaderContext context, int doc)` Returns `Matches` for a specific document, or `null` if the document does not match the parent query A query match that contains no position information (for example, a Point or DocValues query) will return `MatchesUtils.MATCH_WITH_NO_TERMS`
    `Matches` | FilterWeight.`matches(LeafReaderContext context, int doc)`
    `Matches` | DisjunctionMaxQuery.DisjunctionMaxWeight.`matches(LeafReaderContext context, int doc)`
    `abstract Scorer` | Weight.`scorer(LeafReaderContext context)` Returns a `Scorer` which can iterate in order over all matching documents and assign them a score.
    `Scorer` | FilterWeight.`scorer(LeafReaderContext context)`
    `Scorer` | DisjunctionMaxQuery.DisjunctionMaxWeight.`scorer(LeafReaderContext context)` Create the scorer used to score our associated DisjunctionMaxQuery
    `ScorerSupplier` | Weight.`scorerSupplier(LeafReaderContext context)` Optional method.

    Method parameters in org.apache.lucene.search with type arguments of type LeafReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | IndexSearcher.`search(List<LeafReaderContext> leaves, Weight weight, Collector collector)` Lower-level search API.
    `protected IndexSearcher.LeafSlice[]` | IndexSearcher.`slices(List<LeafReaderContext> leaves)` Expert: Creates an array of leaf slices each holding a subset of the given leaves.

    Constructors in org.apache.lucene.search with parameters of type LeafReaderContext
    Constructor and Description
    `LeafSlice(LeafReaderContext... leaves)`

    Constructor parameters in org.apache.lucene.search with type arguments of type LeafReaderContext
    Constructor and Description
    `LRUQueryCache(int maxSize, long maxRamBytesUsed, Predicate<LeafReaderContext> leavesToCache, float skipCacheFactor)` Expert: Create a new instance that will cache at most `maxSize` queries with at most `maxRamBytesUsed` bytes of memory, only on leaves that satisfy `leavesToCache`.

  - ### Uses of LeafReaderContext in org.apache.lucene.search.comparators

    Methods in org.apache.lucene.search.comparators with parameters of type LeafReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `LeafFieldComparator` | DoubleComparator.`getLeafComparator(LeafReaderContext context)`
    `LeafFieldComparator` | FloatComparator.`getLeafComparator(LeafReaderContext context)`
    `LeafFieldComparator` | DocComparator.`getLeafComparator(LeafReaderContext context)`
    `LeafFieldComparator` | LongComparator.`getLeafComparator(LeafReaderContext context)`
    `LeafFieldComparator` | IntComparator.`getLeafComparator(LeafReaderContext context)`
    `protected NumericDocValues` | NumericComparator.NumericLeafComparator.`getNumericDocValues(LeafReaderContext context, String field)` Retrieves the NumericDocValues for the field in this segment

    Constructors in org.apache.lucene.search.comparators with parameters of type LeafReaderContext
    Constructor and Description
    `DoubleLeafComparator(LeafReaderContext context)`
    `FloatLeafComparator(LeafReaderContext context)`
    `IntLeafComparator(LeafReaderContext context)`
    `LongLeafComparator(LeafReaderContext context)`
    `NumericLeafComparator(LeafReaderContext context)`

  - ### Uses of LeafReaderContext in org.apache.lucene.search.spans

    Methods in org.apache.lucene.search.spans with parameters of type LeafReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `Explanation` | SpanWeight.`explain(LeafReaderContext context, int doc)`
    `LeafSimScorer` | SpanWeight.`getSimScorer(LeafReaderContext context)` Return a LeafSimScorer for this context
    `Spans` | SpanOrQuery.SpanOrWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `Spans` | SpanNearQuery.SpanNearWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `Spans` | SpanPositionCheckQuery.SpanPositionCheckWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `Spans` | SpanWithinQuery.SpanWithinWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)` Return spans from `little` that are contained in a spans from `big`.
    `abstract Spans` | SpanWeight.`getSpans(LeafReaderContext ctx, SpanWeight.Postings requiredPostings)` Expert: Return a Spans object iterating over matches from this Weight
    `Spans` | SpanContainingQuery.SpanContainingWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)` Return spans from `big` that contain at least one spans from `little`.
    `Spans` | SpanTermQuery.SpanTermWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `Spans` | SpanNotQuery.SpanNotWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `boolean` | SpanOrQuery.SpanOrWeight.`isCacheable(LeafReaderContext ctx)`
    `boolean` | SpanNearQuery.SpanNearWeight.`isCacheable(LeafReaderContext ctx)`
    `boolean` | SpanPositionCheckQuery.SpanPositionCheckWeight.`isCacheable(LeafReaderContext ctx)`
    `boolean` | SpanWithinQuery.SpanWithinWeight.`isCacheable(LeafReaderContext ctx)`
    `boolean` | SpanContainingQuery.SpanContainingWeight.`isCacheable(LeafReaderContext ctx)`
    `boolean` | SpanTermQuery.SpanTermWeight.`isCacheable(LeafReaderContext ctx)`
    `boolean` | SpanNotQuery.SpanNotWeight.`isCacheable(LeafReaderContext ctx)`
    `Matches` | SpanWeight.`matches(LeafReaderContext context, int doc)`
    `SpanScorer` | SpanWeight.`scorer(LeafReaderContext context)`

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