org.elasticsearch.index.query.functionscore.random

Class RandomScoreFunctionBuilder

java.lang.Object

org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder

org.elasticsearch.index.query.functionscore.random.RandomScoreFunctionBuilder

All Implemented Interfaces:

ToXContent

public class RandomScoreFunctionBuilder
extends ScoreFunctionBuilder

A function that computes a random score for the matched documents

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
RandomScoreFunctionBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
void	doXContent(XContentBuilder builder, ToXContent.Params params)
String	getName()
RandomScoreFunctionBuilder	seed(int seed) Sets the seed based on which the random number will be generated.
RandomScoreFunctionBuilder	seed(long seed) seed variant taking a long value.
RandomScoreFunctionBuilder	seed(String seed) seed variant taking a String value.

Methods inherited from class org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder

buildWeight, setWeight, toXContent

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomScoreFunctionBuilder

public RandomScoreFunctionBuilder()

Method Detail

getName

public String getName()

Specified by:

getName in class ScoreFunctionBuilder

seed

public RandomScoreFunctionBuilder seed(int seed)

Sets the seed based on which the random number will be generated. Using the same seed is guaranteed to generate the same random number for a specific doc.

Parameters:

seed - The seed.

seed

public RandomScoreFunctionBuilder seed(long seed)

seed variant taking a long value.

See Also:

seed(int)

seed

public RandomScoreFunctionBuilder seed(String seed)

seed variant taking a String value.

See Also:

seed(int)

doXContent

public void doXContent(XContentBuilder builder,
              ToXContent.Params params)
                throws IOException

Specified by:

doXContent in class ScoreFunctionBuilder

Throws:

IOException