com.mware.ge

Enum TextIndexHint

java.lang.Object

java.lang.Enum<TextIndexHint>

com.mware.ge.TextIndexHint

All Implemented Interfaces:

Serializable, Comparable<TextIndexHint>

public enum TextIndexHint
extends Enum<TextIndexHint>

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXACT_MATCH Index this property for exact match searches.
FULL_TEXT Tokenize this property and index it for full text search.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<TextIndexHint>	ALL The set of indexing hints that trigger all available indexes for a Text property.
static Set<TextIndexHint>	NONE Use this to prevent indexing of this Text property.

Method Summary

Modifier and Type	Method and Description
static Set<TextIndexHint>	parse(String str)
static byte	toBits(Collection<TextIndexHint> hints)
static byte	toBits(TextIndexHint... indexHints)
static Set<TextIndexHint>	toSet(byte indexHint)
static TextIndexHint	valueOf(String name) Returns the enum constant of this type with the specified name.
static TextIndexHint[]	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

FULL_TEXT

public static final TextIndexHint FULL_TEXT

Tokenize this property and index it for full text search.

EXACT_MATCH

public static final TextIndexHint EXACT_MATCH

Index this property for exact match searches.

Field Detail

NONE

public static final Set<TextIndexHint> NONE

Use this to prevent indexing of this Text property. The property will not be searchable.

ALL

public static final Set<TextIndexHint> ALL

The set of indexing hints that trigger all available indexes for a Text property.

Method Detail

values

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

Returns:

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

valueOf

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

toBits

public static byte toBits(TextIndexHint... indexHints)

toBits

public static byte toBits(Collection<TextIndexHint> hints)

toSet

public static Set<TextIndexHint> toSet(byte indexHint)

parse

public static Set<TextIndexHint> parse(String str)