org.elasticsearch.search.aggregations.bucket.significant.heuristics

Class ScriptHeuristic

java.lang.Object

org.elasticsearch.search.aggregations.bucket.significant.heuristics.SignificanceHeuristic

org.elasticsearch.search.aggregations.bucket.significant.heuristics.ScriptHeuristic

public class ScriptHeuristic
extends SignificanceHeuristic

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ScriptHeuristic.LongAccessor
static class	ScriptHeuristic.ScriptHeuristicBuilder
static class	ScriptHeuristic.ScriptHeuristicParser

Field Summary

Fields

Modifier and Type	Field and Description
protected static ParseField	NAMES_FIELD
static SignificanceHeuristicStreams.Stream	STREAM

Constructor Summary

Constructors

Constructor and Description
ScriptHeuristic(ExecutableScript searchScript, String scriptLang, String scriptString, ScriptService.ScriptType scriptType, Map<String,Object> params)

Method Summary

Modifier and Type	Method and Description
double	getScore(long subsetFreq, long subsetSize, long supersetFreq, long supersetSize) Calculates score with a script
void	initialize(InternalAggregation.ReduceContext context)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.search.aggregations.bucket.significant.heuristics.SignificanceHeuristic

checkFrequencyValidity

Methods inherited from class java.lang.Object

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

Field Detail

NAMES_FIELD

protected static final ParseField NAMES_FIELD

STREAM

public static final SignificanceHeuristicStreams.Stream STREAM

Constructor Detail

ScriptHeuristic

public ScriptHeuristic(ExecutableScript searchScript,
                       String scriptLang,
                       String scriptString,
                       ScriptService.ScriptType scriptType,
                       Map<String,Object> params)

Method Detail

initialize

public void initialize(InternalAggregation.ReduceContext context)

Overrides:

initialize in class SignificanceHeuristic

getScore

public double getScore(long subsetFreq,
                       long subsetSize,
                       long supersetFreq,
                       long supersetSize)

Calculates score with a script

Specified by:

getScore in class SignificanceHeuristic

Parameters:

subsetFreq - The frequency of the term in the selected sample

subsetSize - The size of the selected sample (typically number of docs)

supersetFreq - The frequency of the term in the superset from which the sample was taken

supersetSize - The size of the superset from which the sample was taken (typically number of docs)

Returns:

a "significance" score

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in class SignificanceHeuristic

Throws:

IOException