Package ch.tocco.nice2.persist.entity.api.fulltext

Enum Class FulltextSearchBuilder.SearchScope

java.lang.Object

java.lang.Enum<FulltextSearchBuilder.SearchScope>

ch.tocco.nice2.persist.entity.api.fulltext.FulltextSearchBuilder.SearchScope

All Implemented Interfaces:

Serializable, Comparable<FulltextSearchBuilder.SearchScope>, Constable

Enclosing interface:

FulltextSearchBuilder

public static enum FulltextSearchBuilder.SearchScope
extends Enum<FulltextSearchBuilder.SearchScope>

What kind of fulltext search it is: FULLTEXT, RELATION or REMOTEFIELD.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULLTEXT	Uses the fulltext search model that is configured in the entity.
RELATION	Uses the relation search model that is configured in the entity.
REMOTEFIELD	Uses the remote-field search model that is configured in the entity.

Method Summary

Modifier and Type	Method	Description
abstract CommonSearchModel	getSearchModel(EntityModel eModel)	Returns the model that defines how fulltext search is to be done.
static FulltextSearchBuilder.SearchScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FulltextSearchBuilder.SearchScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FULLTEXT

public static final FulltextSearchBuilder.SearchScope FULLTEXT

Uses the fulltext search model that is configured in the entity.

RELATION

public static final FulltextSearchBuilder.SearchScope RELATION

Uses the relation search model that is configured in the entity.

REMOTEFIELD

public static final FulltextSearchBuilder.SearchScope REMOTEFIELD

Uses the remote-field search model that is configured in the entity.

Method Details

values

public static FulltextSearchBuilder.SearchScope[] 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 FulltextSearchBuilder.SearchScope 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

getSearchModel

public abstract CommonSearchModel getSearchModel(EntityModel eModel)

Returns the model that defines how fulltext search is to be done.