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

- Packages that use TermStates
  Package | Description
  --- | ---
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.search.spans | The calculus of spans.

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

    Methods in org.apache.lucene.index that return TermStates
    Modifier and Type | Method and Description
    --- | ---
    `static TermStates` | TermStates.`build(IndexReaderContext context, Term term, boolean needsStats)` Creates a `TermStates` from a top-level `IndexReaderContext` and the given `Term`.

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

    Methods in org.apache.lucene.search that return TermStates
    Modifier and Type | Method and Description
    --- | ---
    `TermStates` | TermQuery.`getTermStates()` Returns the `TermStates` passed to the constructor, or null if it was not passed.

    Methods in org.apache.lucene.search with parameters of type TermStates
    Modifier and Type | Method and Description
    --- | ---
    `BlendedTermQuery.Builder` | BlendedTermQuery.Builder.`add(Term term, float boost, TermStates context)` Expert: Add a `Term` with the provided boost and context.
    `protected void` | MultiTermQuery.TopTermsBlendedFreqScoringRewrite.`addClause(BlendedTermQuery.Builder topLevel, Term term, int docCount, float boost, TermStates states)`
    `protected void` | MultiTermQuery.TopTermsScoringBooleanQueryRewrite.`addClause(BooleanQuery.Builder topLevel, Term term, int docCount, float boost, TermStates states)`
    `protected void` | MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite.`addClause(BooleanQuery.Builder topLevel, Term term, int docFreq, float boost, TermStates states)`
    `TermStatistics` | IndexSearcher.`termStatistics(Term term, TermStates context)` Deprecated. in favor of `IndexSearcher.termStatistics(Term, int, long)`.

    Constructors in org.apache.lucene.search with parameters of type TermStates
    Constructor and Description
    `TermQuery(Term t, TermStates states)` Expert: constructs a TermQuery that will use the provided docFreq instead of looking up the docFreq against the searcher.

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

    Fields in org.apache.lucene.search.spans declared as TermStates
    Modifier and Type | Field and Description
    --- | ---
    `protected TermStates` | SpanTermQuery.`termStates`

    Methods in org.apache.lucene.search.spans that return TermStates
    Modifier and Type | Method and Description
    --- | ---
    `TermStates` | SpanTermQuery.`getTermStates()` Returns the `TermStates` passed to the constructor, or null if it was not passed.

    Methods in org.apache.lucene.search.spans that return types with arguments of type TermStates
    Modifier and Type | Method and Description
    --- | ---
    `static Map<Term,TermStates>` | SpanQuery.`getTermStates(Collection<SpanWeight> weights)` Build a map of terms to `TermStates`, for use in constructing SpanWeights
    `static Map<Term,TermStates>` | SpanQuery.`getTermStates(SpanWeight... weights)` Build a map of terms to `TermStates`, for use in constructing SpanWeights

    Method parameters in org.apache.lucene.search.spans with type arguments of type TermStates
    Modifier and Type | Method and Description
    --- | ---
    `void` | SpanOrQuery.SpanOrWeight.`extractTermStates(Map<Term,TermStates> contexts)`
    `void` | SpanNearQuery.SpanNearWeight.`extractTermStates(Map<Term,TermStates> contexts)`
    `void` | SpanPositionCheckQuery.SpanPositionCheckWeight.`extractTermStates(Map<Term,TermStates> contexts)`
    `abstract void` | SpanWeight.`extractTermStates(Map<Term,TermStates> contexts)` Collect all TermStates used by this Weight
    `void` | SpanTermQuery.SpanTermWeight.`extractTermStates(Map<Term,TermStates> contexts)`
    `void` | SpanNotQuery.SpanNotWeight.`extractTermStates(Map<Term,TermStates> contexts)`

    Constructors in org.apache.lucene.search.spans with parameters of type TermStates
    Constructor and Description
    `SpanTermQuery(Term term, TermStates termStates)` Expert: Construct a SpanTermQuery matching the named term's spans, using the provided TermStates
    `SpanTermWeight(TermStates termStates, IndexSearcher searcher, Map<Term,TermStates> terms, float boost)`

    Constructor parameters in org.apache.lucene.search.spans with type arguments of type TermStates
    Constructor and Description
    `SpanContainingWeight(IndexSearcher searcher, Map<Term,TermStates> terms, SpanWeight bigWeight, SpanWeight littleWeight, float boost)`
    `SpanNearWeight(List<SpanWeight> subWeights, IndexSearcher searcher, Map<Term,TermStates> terms, float boost)`
    `SpanNotWeight(IndexSearcher searcher, Map<Term,TermStates> terms, SpanWeight includeWeight, SpanWeight excludeWeight, float boost)`
    `SpanOrWeight(IndexSearcher searcher, Map<Term,TermStates> terms, List<SpanWeight> subWeights, float boost)`
    `SpanPositionCheckWeight(SpanWeight matchWeight, IndexSearcher searcher, Map<Term,TermStates> terms, float boost)`
    `SpanTermWeight(TermStates termStates, IndexSearcher searcher, Map<Term,TermStates> terms, float boost)`
    `SpanWeight(SpanQuery query, IndexSearcher searcher, Map<Term,TermStates> termStates, float boost)` Create a new SpanWeight
    `SpanWithinWeight(IndexSearcher searcher, Map<Term,TermStates> terms, SpanWeight bigWeight, SpanWeight littleWeight, float boost)`

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