au.org.ala.names.model
Enum SynonymType

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

All Implemented Interfaces:

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

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

Stores the Synonym type information. These synonyms types are based on the ones supplied in NSL relationship CSV. The numeric values come from the dictionary_relationship table of the ala_names as setup by http://code.google.com/p/ala-portal/source/browse/trunk/ala-names-generator/src/main/resources/ala-names-setup.sql

TODO: Get a correct description for the synonym types.

Author:

Natasha Carter

Enum Constant Summary

COL_SYNONYM

CONGRUENT

CONGRUENT_EMENDATION

CONGRUENT_ORIGINAL_SPELLING

CONGRUENT_REPLACEMENT_NAME

CONGRUENT_SUBJECTIVE

CONGRUENT_SYNONYM

EXCLUDES

GENERIC_COMB_UNPLACED

GENERIC_COMBINATION

HOMONYM

INCLDUES_UNPLACED

INCLUDES_INCERTAE_SEDIS

INCLUDES_NOMENCLATURAL

INCLUDES_SP_INQUIRENDA

INCLUDES_TAXONOMIC

INVALID_PUBLICATION

LEGISLATIVE_NAME

MISAPPLIED

MISC_LITERATURE

OBJECTIVE_SYNONYM

ORIGINAL_SPELLING

REPLACED

REPLACEMENT_NAME

SUBJECTIVE_SYNONYM

SUBSEQUENT_MISSPELLING

SYNONYM

SYNONYM_EMEDATION

SYNONYM_SENS_LAT

SYNONYM_SYNONYM

TRADE_NAME

VARIANT

Method Summary

java.lang.Integer	getId()
static SynonymType	getTypeFor(java.lang.String value)
static SynonymType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SynonymType[]	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

HOMONYM

public static final SynonymType HOMONYM

INVALID_PUBLICATION

public static final SynonymType INVALID_PUBLICATION

MISAPPLIED

public static final SynonymType MISAPPLIED

REPLACED

public static final SynonymType REPLACED

TRADE_NAME

public static final SynonymType TRADE_NAME

VARIANT

public static final SynonymType VARIANT

EXCLUDES

public static final SynonymType EXCLUDES

GENERIC_COMBINATION

public static final SynonymType GENERIC_COMBINATION

GENERIC_COMB_UNPLACED

public static final SynonymType GENERIC_COMB_UNPLACED

LEGISLATIVE_NAME

public static final SynonymType LEGISLATIVE_NAME

MISC_LITERATURE

public static final SynonymType MISC_LITERATURE

SYNONYM

public static final SynonymType SYNONYM

SYNONYM_EMEDATION

public static final SynonymType SYNONYM_EMEDATION

OBJECTIVE_SYNONYM

public static final SynonymType OBJECTIVE_SYNONYM

ORIGINAL_SPELLING

public static final SynonymType ORIGINAL_SPELLING

REPLACEMENT_NAME

public static final SynonymType REPLACEMENT_NAME

SYNONYM_SENS_LAT

public static final SynonymType SYNONYM_SENS_LAT

SUBJECTIVE_SYNONYM

public static final SynonymType SUBJECTIVE_SYNONYM

SUBSEQUENT_MISSPELLING

public static final SynonymType SUBSEQUENT_MISSPELLING

SYNONYM_SYNONYM

public static final SynonymType SYNONYM_SYNONYM

INCLUDES_INCERTAE_SEDIS

public static final SynonymType INCLUDES_INCERTAE_SEDIS

INCLUDES_NOMENCLATURAL

public static final SynonymType INCLUDES_NOMENCLATURAL

INCLUDES_SP_INQUIRENDA

public static final SynonymType INCLUDES_SP_INQUIRENDA

INCLUDES_TAXONOMIC

public static final SynonymType INCLUDES_TAXONOMIC

INCLDUES_UNPLACED

public static final SynonymType INCLDUES_UNPLACED

CONGRUENT

public static final SynonymType CONGRUENT

CONGRUENT_EMENDATION

public static final SynonymType CONGRUENT_EMENDATION

CONGRUENT_ORIGINAL_SPELLING

public static final SynonymType CONGRUENT_ORIGINAL_SPELLING

CONGRUENT_REPLACEMENT_NAME

public static final SynonymType CONGRUENT_REPLACEMENT_NAME

CONGRUENT_SUBJECTIVE

public static final SynonymType CONGRUENT_SUBJECTIVE

CONGRUENT_SYNONYM

public static final SynonymType CONGRUENT_SYNONYM

COL_SYNONYM

public static final SynonymType COL_SYNONYM

Method Detail

values

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

Returns:

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

valueOf

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

getId

public java.lang.Integer getId()

getTypeFor

public static SynonymType getTypeFor(java.lang.String value)