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

- Packages that use AtomicReaderContext
  Package | Description
  --- | ---
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.search.payloads | The payloads package provides Query mechanisms for finding and using payloads.
  org.apache.lucene.search.similarities | This package contains the various ranking models that can be used in Lucene.
  org.apache.lucene.search.spans | The calculus of spans.

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

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

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

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

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

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

    Methods in org.apache.lucene.search with parameters of type AtomicReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `abstract Explanation` | Weight.`explain(AtomicReaderContext context, int doc)` An explanation of the score computation for the named document.
    `Explanation` | DisjunctionMaxQuery.DisjunctionMaxWeight.`explain(AtomicReaderContext context, int doc)` Explain the score we computed for doc
    `Explanation` | ConstantScoreQuery.ConstantWeight.`explain(AtomicReaderContext context, int doc)`
    `Explanation` | BooleanQuery.BooleanWeight.`explain(AtomicReaderContext context, int doc)`
    `abstract Scorer` | FilteredQuery.FilterStrategy.`filteredScorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Weight weight, DocIdSet docIdSet)` Returns a filtered `Scorer` based on this strategy.
    `Scorer` | FilteredQuery.RandomAccessFilterStrategy.`filteredScorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Weight weight, DocIdSet docIdSet)`
    `DocIdSet` | QueryWrapperFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)`
    `DocIdSet` | MultiTermQueryWrapperFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)` Returns a DocIdSet with documents that should be permitted in search results.
    `abstract DocIdSet` | Filter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)` Creates a `DocIdSet` enumerating the documents that should be permitted in search results.
    `DocIdSet` | FieldValueFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)`
    `DocIdSet` | FieldCacheTermsFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)`
    `abstract DocIdSet` | FieldCacheRangeFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)` This method is implemented for each data type
    `abstract DocIdSet` | DocTermOrdsRangeFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)` This method is implemented for each data type
    `DocIdSet` | CachingWrapperFilter.`getDocIdSet(AtomicReaderContext context, Bits acceptDocs)`
    `abstract Scorer` | Weight.`scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)` Returns a `Scorer` which scores documents in/out-of order according to `scoreDocsInOrder`.
    `Scorer` | DisjunctionMaxQuery.DisjunctionMaxWeight.`scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)` Create the scorer used to score our associated DisjunctionMaxQuery
    `Scorer` | ConstantScoreQuery.ConstantWeight.`scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)`
    `Scorer` | BooleanQuery.BooleanWeight.`scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)`
    `void` | TotalHitCountCollector.`setNextReader(AtomicReaderContext context)`
    `void` | TopScoreDocCollector.`setNextReader(AtomicReaderContext context)`
    `void` | TimeLimitingCollector.`setNextReader(AtomicReaderContext context)`
    `void` | PositiveScoresOnlyCollector.`setNextReader(AtomicReaderContext context)`
    `void` | MultiCollector.`setNextReader(AtomicReaderContext context)`
    `abstract FieldComparator<T>` | FieldComparator.`setNextReader(AtomicReaderContext context)` Set a new `AtomicReaderContext`.
    `FieldComparator<T>` | FieldComparator.NumericComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<Byte>` | FieldComparator.ByteComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<Double>` | FieldComparator.DoubleComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<Float>` | FieldComparator.FloatComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<Short>` | FieldComparator.ShortComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<Integer>` | FieldComparator.IntComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<Long>` | FieldComparator.LongComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<Float>` | FieldComparator.RelevanceComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<Integer>` | FieldComparator.DocComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<BytesRef>` | FieldComparator.TermOrdValComparator.`setNextReader(AtomicReaderContext context)`
    `FieldComparator<BytesRef>` | FieldComparator.TermValComparator.`setNextReader(AtomicReaderContext context)`
    `abstract void` | Collector.`setNextReader(AtomicReaderContext context)` Called before collecting from each `AtomicReaderContext`.
    `void` | CachingCollector.`setNextReader(AtomicReaderContext context)`

    Method parameters in org.apache.lucene.search with type arguments of type AtomicReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | IndexSearcher.`search(List<AtomicReaderContext> leaves, Weight weight, Collector collector)` Lower-level search API.
    `protected TopFieldDocs` | IndexSearcher.`search(List<AtomicReaderContext> leaves, Weight weight, FieldDoc after, int nDocs, Sort sort, boolean fillFields, boolean doDocScores, boolean doMaxScore)` Just like `IndexSearcher.search(Weight, int, Sort, boolean, boolean)`, but you choose whether or not the fields in the returned `FieldDoc` instances should be set by specifying fillFields.
    `protected TopDocs` | IndexSearcher.`search(List<AtomicReaderContext> leaves, Weight weight, ScoreDoc after, int nDocs)` Expert: Low-level search implementation.
    `protected IndexSearcher.LeafSlice[]` | IndexSearcher.`slices(List<AtomicReaderContext> 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 AtomicReaderContext
    Constructor and Description
    `IndexSearcher.LeafSlice(AtomicReaderContext... leaves)`

  - ### Uses of AtomicReaderContext in org.apache.lucene.search.payloads

    Methods in org.apache.lucene.search.payloads with parameters of type AtomicReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `Explanation` | PayloadTermQuery.PayloadTermWeight.`explain(AtomicReaderContext context, int doc)`
    `Explanation` | PayloadNearQuery.PayloadNearSpanWeight.`explain(AtomicReaderContext context, int doc)`
    `Scorer` | PayloadTermQuery.PayloadTermWeight.`scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)`
    `Scorer` | PayloadNearQuery.PayloadNearSpanWeight.`scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)`

  - ### Uses of AtomicReaderContext in org.apache.lucene.search.similarities

    Methods in org.apache.lucene.search.similarities with parameters of type AtomicReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `Similarity.ExactSimScorer` | TFIDFSimilarity.`exactSimScorer(Similarity.SimWeight stats, AtomicReaderContext context)`
    `Similarity.ExactSimScorer` | SimilarityBase.`exactSimScorer(Similarity.SimWeight stats, AtomicReaderContext context)`
    `abstract Similarity.ExactSimScorer` | Similarity.`exactSimScorer(Similarity.SimWeight weight, AtomicReaderContext context)` Creates a new `Similarity.ExactSimScorer` to score matching documents from a segment of the inverted index.
    `Similarity.ExactSimScorer` | PerFieldSimilarityWrapper.`exactSimScorer(Similarity.SimWeight weight, AtomicReaderContext context)`
    `Similarity.ExactSimScorer` | MultiSimilarity.`exactSimScorer(Similarity.SimWeight stats, AtomicReaderContext context)`
    `Similarity.ExactSimScorer` | BM25Similarity.`exactSimScorer(Similarity.SimWeight stats, AtomicReaderContext context)`
    `Similarity.SloppySimScorer` | TFIDFSimilarity.`sloppySimScorer(Similarity.SimWeight stats, AtomicReaderContext context)`
    `Similarity.SloppySimScorer` | SimilarityBase.`sloppySimScorer(Similarity.SimWeight stats, AtomicReaderContext context)`
    `abstract Similarity.SloppySimScorer` | Similarity.`sloppySimScorer(Similarity.SimWeight weight, AtomicReaderContext context)` Creates a new `Similarity.SloppySimScorer` to score matching documents from a segment of the inverted index.
    `Similarity.SloppySimScorer` | PerFieldSimilarityWrapper.`sloppySimScorer(Similarity.SimWeight weight, AtomicReaderContext context)`
    `Similarity.SloppySimScorer` | MultiSimilarity.`sloppySimScorer(Similarity.SimWeight stats, AtomicReaderContext context)`
    `Similarity.SloppySimScorer` | BM25Similarity.`sloppySimScorer(Similarity.SimWeight stats, AtomicReaderContext context)`

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

    Methods in org.apache.lucene.search.spans with parameters of type AtomicReaderContext
    Modifier and Type | Method and Description
    --- | ---
    `Explanation` | SpanWeight.`explain(AtomicReaderContext context, int doc)`
    `Spans` | SpanTermQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `abstract Spans` | SpanQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)` Expert: Returns the matches for this query in an index.
    `Spans` | SpanPositionCheckQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | SpanOrQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | SpanNotQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | SpanNearQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | SpanMultiTermQueryWrapper.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | FieldMaskingSpanQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Scorer` | SpanWeight.`scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)`

    Constructors in org.apache.lucene.search.spans with parameters of type AtomicReaderContext
    Constructor and Description
    `NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts, boolean collectPayloads)`
    `NearSpansUnordered(SpanNearQuery query, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `SpanPositionCheckQuery.PositionCheckSpan(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`

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