Programming for DataTurbine

Introduction

A requirement to programming for DataTurbine is a familiarity with programming in java. If you have programmed in other object oriented languages before, Java will be very familiar. If you are new to programming in Java, there are a lot of resources available, a good place to get started is this set of videos on using Java and eclipse (an integrated development environment for Java).

When referring to programming for DataTurbine we can refer to one of two things:

  • Modifying or the DataTurbine base code to fit a particular application
  • Writing an application that runs on top of DataTurbine (the usual case)

Most of the time you will only need to write an application that interfaces with DataTurbine. In this case you do not need the DataTurbine Source Code instead all you need is the rbnb.jar file, when imported as a library it will give you all the tools you will need to create your customized interface.

Modifying the Base Code

Before jumping in to modify the base code make sure that is what you really need for your application. Most applications can be satisfied by writing a source or sink that runs on top of the existing system. DataTurbine is a scalable modular system, and part of its strength is the versatility it provides without having to change its core. This being said it is well documented and open source, so should you wish to modify it to fit your project go to the download page and download the source code.

Writing a Application that Interfaces with DataTurbine

Sometimes when integrate new pieces of architecture into a DataTurbine deployment you will need to write a source or sink that will interface with DataTurbine. This is not a complicated process and does not require reading or modifying the DataTurbine Source Code. Instead all you will is rbnb.jar, it is available from the download page and in either the first time deployment or the full distributions.

When programming make sure that rbnb.jar is on your build path, and import it at the top of your .java files:

import com.rbnb*;

How to start

  1. Writing a Source or Sinks: When writing sources or sinks we highly recommend you look at the Simple Tool classes. They hides away a lot of the difficulties that initially come up when writing a sources and sinks.
  2. Other projects: For other projects or those going beyond the scope of SimpleSource we encourage you to look at the Simple Application Programming Interface (SAPI)
  3. If you get stuck look at the Programming Gotchas and Tips section, it may be of help
  4. If you would like some personal help consider contacting us.

JavaDoc

This interfaces and APIs for DataTurbine are published via a JavaDoc. The document is very thorough, so we recommend you also read the programing guides linked in this section as a way to guide you to useful classes and methods.

The JavaDoc documentation is included in the full OSDT Installation.

Open Source DataTurbine Initiative © 2017 Frontier Theme