Difference between revisions of "Species Product Discovery: client library"
From Gcube Wiki
Lucio.lelii (Talk | contribs) (Created page with 'This client library allows user to contact the Species Product Discovery Service. === Maven Coordinates ===') |
Lucio.lelii (Talk | contribs) m (→Maven Coordinates) |
||
| Line 1: | Line 1: | ||
This client library allows user to contact the Species Product Discovery Service. | This client library allows user to contact the Species Product Discovery Service. | ||
| − | === | + | The '''spd-client-library''' is a client library for the '''Species Product Discovery''' Service. It helps clients interacting with the service and processing result. This library is part of the [https://gcube.wiki.gcube-system.org/gcube/index.php/Featherweight_Stack FeatherWeight Stack]. |
| + | |||
| + | === Download === | ||
| + | |||
| + | The maven coordinates to get the spd-client-library is: | ||
| + | |||
| + | <source lang="xml"> | ||
| + | <dependency> | ||
| + | <groupId>org.gcube.data.spd</groupId> | ||
| + | <artifactId>spd-client-library</artifactId> | ||
| + | <version>${version}</version> | ||
| + | </dependency> | ||
| + | </source> | ||
| + | |||
| + | '''''the lastest released version is''''' : 2.0.0 | ||
| + | |||
| + | '''''the lastest under development version is''''' : 2.1.0-SNAPSHOT | ||
| + | |||
| + | |||
| + | === Architecture === | ||
| + | |||
| + | The '''spd-cl''' is divided into 4 parts: | ||
| + | * ''QueryManager'': helps clients submitting queries to the service; | ||
| + | * ''OccurrencesManager'': helps clients retrieving occurrences and generating maps using retrieved occurrences; | ||
| + | * ''TaxonManager'': help clients retrieving taxa and their ancestor by ids. | ||
| + | * ''ExecutorManager'': helps clients submitting jobs to the system. | ||
| + | |||
| + | == QueryManager == | ||
| + | |||
| + | <source lang="java"> | ||
| + | public Stream<ResultElement> search(String query) throws InvalidQueryException, UnsupportedPluginException; | ||
| + | </source> | ||
| + | |||
| + | <source lang="java"> | ||
| + | public List<PluginDescription> getPluginsDescription(); | ||
| + | </source> | ||
Revision as of 16:41, 20 March 2013
This client library allows user to contact the Species Product Discovery Service.
The spd-client-library is a client library for the Species Product Discovery Service. It helps clients interacting with the service and processing result. This library is part of the FeatherWeight Stack.
Download
The maven coordinates to get the spd-client-library is:
<dependency> <groupId>org.gcube.data.spd</groupId> <artifactId>spd-client-library</artifactId> <version>${version}</version> </dependency>
the lastest released version is : 2.0.0
the lastest under development version is : 2.1.0-SNAPSHOT
Architecture
The spd-cl is divided into 4 parts:
- QueryManager: helps clients submitting queries to the service;
- OccurrencesManager: helps clients retrieving occurrences and generating maps using retrieved occurrences;
- TaxonManager: help clients retrieving taxa and their ancestor by ids.
- ExecutorManager: helps clients submitting jobs to the system.
QueryManager
public Stream<ResultElement> search(String query) throws InvalidQueryException, UnsupportedPluginException;
public List<PluginDescription> getPluginsDescription();
