Package org.gbif.api.model.checklistbank

Class DatasetMetrics

  • public class DatasetMetrics
extends Object
    Simple metrics about a single, processed checklist dataset in time. The created timestamp with the dataset key should be unique and can be used to create graphs over time.

    • Method Detail

      • getKey

        public int getKey()

      • setKey

        public void setKey​(int key)

      • getColCoveragePct

        @Max(100L)
@Min(0L)
public @javax.validation.constraints.Max(100L),@javax.validation.constraints.Min(0L) int getColCoveragePct()
        Returns:
        percentage of distinct names that match a name in the Catalogue of Life

      • getDistinctNamesCount

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getDistinctNamesCount()
        Returns:
        the number of distinct canonical name strings

      • getColMatchingCount

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getColMatchingCount()
        Returns:
        number of records matching a name in the Catalogue of Life

      • getNubMatchingCount

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getNubMatchingCount()
        Returns:
        number of records matching a name in the GBIF backbone taxonomy

      • getSynonymsCount

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getSynonymsCount()
        Returns:
        number of records with a taxonomic status of a synonym. For occurrence records the nub taxonomy status is used

      • getUsagesCount

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getUsagesCount()
        Returns:
        total number of name usage records in checklistbank

      • getCreated

        @NotNull
@Past
public @NotNull @Past Date getCreated()
        Returns:
        date this metric was generated. Roughly equivalent with date of indexing

      • getDownloaded

        @NotNull
@Past
public @NotNull @Past Date getDownloaded()
        Returns:
        date new dataset data was downloaded/harvested last time

      • getNubCoveragePct

        @Max(100L)
@Min(0L)
public @javax.validation.constraints.Max(100L),@javax.validation.constraints.Min(0L) int getNubCoveragePct()
        Returns:
        percentage of distinct names that match a name in the GBIF backbone taxonomy

      • getCountByKingdom

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getCountByKingdom​(Kingdom kingdom)
        For an occurrence dataset get the number of records that are interpreted to belong to a certain nub kingdom. For checklists the number of usages belonging to a certain nub kingdom. Note this is not the kingdom as explicitly given by the checklist, but the nub kingdom after matching the usages to the nub.
        Parameters:
        kingdom - to get metrics for
        Returns:
        the number of records found in the respective kingdom

      • getCountByRank

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getCountByRank​(Rank rank)
        Get the metrics by taxonomic rank, i.e. the lowest rank to which an occurrence record was identified or the rank of the name usage in a checklist.
        Parameters:
        rank - to get metrics for. Mayor Linnéan ranks only down to species plus INFRASPECIFIC_NAME.
        Returns:
        the number of records for the given taxonomic rank.

      • getCountByOrigin

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getCountByOrigin​(Origin origin)
        Get the metrics by name usage origin.

      • getCountByIssue

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getCountByIssue​(NameUsageIssue issue)
        Get the metrics by name usage issue.

      • getOtherCount

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getOtherCount​(String key)
        Get the metrics for other dynamic counts.

      • getCountNamesByLanguage

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getCountNamesByLanguage​(Language language)
        Number of vernacular names in this checklist dataset by language. For occurrence datasets always 0.
        Parameters:
        language - of common names
        Returns:
        the number of records found for the extension

      • getExtensionRecordCount

        @Min(0L)
public @javax.validation.constraints.Min(0L) int getExtensionRecordCount​(Extension extension)
        Number of extension records found in the dataset.
        Returns:
        the number of records found for the extension