The purpose of this document is to define simple documentation on getting started with Turbine. For information about the overall structure of Turbine, please refer to the Functional Specification Document (FSD) as well as the other documentation that is available.
The first thing that you should do is download and install the Turbine Developer Kit (TDK). The TDK has everything that you need to get started with Turbine, including the Tomcat Servlet Engine which is preconfigured to run Turbine. The TDK also has sample applications as well as scripts that allow you to quickly build your own application. As time progresses, we will be including more and more helpful information in the TDK. Please see the Turbine Development Kit Howto for more information.
Turbine can be used in three different ways depending on what you need. You can choose to only use one way or choose to use all three. It is up to you.
In all cases, it means that you simply link against the API and code provided in the turbine.jar file. In other words, if you want to only use the Object Relational aspects of Turbine, then you would use Torque to build your Object Relational code and then add the turbine.jar into your classpath. Another example is if you want to use Turbine's connection pool code. All you need to do is tell Turbine where its configuration file is, add turbine.jar to your classpath and then add the appropriate Turbine Java code into your application.
Turbine is now a fairly large codebase. This can be daunting to people who are just starting out with Turbine. However, the code is fairly well organized and as you learn about each part of the code, the entire architecture starts to make sense and is really quite easy to master. All of our code is well javadoc'd so we encourage you to review not only the actual source code, but also the documentation. :-) The different parts of Turbine are:
Turbine can be easily used on its own. In order to do so, all you need to do is something like this before you attempt to make a call to Turbine based code:
TurbineConfig tc = new TurbineConfig("/path","TurbineResources.properties"); tc.init();
What that does is it tells Turbine the path to its configuration file based on the relative path from "/path" (insert your own path). This is held as a static in memory and therefore you only need to do it once. You do not even have to worry about hanging on to the TurbineConfig object. For more information, please see the javadoc for the TurbineConfig object.
To generate the Javadocs for Turbine check out Turbine from CVS, cd to the 'build' directory and execute the javadocs target:
cd jakarta-turbine/build ant javadocs
The javadocs will be generated in the ../docs/apidocs directory.