Enum Class SearchSettings.SearchMode

java.lang.Object

java.lang.Enum<SearchSettings.SearchMode>

ubic.gemma.model.common.search.SearchSettings.SearchMode

All Implemented Interfaces:

Serializable, Comparable<SearchSettings.SearchMode>, Constable

Enclosing class:

SearchSettings

public static enum SearchSettings.SearchMode
extends Enum<SearchSettings.SearchMode>

Author:

paul

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCURATE	Prefer correctness to speed.
BALANCED	Normal search mode with trade-offs to make it usable.
EXACT	Very fast search mode, designed for exact matching of identifiers, etc.
FAST	Fast search mode, designed for autocompletion.

Method Summary

Modifier and Type	Method	Description
boolean	isAtLeast(SearchSettings.SearchMode other)	Check if a search mode is at least as thorough as the given one.
boolean	isAtMost(SearchSettings.SearchMode searchMode)	Check if a search mode is at most as thorough as the given one.
static SearchSettings.SearchMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchSettings.SearchMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXACT

public static final SearchSettings.SearchMode EXACT

Very fast search mode, designed for exact matching of identifiers, etc.

FAST

public static final SearchSettings.SearchMode FAST

Fast search mode, designed for autocompletion.

In this mode, we stop searching as soon as we have enough results to satisfy the request.

BALANCED

public static final SearchSettings.SearchMode BALANCED

Normal search mode with trade-offs to make it usable.

ACCURATE

public static final SearchSettings.SearchMode ACCURATE

Prefer correctness to speed.

Method Details

values

public static SearchSettings.SearchMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SearchSettings.SearchMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isAtLeast

public boolean isAtLeast(SearchSettings.SearchMode other)

Check if a search mode is at least as thorough as the given one.

isAtMost

public boolean isAtMost(SearchSettings.SearchMode searchMode)

Check if a search mode is at most as thorough as the given one.