RimuDB Logo
Database Access Framework for Java

Getting Started

To use the framework the developer must first create several artifacts for each table:

  • Table Descriptor document - An XML document containing meta data about the table.
  • Finder class - A java class that provides methods to select records.
  • DO class - A java class that represents a single record.

Each application that uses these artifacts will need the following:

  • A Compound Database Configuration document - An XML document describing the jdbc connection parameters, connection pooling, locking mechanism etc
RimuDB Overview

The RimuDB Database Access Framework includes an editor tool that generates the Table Descriptor document, the Finder class and the DO class. These artifacts can be created by hand if necessary, but the editor makes it much easier.

The editor makes sure the naming conventions of the artifacts are followed. This naming convention is essential for the framework to work. For example if the table name is ORDERHEADER, then the Data Object name OrderHeader might be chosen. This results in the Table Descriptor being named OrderHeader.xml, a Finder class being named OrderHeaderFinder, and a DO class being named OrderHeaderDO. Using the editor tool makes it easier for all three artifacts to be created and named consistently.

The editor can import from a database table. This allows almost all of the information needed to create the TableDescriptor to be generated. Usually just the package name for the class files needs to be set. If suitable column names have been used for the table, then the property names are unlikely to have to be set.

The editor generates the DO and Finder class using the Table Descriptor document.

The Compound Database document is created by hand. Later sections of this documentation have examples and definitions of the format. The document uses an XML schema for validation. The document allows the configuration of multiple databases for an application.