Enum Class NameUsageSearchParameter
java.lang.Object
java.lang.Enum<NameUsageSearchParameter>
org.gbif.api.model.checklistbank.search.NameUsageSearchParameter
- All Implemented Interfaces:
Serializable
,Comparable<NameUsageSearchParameter>
,Constable
,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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe (sub)dataset constituent key as a UUID.The checklist dataset key as a UUID.Filter by the known habitats.Filters by any of the higher Linnean rank keys.Boolean filter for extinct taxa.Searches name usages for those that have a specific issue.Filter by the name type.Filter by the nomenclatural status.Searches name usages for those with a specific origin.Filters by the rank of the name usage.Filter by the taxonomis status.Filter by the threat status. -
Method Summary
Modifier and TypeMethodDescriptionClass<?>
type()
static NameUsageSearchParameter
Returns the enum constant of this class with the specified name.static NameUsageSearchParameter[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from interface org.gbif.api.model.common.search.SearchParameter
name
-
Enum Constant Details
-
DATASET_KEY
The checklist dataset key as a UUID. -
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
Filters by the rank of the name usage. -
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
Filter by the taxonomis status. -
IS_EXTINCT
Boolean filter for extinct taxa. -
HABITAT
Filter by the known habitats. -
THREAT
Filter by the threat status. -
NOMENCLATURAL_STATUS
Filter by the nomenclatural status. -
NAME_TYPE
Filter by the name type. -
ISSUE
Searches name usages for those that have a specific issue. -
ORIGIN
Searches name usages for those with a specific origin.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
type
- Specified by:
type
in interfaceSearchParameter
- Returns:
- the data type expected for the value of the respective search parameter
-