org.alfresco.repo.dictionary

Enum IndexTokenisationMode

java.lang.Object

java.lang.Enum<IndexTokenisationMode>

org.alfresco.repo.dictionary.IndexTokenisationMode

All Implemented Interfaces:

Serializable, Comparable<IndexTokenisationMode>

public enum IndexTokenisationMode
extends Enum<IndexTokenisationMode>

How tokenisation is supported in the index.

Author:

andyh

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH There may be two indexes - one to support ordering and one to support search.
FALSE Do not tokenise the property.
TRUE Tokenise the property.

Method Summary

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

TRUE

public static final IndexTokenisationMode TRUE

Tokenise the property. If the analyser supported ordering then the field supports ordering FTS is supported via analysis.

FALSE

public static final IndexTokenisationMode FALSE

Do not tokenise the property. The field supports ordering and pattern matching.

BOTH

public static final IndexTokenisationMode BOTH

There may be two indexes - one to support ordering and one to support search.

Method Detail

values

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

Returns:

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

valueOf

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

serializer

public static String serializer(IndexTokenisationMode indexTokenisationMode)

deserializer

public static IndexTokenisationMode deserializer(String value)