eu.etaxonomy.cdm.ext.ipni

Interface IIpniService

All Known Implementing Classes:

IpniService

public interface IIpniService

Interface for queying IPNI via webservice (http://www.uk.ipni.org/). Services are available for the plant name index, the autor index and the publication index.

Since:

Aug 16, 2010

Author:

a.mueller

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IIpniService.DelimitedFormat Enumeration of the four return delimited data formats provided by IPNI.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADVANCED_NAME_SERVICE_URL
static java.lang.String	AUTHOR_SERVICE_URL
static java.lang.String	ID_NAMESEARCH_SERVICE_URL
static java.lang.String	ID_PUBLICATION_SERVICE_URL
static java.lang.String	PUBLICATION_SERVICE_URL
static java.lang.String	SIMPLE_NAME_SERVICE_URL
static java.util.UUID	uuidAlternativeNames UUID for the extension type 'Alternative name': eee99927-1f9f-4df2-9d8f-11746bf35c0c
static java.util.UUID	uuidIpni UUID for the reference representing the IPNI database: 8b6d750f-c7e0-4180-afbf-aa4c50148813

Method Summary

Modifier and Type	Method and Description
java.util.List<Person>	getAuthors(java.lang.String abbreviation, java.lang.String surname, java.lang.String forename, java.lang.String isoCountry, ICdmRepository appConfig, IpniServiceAuthorConfigurator config) Returns a list of persons (authors) defined by their abbreviation, surname, forename and/or isoCountry.
java.util.List<IBotanicalName>	getNamesAdvanced(java.lang.String family, java.lang.String genus, java.lang.String species, java.lang.String infraFamily, java.lang.String infraGenus, java.lang.String infraSpecies, java.lang.String authorAbbrev, java.lang.String publicationTitle, IpniService.IpniRank ipniRankToReturn, IpniServiceNamesConfigurator config, ICdmRepository repository) Returns a list of names matching the relevant parameters according to the IPNI full search function.
java.util.List<IBotanicalName>	getNamesAdvanced(java.lang.String family, java.lang.String genus, java.lang.String species, java.lang.String infraFamily, java.lang.String infraGenus, java.lang.String infraSpecies, java.lang.String authorAbbrev, java.lang.String publicationTitle, Rank rankRangeToReturn, IpniServiceNamesConfigurator config, ICdmRepository repository) As #getNamesAdvanced(String, String, String, String, String, String, String, Boolean, Boolean, String, Boolean, Boolean, Boolean, IpniRank, Boolean, IpniServiceNamesConfigurator, ICdmRepository) but using CDM Rank instead of IpniRank.
java.io.InputStream	getNamesById(java.lang.String id) Returns the name matching the id parameter according to the IPNI Quick search function.
java.util.List<IBotanicalName>	getNamesSimple(java.lang.String wholeName, ICdmRepository services, IpniServiceNamesConfigurator config) Returns a list of names matching the wholeName parameter according to the IPNI Quick search function.
java.util.List<Reference>	getPublications(java.lang.String title, java.lang.String abbreviation, ICdmRepository services, IpniServicePublicationConfigurator config) Returns a list of publications matching the title and/or the abbreviation parameter according to the IPNI Publication search function.
java.io.InputStream	getPublicationsById(java.lang.String id) Returns the publication matching the id parameter according to the IPNI Quick search function.
java.net.URL	getServiceUrl(java.lang.String url)

Field Detail

uuidIpni

static final java.util.UUID uuidIpni

UUID for the reference representing the IPNI database:
8b6d750f-c7e0-4180-afbf-aa4c50148813

uuidAlternativeNames

static final java.util.UUID uuidAlternativeNames

UUID for the extension type 'Alternative name':
eee99927-1f9f-4df2-9d8f-11746bf35c0c

AUTHOR_SERVICE_URL

static final java.lang.String AUTHOR_SERVICE_URL

See Also:

Constant Field Values

SIMPLE_NAME_SERVICE_URL

static final java.lang.String SIMPLE_NAME_SERVICE_URL

See Also:

Constant Field Values

ADVANCED_NAME_SERVICE_URL

static final java.lang.String ADVANCED_NAME_SERVICE_URL

See Also:

Constant Field Values

PUBLICATION_SERVICE_URL

static final java.lang.String PUBLICATION_SERVICE_URL

See Also:

Constant Field Values

ID_PUBLICATION_SERVICE_URL

static final java.lang.String ID_PUBLICATION_SERVICE_URL

See Also:

Constant Field Values

ID_NAMESEARCH_SERVICE_URL

static final java.lang.String ID_NAMESEARCH_SERVICE_URL

See Also:

Constant Field Values

Method Detail

getAuthors

java.util.List<Person> getAuthors(java.lang.String abbreviation,
                                  java.lang.String surname,
                                  java.lang.String forename,
                                  java.lang.String isoCountry,
                                  ICdmRepository appConfig,
                                  IpniServiceAuthorConfigurator config)

Returns a list of persons (authors) defined by their abbreviation, surname, forename and/or isoCountry. The amount of data added to each person depends on the format and the database connection (appConfig).

The minimal and short format returns the standard form as the nomenclatural title, the default author forename as the givenname and the default author surname as the family name of the returned person object. The id and the version are added as source where the id is the id, the namespace is "Author" and the microcitation is the version. If an a database connection is passed (appConig is not null) the database is searched for an existing citation representing the IPNI webservice. If not exists a new such reference with the given ipni uuid is created and stored in the database.
If no database connection is passed a new reference is created each time with a random UUID to avoid duplicate key problems when trying to save the returned objects.

The minimal format returns the same object as the short format but additionally the date is evaluated as lifespan. Also an extension of type ExtensionType.INFORMAL_CATEGORY is added for each semicolon separated part of the 'Alternative names' result. TODO make alternative name or alternative title an own ExtensionType

The classic format at the moment returns the same object as the extended format as the remaining parameters are not yet implemented.

Parameters:

abbreviation -

surname -

forename -

isoCountry -

format -

appConfig -

Returns:

getNamesSimple

java.util.List<IBotanicalName> getNamesSimple(java.lang.String wholeName,
                                              ICdmRepository services,
                                              IpniServiceNamesConfigurator config)

Returns a list of names matching the wholeName parameter according to the IPNI Quick search function. See http://www.uk.ipni.org/sample_searches.html#name_quick for further explanation about the IPNI Quick search.

The format parameter defines the depth of the data returned. See http://www.ipni.org/ipni/delimited_help.html for further information on the supported data formats.
Please be aware that not all data returned by IPNI are transformed into CDM data as some of the data types are not available in the CDM and some types are just not yet implemented.

Parameters:

wholeName -

format -

appConfig -

Returns:

getNamesById

java.io.InputStream getNamesById(java.lang.String id)

Returns the name matching the id parameter according to the IPNI Quick search function. See http://www.uk.ipni.org/sample_searches.html#name_quick for further explanation about the IPNI Quick search.

Please be aware that not all data returned by IPNI are transformed into CDM data as some of the data types are not available in the CDM and some types are just not yet implemented.

Parameters:

id -

Returns:

getPublicationsById

java.io.InputStream getPublicationsById(java.lang.String id)

Returns the publication matching the id parameter according to the IPNI Quick search function. See http://www.uk.ipni.org/sample_searches.html#name_quick for further explanation about the IPNI Quick search.

Please be aware that not all data returned by IPNI are transformed into CDM data as some of the data types are not available in the CDM and some types are just not yet implemented.

Parameters:

id -

Returns:

getNamesAdvanced

java.util.List<IBotanicalName> getNamesAdvanced(java.lang.String family,
                                                java.lang.String genus,
                                                java.lang.String species,
                                                java.lang.String infraFamily,
                                                java.lang.String infraGenus,
                                                java.lang.String infraSpecies,
                                                java.lang.String authorAbbrev,
                                                java.lang.String publicationTitle,
                                                IpniService.IpniRank ipniRankToReturn,
                                                IpniServiceNamesConfigurator config,
                                                ICdmRepository repository)

Returns a list of names matching the relevant parameters according to the IPNI full search function. See {http://www.uk.ipni.org/sample_searches.html#name_full} for further explanation about the IPNI Full search.

The format parameter defines the depth of the data returned. See http://www.ipni.org/ipni/delimited_help.html for further information on the supported data formats.
Please be aware that not all data returned by IPNI are transformed into CDM data as some of the data types are not available in the CDM and some types are just not yet implemented.

Parameters:

family -

genus -

species -

infraFamily -

infraGenus -

infraSpecies -

authorAbbrev -

includePublicationAuthors -

includeBasionymAuthors -

publicationTitle -

isAPNIRecord -

isGCIRecord -

isIKRecord -

rankToReturn -

sortByFamily -

format -

appConfig -

Returns:

List of botanical names returned by the IPNI web service.

getNamesAdvanced

java.util.List<IBotanicalName> getNamesAdvanced(java.lang.String family,
                                                java.lang.String genus,
                                                java.lang.String species,
                                                java.lang.String infraFamily,
                                                java.lang.String infraGenus,
                                                java.lang.String infraSpecies,
                                                java.lang.String authorAbbrev,
                                                java.lang.String publicationTitle,
                                                Rank rankRangeToReturn,
                                                IpniServiceNamesConfigurator config,
                                                ICdmRepository repository)

As #getNamesAdvanced(String, String, String, String, String, String, String, Boolean, Boolean, String, Boolean, Boolean, Boolean, IpniRank, Boolean, IpniServiceNamesConfigurator, ICdmRepository) but using CDM Rank instead of IpniRank. The CDM Rank is transformed into an IpniRank so it returns all names that are in the same IpniRange as the CDM rank. Therefore when using CDM rank 'variety' also a 'subspecies' may be returned as 'variety' and 'subspecies' are within the same IpniRange 'Infraspecific'.

Parameters:

family -

genus -

species -

infraFamily -

infraGenus -

infraSpecies -

authorAbbrev -

includePublicationAuthors -

includeBasionymAuthors -

publicationTitle -

isAPNIRecord -

isGCIRecord -

isIKRecord -

rankToReturn -

sortByFamily -

format -

appConfig -

Returns:

List of botanical names returned by the IPNI web service.

getPublications

java.util.List<Reference> getPublications(java.lang.String title,
                                          java.lang.String abbreviation,
                                          ICdmRepository services,
                                          IpniServicePublicationConfigurator config)

Returns a list of publications matching the title and/or the abbreviation parameter according to the IPNI Publication search function. See http://www.uk.ipni.org/sample_searches.html#publication_examples for further explanation about the IPNI Publication search.

Please be aware that not all data returned by IPNI are transformed into CDM data as some of the data types are not available in the CDM and some types are just not yet implemented.

Parameters:

title -

abbreviation -

services - to retrieve data from the database. Needed to attach the same 'IPNI' reference to each of the resulting objects. Otherwise the resulting IPNI reference will be duplicate for each result and each time the service is called.

config - for finetuning, maybe null

Returns:

getServiceUrl

java.net.URL getServiceUrl(java.lang.String url)