lux.index

Enum FieldRole

java.lang.Object

java.lang.Enum<FieldRole>

lux.index.FieldRole

All Implemented Interfaces:

Serializable, Comparable<FieldRole>

public enum FieldRole
extends Enum<FieldRole>

Certain fields are known to the indexer and optimizer: these are identified by their FieldRole.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATT_QNAME
ATTRIBUTE_TEXT
ELEMENT_TEXT
ELT_QNAME
ID
PATH
PATH_VALUE
QNAME_VALUE
URI
XML_STORE
XML_TEXT

Field Summary

Fields

Modifier and Type	Field and Description
static String	LUX_DOCID
static String	LUX_SCORE

Method Summary

Methods

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

URI

public static final FieldRole URI

ID

public static final FieldRole ID

XML_STORE

public static final FieldRole XML_STORE

ELT_QNAME

public static final FieldRole ELT_QNAME

ATT_QNAME

public static final FieldRole ATT_QNAME

PATH

public static final FieldRole PATH

PATH_VALUE

public static final FieldRole PATH_VALUE

QNAME_VALUE

public static final FieldRole QNAME_VALUE

ELEMENT_TEXT

public static final FieldRole ELEMENT_TEXT

ATTRIBUTE_TEXT

public static final FieldRole ATTRIBUTE_TEXT

XML_TEXT

public static final FieldRole XML_TEXT

Field Detail

LUX_DOCID

public static final String LUX_DOCID

See Also:

Constant Field Values

LUX_SCORE

public static final String LUX_SCORE

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getFieldName

public String getFieldName()