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, org.apache.lucene.search.similarities.Similarity.SimWeight

Constructor Summary

Constructors

Constructor	Description
ScriptedSimilarity(java.lang.String weightScriptString, SimilarityWeightScript.Factory weightScriptFactory, java.lang.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.SimWeight	computeWeight(float boost, org.apache.lucene.search.CollectionStatistics collectionStats, org.apache.lucene.search.TermStatistics... termStats)
org.apache.lucene.search.similarities.Similarity.SimScorer	simScorer(org.apache.lucene.search.similarities.Similarity.SimWeight w, org.apache.lucene.index.LeafReaderContext context)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptedSimilarity

public ScriptedSimilarity(java.lang.String weightScriptString,
                          SimilarityWeightScript.Factory weightScriptFactory,
                          java.lang.String scriptString,
                          SimilarityScript.Factory scriptFactory,
                          boolean discountOverlaps)

Sole constructor.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

computeNorm

public long computeNorm(org.apache.lucene.index.FieldInvertState state)

Specified by:

computeNorm in class org.apache.lucene.search.similarities.Similarity

computeWeight

public org.apache.lucene.search.similarities.Similarity.SimWeight computeWeight(float boost,
                                                                                org.apache.lucene.search.CollectionStatistics collectionStats,
                                                                                org.apache.lucene.search.TermStatistics... termStats)

Specified by:

computeWeight in class org.apache.lucene.search.similarities.Similarity

simScorer

public org.apache.lucene.search.similarities.Similarity.SimScorer simScorer(org.apache.lucene.search.similarities.Similarity.SimWeight w,
                                                                            org.apache.lucene.index.LeafReaderContext context)
                                                                     throws java.io.IOException

Specified by:

simScorer in class org.apache.lucene.search.similarities.Similarity

Throws:

java.io.IOException