Package org.gbif.api.model.checklistbank.search

Enum NameUsageSearchParameter

java.lang.Object

java.lang.Enum<NameUsageSearchParameter>

org.gbif.api.model.checklistbank.search.NameUsageSearchParameter

All Implemented Interfaces:

Serializable, Comparable<NameUsageSearchParameter>, SearchParameter

public enum NameUsageSearchParameter
extends Enum<NameUsageSearchParameter>
implements SearchParameter

Each value in the enum represents a search parameter or facet of the name usage search.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONSTITUENT_KEY	The (sub)dataset constituent key as a UUID.
DATASET_KEY	The checklist dataset key as a UUID.
HABITAT	Filter by the known habitats.
HIGHERTAXON_KEY	Filters by any of the higher Linnean rank keys.
IS_EXTINCT	Boolean filter for extinct taxa.
ISSUE	Searches name usages for those that have a specific issue.
NAME_TYPE	Filter by the name type.
NOMENCLATURAL_STATUS	Filter by the nomenclatural status.
ORIGIN	Searches name usages for those with a specific origin.
RANK	Filters by the rank of the name usage.
STATUS	Filter by the taxonomis status.
THREAT	Filter by the threat status.

Method Summary

Modifier and Type	Method	Description
Class<?>	type()
static NameUsageSearchParameter	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NameUsageSearchParameter[]	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

Methods inherited from interface org.gbif.api.model.common.search.SearchParameter

name

Enum Constant Detail

DATASET_KEY

public static final NameUsageSearchParameter DATASET_KEY

The checklist dataset key as a UUID.

CONSTITUENT_KEY

public static final NameUsageSearchParameter CONSTITUENT_KEY

The (sub)dataset constituent key as a UUID. Useful to query larger assembled datasets such as the GBIF Backbone or the Catalogue of Life

RANK

public static final NameUsageSearchParameter RANK

Filters by the rank of the name usage.

HIGHERTAXON_KEY

public static final NameUsageSearchParameter HIGHERTAXON_KEY

Filters by any of the higher Linnean rank keys. Note this is within the respective checklist and not searching NUB keys across all checklists.

STATUS

public static final NameUsageSearchParameter STATUS

Filter by the taxonomis status.

IS_EXTINCT

public static final NameUsageSearchParameter IS_EXTINCT

Boolean filter for extinct taxa.

HABITAT

public static final NameUsageSearchParameter HABITAT

Filter by the known habitats.

THREAT

public static final NameUsageSearchParameter THREAT

Filter by the threat status.

NOMENCLATURAL_STATUS

public static final NameUsageSearchParameter NOMENCLATURAL_STATUS

Filter by the nomenclatural status.

NAME_TYPE

public static final NameUsageSearchParameter NAME_TYPE

Filter by the name type.

ISSUE

public static final NameUsageSearchParameter ISSUE

Searches name usages for those that have a specific issue.

ORIGIN

public static final NameUsageSearchParameter ORIGIN

Searches name usages for those with a specific origin.

Method Detail

values

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

Returns:

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

valueOf

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

type

public Class<?> type()

Specified by:

type in interface SearchParameter

Returns:

the data type expected for the value of the respective search parameter