com.bericotech.clavin.index

Enum IndexField

java.lang.Object

java.lang.Enum<IndexField>

com.bericotech.clavin.index.IndexField

All Implemented Interfaces:

Serializable, Comparable<IndexField>

public enum IndexField
extends Enum<IndexField>

The fields of the Lucene gazetteer index.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANCESTOR_IDS
FEATURE_CODE
GEONAME
GEONAME_ID
HISTORICAL
INDEX_NAME
PARENT_ID
POPULATION
PREFERRED_NAME
SORT_POP

Method Summary

Methods

Modifier and Type	Method and Description
static int	getBooleanIndexValue(boolean inBool) Gets the integer value representing the provided boolean value in the Lucene index.
<T> T	getValue(org.apache.lucene.document.Document doc) Get the value of this field as set in the given document or null if the field is not set or cannot be retrieved.
String	key()
static IndexField	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexField[]	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

INDEX_NAME

public static final IndexField INDEX_NAME

GEONAME

public static final IndexField GEONAME

GEONAME_ID

public static final IndexField GEONAME_ID

PARENT_ID

public static final IndexField PARENT_ID

ANCESTOR_IDS

public static final IndexField ANCESTOR_IDS

POPULATION

public static final IndexField POPULATION

SORT_POP

public static final IndexField SORT_POP

HISTORICAL

public static final IndexField HISTORICAL

FEATURE_CODE

public static final IndexField FEATURE_CODE

PREFERRED_NAME

public static final IndexField PREFERRED_NAME

Method Detail

values

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

Returns:

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

valueOf

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

key

public String key()

getValue

public <T> T getValue(org.apache.lucene.document.Document doc)

Get the value of this field as set in the given document or null if the field is not set or cannot be retrieved. If a field has multiple values, the value that is returned may be arbitrarily selected from one of the values. In this instance, use the methods in Document directly to retrieve multiple values.

Type Parameters:

T - the expected return type

Parameters:

doc - the input document

Returns:

the value of this field in the input document, if it has been set, or null

getBooleanIndexValue

public static int getBooleanIndexValue(boolean inBool)

Gets the integer value representing the provided boolean value in the Lucene index.

Parameters:

inBool - the boolean value

Returns:

the numeric value representing the boolean in the index