Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 12.3 KB

README.md

File metadata and controls

95 lines (73 loc) · 12.3 KB

DAO Implementation of 52n Sensor Web Server Helgoland

Build Status Java CI Maven Central Total alerts Language grade: JavaScript Language grade: Java

Sensor Web Server Helgoland architecture overview

Description

Provide database data via 52n Sensor Web Server Helgoland.

This module is an SPI implementation of the 52°North Sensor Web Server Helgoland. It provides data access objects which access series data from relational databases. Using Hibernate the data model is not fixed to one specific.

The DAO module implements the Series API's Service Provider Interface (SPI). It serves as backend access layer to retrieve data from a relational database and to provide it via a well defined RESTful interface. Lightweight clients can then query and work with that series data easily in a common way (other data access mechanisms are available as well). Besides pure data access, the data can be preprocessed with common IO functionalities e.g.

  • prerendering of series data,
  • generalization,
  • overlaying of data from multiple series
  • conversion of raw data to other formats like pdf and png

Using Hibernate makes it flexible to use almost arbitrary data models, i.e. there is no need to have convert your data intot a specific data model. The combination of making adjustments to hbm.xml mapping files and database views (not always needed) make it possible to match existing databases quite well. The series data model of the 52°North SOS is used by default and can be used right out-of-the-box.

The following main frameworks are used to provide this API:

References

tbd

License

The module is published under the GNU General Public License v2 (GPLv2).

Changelog

Contributing

We try to follow the GitFlow model, although we do not see it that strict.

However, make sure to do pull requests for features, hotfixes, etc. by making use of GitFlow. Altlassian provides [a good overview] (https://www.atlassian.com/de/git/workflows#!workflow-gitflow). of the most common workflows.

Contact

Henning Bredel (h.bredel@52north.org)

Quick Start

Webapp Installation

  • tbd: deployment configuration
  • tbd: build from source
  • tbd: externalize config before build

Configuration

  • general config options
    • Generalizer
    • Prerendering
    • Date formatting
    • Rendering Hints
    • Status Intervals
    • Metadata from a Database

Logging

Depending on which build environment you've chosen open one the WEB-INF/classes/logback-{dev,ci,prod}.xml. Here you can edit log levels and log outputs.

Client development

Refer to the official Series REST API documentation to get a detailed overview on how to access the data provided by the API.

Credits

The development of the 52°North Sensor Web Server Helgoland DAO implementation was supported by several organizations and projects. Among other we would like to thank the following organisations and project

Project/Logo Description
Cos4Cloud - Co-designed citizen observatories for the EOS-Cloud The development of this version of the 52°North Sensor Web Server DAO was supported by the European Union’s Horizon 2020 research project Cos4Cloud (co-funded by the European Commission under the grant agreement n°863463)
BMBFTaMIS - Das Talsperren-Mess-Informations-System The development of this version of the 52°North Sensor Web Server DAO was supported by the German Federal Ministry of Education and Research research project TaMIS (co-funded by the German Federal Ministry of Education and Research, programme Geotechnologien, under grant agreement no. 03G0854[A-D])
JERICO-S3 - Science - Services- Sustainability The development of this version of the 52°North Sensor Web Server DAO was supported by the European Union’s Horizon 2020 research project JERICO-S3 (co-funded by the European Commission under the grant agreement n°871153)
BMBFCOLABIS - Collaborative Early Warning Information Systems for Urban Infrastructures The development of this version of the 52°North Sensor Web Server DAO was supported by the German Federal Ministry of Education and Research research project COLABIS (co-funded by the German Federal Ministry of Education and Research, programme Geotechnologien, under grant agreement no. 03G0852A)
NeXOS - Next generation, Cost-effective, Compact, Multifunctional Web Enabled Ocean Sensor Systems Empowering Marine, Maritime and Fisheries Management The development of this version of the 52°North Sensor Web Server DAO was supported by the European FP7 research project NeXOS (co-funded by the European Commission under the grant agreement n°614102)
FixO3 - Fixed-Point Open Ocean Observatories The development of this version of the 52°North Sensor Web Server DAO was supported by the European FP7 research project FixO3 (co-funded by the European Commission under the grant agreement n°312463)
ODIP II - Ocean Data Interoperability Platform The development of this version of the 52°North Sensor Web Server DAO was supported by the Horizon 2020 research project ODIP II (co-funded by the European Commission under the grant agreement n°654310)
SeaDataCloud The development of this version of the 52°North Sensor Web Server DAO was supported by the Horizon 2020 research project SeaDataCloud (co-funded by the European Commission under the grant agreement n°730960)
Wupperverband The Wupperverband for water, humans and the environment (Germany)
Belgian Interregional Environment Agency (IRCEL - CELINE) The Belgian Interregional Environment Agency (IRCEL - CELINE) is active in the domain of air quality (modelling, forecasts, informing the public on the state of their air quality, e-reporting to the EU under the air quality directives, participating in scientific research on air quality, etc.). IRCEL — CELINE is a permanent cooperation between three regional environment agencies: Agence wallonne de l'Air et du Climat (AWAC), Bruxelles Environnement - Leefmilieu Brussel and Vlaamse Milieumaatschappij (VMM).
GEOWOW - GEOSS interoperability for Weather, Ocean and Water The development of this version of the 52°North Sensor Web Server DAO was supported by the European FP7 research project GEOWOW (co-funded by the European Commission under the grant agreement n°282915)