Create a Data Access Object for Perigon 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 Perigon integrates connectivity to live Perigon data in Java applications. By pairing these technologies, you gain simple, programmatic access to Perigon data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Perigon data.

Create a DAO for the Perigon Articles 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 MyArticlesDAO {
  //request specific data from Perigon (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Articles WHERE  = :")
  String findBy(@Bind("") String );

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

Open a Connection to Perigon

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

Using API Key Authentication

To use the Perigon API, you need to obtain an API key from your Perigon account. Navigate to the Perigon dashboard and generate an API key from your account settings.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Perigon API key.

Example connection string:

Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

Available Tables

The Perigon profile provides access to the following tables:

• Articles - News articles retrieved from the Perigon news intelligence API
• Headlines - Story clusters grouping related headline articles
• Sources - News sources tracked by the Perigon news intelligence API
• Journalists - Journalist profiles tracked by the Perigon news intelligence API

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Perigon 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 Perigon will typically look like the following:

jdbc:api:Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

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\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"");
MyArticlesDAO dao = dbi.open(MyArticlesDAO.class);

//do stuff with the DAO

dao.close();

Read Perigon Data

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

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

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