Package org.gbif.api.model.registry.search

Enum Class DatasetSearchParameter

java.lang.Object

java.lang.Enum<DatasetSearchParameter>

org.gbif.api.model.registry.search.DatasetSearchParameter

All Implemented Interfaces:

Serializable, Comparable<DatasetSearchParameter>, Constable, SearchParameter

public enum DatasetSearchParameter
extends Enum<DatasetSearchParameter>
implements SearchParameter

Each value in the enum represents a possible facet for the Dataset search.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLLECTION_KEY	Collection key associate to this dataset.
CONTINENT	Continent of the geospatial coverage of a dataset.
COUNTRY	Country of the geospatial coverage of a dataset.
DATASET_TITLE	Dataset title/name.
DECADE	Filters datasets by their temporal coverage broken down to decades.
DOI	DOI associated to one more dataset.
ENDORSING_NODE_KEY	Node key that endorsed this dataset's publisher.
ENDPOINT_TYPE	EndpointType associated to a dataset.
HOSTING_COUNTRY	The owning organization's country.
HOSTING_ORG	The hosting organization's uuid key.
INSTALLATION_KEY	Hosting installation key.
INSTITUTION_KEY	Institution key associated to the dataset and/or to the collection.
KEYWORD	A case insensitive plain text keyword from coverages or serialized tag as created by Tag.toString().
LICENSE	License of a dataset.
MODIFIED_DATE	Date when the dataset was last updated
NETWORK_KEY	Network key associated to a dataset.
PROJECT_ID	Identifier of the associated project.
PUBLISHING_COUNTRY	The hosting organization's country.
PUBLISHING_ORG	The owning organizations uuid key.
RECORD_COUNT	Number of indexed records.
SUBTYPE	DatasetSubtype enumeration value.
TAXON_KEY	Backbone name usage key that this dataset covers.
TYPE	DatasetType enumeration value.
YEAR	Filters datasets by their temporal coverage broken down to years as extracted from the occurrence data.

Method Summary

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

getClass, notify, notifyAll, wait, wait, wait

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

name

Enum Constant Details

TYPE

public static final DatasetSearchParameter TYPE

DatasetType enumeration value.

SUBTYPE

public static final DatasetSearchParameter SUBTYPE

DatasetSubtype enumeration value.

PUBLISHING_ORG

public static final DatasetSearchParameter PUBLISHING_ORG

The owning organizations uuid key.

HOSTING_ORG

public static final DatasetSearchParameter HOSTING_ORG

The hosting organization's uuid key.

KEYWORD

public static final DatasetSearchParameter KEYWORD

A case insensitive plain text keyword from coverages or serialized tag as created by Tag.toString().

DECADE

public static final DatasetSearchParameter DECADE

Filters datasets by their temporal coverage broken down to decades. Decade given as a full year, e.g. 1950, 1960 or 1980.

PUBLISHING_COUNTRY

public static final DatasetSearchParameter PUBLISHING_COUNTRY

The hosting organization's country.

HOSTING_COUNTRY

public static final DatasetSearchParameter HOSTING_COUNTRY

The owning organization's country.

COUNTRY

public static final DatasetSearchParameter COUNTRY

Country of the geospatial coverage of a dataset.

CONTINENT

public static final DatasetSearchParameter CONTINENT

Continent of the geospatial coverage of a dataset.

LICENSE

public static final DatasetSearchParameter LICENSE

License of a dataset.

PROJECT_ID

public static final DatasetSearchParameter PROJECT_ID

Identifier of the associated project.

TAXON_KEY

public static final DatasetSearchParameter TAXON_KEY

Backbone name usage key that this dataset covers.

RECORD_COUNT

public static final DatasetSearchParameter RECORD_COUNT

Number of indexed records. Depending on type of dataset these are occurrences or name usages.

YEAR

public static final DatasetSearchParameter YEAR

Filters datasets by their temporal coverage broken down to years as extracted from the occurrence data.

MODIFIED_DATE

public static final DatasetSearchParameter MODIFIED_DATE

Date when the dataset was last updated

DATASET_TITLE

public static final DatasetSearchParameter DATASET_TITLE

Dataset title/name.

COLLECTION_KEY

public static final DatasetSearchParameter COLLECTION_KEY

Collection key associate to this dataset.

INSTITUTION_KEY

public static final DatasetSearchParameter INSTITUTION_KEY

Institution key associated to the dataset and/or to the collection.

DOI

public static final DatasetSearchParameter DOI

DOI associated to one more dataset.

NETWORK_KEY

public static final DatasetSearchParameter NETWORK_KEY

Network key associated to a dataset.

ENDORSING_NODE_KEY

public static final DatasetSearchParameter ENDORSING_NODE_KEY

Node key that endorsed this dataset's publisher.

INSTALLATION_KEY

public static final DatasetSearchParameter INSTALLATION_KEY

Hosting installation key.

ENDPOINT_TYPE

public static final DatasetSearchParameter ENDPOINT_TYPE

EndpointType associated to a dataset.

Method Details

values

public static DatasetSearchParameter[] 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

public static DatasetSearchParameter valueOf(String name)

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 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