io.georocket.query

Enum QueryCompiler.MatchPriority

java.lang.Object

java.lang.Enum<QueryCompiler.MatchPriority>

io.georocket.query.QueryCompiler.MatchPriority

All Implemented Interfaces:

Serializable, Comparable<QueryCompiler.MatchPriority>

Enclosing interface:

QueryCompiler

public static enum QueryCompiler.MatchPriority
extends Enum<QueryCompiler.MatchPriority>

Specifies how the query returned by QueryCompiler.compileQuery(String) should be applied

Enum Constant Summary

Enum Constants

Enum Constant and Description
MUST The query must appear in the matching documents
NONE The query should not be applied at all
ONLY The query is the only one that should be applied.
SHOULD The query should appear in the matching documents

Method Summary

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

NONE

public static final QueryCompiler.MatchPriority NONE

The query should not be applied at all

SHOULD

public static final QueryCompiler.MatchPriority SHOULD

The query should appear in the matching documents

MUST

public static final QueryCompiler.MatchPriority MUST

The query must appear in the matching documents

ONLY

public static final QueryCompiler.MatchPriority ONLY

The query is the only one that should be applied. Queries by other QueryCompiler instances should be ignored.

Method Detail

values

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

Returns:

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

valueOf

public static QueryCompiler.MatchPriority 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