Difference between revisions of "Developer's Guide"
From Gcube Wiki
m |
(→How-tos) |
||
| (55 intermediate revisions by 7 users not shown) | |||
| Line 5: | Line 5: | ||
Documents technical-oriented information that will help developers further extend and exploit gCube’s source code. The document will target two classes of programmers: | Documents technical-oriented information that will help developers further extend and exploit gCube’s source code. The document will target two classes of programmers: | ||
| − | * Those who want to reuse | + | * Those who want to interface with gCube or to reuse gCube code – Programmers who will use gCube’s libraries to build their own tools, without need to access the source code. |
* Those who want to modify/extend the source code – Programmers who will use the platforms source code to enhance it, correct it, adapt it to different environments and applications domains. | * Those who want to modify/extend the source code – Programmers who will use the platforms source code to enhance it, correct it, adapt it to different environments and applications domains. | ||
| − | + | The Guide is organised as follows. | |
| − | + | [[#Overview | Overview]] provides the developer with a general summary of the gCube technology. | |
| + | [[#How-tos | How-to]] provides the developer with pragmatic, detailed and practical advice on gCube technology. | ||
| + | Components Programming Reference Sections provide the developer with a detailed description of the gCube constituents organising them according to a [[#Components Programming Reference: Functionality-oriented View | Functionality-oriented View]] and a | ||
| + | [[#Components Programming Reference: Data-typology-oriented View | Data-typology-oriented View]]. | ||
| − | + | The gCube team welcomes contributions from everyone who shares our vision and wishes to contribute in a constructive manner to improve and enhance the available software assets. | |
| − | + | As such, gCube have adopted this [[Code of Conduct | Code of Conduct ]] and require all those who wish to participate to agree to these guidelines. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | === [[Developer's Guide: Introduction | Overview]] === | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | === [[Developer's Guide:Introduction | Overview]] === | + | |
: [[Reference_Model | gCube Reference Model]] | : [[Reference_Model | gCube Reference Model]] | ||
: [[GCube_Architecture | gCube Reference Architecture]] | : [[GCube_Architecture | gCube Reference Architecture]] | ||
: [[Glossary]] | : [[Glossary]] | ||
| − | === | + | === How-tos === |
: [[How to develop a gCube Component]] | : [[How to develop a gCube Component]] | ||
: [[How to develop a gCube Portlet]] | : [[How to develop a gCube Portlet]] | ||
: [[Featherweight Stack | How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)]] | : [[Featherweight Stack | How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)]] | ||
: [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries_Framework | How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)]] | : [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries_Framework | How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)]] | ||
| − | : [[How-to Implement Algorithms for the | + | : [[SmartGears | How to turn software applications and containers into gCube resources (a.k.a. the gCube SmartGears Framework)]] |
| + | : [[FHNManager | How to integrate gCube system with external Cloud Providers]] | ||
| + | : Accounting | ||
| + | :: [[Accounting Lib | How to produce accounting records]] | ||
| + | :: [[Accounting Analytics | How to consume accounting records]] | ||
| + | :: [[Accounting Portlet: How to install and configure |How to install and configure Accounting Portlet(AM)]] | ||
| + | : Data Analytics | ||
| + | :: [[Statistical Algorithms Importer: How to install and configure| How to install and configure Statistical Algorithms Importer(SAI)]] | ||
| + | :: [[Statistical_Algorithms_Importer | How to Implement Algorithms by Statistical Algorithms Importer(SAI)]] | ||
| + | :: [[How-to Implement Algorithms for DataMiner | How to Implement Algorithms for DataMiner by Java libraries]] | ||
| + | :: [[How_to_Interact_with_the_DataMiner_by_client | How to Interact with the DataMiner by client]] | ||
| + | :: [[How to use the DataMiner Pool Manager | How to use the DataMiner Pool Manager]] | ||
| + | <!-- :: <strike>[[Legacy_applications_integration | How to integrate legacy applications and offer them via WPS]]</strike> --> | ||
| + | : Data Publishing | ||
| + | :: [[How to programmatically publishing a spatial dataset and the associated metadata by the gCube SDI]] | ||
| + | :: [[How to use Data Transfer 2]] | ||
| + | : Data Discovery and Access | ||
| + | :: [[GeoNetwork library | How to programmatically discover geospatial metadata]] | ||
=== Components Programming Reference: Functionality-oriented View === | === Components Programming Reference: Functionality-oriented View === | ||
| − | ; Core-facilities | + | ; [[Core-facilities]] |
| − | + | : [[Core-facilities#Data_Infrastructure_Management_Facilities | Data Infrastructure Management Facilities]] | |
| − | + | : [[Core-facilities#Data_Infrastructure_Policy-oriented_Security_Facilities | Data Infrastructure Policy-oriented Security Facilities]] | |
| − | + | : [[Core-facilities#Workflow_Management_Facilities | Workflow Management Facilities]] | |
| − | : [[ | + | |
| − | + | ||
| − | : Workflow Management Facilities | + | |
| − | + | ||
| − | + | ||
; [[Data Management Facilities]] | ; [[Data Management Facilities]] | ||
| − | : Data Access and Storage Facilities | + | : [[Data_Management_Facilities#Data_Access_and_Storage_Facilities | Data Access and Storage Facilities]] |
| − | + | : [[Data_Management_Facilities#Data_Transfer_Facilities | Data Transfer Facilities]] | |
| − | + | : [[Data_Management_Facilities#Data_Assessment,_Harmonisation,_and_Certification_Facilities | Data Assessment, Harmonisation, and Certification Facilities]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
; [[Data Consumption Facilities]] | ; [[Data Consumption Facilities]] | ||
: [[Data_Consumption_Facilities#Data_Retrieval_Facilities | Data Retrieval Facilities]] | : [[Data_Consumption_Facilities#Data_Retrieval_Facilities | Data Retrieval Facilities]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
: [[Data_Consumption_Facilities#Data_Manipulation_Facilities | Data Manipulation Facilities]] | : [[Data_Consumption_Facilities#Data_Manipulation_Facilities | Data Manipulation Facilities]] | ||
| − | + | : [[Data Mining Facilities | Data Mining Facilities]] | |
| − | + | ||
: [[Data_Consumption_Facilities#Data_Visualisation_Facilities | Data Visualisation Facilities]] | : [[Data_Consumption_Facilities#Data_Visualisation_Facilities | Data Visualisation Facilities]] | ||
: [[Data_Consumption_Facilities#Semantic_Data_Analysis_Facilities | Semantic Data Analysis Facilities]] | : [[Data_Consumption_Facilities#Semantic_Data_Analysis_Facilities | Semantic Data Analysis Facilities]] | ||
; [[gCube APIs]] | ; [[gCube APIs]] | ||
| − | + | : [http://wiki.gcube-system.org/gcube/Social_Networking_Library Social Networking Library] and [[Social Networking Service]] | |
| + | : [[Social Networking Data Discovery]] | ||
| + | : [https://wiki.gcube-system.org/gcube/Storage_Manager Storage Manager Service] | ||
| + | : [https://wiki.gcube-system.org/gcube/Home_Library_2.0_API_Framework_Specification Home Library Service (DEPRECATED, see StorageHub)] | ||
| + | : [https://gcube.wiki.gcube-system.org/gcube/StorageHub_REST_API Storage Hub Service] | ||
| + | :[https://wiki.gcube-system.org/gcube/Portal_Context Portal Context] and [https://wiki.gcube-system.org/gcube/UserManagement_Core Portal User, Group and Roles Management] | ||
| + | : [[Portal Mailing API]] | ||
; [[gCube Presentation Services]] | ; [[gCube Presentation Services]] | ||
| − | + | :[https://wiki.gcube-system.org/gcube/GCube_Widgets_Store GCube Widgets Store] | |
| + | === Components Programming Reference: Data-typology-oriented View === | ||
| + | ; [[Biodiversity Data Facilities]] | ||
; [[Geospatial Data Facilities]] | ; [[Geospatial Data Facilities]] | ||
| + | ; [[Semantic Data Facilities]] | ||
| + | ; [[Statistical Data Facilities]] | ||
Latest revision as of 11:00, 13 July 2020
Documents technical-oriented information that will help developers further extend and exploit gCube’s source code. The document will target two classes of programmers:
- Those who want to interface with gCube or to reuse gCube code – Programmers who will use gCube’s libraries to build their own tools, without need to access the source code.
- Those who want to modify/extend the source code – Programmers who will use the platforms source code to enhance it, correct it, adapt it to different environments and applications domains.
The Guide is organised as follows. Overview provides the developer with a general summary of the gCube technology. How-to provides the developer with pragmatic, detailed and practical advice on gCube technology. Components Programming Reference Sections provide the developer with a detailed description of the gCube constituents organising them according to a Functionality-oriented View and a Data-typology-oriented View.
The gCube team welcomes contributions from everyone who shares our vision and wishes to contribute in a constructive manner to improve and enhance the available software assets. As such, gCube have adopted this Code of Conduct and require all those who wish to participate to agree to these guidelines.
Overview
How-tos
- How to develop a gCube Component
- How to develop a gCube Portlet
- How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)
- How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)
- How to turn software applications and containers into gCube resources (a.k.a. the gCube SmartGears Framework)
- How to integrate gCube system with external Cloud Providers
- Accounting
- Data Analytics
- Data Publishing
- Data Discovery and Access
Components Programming Reference: Functionality-oriented View
- Core-facilities
- Data Infrastructure Management Facilities
- Data Infrastructure Policy-oriented Security Facilities
- Workflow Management Facilities
- Data Management Facilities
- Data Access and Storage Facilities
- Data Transfer Facilities
- Data Assessment, Harmonisation, and Certification Facilities
- Data Consumption Facilities
- Data Retrieval Facilities
- Data Manipulation Facilities
- Data Mining Facilities
- Data Visualisation Facilities
- Semantic Data Analysis Facilities
- gCube APIs
- Social Networking Library and Social Networking Service
- Social Networking Data Discovery
- Storage Manager Service
- Home Library Service (DEPRECATED, see StorageHub)
- Storage Hub Service
- Portal Context and Portal User, Group and Roles Management
- Portal Mailing API
- gCube Presentation Services
