org.elasticsearch.index.search.child

Enum ScoreType

java.lang.Object

java.lang.Enum<ScoreType>

org.elasticsearch.index.search.child.ScoreType

All Implemented Interfaces:

Serializable, Comparable<ScoreType>

public enum ScoreType
extends Enum<ScoreType>

Defines how scores from child documents are mapped into the parent document.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVG The average score based on all matching child documents are mapped into the parent.
MAX Only the highest score of all matching child documents is mapped into the parent.
MIN Only the lowest score of all matching child documents is mapped into the parent.
NONE Scores are not taken into account
SUM The matching children scores is summed up and mapped into the parent.

Method Summary

Methods

Modifier and Type	Method and Description
static ScoreType	fromString(String type)
static ScoreType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScoreType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MIN

public static final ScoreType MIN

Only the lowest score of all matching child documents is mapped into the parent.

MAX

public static final ScoreType MAX

Only the highest score of all matching child documents is mapped into the parent.

AVG

public static final ScoreType AVG

The average score based on all matching child documents are mapped into the parent.

SUM

public static final ScoreType SUM

The matching children scores is summed up and mapped into the parent.

NONE

public static final ScoreType NONE

Scores are not taken into account

Method Detail

values

public static ScoreType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScoreType c : ScoreType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScoreType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static ScoreType fromString(String type)