Pick a location on your hard drive where you want to work through these examples, and create a new folder, which we’ll refer to from now on as your project directory.

Move into that directory, and create subdirectories called src, lib, tools, and data. The hierarchy of Java source and related resources will be in the src directory. Our build process will compile it into a classes directory it creates, as well as copy any runtime resources there. The data directory is where we’ll put the HSQLDB database.

The lib directory is where we’ll place third-party libraries we use in the project. For now, copy the HSQLDB and Hibernate JAR files into the lib directory: If you haven’t yet done so, expand the hsqldb ZIP file you downloaded. You’ll find hsqldb.jar in its lib directory; copy it to your own project lib directory (the lib directory you just created in your new project directory).

Similarly, locate the lib directory in the Hibernate directory you expanded in the previous section, and copy all of its contents into your own project lib directory (you’ll notice that Hibernate relies on a lot of other libraries; conveniently, they’re included in its binary distribution so you don’t have to hunt them all down yourself.) Then copy Hibernate itself, in the form of the hibernate3.jar file at the top level of the distribution, into your project lib directory.

Installing the Hibernate Tools is a bit more tricky. Although they still support being used from the command line through Ant, as we’ll be doing in these examples, the primary focus of the tools has shifted toward use as a plug-in for the powerful Eclipse development environment. If you haven’t explored Eclipse yet, it’s probably worth your while to do so, but that’s way outside the scope of this PDF. So for now, here’s how to use the tools outside of Eclipse.

Locate the file hibernate-tools.jar inside the Hibernate Tools directory you expanded, and copy it into your own tools directory. It’s probably easiest to let your operating system find the file for you, because it’s nested in a deep path. (Currently, plugins/org.hibernate.eclipse_3.2.0.beta6a/lib/tools, but this will change with each release of the tools.)

Copy the other files contained in the same directory as hibernate-tools.jar into your tools directory. These are used by the Hibernate Tools and currently include freemarker.jar and jtidy-r8-21122004.jar.

Copy the entire hibernate directory that is sitting next to the directory from which you’ve been copying these tools (in other words, given the current plug-in structure, plugins/org.hibernate.eclipse_3.2.0.beta6a/lib/hibernate) into your project tools directory, too. This lets the Tools access their private, custom Hibernate version, which is currently required. Your tools directory should now contain:

% ls tools
freemarker.jar        hibernate-tools.jar
hibernate/            jtidy-r8-21122004.jar

The example classes we’re going to create are all going to live in the com.oreilly.hh (harnessing Hibernate) package, so create these directories under the src directory. On Linux and Mac OS X, you can use:

                   mkdir -p src/com/oreilly/hh
            

from within your project directory to accomplish this in one step.