com.bericotech.clavin.gazetteer.query

Enum FuzzyMode

java.lang.Object

java.lang.Enum<FuzzyMode>

com.bericotech.clavin.gazetteer.query.FuzzyMode

All Implemented Interfaces:

Serializable, Comparable<FuzzyMode>

public enum FuzzyMode
extends Enum<FuzzyMode>

This enum is used to indicate how and when to apply fuzzy matching for gazetteer queries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILL Use fuzzy matching to fill search results, up to the requested maximum number, after all exact matches have been discovered.
NO_EXACT Use fuzzy matching only if no exact matches can be found.
OFF Do not use fuzzy matching.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	useFuzzyMatching(int maxResults, int exactResults) Indicates whether a fuzzy query should be performed in this mode based on the number of results found and the maximum number of results.
static FuzzyMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FuzzyMode[]	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

OFF

public static final FuzzyMode OFF

Do not use fuzzy matching.

NO_EXACT

public static final FuzzyMode NO_EXACT

Use fuzzy matching only if no exact matches can be found. This is the original behavior of CLAVIN when fuzzy=true.

FILL

public static final FuzzyMode FILL

Use fuzzy matching to fill search results, up to the requested maximum number, after all exact matches have been discovered.

Method Detail

values

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

Returns:

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

valueOf

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

useFuzzyMatching

public boolean useFuzzyMatching(int maxResults,
                       int exactResults)

Indicates whether a fuzzy query should be performed in this mode based on the number of results found and the maximum number of results.

Parameters:

maxResults - the maximum number of results to return

exactResults - the number of exact results found

Returns:

true if fuzzy matching should be applied