Module org.elasticsearch.server
Package org.elasticsearch.index.similarity

Class ScriptedSimilarity

java.lang.Object
org.apache.lucene.search.similarities.Similarity
org.elasticsearch.index.similarity.ScriptedSimilarity
public final class ScriptedSimilarity extends org.apache.lucene.search.similarities.Similarity
A Similarity implementation that allows scores to be scripted.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ScriptedSimilarity.Doc
    Statistics that are specific to a document.
    static class 
    ScriptedSimilarity.Field
    Statistics that are specific to a given field.
    static class 
    ScriptedSimilarity.Query
    Scoring factors that come from the query.
    static class 
    ScriptedSimilarity.Term
    Statistics that are specific to a given term.

    Nested classes/interfaces inherited from class org.apache.lucene.search.similarities.Similarity

    org.apache.lucene.search.similarities.Similarity.SimScorer

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScriptedSimilarity(String weightScriptString, SimilarityWeightScript.Factory weightScriptFactory, String scriptString, SimilarityScript.Factory scriptFactory, boolean discountOverlaps)
    Sole constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    computeNorm(org.apache.lucene.index.FieldInvertState state)
     
    org.apache.lucene.search.similarities.Similarity.SimScorer
    scorer(float boost, org.apache.lucene.search.CollectionStatistics collectionStats, org.apache.lucene.search.TermStatistics... termStats)
     
    String
    toString()
     

    Methods inherited from class org.apache.lucene.search.similarities.Similarity

    getDiscountOverlaps

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • computeNorm

      public long computeNorm(org.apache.lucene.index.FieldInvertState state)
      Overrides:
      computeNorm in class org.apache.lucene.search.similarities.Similarity

    • scorer

      public org.apache.lucene.search.similarities.Similarity.SimScorer scorer(float boost, org.apache.lucene.search.CollectionStatistics collectionStats, org.apache.lucene.search.TermStatistics... termStats)
      Specified by:
      scorer in class org.apache.lucene.search.similarities.Similarity