au.org.ala.names.model
Enum NameIndexField

java.lang.Object
  java.lang.Enum<NameIndexField>
      au.org.ala.names.model.NameIndexField

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NameIndexField>

public enum NameIndexField
extends java.lang.Enum<NameIndexField>

An Enum for all the fields that are indexed for the name matching. This enum is used by ALANameIndexer to create the index and ALANameSearcher to search the index

Author:

Natasha Carter

Enum Constant Summary

ACCEPTED

ALA

AUTHOR

GENUS_EX

ID

INFRA_EX

INFRA_SPECIFIC

iS_SYNONYM

LSID

NAME

PHRASE

RANK

RANK_ID

SPECIES_EX

SPECIFIC

SYNONYM_TYPE

VOUCHER

Method Summary

java.lang.String	toString()
static NameIndexField	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NameIndexField[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ID

public static final NameIndexField ID

LSID

public static final NameIndexField LSID

ACCEPTED

public static final NameIndexField ACCEPTED

iS_SYNONYM

public static final NameIndexField iS_SYNONYM

GENUS_EX

public static final NameIndexField GENUS_EX

SPECIES_EX

public static final NameIndexField SPECIES_EX

INFRA_EX

public static final NameIndexField INFRA_EX

SPECIFIC

public static final NameIndexField SPECIFIC

INFRA_SPECIFIC

public static final NameIndexField INFRA_SPECIFIC

NAME

public static final NameIndexField NAME

RANK_ID

public static final NameIndexField RANK_ID

RANK

public static final NameIndexField RANK

AUTHOR

public static final NameIndexField AUTHOR

PHRASE

public static final NameIndexField PHRASE

VOUCHER

public static final NameIndexField VOUCHER

ALA

public static final NameIndexField ALA

SYNONYM_TYPE

public static final NameIndexField SYNONYM_TYPE

Method Detail

values

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

Returns:

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

valueOf

public static NameIndexField valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<NameIndexField>