net.sf.mmm.search.api.config

Enum SearchFieldMode

java.lang.Object

java.lang.Enum<SearchFieldMode>

net.sf.mmm.search.api.config.SearchFieldMode

All Implemented Interfaces:

Serializable, Comparable<SearchFieldMode>

public enum SearchFieldMode
extends Enum<SearchFieldMode>

This enum contains the available modes for indexing and storing fields.

See Also:

SearchFieldConfiguration.getMode()

Enum Constant Summary

Enum Constants

Enum Constant and Description
RETRIEVABLE Indicates that the field will NOT be indexed but only stored.
SEARCHABLE Indicates that the field will be searchable but NOT retrievable.
SEARCHABLE_AND_RETRIEVABLE Indicates that the field will be searchable and retrievable.

Method Summary

Modifier and Type	Method and Description
boolean	isRetrievable() This method determines if the represented field can be retrieved from a SearchEntry.
boolean	isSearchable() This method determines if the represented field will be searchable so it can be found via the SearchEngine.
static SearchFieldMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchFieldMode[]	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

SEARCHABLE_AND_RETRIEVABLE

public static final SearchFieldMode SEARCHABLE_AND_RETRIEVABLE

Indicates that the field will be searchable and retrievable. This is the default.

SEARCHABLE

public static final SearchFieldMode SEARCHABLE

Indicates that the field will be searchable but NOT retrievable. This is useful for indexing very large texts. Please note that highlighting only works for retrievable fields.

RETRIEVABLE

public static final SearchFieldMode RETRIEVABLE

Indicates that the field will NOT be indexed but only stored. Such field is hidden for the SearchEngine but can be retrieved from the result.

Method Detail

values

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

Returns:

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

valueOf

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

isSearchable

public boolean isSearchable()

This method determines if the represented field will be searchable so it can be found via the SearchEngine.

Returns:

true if searchable, false otherwise (hidden for searches).

isRetrievable

public boolean isRetrievable()

This method determines if the represented field can be retrieved from a SearchEntry.

Returns:

true if retrievable, false otherwise (can be found but NOT retrieved).