org.gbif.api.service.occurrence

Interface OccurrenceDatasetIndexService

public interface OccurrenceDatasetIndexService

Supports the listing of datasets having occurrence records.

Method Summary

Modifier and Type	Method and Description
SortedMap<UUID,Long>	occurrenceDatasetsForCountry(Country country) This provides a map of occurrence dataset keys to the number of records matching the given country.
SortedMap<UUID,Long>	occurrenceDatasetsForNubKey(int taxonKey) This provides a map of occurrence dataset keys to the number of records matching the given nub key.

Method Detail

occurrenceDatasetsForCountry

SortedMap<UUID,Long> occurrenceDatasetsForCountry(Country country)

This provides a map of occurrence dataset keys to the number of records matching the given country. Datasets which do not have content are not included (e.g. no zero-values will exist). That is to say the count represents the number of records in the dataset that are interpreted as the provided country, and not the total count of records in the dataset.

Parameters:

country - to filter occurrence datasets by

Returns:

a map of dataset keys to counts sorted by count descending

occurrenceDatasetsForNubKey

SortedMap<UUID,Long> occurrenceDatasetsForNubKey(int taxonKey)

This provides a map of occurrence dataset keys to the number of records matching the given nub key. Datasets which do not have content are not included (e.g. no zero-values will exist). That is to say the count represents the number of records in the dataset that are interpreted as the provided taxon (or any subordinate taxon), and not the total count of records in the dataset. E.g. a dataset of 1 million records covering everything, might report it has 300k records of birds (Aves); those records might themselves have more specific identifications (such as the species).

Parameters:

taxonKey - to filter occurrence datasets by

Returns:

a map of dataset keys to counts sorted by count descending