lux.index.field
Enum FieldDefinition.Type

java.lang.Object
  java.lang.Enum<FieldDefinition.Type>
      lux.index.field.FieldDefinition.Type

All Implemented Interfaces:

Serializable, Comparable<FieldDefinition.Type>

Enclosing class:

FieldDefinition

public static enum FieldDefinition.Type
extends Enum<FieldDefinition.Type>

Represents the type of data fed to the index for a given field. TOKENS-type fields are expected to provide a TokenStream, where the other types provide each values as a Java object.

Enum Constant Summary

BYTES

INT

LONG

STRING

TEXT

TOKENS

Method Summary

org.apache.lucene.search.SortField.Type	getLuceneSortFieldType()
static FieldDefinition.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static FieldDefinition.Type[]	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

TOKENS

public static final FieldDefinition.Type TOKENS

STRING

public static final FieldDefinition.Type STRING

BYTES

public static final FieldDefinition.Type BYTES

INT

public static final FieldDefinition.Type INT

LONG

public static final FieldDefinition.Type LONG

TEXT

public static final FieldDefinition.Type TEXT

Method Detail

values

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

Returns:

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

valueOf

public static FieldDefinition.Type 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

getLuceneSortFieldType

public org.apache.lucene.search.SortField.Type getLuceneSortFieldType()