Package com.atlassian.confluence.search.v2.query

Enum FunctionScoreQuery.BoostMode

java.lang.Object

java.lang.Enum<FunctionScoreQuery.BoostMode>

com.atlassian.confluence.search.v2.query.FunctionScoreQuery.BoostMode

All Implemented Interfaces:

Serializable, Comparable<FunctionScoreQuery.BoostMode>

Enclosing class:

FunctionScoreQuery

public static enum FunctionScoreQuery.BoostMode
extends Enum<FunctionScoreQuery.BoostMode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MAX
MIN
MULTIPLY
REPLACE
SUM

Method Summary

Modifier and Type	Method	Description
abstract double	apply(double queryScore, double functionScore)
static FunctionScoreQuery.BoostMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FunctionScoreQuery.BoostMode[]	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

MULTIPLY

public static final FunctionScoreQuery.BoostMode MULTIPLY

SUM

public static final FunctionScoreQuery.BoostMode SUM

MIN

public static final FunctionScoreQuery.BoostMode MIN

MAX

public static final FunctionScoreQuery.BoostMode MAX

REPLACE

public static final FunctionScoreQuery.BoostMode REPLACE

Method Detail

values

public static FunctionScoreQuery.BoostMode[] 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 (FunctionScoreQuery.BoostMode c : FunctionScoreQuery.BoostMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static FunctionScoreQuery.BoostMode 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

apply

public abstract double apply(double queryScore,
                             double functionScore)