com.attivio.sdk.search.relevancy

Enum ScoreMode

java.lang.Object

java.lang.Enum<ScoreMode>

com.attivio.sdk.search.relevancy.ScoreMode

All Implemented Interfaces:

Serializable, Comparable<ScoreMode>

public enum ScoreMode
extends Enum<ScoreMode>

Scoring mode for PhraseQuery relevancy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BM11 BM25 scoring with b coefficient of 1.0
BM15 BM25 scoring with b coefficient of 0.0
CONSTANT Constant scoring.
POSITION Position based scoring.
TFIDF BM25 based scoring (default).

Method Summary

Modifier and Type	Method and Description
static ScoreMode	valueOf(Query query) Get the scoring mode set for query.
static ScoreMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScoreMode[]	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

TFIDF

public static final ScoreMode TFIDF

BM25 based scoring (default).

CONSTANT

public static final ScoreMode CONSTANT

Constant scoring.

POSITION

public static final ScoreMode POSITION

Position based scoring.

BM11

public static final ScoreMode BM11

BM25 scoring with b coefficient of 1.0

BM15

public static final ScoreMode BM15

BM25 scoring with b coefficient of 0.0

Method Detail

values

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

Returns:

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

valueOf

public static ScoreMode 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

valueOf

public static ScoreMode valueOf(Query query)

Get the scoring mode set for query.