org.gbif.api.util.iterables

Class Iterables

java.lang.Object

org.gbif.api.util.iterables.Iterables

public class Iterables
extends Object

Factory constructing registry entity iterables using specific pagers under the hood.

Method Summary

Modifier and Type	Method and Description
static Iterable<CollectionView>	collections(CollectionSearchRequest searchRequest, CollectionService service, Integer limit) Iterable for CollectionService.list(CollectionSearchRequest).
static Iterable<Dataset>	constituentDatasets(UUID key, DatasetService service)
static Iterable<DatasetOccurrenceDownloadUsage>	datasetOccurrenceDownloadUsages(OccurrenceDownloadService service, String downloadKey, Integer limit) Iterable for OccurrenceDownloadService.listDatasetUsages(String, Pageable).
static Iterable<Dataset>	datasets(DatasetType type, DatasetService service)
static Iterable<Dataset>	datasets(UUID key, DatasetType type, DatasetService ds, OrganizationService os, InstallationService is, NetworkService ns, NodeService nos)
static Iterable<Dataset>	datasets(UUID key, DatasetType type, DatasetService ds, OrganizationService os, InstallationService is, NetworkService ns, NodeService nos, int pageSize) Returns a dataset iterable by testing the given registry key first to see whether it is a dataset, organization or installation.
static Iterable<DatasetSearchResult>	datasetSearchResults(DatasetSearchRequest datasetSearchRequest, DatasetSearchService datasetSearchService, Integer limit) Iterates over dataset search results.
static Iterable<Dataset>	datasetsIterable(Function<PagingRequest,PagingResponse<Dataset>> pager)
static Iterable<Descriptor>	descriptors(DescriptorsService service, DescriptorSearchRequest searchRequest, Integer limit) Iterable for DescriptorsService.listDescriptors(DescriptorSearchRequest).
static Iterable<Map<String,String>>	descriptorVerbatims(DescriptorsService service, DescriptorSearchRequest searchRequest, Integer limit) Iterable for the verbatim fields of DescriptorsService.listDescriptors(DescriptorSearchRequest).
static Iterable<DownloadStatistics>	downloadStatistics(OccurrenceDownloadService service, Date fromDate, Date toDate, Country publishingCountry, UUID datasetKey, UUID publishingOrgKey, Integer limit) Iterable for OccurrenceDownloadService.getDownloadStatistics(Date, Date, Country, UUID, UUID, Pageable).
static Iterable<Dataset>	endorsedDatasets(UUID nodeKey, DatasetType type, NodeService service)
static Iterable<Organization>	endorsedOrganizations(UUID nodeKey, NodeService service)
static Iterable<Dataset>	hostedDatasets(UUID key, DatasetType type, InstallationService service)
static Iterable<Dataset>	hostedDatasets(UUID key, DatasetType type, OrganizationService service)
static Iterable<Institution>	institutions(InstitutionSearchRequest searchRequest, InstitutionService service, Integer limit) Iterable for InstitutionService.list(InstitutionSearchRequest).
static Iterable<Dataset>	networkDatasets(UUID key, DatasetType type, NetworkService service) Iterates over all constituents of a given network.
static Iterable<Node>	nodes(NodeService service) Iterate over all endorsing nodes
static Iterable<Organization>	organizations(Country country, OrganizationService service)
static Iterable<Dataset>	publishedDatasets(UUID key, DatasetType type, OrganizationService service)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

datasets

public static Iterable<Dataset> datasets(@Nullable
                                         UUID key,
                                         @Nullable
                                         DatasetType type,
                                         DatasetService ds,
                                         OrganizationService os,
                                         InstallationService is,
                                         NetworkService ns,
                                         NodeService nos)

Parameters:

key - a valid dataset, organization or installation key. If null all datasets will be iterated over

Throws:

IllegalArgumentException - if given key is not existing

datasets

public static Iterable<Dataset> datasets(@Nullable
                                         UUID key,
                                         @Nullable
                                         DatasetType type,
                                         DatasetService ds,
                                         OrganizationService os,
                                         InstallationService is,
                                         NetworkService ns,
                                         NodeService nos,
                                         int pageSize)

Returns a dataset iterable by testing the given registry key first to see whether it is a dataset, organization or installation. In case of an organization key the published datasets will be returned.

Parameters:

key - a valid dataset, organization or installation key. If null all datasets will be iterated over

pageSize - to use when talking to the registry

Throws:

IllegalArgumentException - if given key is not existing

datasets

public static Iterable<Dataset> datasets(@Nullable
                                         DatasetType type,
                                         DatasetService service)

