org.alfresco.repo.search.adaptor.lucene

Enum LuceneFunction

java.lang.Object

java.lang.Enum<LuceneFunction>

org.alfresco.repo.search.adaptor.lucene.LuceneFunction

All Implemented Interfaces:

Serializable, Comparable<LuceneFunction>

public enum LuceneFunction
extends Enum<LuceneFunction>

Functions that can be applied to lucene fields Currently upper and lower that perform a case insensitive match for untokenised fields. (If the field is tokenised the match should already be case insensitive.)

Author:

andyh

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIELD A normal lucene field match.
LOWER Match as if the field was converted to lower case.
UPPER Match as if the field was converted to upper case.

Method Summary

Methods

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

UPPER

public static final LuceneFunction UPPER

Match as if the field was converted to upper case.

LOWER

public static final LuceneFunction LOWER

Match as if the field was converted to lower case.

FIELD

public static final LuceneFunction FIELD

A normal lucene field match.

Method Detail

values

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

Returns:

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

valueOf

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