Package org.gbif.dwc.terms

Enum DwcaTerm

java.lang.Object

java.lang.Enum<DwcaTerm>

org.gbif.dwc.terms.DwcaTerm

All Implemented Interfaces:

Serializable, Comparable<DwcaTerm>, AlternativeNames, Term

public enum DwcaTerm
extends Enum<DwcaTerm>
implements Term, AlternativeNames, Serializable

Darwin Core Archive terms with namespace http://rs.tdwg.org/dwc/text/.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ID	Archive internal (core) id column.

Method Summary

Modifier and Type	Method	Description
String[]	alternativeNames()
boolean	isClass()	Informs if a term is generally used as a class term, i.e.
URI	namespace()	The namespace the terms are in.
String	prefix()	A unique standard prefix representing the namespace.
String	simpleName()	The simple term name without any namespace or paths.
String	toString()
static DwcaTerm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DwcaTerm[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gbif.dwc.terms.Term

prefixedName, qualifiedName

Enum Constant Detail

ID

public static final DwcaTerm ID

Archive internal (core) id column.

Method Detail

values

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

Returns:

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

valueOf

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

prefix

public String prefix()

Description copied from interface: Term

A unique standard prefix representing the namespace. For example dwc.

Specified by:

prefix in interface Term

namespace

public URI namespace()

Description copied from interface: Term

The namespace the terms are in. Default implementations here expect the namespace to end with a slash.

Specified by:

namespace in interface Term

simpleName

public String simpleName()

Description copied from interface: Term

The simple term name without any namespace or paths. For example scientificName.

Specified by:

simpleName in interface Term

toString

public String toString()

Overrides:

toString in class Enum<DwcaTerm>

alternativeNames

public String[] alternativeNames()

Specified by:

alternativeNames in interface AlternativeNames

Returns:

array of simple, alternative term names

isClass

public boolean isClass()

Description copied from interface: Term

Informs if a term is generally used as a class term, i.e. defining rowTypes not properties. For example VernacularName, Taxon or Occurrence

Specified by:

isClass in interface Term

Returns:

true if the term is defining a class instead of a property, e.g. Taxon