Difference between revisions of "GFeed-plugins-list"

From Gcube Wiki
Jump to: navigation, search
(Transformation MAtrix)
 
(5 intermediate revisions by the same user not shown)
Line 17: Line 17:
  
 
*DATAMINER_ALGORITHMS_COLLECTOR.GUI_BASE_URL (String)
 
*DATAMINER_ALGORITHMS_COLLECTOR.GUI_BASE_URL (String)
 +
*DATAMINER_ALGORITHMS_COLLECTOR.GATEWAY_NAME (Boolean)
 
*DATAMINER_ALGORITHMS_COLLECTOR.DEFAULT_AUTHOR (String)
 
*DATAMINER_ALGORITHMS_COLLECTOR.DEFAULT_AUTHOR (String)
 
*DATAMINER_ALGORITHMS_COLLECTOR.DEFAULT_MAINTAINER (String)  
 
*DATAMINER_ALGORITHMS_COLLECTOR.DEFAULT_MAINTAINER (String)  
 
*DATAMINER_ALGORITHMS_COLLECTOR.PRIVATE (Boolean)
 
*DATAMINER_ALGORITHMS_COLLECTOR.PRIVATE (Boolean)
 +
  
 
It supports translation towards gCat-Controller.
 
It supports translation towards gCat-Controller.
Line 26: Line 28:
 
The OAI-PMH Collector gathers information from oai-pmh endpoint(s) defined in the VRE.
 
The OAI-PMH Collector gathers information from oai-pmh endpoint(s) defined in the VRE.
 
It looks for the foolowing resources in the VRE :  
 
It looks for the foolowing resources in the VRE :  
* Service Endpoint [Category = Repository, Platform.Name = Zenodo] describing :  
+
* Service Endpoint [Category = Repository, Platform.Name = oai-pmh] describing :  
** Zenodo Endpoint url
+
** OAI-PMH Repository entry point
** Zenodo Api Key
+
** [Optional] list of set to extract (Access Point property "set")
** [Optional] list of collections to extract
+
** [Optional] list of formats to extract
 
+
*[Optional] Generic Resource [SecondaryType = Ckan-Zenodo-Mappings, name = ''<profile>''] describing mappings between fields of Zenodo and CKAN model;
+
  
 
It supports the translation towards gCat-Controller.
 
It supports the translation towards gCat-Controller.
Line 46: Line 46:
 
GCat Controller allows the publication of item(s) and resource(s) (along with their profile(s)) via interacting with gCat-Service.
 
GCat Controller allows the publication of item(s) and resource(s) (along with their profile(s)) via interacting with gCat-Service.
  
=Transformation Map=
+
=Transformation Matrix=
 +
 
 +
The following Table reports supported model transformations between currently implemented collectors (sources) and controllers (destinations).
 +
 
 +
In more details, for each couple of plugin '''source->destination''', it is reported either :
 +
 
 +
* '''V''' if the model transformation is supported
 +
* '''X''' otherwise
 +
 
 +
 
 +
{| class="wikitable"
 +
|+ Caption: Transformation Map
 +
|-
 +
! Collectors \ Controllers
 +
! gCat Controller
 +
|-
 +
! oai-harvester
 +
| style="color: green" | V
 +
|-
 +
! DataMinerAlgorithmsCrawler
 +
| style="color: green" | V
 +
|}

Latest revision as of 14:46, 2 February 2023

Aim of this page is to present implemented plugins for gFeed Service, describing their behavior and capabilities. The transformation map represents briefly the current capabilities of the system by identifying what Transformations (source -> dest) can be invoked.

Each implementation might use different VRE Resources, while the use of the common Generic Resource configuration:gcat-feeder is highly encouraged.

Collectors

Collectors gather information from certain sources, producing data ready to be published by Controllers. They are responsible for :

  • data access : searching, filtering
  • data preparation : aggregation, translation

Since Collectors are responsible for model translation(s), they declares the list of Controllers' model supported by their implementation.

DataMiner Algorithm Collector

The DataMiner Algorithm Collector gathers information on the DM algorithms published in the VRE. It uses the following parameters in the VRE :

  • DATAMINER_ALGORITHMS_COLLECTOR.GUI_BASE_URL (String)
  • DATAMINER_ALGORITHMS_COLLECTOR.GATEWAY_NAME (Boolean)
  • DATAMINER_ALGORITHMS_COLLECTOR.DEFAULT_AUTHOR (String)
  • DATAMINER_ALGORITHMS_COLLECTOR.DEFAULT_MAINTAINER (String)
  • DATAMINER_ALGORITHMS_COLLECTOR.PRIVATE (Boolean)


It supports translation towards gCat-Controller.

OAI-PMH Collector

The OAI-PMH Collector gathers information from oai-pmh endpoint(s) defined in the VRE. It looks for the foolowing resources in the VRE :

  • Service Endpoint [Category = Repository, Platform.Name = oai-pmh] describing :
    • OAI-PMH Repository entry point
    • [Optional] list of set to extract (Access Point property "set")
    • [Optional] list of formats to extract

It supports the translation towards gCat-Controller.

Controllers

Controllers allow the publication of data produced by Collectors. They are responsible for :

  • Accessing Destination(s)
  • Publishing data (CREATE/UPDATE)

They expect domain-specific model formats from Collectors in order to deal with complex publication logics.

GCat Controller

GCat Controller allows the publication of item(s) and resource(s) (along with their profile(s)) via interacting with gCat-Service.

Transformation Matrix

The following Table reports supported model transformations between currently implemented collectors (sources) and controllers (destinations).

In more details, for each couple of plugin source->destination, it is reported either :

  • V if the model transformation is supported
  • X otherwise


Caption: Transformation Map
Collectors \ Controllers gCat Controller
oai-harvester V
DataMinerAlgorithmsCrawler V