com.endeca.infront.navigation.model

Enum MatchMode

java.lang.Object

java.lang.Enum<MatchMode>

com.endeca.infront.navigation.model.MatchMode

All Implemented Interfaces:

Serializable, Comparable<MatchMode>

public enum MatchMode
extends Enum<MatchMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Match all user search terms (i.e., perform a conjunctive search).
ALLANY Match all user search terms if possible, otherwise match at least one.
ALLPARTIAL Match all user search terms if possible, otherwise match some.
ANY Match at least one user search term.
BOOLEAN Match using a Boolean query.
PARTIAL Match some user search terms.
PARTIALMAX Match a maximal subset of user search terms.
UNKNOWN The mode is unknown.

Method Summary

Methods

Modifier and Type	Method and Description
static MatchMode	getValue(String mode) Returns the MatchMode whose name or toString() method matches the input argument.
String	toString()
static MatchMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static MatchMode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALL

public static final MatchMode ALL

Match all user search terms (i.e., perform a conjunctive search).

PARTIAL

public static final MatchMode PARTIAL

Match some user search terms.

ANY

public static final MatchMode ANY

Match at least one user search term.

ALLPARTIAL

public static final MatchMode ALLPARTIAL

Match all user search terms if possible, otherwise match some.

ALLANY

public static final MatchMode ALLANY

Match all user search terms if possible, otherwise match at least one.

PARTIALMAX

public static final MatchMode PARTIALMAX

Match a maximal subset of user search terms.

BOOLEAN

public static final MatchMode BOOLEAN

Match using a Boolean query.

UNKNOWN

public static final MatchMode UNKNOWN

The mode is unknown.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<MatchMode>

getValue

public static MatchMode getValue(String mode)

Returns the MatchMode whose name or toString() method matches the input argument. If no such MatchMode is found, throws an IllegalArgumentException.

This method should be used instead of Enum.valueOf(Class, String) because this enum modifies the return value of toString().