## Uses of Class
org.apache.lucene.search.Similarity

- Packages that use Similarity
  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.spans | The calculus of spans.

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

    Methods in org.apache.lucene.index that return Similarity
    Modifier and Type | Method and Description
    --- | ---
    `Similarity` | IndexWriter.`getSimilarity()` Expert: Return the Similarity implementation used by this IndexWriter.

    Methods in org.apache.lucene.index with parameters of type Similarity
    Modifier and Type | Method and Description
    --- | ---
    `void` | IndexWriter.`setSimilarity(Similarity similarity)` Expert: Set the Similarity implementation used by this IndexWriter.

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

    Subclasses of Similarity in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DefaultSimilarity` Expert: Default scoring implementation.
    `class` | `SimilarityDelegator` Expert: Delegating scoring implementation.

    Fields in org.apache.lucene.search declared as Similarity
    Modifier and Type | Field and Description
    --- | ---
    `protected Similarity` | DisjunctionMaxQuery.DisjunctionMaxWeight.`similarity` The Similarity implementation.
    `protected Similarity` | BooleanQuery.BooleanWeight.`similarity` The Similarity implementation.

    Methods in org.apache.lucene.search that return Similarity
    Modifier and Type | Method and Description
    --- | ---
    `static Similarity` | Similarity.`getDefault()` Return the default Similarity implementation used by indexing and search code.
    `Similarity` | Searcher.`getSimilarity()` Expert: Return the Similarity implementation used by this Searcher.
    `Similarity` | ScoreCachingWrappingScorer.`getSimilarity()`
    `Similarity` | Scorer.`getSimilarity()` Returns the Similarity implementation used by this scorer.
    `Similarity` | BooleanQuery.`getSimilarity(Searcher searcher)`
    `Similarity` | Query.`getSimilarity(Searcher searcher)` Expert: Returns the Similarity implementation to be used for this query.

    Methods in org.apache.lucene.search with parameters of type Similarity
    Modifier and Type | Method and Description
    --- | ---
    `static void` | Similarity.`setDefault(Similarity similarity)` Set the default Similarity implementation used by indexing and search code.
    `void` | Searcher.`setSimilarity(Similarity similarity)` Expert: Set the Similarity implementation used by this Searcher.

    Constructors in org.apache.lucene.search with parameters of type Similarity
    Constructor and Description
    `ConstantScorer(Similarity similarity, IndexReader reader, Weight w)`
    `Scorer(Similarity similarity)` Constructs a Scorer.
    `SimilarityDelegator(Similarity delegee)` Construct a `Similarity` that delegates all methods to another.

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

    Methods in org.apache.lucene.search.payloads with parameters of type Similarity
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer.`processPayload(Similarity similarity)`

    Constructors in org.apache.lucene.search.payloads with parameters of type Similarity
    Constructor and Description
    `PayloadNearSpanScorer(Spans spans, Weight weight, Similarity similarity, byte[] norms)`
    `PayloadTermSpanScorer(TermSpans spans, Weight weight, Similarity similarity, byte[] norms)`

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

    Fields in org.apache.lucene.search.spans declared as Similarity
    Modifier and Type | Field and Description
    --- | ---
    `protected Similarity` | SpanWeight.`similarity`

    Methods in org.apache.lucene.search.spans that return Similarity
    Modifier and Type | Method and Description
    --- | ---
    `Similarity` | FieldMaskingSpanQuery.`getSimilarity(Searcher searcher)`

    Constructors in org.apache.lucene.search.spans with parameters of type Similarity
    Constructor and Description
    `SpanScorer(Spans spans, Weight weight, Similarity similarity, byte[] norms)`

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