001/*
002 * Copyright 2020 Global Biodiversity Information Facility (GBIF)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.gbif.api.service.occurrence;
017
018import org.gbif.api.vocabulary.Country;
019
020import java.util.Map;
021
022/**
023 * Supports the listing of countries having occurrence records.
024 */
025public interface OccurrenceCountryIndexService {
026
027  /**
028   * Lists all publishing countries of occurrences falling within a given country.
029   * @param country the country the occurrences fall into
030   * @return map of publishing country to number of occurrences ordered by number of occurrences
031   */
032  Map<Country, Long> publishingCountriesForCountry(Country country);
033
034  /**
035   * Lists all countries occurrences are falling into that have been published by a given country.
036   * @return map of countries to number of occurrences ordered by number of occurrences
037   */
038  Map<Country, Long> countriesForPublishingCountry(Country publishingCountry);
039}