Package de.cxp.ocs.smartsuggest.spi

Enum Class SuggestConfig.SortStrategy

java.lang.Object

java.lang.Enum<SuggestConfig.SortStrategy>

de.cxp.ocs.smartsuggest.spi.SuggestConfig.SortStrategy

All Implemented Interfaces:

Serializable, Comparable<SuggestConfig.SortStrategy>, Constable

Enclosing class:

SuggestConfig

public static enum SuggestConfig.SortStrategy
extends Enum<SuggestConfig.SortStrategy>

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
MatchGroupsSeparated	Suggestions are ordered by their match-group (sharpened, primary, secondary, fuzzy1, fuzzy2, etc).
PrimaryAndSecondaryByWeight	Similar to MatchGroupsSeparated, but "primary" and "secondary" group are considered equal and merged.

Method Summary

Modifier and Type	Method	Description
static SuggestConfig.SortStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SuggestConfig.SortStrategy[]	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

MatchGroupsSeparated

public static final SuggestConfig.SortStrategy MatchGroupsSeparated

Suggestions are ordered by their match-group (sharpened, primary, secondary, fuzzy1, fuzzy2, etc). Within each group, matches are ordered according to "best match" (a combination of match-position and weight).

PrimaryAndSecondaryByWeight

public static final SuggestConfig.SortStrategy PrimaryAndSecondaryByWeight

Similar to MatchGroupsSeparated, but "primary" and "secondary" group are considered equal and merged. Within these first match groups, suggestions are only ordered by weight.

Method Details

values

public static SuggestConfig.SortStrategy[] 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 SuggestConfig.SortStrategy 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