Difference between revisions of "Developer's Guide"

Revision as of 16:26, 23 July 2013

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 the 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.

Contents

1. Introduction
2. gCube Architecture
3. Reference Model
4. gCube Components Programming Reference
   1. gCube Infrastructure Enabling Services
      1. Information System
      2. Virtual Organisation Management
         1. GCube Clients Integration with security
      3. VRE Management
      4. Execution Engine
      5. Workflow Engine
      6. Messaging Infrastructure
         1. Common Messaging Endpoints Library
      7. Featherweight Client Stack
      8. Utility and Common Libraries
         1. common-utils-encryption
         2. common-encryption
         3. common-accounting-model
         4. common-accounting
   2. gCube Information Organisation Services
      1. Storage Manager
      2. Tree Manager
         1. Tree Manager Framework
         2. Tree Library
         3. Tree Manager Library
         4. OAI TM Plugin
         5. Species TM Plugin
         6. FIGIS TM Plugin
      3. Species Product Discovery
         1. Species Product Discovery Client Library
         2. Species Product Discovery Objects
         3. Darwin Core Terms
         4. Species Product Discovery TestSuite
   3. gCube Information Retrieval Services
      1. gCube ResultSet 2 (gRS2)
      2. gRS2 Broker
      3. Search 2 Framework (NEW)
      4. OpenSearch Framework
      5. Index Management Framework
      6. Data Transformation
      7. Personalisation
      8. Distributed Information Retrieval Support Framework
      9. gCube Ontology Management Service
   4. gCube Data Consumption Facilities
      1. Implementation of Algorithms for the Statistical Manager Service
      2. Ecological Modeling: Features for Analyzing Biological Phenomena and Species
   5. gCube Data Transfer Facilities
      1. Data Transfer Agent
      2. Data Transfer Scheduler
      3. The Data Transfer Portlet
      4. The Data Transfer Common Messaging Interface
      5. URI resolver
   6. gCube Data Assessment, Harmonization and Certification Facilities
      1. Time Series Management and Analysis
   7. gCube Data Publishing Facilities
      1. gCube SDMX Statistical Data Dissemination System
   8. Geospatial Data Facilities
      1. Legacy ISO Metadata Publishing
      2. GeoNetwork library
      3. GIS Interface
      4. GIS Publisher service
      5. Environment Explorer: Features for Retrieving environmental data associated to a set of coordinates
      6. Geo Spatial Data Processing: Features for processing geo-spatial data
      7. gCube GeoExplorer Portlet: A web interface for performing discovery of layers in a distributed GeoServer network
      8. GeoExplorer Data Visualization Plugins : A set of GeoExplorer plugins to support visualization of the underlying data
   9. gCube Presentation Services
      1. Application Support Layer
      2. gCube Portal Engine
      3. ASL HTTP Front End
      4. Social Networking Library

1. Step by step guide
   1. Developing a gCube Component
      1. Developing a Service
      2. Profile Specification
      3. Software Archive Specification
   2. Portlet Development
      1. Developing gCube Portlets Guide
         1. Create a new Mavenized gCube GWT Portlet Guide (NEW)
      2. Adding a Quick tour guide to your portlet
      3. Publish App News in User Feeds (Social Portal)
      4. GCube Widgets Library - General guidelines about Portlet StyleSheets
      5. GCube Portlets common icon set
      6. Inter Portlet Subscription/Notification Mechanism (Client side)
      7. Building your gCube Portlet in ETICS
2. References
3. Glossary
4. Lexical Convention

Alternative TOC

Overview

gCube Reference Model

gCube Reference Architecture

Glossary

Lexical Convention (do we need this?)

References (do we need this? Very obsolete!!!)

Basic 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 Implement Algorithms for the Statistical Manager

Components Programming Reference

Core-facilities

Data Infrastructure Management Facilities

Information System

Resource and VRE Management

Utilities and Common Libraries

Data Infrastructure Policy-oriented Security Facilities

Workflow Management Facilities

Workflow Engine

Execution Engine

Data Management

Data Access and Storage Facilities

File-based Data Access

Tree-based Data Access

Biodiversity Data Access

Data Transfer Facilities

Result Set

Data Transfer

Data Assessment, Harmonisation, and Certification Facilities

Tabular Data Facilities

Biodiversity Data Facilities

Data Consumption Facilities

Data Retrieval Facilities

Data Manipulation Facilities

Data Mining Facilities

Data Visualisation Facilities

Semantic Data Analysis Facilities

API

Data Management APIs

Data Consumption APIs

PAGES TO BE PLACED

1. 1. gCube Data Publishing Facilities
      1. gCube SDMX Statistical Data Dissemination System

1. 1. Geospatial Data Facilities
      1. GeoNetwork library
      2. GIS Interface
      3. GIS Publisher service
      4. Environment Explorer: Features for Retrieving environmental data associated to a set of coordinates
      5. Geo Spatial Data Processing: Features for processing geo-spatial data
      6. gCube GeoExplorer Portlet: A web interface for performing discovery of layers in a distributed GeoServer network
      7. GeoExplorer Data Visualization Plugins : A set of GeoExplorer plugins to support visualization of the underlying data

1. 1. gCube Presentation Services
      1. Application Support Layer
      2. gCube Portal Engine
      3. ASL HTTP Front End
      4. Social Networking Library