Enum DatasetSearchParameter
- java.lang.Object
-
- java.lang.Enum<DatasetSearchParameter>
-
- org.gbif.api.model.registry.search.DatasetSearchParameter
-
- All Implemented Interfaces:
Serializable,Comparable<DatasetSearchParameter>,SearchParameter
public enum DatasetSearchParameter extends Enum<DatasetSearchParameter> implements SearchParameter
Each value in the enum represents a possible facet for the Dataset search.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CATEGORYCategory of the dataset.COLLECTION_KEYCollection key associate to this dataset.CONTACT_EMAILCONTACT_USER_IDCONTINENTContinentof the geospatial coverage of a dataset.COUNTRYCountry of the geospatial coverage of a dataset.DATASET_TITLEDataset title/name.DECADEFilters datasets by their temporal coverage broken down to decades.DOIDOI associated to one more dataset.DWCA_CORE_TYPEPublished DwC-A row/core type.DWCA_EXTENSIONPublished DwC-A extension.ENDORSING_NODE_KEYNode key that endorsed this dataset's publisher.ENDPOINT_TYPEEndpointType associated to a dataset.HOSTING_COUNTRYThe owning organization's country.HOSTING_ORGThe hosting organization's uuid key.INSTALLATION_KEYHosting installation key.INSTITUTION_KEYInstitution key associated to the dataset and/or to the collection.KEYWORDA case-insensitive plain text keyword from coverages or serialized tag as created by Tag.toString().LICENSELicenseof a dataset.MODIFIED_DATEDate when the dataset was last updatedNETWORK_KEYNetwork key associated to a dataset.PROJECT_IDIdentifier of the associated project.PUBLISHING_COUNTRYThe hosting organization's country.PUBLISHING_ORGThe owning organizations uuid key.RECORD_COUNTNumber of indexed records.SUBTYPEDatasetSubtypeenumeration value.TAXON_KEYBackbone name usage key that this dataset covers.TYPEDatasetTypeenumeration value.YEARFilters datasets by their temporal coverage broken down to years as extracted from the occurrence data.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Class<?>type()static DatasetSearchParametervalueOf(String name)Returns the enum constant of this type with the specified name.static DatasetSearchParameter[]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 interface org.gbif.api.model.common.search.SearchParameter
name
-
-
-
-
Enum Constant Detail
-
TYPE
public static final DatasetSearchParameter TYPE
DatasetTypeenumeration value.
-
SUBTYPE
public static final DatasetSearchParameter SUBTYPE
DatasetSubtypeenumeration 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
Continentof the geospatial coverage of a dataset.
-
LICENSE
public static final DatasetSearchParameter LICENSE
Licenseof 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.
-
DWCA_EXTENSION
public static final DatasetSearchParameter DWCA_EXTENSION
Published DwC-A extension.
-
DWCA_CORE_TYPE
public static final DatasetSearchParameter DWCA_CORE_TYPE
Published DwC-A row/core type.
-
CONTACT_USER_ID
public static final DatasetSearchParameter CONTACT_USER_ID
-
CONTACT_EMAIL
public static final DatasetSearchParameter CONTACT_EMAIL
-
CATEGORY
public static final DatasetSearchParameter CATEGORY
Category of the dataset.
-
-
Method Detail
-
values
public static DatasetSearchParameter[] 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 (DatasetSearchParameter c : DatasetSearchParameter.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DatasetSearchParameter 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 nameNullPointerException- if the argument is null
-
type
public Class<?> type()
- Specified by:
typein interfaceSearchParameter- Returns:
- the data type expected for the value of the respective search parameter
-
-