au.org.ala.biocache.dto

Enum OccurrenceSource

java.lang.Object

java.lang.Enum<OccurrenceSource>

au.org.ala.biocache.dto.OccurrenceSource

All Implemented Interfaces:

Serializable, Comparable<OccurrenceSource>

public enum OccurrenceSource
extends Enum<OccurrenceSource>

Stores the details for the "SOURCES" facet information. This class exists to hide the details from the web clients. We are able to display sources without exposing the "confidence" SOLR field TODO Rename everything to more fitting names

Author:

Natasha Carter

Enum Constant Summary

Enum Constants

Enum Constant and Description
CITZEN
NON_CITIZEN

Field Summary

Fields

Modifier and Type	Field and Description
static String	FACET_NAME

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName()
static OccurrenceSource	getForDisplayName(String name)
static OccurrenceSource	getForRange(String range)
String	getRange()
static OccurrenceSource	valueOf(String name) Returns the enum constant of this type with the specified name.
static OccurrenceSource[]	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

NON_CITIZEN

public static final OccurrenceSource NON_CITIZEN

CITZEN

public static final OccurrenceSource CITZEN

Field Detail

FACET_NAME

public static final String FACET_NAME

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getRange

public String getRange()

getDisplayName

public String getDisplayName()

getForDisplayName

public static OccurrenceSource getForDisplayName(String name)

getForRange

public static OccurrenceSource getForRange(String range)