com.marklogic.client.type

Enum PlanSearchOptions.ScoreMethod

java.lang.Object

java.lang.Enum<PlanSearchOptions.ScoreMethod>

com.marklogic.client.type.PlanSearchOptions.ScoreMethod

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PlanSearchOptions.ScoreMethod>

Enclosing interface:

PlanSearchOptions

public static enum PlanSearchOptions.ScoreMethod
extends java.lang.Enum<PlanSearchOptions.ScoreMethod>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BM25
LOGTF
LOGTFIDF
SIMPLE

Method Summary

Modifier and Type	Method and Description
static PlanSearchOptions.ScoreMethod	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PlanSearchOptions.ScoreMethod[]	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

LOGTFIDF

public static final PlanSearchOptions.ScoreMethod LOGTFIDF

LOGTF

public static final PlanSearchOptions.ScoreMethod LOGTF

SIMPLE

public static final PlanSearchOptions.ScoreMethod SIMPLE

BM25

public static final PlanSearchOptions.ScoreMethod BM25

Method Detail

values

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

Returns:

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

valueOf

public static PlanSearchOptions.ScoreMethod valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null