org.jbei.ice.lib.dto.search

Enum SearchBoostField

java.lang.Object

java.lang.Enum<SearchBoostField>

org.jbei.ice.lib.dto.search.SearchBoostField

All Implemented Interfaces:

Serializable, Comparable<SearchBoostField>

public enum SearchBoostField
extends Enum<SearchBoostField>

Search fields that have user boost support (shown in the user preference section)

Author:

Hector Plahar

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIAS
KEYWORDS
NAME
SELECTION_MARKER
SUMMARY

Method Summary

Modifier and Type	Method and Description
static SearchBoostField	boostFieldForField(String field)
String	getField()
static SearchBoostField	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchBoostField[]	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

NAME

public static final SearchBoostField NAME

ALIAS

public static final SearchBoostField ALIAS

KEYWORDS

public static final SearchBoostField KEYWORDS

SUMMARY

public static final SearchBoostField SUMMARY

SELECTION_MARKER

public static final SearchBoostField SELECTION_MARKER

Method Detail

values

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

Returns:

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

valueOf

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

getField

public String getField()

boostFieldForField

public static SearchBoostField boostFieldForField(String field)

Parameters:

field - index field

Returns:

boost field associated with index field