Package org.opencms.search.galleries

Enum Class CmsGallerySearchParameters.CmsGallerySearchWordMode

java.lang.Object

java.lang.Enum<CmsGallerySearchParameters.CmsGallerySearchWordMode>

org.opencms.search.galleries.CmsGallerySearchParameters.CmsGallerySearchWordMode

All Implemented Interfaces:

Serializable, Comparable<CmsGallerySearchParameters.CmsGallerySearchWordMode>, Constable

Enclosing class:

CmsGallerySearchParameters

public static enum CmsGallerySearchParameters.CmsGallerySearchWordMode
extends Enum<CmsGallerySearchParameters.CmsGallerySearchWordMode>

Modes for the pre-processing of the search words entered by the user.

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
infix	Search for the words as sub-words, matching anywhere within a word.
plain	Search for the words as entered, without any pre-processing.

Field Summary

Fields

Modifier and Type	Field	Description
static final CmsGallerySearchParameters.CmsGallerySearchWordMode	DEFAULT	The default search word mode.

Method Summary

Modifier and Type	Method	Description
static CmsGallerySearchParameters.CmsGallerySearchWordMode	lookup(String value)	Returns the search word mode matching the given configuration value.
static CmsGallerySearchParameters.CmsGallerySearchWordMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CmsGallerySearchParameters.CmsGallerySearchWordMode[]	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

infix

public static final CmsGallerySearchParameters.CmsGallerySearchWordMode infix

Search for the words as sub-words, matching anywhere within a word.

plain

public static final CmsGallerySearchParameters.CmsGallerySearchWordMode plain

Search for the words as entered, without any pre-processing.

Field Details

DEFAULT

public static final CmsGallerySearchParameters.CmsGallerySearchWordMode DEFAULT

The default search word mode.

Method Details

values

public static CmsGallerySearchParameters.CmsGallerySearchWordMode[] 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 CmsGallerySearchParameters.CmsGallerySearchWordMode 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

lookup

public static CmsGallerySearchParameters.CmsGallerySearchWordMode lookup(String value)

Returns the search word mode matching the given configuration value.

In case the value does not match a search word mode, DEFAULT is returned.

Parameters:

value - the configuration value to look up

Returns:

the search word mode matching the given configuration value