Create a Data Access Object for Elorus Data using JDBI

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Elorus integrates connectivity to live Elorus data in Java applications. By pairing these technologies, you gain simple, programmatic access to Elorus data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Elorus data.

Create a DAO for the Elorus BillAttachments Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyBillAttachmentsDAO {
  //request specific data from Elorus (String type is used for simplicity)
  @SqlQuery("SELECT Id FROM BillAttachments WHERE BillId = :billId")
  String findIdByBillId(@Bind("billId") String billId);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Elorus

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Elorus.

Start by setting the Profile connection property to the location of the Elorus Profile on disk (e.g. C:\profiles\Elorus.apip). Next, set the ProfileSettings connection property to the connection string for Elorus (see below).

Elorus API Profile Settings

Obtain your API Key from your User Profile in the top-right corner of Elorus. Find your Organization ID under Settings > Organization.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Elorus JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Elorus will typically look like the following:

jdbc:api:Profile=C:\profiles\Elorus.apip;ProfileSettings='APIKey=your_api_key;OrganizationId=your_org_id';

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Elorus.apip;ProfileSettings='APIKey=your_api_key;OrganizationId=your_org_id';");
MyBillAttachmentsDAO dao = dbi.open(MyBillAttachmentsDAO.class);

//do stuff with the DAO

dao.close();

Read Elorus Data

With the connection open to Elorus, simply call the previously defined method to retrieve data from the BillAttachments entity in Elorus.

//disply the result of our 'find' method
String id = dao.findIdByBillId("1");
System.out.println(id);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Elorus by integrating with the CData JDBC Driver for Elorus. Download a free trial and work with live Elorus data in custom Java applications today.