Sdw:Documentation
From SensorDataLab
Contents |
General Project Information
The SensorDataWeb Stream application consists of three parts: the core project, a web frontend and an application for recording and querying provenance. These three parts are provided as Maven projects to make installation as simple as possible. The project has the following prerequisites:
- Java5 or 6 (depending on the application server used)
- An application server (recommended: Apache Tomcat)
- A postgreSQL or mySQL database
- Apache Maven
Core Application Documentation
Stream is the core application. It contains the query network that processes incoming tuples from stream sources. Every class and method in Stream has been documented using JavaDoc. The Javadoc of Stream can be found in /docs.
- Sdw:Stream - Step by step installation instructions
- Sdw:Stream - Starting the Network and Running Queries
- Sdw:Stream - Stream Sources
- Sdw:Stream - Stream Sinks
Web Frontend Documentation
StreamWeb is a frontend to the core application. Its sole purpose is to allow a user to send queries to the system. The job of the frontend is to translate user input to a HTTP request and send that to one of the servlets of the core application. Of course, it also appropriately handles the servlet responses appropriately.
Tupelo Provenance Service Documentation
The Tupelo OPM service is used by Stream to record provenance information. If a tupelo service has been configured (it is in fact optional), it will send this information upon node (re-)initialization. This information can then be queried again by using the ProvenanceSinks, which are available in the core application. The Tupelo OPM service uses the Tupelo2 library to store new Open Provenance Model metadata (http://tupeloproject.ncsa.uiuc.edu/), hence its name.
- Sdw:TupeloOPM - Step by step installation instructions
- Sdw:TupeloOPM - Recording provenance
- Sdw:TupeloOPM - Querying provenance
Query Language Documentation
PASN-QL queries can consist of one or more commands. There are two types of commands: show-commands and register-commands. Show commands are meant for retrieving data and are extensively explained in the section Sdw:Stream - Stream Sinks. The following pages go into further detail on register-commands, which are for registering new nodes in the query network.
