Difference between revisions of "Data Retrieval APIs"
From Gcube Wiki
| Line 25: | Line 25: | ||
|- | |- | ||
|} | |} | ||
| + | |||
| + | ==gCQLParser API== | ||
| + | * '''Description''': Provides functionality that helps presentation layer to use gCube services. | ||
| + | * '''Type''': Local | ||
| + | * '''Protocol''': Java | ||
| + | * '''Framework''': none | ||
| + | * '''Documentation''' | ||
| + | * '''Key Features''' | ||
| + | :* ''submission of gCQL queries as plain string'' | ||
| + | :* ''support for gCube extensions in CQL language for presentable information'' | ||
| + | |||
| + | |||
| + | ==Index Service API== | ||
| + | * '''Description''': Provides indexing functionality for the resources. | ||
| + | * '''Type''': WS | ||
| + | * '''Protocol''': SOAP | ||
| + | * '''Framework''': [https://gcore.wiki.gcube-system.org/gCube gCore] | ||
| + | |- | ||
| + | * [[Index_Management_Framework|'''Documentation''']] | ||
| + | * '''Key Features''' | ||
| + | :* ''Full Text Index receives CQL queries and transforms them into Lucene queries'' | ||
| + | :* ''2 linguistics components are available; the language identifier module, and the lemmatizer module'' | ||
| + | :* ''database partitioning is supported'' | ||
| + | :* ''geo-spatial Index Lookup supports one custom CQL relation'' | ||
| + | :* ''the "geosearch" relation has a number of modifiers that specify parameters such as collection, language, query inclusion type, refiner and ranker'' | ||
| + | :* ''support of customs refiners and rankers'' | ||
| + | :* ''the content to be fed into a Geo Index, must be served as a ResultSet containing XML documents conforming to the GeoROWSET schemafield presense and handling by the Geo Index is specified through a GeoIndexType; an XML document conforming to the GeoIndexType schemathe content to be fed into a Geo Index, must be served as a ResultSet containing XML documents conforming to the GeoROWSET schema'' | ||
Revision as of 10:09, 27 August 2012
Data Retrieval APIs provide access to to Information Retrieval facilites over large heterogeneous environments, offering a declarative approach for querying the hosted information and allowing for easy integration of external data sources of information.
This page outlines the design rationale for those APIs.
Overview
| Name | Description | Type | Protocol | Framework |
| gCQLParser | The gCube parser for CQL language (extended with gCube elements) | Java | Local | none |
| Index Service | Provides indexing functionality for the resources | WS | SOAP | gCore |
| OperatorLibrary | The search operators cover the basic functionality that could be encountered in a typical search operation | Java | Local | none |
| Search System Service | Web service that offers information retrieval functionality in a gCube infrastructure. | WS | SOAP | gCore |
| OpenSearch Library | The OpenSearch Core Library conforms to the latest OpenSearch specification and provides general OpenSearch-related functionality to any component which needs to query OpenS earch providers. | CL | Local | none |
| OpenSearchService | TThe OpenSearch Service is a stateful web service responsible for the invocation of the OpenSearch Operator in the context of the provider to be queried. | WS | SOAP | gCore |
gCQLParser API
- Description: Provides functionality that helps presentation layer to use gCube services.
- Type: Local
- Protocol: Java
- Framework: none
- Documentation
- Key Features
- submission of gCQL queries as plain string
- support for gCube extensions in CQL language for presentable information
Index Service API
- Description: Provides indexing functionality for the resources.
- Type: WS
- Protocol: SOAP
- Framework: gCore
|-
- Documentation
- Key Features
- Full Text Index receives CQL queries and transforms them into Lucene queries
- 2 linguistics components are available; the language identifier module, and the lemmatizer module
- database partitioning is supported
- geo-spatial Index Lookup supports one custom CQL relation
- the "geosearch" relation has a number of modifiers that specify parameters such as collection, language, query inclusion type, refiner and ranker
- support of customs refiners and rankers
- the content to be fed into a Geo Index, must be served as a ResultSet containing XML documents conforming to the GeoROWSET schemafield presense and handling by the Geo Index is specified through a GeoIndexType; an XML document conforming to the GeoIndexType schemathe content to be fed into a Geo Index, must be served as a ResultSet containing XML documents conforming to the GeoROWSET schema
