All Classes and Interfaces
Class
Description
An abstract GBIF user account.
Deprecated.
As per CoL Data Submission Format, ver.
All Audiovisual Core terms with namespace http://rs.tdwg.org/ac/terms/.
The particulars of the place where a institution of collection is situated.
A package visible providing the commonality for addresses, including the constraint validations.
Enumeration for user identifiers like ORCID, WIKIDATA and etc
Models a GrSciColl alternative code.
Holds the alternative results of the collections lookup.
Optional interface for terms that have known alternative simple names the TermFactory should be aware of.
Utility method to work with annotations.
Result returned by the API when a
ChangeSuggestion is applied.Similar to
GbifUserPrincipal but represents an application instead of a user.Role(s) that can be assigned to authenticated application.
Iterator over registry entities from paging responses that filters out deleted entities.
A simple enumeration of all DarwinCore values of BasisOfRecord legal for occurrences.
Serializer for BasisOfRecord.
Jackson
JsonDeserializer for BasisOfRecord.Jackson
JsonSerializer for BasisOfRecord.A batch that can contain either institutions or collections to create or update them in bulk.
Defines the service to work with batches.
Geographic coverage geometry in the form of 4 sided bounding box.
Encapsulate a challenge code.
Defines the service to suggest changes in GRSciColl entities.
All Chronometric terms with namespace http://rs.tdwg.org/chrono/terms/.
A citation can have one or both of a textual component and an identifier which can be
of any form, but expected to be resolvable in some way such as an LSID, DOI or similar.
A contact used to generate a dataset citation.
Helper class tha generates a Citation String from
Dataset and Organization
objects.Vocabulary for the 3 CITES (Convention on International Trade in Endangered Species of Wild Fauna and Flora)
Appendix numbers.
A group of specimens or other natural history objects.
Collection data for the Dataset.
Deprecated.
Iterates over results of
DescriptorsService.listDescriptors(DescriptorSearchRequest).Iterates over results of
DescriptorsService.listDescriptors(DescriptorSearchRequest).Entity .
Contains the parameters to create a collection from a dataset.
Models the response for the Collection search.
API Service to work with collections.
Models the response for the Collections search.
Iterates over results of
CollectionService.list(CollectionSearchRequest).Generic comment interface for entities.
Service provides a set of operations on
Comment.The usual (search) limit and offset parameters
A normal full-text search parameter.
A compound predicate is a Predicate that itself contains other Predicates.
Confirmation key is a UUID used to confirm an entity.
This predicate is "AND"-ing its subpredicates together.
Common variables used by API.
Contact associated to a GRSciColl
Collection or Institution.Entity that can have a list of contacts and addresses.
Generic contact interface for entities.
API Service for the contacts in the collections service.
Service provides a set of operations on
Contact.Enumeration for all contact types.
Enumeration for all continents based on the 7 continent model found on
Wikipedia and the
World Geographical Scheme for Recording Plant Distributions (WGSRPD).
An enumeration for all current ISO 3166-1 Alpha-2 and Alpha-3 country codes.
Deserializes the value from a 2-letter ISO format.
Serializes the value in a 2-letter ISO format.
Deserializes the value from an English country title exactly as given by the enumeration.
Serializes the value as the English country title.
Represents the information about the usage of one country in an occurrence download.
Fields to sort by the country usages in an occurrence download.
This class represents a job to be worked on by a crawler.
Base CRUD service for
CollectionEntity entities.A generic CRUD service interface for any writable entity.
The cube API service, for reading addressable counts from a basic cube.
The base class of all curatorial units.
Composite class, combining fields from CuratorialUnitCount and CuratorialUnitRange for simpler parsing of
curatorial units, since both count and range types share the same root element.
Used for acuratorial unit count with uncertainty.
Used to indicate that the curatorial unit falls within a range of values.
Allows for typed units.
Describes the format of externally available data on a URL.
A GBIF dataset which provides occurrence data, checklist data, sampling event data or metadata.
Iterates over all dataset constituents of a given super dataset.
A typed dataset key for both registered and external datasets.
Simple metrics about a single, processed checklist dataset in time.
Represents the information about the usage of one dataset in an occurrence download.
Interface to access and persists information about occurrence download events.
Iterates over results of
OccurrenceDownloadService.listDatasetUsages(String, Pageable).Pages through all datasets filtering by type only.
This service exposes information regarding current crawling process and is not intended to provide historical
information.
Information about a dataset that is currently being processed.
Interface to access and persist information about dataset processing statuses.
Parameters to list datasets.
Each value in the enum represents a possible facet for the Dataset search.
A dataset specific search request with convenience methods to add facet filters.
The dataset search model object for faceted and full text search.
Pages through all datasets search results.
Interface that provides search and suggest operations over Datasets.
Enumeration for all possible dataset subtypes.
A dataset specific suggest request.
The dataset search model object for suggest searches of datasets.
Enumeration for all possible dataset types.
Fields to sort by the dataset usages in an occurrence download.
A period of time.
Jackson
JsonSerializer classes for Dates with specified formats.Jackson
JsonDeserializer for Dates formatted above, falling back to the Jackson way.Jackson
JsonSerializer for Date.All Dublin Core terms with namespace http://purl.org/dc/elements/1.1/.
All Dublin Core terms with namespace http://purl.org/dc/terms/.
Description Model Object represents a taxon description.
Service interface for Description Interface methods.
API service to work with collection descriptors.
A typed dimension to a cube, which is constructed with a unique key.
Deprecated.
This predicate is "OR"-ing its subpredicates together.
The DistanceUnit enumerates several units for measuring distances.
Distribution Model Object represents a species distribution.
Service interface for Distribution Interface methods.
A statement about the presence or absence of a Taxon at a Location.
Class representing a single Digital Object Identifier (DOI) breaking it down to a prefix and suffix.
Data about a DOI with a target URI and a status enumeration.
This enumeration represents the status of a DOI identifier.
Reflects the possibles statuses of a download during its execution.
Download output requested format.
Represents a request to download occurrence records.
Download request deserializer.
Provides services to manage download requests and retrieve the download file.
Iterates over results of
OccurrenceDownloadService.getDownloadStatistics(Date, Date, Country, UUID, UUID, Pageable).Monthly dataset download statistics.
Defines the type of citable data download.
Models a duplicate in GRSciColl.
Request to be used for the GRSciColl API duplicates services.
Result to be used for the GRSciColl API duplicates services.
Darwin Core Archive terms with namespace http://rs.tdwg.org/dwc/text/.
A report of the validity of a DwC-A.
All Darwin Core terms with namespace http://rs.tdwg.org/dwc/terms/ as an
enumeration with alternative term names found sometimes in data.
ConstraintValidator that validates emails.Indicates that the field is suitable to convert empty strings into null.
Generic endpoint interface for entities.
An ordering that uses the created date of an endpoint for ordering.
Compares two Endpoints.
Service provides a set of operations on
Endpoint.Enumeration for all endpoint types.
This predicate checks if its
key is equal to its value.Deprecated.
Event class based on https://dwc.tdwg.org/terms/#event.
All Adobe EXIF terms with namespace http://ns.adobe.com/exif/1.0/.
Experimental features are available but are not as robustly supported as other features.
Supported export formats.
Simply an extension of
Principal to add the possibility to check roles.Enumeration of dwc extensions for both Occurrence and Taxon that are indexed by GBIF.
Deserializer for
Extension in key values.Represents a clustering of search results into categories.
Nested class that represents the count of each category.
Generic request class for search operations requesting facets.
Annotation to document the facet query parameters.
This enum lists the reasons why a crawl is finished.
This predicate checks performs a full text search based on a query parameter.
GADM level.
A GADM region feature.
Terms defined in the DNA extension.
Internal GBIF terms used for processing, fragmenting, crawling, ...
Terms defined in the DNA extension.
An enumeration for all GBIF Regions.
A GBIF user account registered in the user Identity database (previously Drupal).
A wrapper class for a GBIF User that exposes the unique account name as the principal name.
Annotation that marks a method as a 'generated' one.
A container class used to capture the information necessary for a generic validation report.
This predicate checks if an occurrence location falls within a distance of a location.
General interface for all geometries such as polygons or bounding boxes.
All Germplasm terms with namespace http://purl.org/germplasm/germplasmTerm#.
All GGBN terms with namespace http://data.ggbn.org/schemas/ggbn/terms/.
This predicate checks if its
key is greater than or equal its value.This predicate checks if its
key is greater than its value.Very coarse habitat vocabulary matching the boolean biome flags found in the species profile extension.
Validates that the URI field is absolute, beginning with either http or https.
Generic identifier interface for entities.
Identifier Model Object represents an alternative identifier for an occurrence or name usage.
Validation and normalization interface for identifier schemes.
Service interface for Identifier methods.
Service provides a set of operations on
Identifier.Enumeration for all possible identifier types.
This class contains utility methods for identifiers.
Identity service accessing a single user, in read-only.
ID type for user IDs in GRSciColl contacts.
This predicate checks if its
key contains any of its values.A technical installation which can serve datasets.
Iterates over all datasets hosted by a given installation.
Enumeration for all possible installation types.
The owner or location of collection.
Deprecated.
Contains the parameters to create an institution from an organization.
Service for institutions in the collections context.
Iterates over results of
InstitutionService.list(InstitutionSearchRequest).Deprecated.
Query parameters used internally (not part of the public API) to support complex data types.
Represents a remark flagged during the interpretation phase.
Severity of an InterpretationRemark.
Enum to represent the pipelines internal interpretation type steps.
Deprecated.
Deprecated.
All International Press Telecommunications Council terms with namespace http://iptc.org/std/Iptc4xmpExt/2008-02-29/.
Validator for ISNI numbers.
Represents an ISO 8601:2019 date, date-time or date/date-time interval.
Jackson
JsonSerializer classes for IsoDateIntervals with specified formats.Jackson
JsonDeserializer for IsoDateIntervals formatted above, falling back to the Jackson way.Jackson
JsonSerializer for IsoDateInterval.Utility class that parses date values, the allowed date formats are: "yyyy-MM-dd", "yyyy-MM" or "yyyy".
Enumerations with the allowed date formats by the occurrence search service.
Factory constructing registry entity iterables using specific pagers under the hood.
A utility container for holding the key, code and name of an entity.
A utility container for holding only the title and key of an entity.
Allows a collection of keywords which may declare a thesaurus from which they come from.
A simple enumeration of all kingdoms found in the GBIF Backbone Taxonomy and also Catalogue of Life.
Enumeration for all ISO 639-1 language codes using 2 lower case letters.
Serializes the value in a 3 letter ISO format.
Deserializes the value from a 3 letter ISO format or the enumeration name itself to maintain as
much backwards compatibility as possible with e.g.
An interface to allow model objects to offer a consistent lenient equality check.
This predicate checks if its
key is less or equal than its value.This predicate checks if its
key is less than its value.Enumeration of the set of licenses GBIF supports for applying to a dataset.
Mixin interface used to serialize license enums into urls.
Jackson
JsonDeserializer for License.Jackson
JsonSerializer for License.Deprecated.
This predicate checks if its
key is LIKE its value.Lineage class to represent relations between events.
A flat taxonomic classification using the major, Linnean ranks with verbatim names.
A flat taxonomic classification using the major, Linnean ranks with verbatim names and integer based keys.
Jackson
JsonDeserializer for LocalDateTime.Jackson
JsonSerializer for LocalDateTime.Holds the parameters that the collections lookup accepts.
Result of a collections lookup that contains the institution and collections matches found.
A tag that has a namespace, name and a value.
Generic machine tag interface for entities.
Service provides a set of operations on
MachineTag.Utility class to simplify your life when dealing with machine tags.
A description of single changes made to the data.
Enumeration for describing the frequency with which changes and additions are made to the dataset after the initial
dataset is completed.
Deprecated.
Deprecated.
Deprecated.
Metadata to sync GRSciColl entities with their master sources.
Type of GRSciColl master source.
Used in the
LookupResult to express how good an entity matches.A measurement or fact about an occurrence.
Metadata for a multimedia object representing an image, video or audio file.
Based on the DC types vocabulary.
Enumeration for all possible metadata types.
Metadata synchronization historical information.
Interface to access and persists historical metadata synchronization results.
Enumeration of all the different categories of results we want to report on during metadata synchronisation.
Mixins are typically used to leave serialization-oriented annotations outside the models to avoid
introducing coupling on a specific SerDe.
All GenSC (Genomics Standards Consortium) Minimum Information about any Sequence (MIxS) terms
with namespace https://w3id.org/mixs/ or https://w3id.org/gensc/terms/MIXS:.
Util class that generates a validates Mod11,2 checksums.
The public interface providing methods for retrieving NameUsageMediaObjects.
Interface for parsing scientific names.
Enumeration to indicate a part of a canonical scientific name.
A short classification of scientific name strings used in Checklist Bank.
A usage of a scientific name according to one particular Checklist including the GBIF Taxonomic Backbone,
the NUB.
An extension to a NameUsage adding all further properties that are not eagerly loaded.
Parameterized service interface for model classes extending a NameUsage.
Enumeration of issues for each name usage record encountered during checklist processing.
The resulting lookup of a name usage match.
NameUsageMatch for API v2
See https://github.com/gbif/checklistbank/issues/49
A lookup service that fuzzy matches classified scientific names against a body of names.
An extension to the common MediaObject that adds a source taxon key property from checklistbank.
Basic metrics for a single name usage.
Each value in the enum represents a search parameter or facet of the name usage search.
A name usage specific search request with convenience methods to add enum based search filters.
Class used for returning results of a full text search operation.
Interface that provides search/suggest(autocomplete) operations over NameUsages.
This is the public interface providing methods for retrieving name usages in general, no matter if nub or
checklist usage.
A name usage specific suggest request.
Class used for returning results of a suggest operation.
A GBIF network.
This interface provides a minimal contract that all network entities (The readable version) will adhere to.
Iterates over all datasets belonging to a given network.
A GBIF participant node.
Pages through all datasets endorsed by a given node.
Pages through all organizations endorsed by a given node.
Pages through all organizations optionally filtering by country.
Actions on a GBIF node.
Enumeration for all possible node types.
Enumeration representing the different nomenclatoral codes found in biology for scientific names.
Vocabulary for the nomenclatural status of a name.
This predicate negates its subpredicate.
Annotation that marks a resource method to throw a NotFoundException (becomes http 404)
when null is returned by the method.
All OBIS terms with namespace http://rs.iobis.org/obis/terms/.
Represents an Occurrence as interpreted by GBIF, adding typed properties on top of the verbatim ones.
Supports the listing of countries having occurrence records.
The occurrence cube dimension definitions and the way in which they are rolled up into counts.
Supports the listing of datasets having occurrence records.
Supports listing occurrence counts by known dimensions.
Interface to access and persist information about occurrence download events.
An enumeration of validation rules for single occurrence records.
Generic
OccurrenceMapping interface for entities.Models the mapping of a GRSciColl institution or collection to an occurrence record.
Service that provides a set of operations on
OccurrenceMapping.These are the possible states of an
Occurrence as it moves through the processing and persistence chain.Search request that uses a predicate filter like the ones used un downloads.
Occurrence relations based on the dwc:ResourceRelationship model.
The slightly simplified standard schemas that a crawled occurrence record could be built in.
Supported query parameters by the occurrence search and download service.
Request class for issuing search request to the occurrence search service.
Interface that provides search operations over Occurrences.
A statement about the presence or absence of an occurrence at a location at a time.
The rules followed here should match the document at:
http://dev.gbif.org/wiki/display/INT/Identifier+problems+and+how+to+solve+them.
Validator for Orcid identifiers.
A GBIF data publisher.
Represents the information about the usage of one organization in an occurrence download.
Pages through all organizations optionally filtering by country.
Fields to sort by the organization usages in an occurrence download.
Iterates over all datasets hosted by a given organisation.
Iterates over all datasets published by a given organisation.
Enumeration to classify name usages by how they originated.
Most simple paging interface for both request and responses.
The usual (search) limit and offset parameters
Generically is a class that contains attributes used by operations that are aware of pagination.
Paging constants.
Paging response bean.
Overrides parameter name when a form param name does not match a method param name.
A container of a taxon name that is atomised into its relevant, separate parts.
ChecklistBank service dealing with parsed names.
This annotation is used to mark Date parameter that can accept partial dates as input.
Enumeration for all of GBIF's participation statuses.
All Adobe Photoshop terms with namespace http://ns.adobe.com/photoshop/1.0/.
Models an execution of a pipeline that can include one or more steps.
Models a pipeline process for a specific dataset and attempt.
Class to send the parameters of a
PipelineProcess.Models a step in pipelines.
Inner class to store metrics.
Enum to represent the status of a step.
Terms used in DwC archives from https://plazi.org
A simple polygon made out of a list of points to be joined.
A marker intended for validation annotations indicating that the rule should be applied for entites before they have
been persisted.
Analogues of methods from guava's Preconditions
An occurrence download request whose filters are based on predicates ( see
Predicate).A marker intended for validation annotations indicating that the rule should be applied for entites before they have
been persisted.
The definition of the available preservation method types (the method used to preserve specimens).
Deprecated.
Deprecated.
This enum lists the state of an occurrence or checklist crawl.
A dataset can be part of a project.
ProjectAward is used to enter information about a funding award associated with a project.
Simplified version of guava's
Range.This predicate checks if its
key is within the range value.A range used for predicates allowing including or excluding the end values.
An ordered taxonomic rank enumeration with the most frequently used values.
Jackson
JsonSerializer and Jackson JsonDeserializer classes for Rank that uses the common rank markers instead of enum names.Jackson
JsonDeserializer for Rank.Jackson
JsonSerializer for Rank.Provides building of addresses for reading the cube.
Deprecated.
Reference Model Object represents a literature reference stating a bibliography for a taxon.
Service interface for Reference Interface methods.
A dedicated class for related projects.
Class that represents a generic invocation of operation.
Builder class for
Request instances.CRUD operation types.
Base class for registry requests to list the entities.
Builder for Response objects.
Response that can contain a list of related responses.
A rollup defines an addressable count that is maintained for a set of dimensions.
Encapsulates the params to pass in the body for the runAll method.
Encapsulates the possible response of the request of re-execute a pipeline of dataset and
attempt.
Builder for
RunPipelineResponse.Possible response statuses.
Contains common search constants.
Interface to be implemented by all search parameter enumerations.
Generic request class for search operations.
Generic response of a search operation.
Models a flat response of a pipeline process search.
Parameterized generic search interface that supports pagination.
Utility class to do basic validation of all search enum based values.
An unchecked exception that indicates that the service is not available.
Deprecated.
A single instance in time.
Sources for GRSciColl.
Annotation to indicate that a field can be populated from external sources.
Holds the info about the GRSciColl fields whose master source is outside GRSciColl.
Container annotation for multiple
Sourceable annotations.SpeciesProfile Model Object represents a species profile which describes basic species characteristics.
Service interface for SpeciesProfile Interface methods.
Contains the response information of a spell check request.
Information about a suggestion made for possible correct spelled version of a search term.
Custom functions supported by the SQL download API.
SQL Based downloads — experimental feature.
General runners, STANDALONE - run an app using local resources, DISTRIBUTED - run an app using
YARN cluster.
Enum to represent the pipelines step names.
Generic search interface for a suggest/autocomplete service.
A simple class to represent a table of contents for multiple languages.
Generic tag interface for entities.
Known
MachineTag.getName() name value.Known namespaces for tags.
Service provides a set of operations on
Tag.An individual coverage.
The taxonomic status of a taxon.
Deprecated.
This class is no longer used.
The base of all types of temporal coverages.
Allows formatter to be dynamically selected based on the concrete type of TemporalCoverage at runtime.
Compares terms by their qualified name.
A json deserializer that turns full qualified term names into dwc terms instances.
Simple, threadsafe factory for terms that knows about all ConceptTerms of this library and keeps singletons for
all unknown Term instances.
Deprecated.
Deprecated.
Utility methods for
TermA json serializer that turns dwc terms into their full qualified term name.
The IUCN threat status.
Indicates that the field is suitable for String trimming.
A vocabulary to be used for reasons for a type designation of a specimen or name.
TypeSpecimen Model originally designed for both specimens and types, including type specimens, type species and type genera and simple
specimens unrelated to types.
Service interface for TypeSpecimen Interface methods.
Deprecated.
Utilities dealing with unicode strings
Exception thrown when a scientific name cannot be parsed.
Constrain validator that validates URI objects with a @HttpURI annotation.
Deprecated.
replaced by
GbifUserUser ID for GRSciColl contacts.
Deprecated.
replaced by
GbifUserPrincipalRoles here shall not be defined in
AppRole (validated by unit test).Deprecated.
Annotation to indicate that an email has to be valid.
An extended map holding all core terms of an occurrence record.
A verbatim (e.g.
The definition of the available contact types.
VernacularName Model Object represents a vernacular name for a scientific taxon.
Service interface for VernacularName Interface methods.
Marker annotation to declare a controlled vocabulary exists in the GBIF vocabulary server.
All WGS84 Geo Positioning terms with namespace http://www.w3.org/2003/01/geo/wgs84_pos#
This predicate checks if an occurrence location falls within the given WKT geometry
value.Models a step in a Pipeline workflow.
Terms for Adobe XMP have URIs that are not resolvable.
Terms for Adobe XMP have URIs that are not resolvable.