Package org.gbif.api.vocabulary

Enum Origin

java.lang.Object

java.lang.Enum<Origin>

org.gbif.api.vocabulary.Origin

All Implemented Interfaces:

Serializable, Comparable<Origin>

public enum Origin
extends Enum<Origin>

Enumeration to classify name usages by how they originated.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTONYM	Generated, missing autonym.
BASIONYM_PLACEHOLDER	Placeholder usage for a missing or implicit basionym.
DENORMED_CLASSIFICATION	Implicit usage from a denormalized classification.
EX_AUTHOR_SYNONYM	Implicit synonym based on the illegitimate ex author.
IMPLICIT_NAME	Generated, missing genus or species for "orphaned" lower name.
MISSING_ACCEPTED	Artificial accepted usage for a synonym if it's missing to preserve the taxonomic hierarchy.
OTHER	Any other origin not covered by the above.
PROPARTE	Duplicated usage from a single pro parte record.
SOURCE	Record came straight from source record.
VERBATIM_ACCEPTED	Implicit usage from a verbatim accepted name usage.
VERBATIM_BASIONYM	Implicit usage from a verbatim basionym/original name.
VERBATIM_PARENT	Implicit usage from a verbatim parent name usage.

Method Summary

Modifier and Type	Method	Description
static Origin	fromString(String origin)	Case-insensitive lookup of an Origin by its name that does not throw an exception but returns null for not found origins.
static Origin	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Origin[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SOURCE

public static final Origin SOURCE

Record came straight from source record.

DENORMED_CLASSIFICATION

public static final Origin DENORMED_CLASSIFICATION

Implicit usage from a denormalized classification.

VERBATIM_PARENT

public static final Origin VERBATIM_PARENT

Implicit usage from a verbatim parent name usage.

VERBATIM_ACCEPTED

public static final Origin VERBATIM_ACCEPTED

Implicit usage from a verbatim accepted name usage.

VERBATIM_BASIONYM

public static final Origin VERBATIM_BASIONYM

Implicit usage from a verbatim basionym/original name.

PROPARTE

public static final Origin PROPARTE

Duplicated usage from a single pro parte record.

AUTONYM

public static final Origin AUTONYM

Generated, missing autonym.

IMPLICIT_NAME

public static final Origin IMPLICIT_NAME

Generated, missing genus or species for "orphaned" lower name.

MISSING_ACCEPTED

public static final Origin MISSING_ACCEPTED

Artificial accepted usage for a synonym if it's missing to preserve the taxonomic hierarchy.

BASIONYM_PLACEHOLDER

public static final Origin BASIONYM_PLACEHOLDER

Placeholder usage for a missing or implicit basionym.

EX_AUTHOR_SYNONYM

public static final Origin EX_AUTHOR_SYNONYM

Implicit synonym based on the illegitimate ex author. See ICN article 46: http://www.iapt-taxon.org/nomen/main.php?page=art46

OTHER

public static final Origin OTHER

Any other origin not covered by the above.

Method Detail

values

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

Returns:

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

valueOf

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

fromString

public static Origin fromString(String origin)

Case-insensitive lookup of an Origin by its name that does not throw an exception but returns null for not found origins.

Parameters:

origin - case-insensitive name of the origin

Returns:

the matching Origin or null