Parameters:

type - an optional filter to just include the given dataset type

datasetSearchResults

public static Iterable<DatasetSearchResult> datasetSearchResults(@Nullable
                                                                 DatasetSearchRequest datasetSearchRequest,
                                                                 DatasetSearchService datasetSearchService,
                                                                 @Nullable
                                                                 Integer limit)

Iterates over dataset search results.

publishedDatasets

public static Iterable<Dataset> publishedDatasets(UUID key,
                                                  @Nullable
                                                  DatasetType type,
                                                  OrganizationService service)

Parameters:

key - a valid organization key

type - an optional filter to just include the given dataset type

hostedDatasets

public static Iterable<Dataset> hostedDatasets(UUID key,
                                               @Nullable
                                               DatasetType type,
                                               OrganizationService service)

Parameters:

key - a valid organization key

type - an optional filter to just include the given dataset type

hostedDatasets

public static Iterable<Dataset> hostedDatasets(UUID key,
                                               @Nullable
                                               DatasetType type,
                                               InstallationService service)

Parameters:

key - a valid installation key

type - an optional filter to just include the given dataset type

constituentDatasets

public static Iterable<Dataset> constituentDatasets(UUID key,
                                                    DatasetService service)

Parameters:

key - a valid dataset key

networkDatasets

public static Iterable<Dataset> networkDatasets(UUID key,
                                                @Nullable
                                                DatasetType type,
                                                NetworkService service)

Iterates over all constituents of a given network.

Parameters:

key - a valid network key

type - an optional filter to just include the given dataset type

endorsedDatasets

public static Iterable<Dataset> endorsedDatasets(UUID nodeKey,
                                                 @Nullable
                                                 DatasetType type,
                                                 NodeService service)

Parameters:

nodeKey - a valid endorsing node key

type - an optional filter to just include the given dataset type

datasetsIterable

public static Iterable<Dataset> datasetsIterable(Function<PagingRequest,PagingResponse<Dataset>> pager)

Parameters:

pager - producer function of next page response

Returns:

a dataset iterable based on producer function

organizations

public static Iterable<Organization> organizations(@Nullable
                                                   Country country,
                                                   OrganizationService service)

Parameters:

country - an optional country filter

endorsedOrganizations

public static Iterable<Organization> endorsedOrganizations(UUID nodeKey,
                                                           NodeService service)

Parameters:

nodeKey - a valid endorsing node key

nodes

public static Iterable<Node> nodes(NodeService service)

Iterate over all endorsing nodes

downloadStatistics

public static Iterable<DownloadStatistics> downloadStatistics(OccurrenceDownloadService service,
                                                              @Nullable
                                                              Date fromDate,
                                                              @Nullable
                                                              Date toDate,
                                                              @Nullable
                                                              Country publishingCountry,
                                                              @Nullable
                                                              UUID datasetKey,
                                                              @Nullable
                                                              UUID publishingOrgKey,
                                                              @Nullable
                                                              Integer limit)

Iterable for OccurrenceDownloadService.getDownloadStatistics(Date, Date, Country, UUID, UUID, Pageable).

datasetOccurrenceDownloadUsages

public static Iterable<DatasetOccurrenceDownloadUsage> datasetOccurrenceDownloadUsages(OccurrenceDownloadService service,
                                                                                       String downloadKey,
                                                                                       @Nullable
                                                                                       Integer limit)

Iterable for OccurrenceDownloadService.listDatasetUsages(String, Pageable).

collections

public static Iterable<CollectionView> collections(CollectionSearchRequest searchRequest,
                                                   CollectionService service,
                                                   @Nullable
                                                   Integer limit)

Iterable for CollectionService.list(CollectionSearchRequest).

institutions

public static Iterable<Institution> institutions(InstitutionSearchRequest searchRequest,
                                                 InstitutionService service,
                                                 @Nullable
                                                 Integer limit)

Iterable for InstitutionService.list(InstitutionSearchRequest).

descriptors

public static Iterable<Descriptor> descriptors(DescriptorsService service,
                                               DescriptorSearchRequest searchRequest,
                                               @Nullable
                                               Integer limit)

Iterable for DescriptorsService.listDescriptors(DescriptorSearchRequest).

descriptorVerbatims

public static Iterable<Map<String,String>> descriptorVerbatims(DescriptorsService service,
                                                               DescriptorSearchRequest searchRequest,
                                                               @Nullable
                                                               Integer limit)

Iterable for the verbatim fields of DescriptorsService.listDescriptors(DescriptorSearchRequest).