Java で Pipedrive のデータ エンティティのオブジェクト リレーショナル マッピング（ORM）を行う

Hibernate を使用して、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングできます。以下のチュートリアルでは、CData JDBC Driver for Pipedrive を使用して Hibernate で Pipedrive リポジトリの ORM を生成する方法を説明します。

本記事では IDE として Eclipse を使用していますが、CData JDBC Driver for Pipedrive は Java ランタイム環境をサポートするあらゆる製品で使用できます。Knowledge Base には、IntelliJ IDEA や NetBeans から Pipedrive のデータ に接続するためのチュートリアルも用意しています。

Hibernate のインストール

以下の手順に従って、Eclipse に Hibernate プラグインをインストールします。

1. Eclipse で、Help -> Install New Software を選択します。
2. Work With ボックスに「http://download.jboss.org/jbosstools/neon/stable/updates/」を入力します。
3. フィルタボックスに「Hibernate」と入力します。
4. Hibernate Tools を選択します。

新規プロジェクトの作成

以下の手順に従って、新しいプロジェクトにドライバー JAR を追加します。

1. 新規プロジェクトを作成します。プロジェクトタイプとして Java Project を選択し、Next をクリックします。プロジェクト名を入力して Finish をクリックします。
2. プロジェクトを右クリックして Properties をクリックします。Java Build Path をクリックし、Libraries タブを開きます。
3. Add External JARs をクリックして、インストールディレクトリの lib サブフォルダにある cdata.jdbc.pipedrive.jar ライブラリを追加します。

Hibernate 設定ファイルの追加

以下の手順に従って、Pipedrive のデータ への接続プロパティを設定します。

1. 新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
2. src を親フォルダとして選択し、Next をクリックします。

3. 以下の値を入力します:

   • Hibernate version:: 5.2
   • Database dialect: Derby
   • Driver class: cdata.jdbc.pipedrive.PipedriveDriver

   • Connection URL: JDBC URL です。jdbc:pipedrive: から始まり、セミコロン区切りの接続プロパティが続きます。

     Pipedrive 接続プロパティの取得・設定方法

     Pipedrive には、接続および認証する2つの方法があります。Basic およびOAuth です。

     Basic 認証

     Basic 認証で認証するには：
     1. API トークンを取得します。
        1. Pipedrive ポータルを開きます。
        2. ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
        3. 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
        4. 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。（これは会社の開発者用サンドボックスのURL です。）
     2. 次の接続プロパティを設定します。
        • APIToken：取得したAPI トークンの値。
        • CompanyDomain：開発者サンドボックスURL のCompanyDomain。
        • AuthScheme：Basic。
     3. 承認されたユーザー名とパスワードでログインします。

     API トークンはPipedrive ポータルに保存されます。これを取得するには、会社名をクリックし、ドロップダウンリストを使用して会社設定 -> Personal Preferences -> API に移動します。

     OAuth 認証

     ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth 認証」セクションを参照してください。

     組み込みの接続文字列デザイナー

     JDBC URL の構築には、Pipedrive JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから jar ファイルを実行してください。

     java -jar cdata.jdbc.pipedrive.jar
     

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     

     一般的な JDBC URL は以下のとおりです:

     jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;

Hibernate から Pipedrive のデータ に接続

以下の手順に従って、前のステップで作成した設定を選択します。

1. Hibernate Configurations パースペクティブに切り替えます: Window -> Open Perspective -> Hibernate。
2. Hibernate Configurations パネルを右クリックし、Add Configuration をクリックします。
3. Hibernate version を 5.2 に設定します。
4. Browse ボタンをクリックし、プロジェクトを選択します。
5. Configuration file フィールドで、Setup -> Use Existing をクリックし、hibernate.cfg.xml ファイルの場所（このデモでは src フォルダ内）を選択します。
6. Classpath タブで、User Entries の下に何もない場合は、Add External JARS をクリックしてドライバー jar を再度追加します。設定が完了したら OK をクリックします。
7. 新しく作成した Hibernate 設定ファイルの Database ノードを展開します。

Pipedrive のデータ のリバースエンジニアリング

以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。

1. Package Explorer に戻ります。
2. プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
3. src を親フォルダとして選択し、Next をクリックします。
4. Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
5. ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。

Hibernate の実行設定

以下の手順に従って、Pipedrive テーブルの POJO（Plain Old Java Object）を生成します。

1. メニューバーから、Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations をクリックします。
2. Console configuration ドロップダウンメニューで、前のセクションで作成した Hibernate 設定ファイルを選択します。Output directory の横にある Browse をクリックし、src を選択します。
3. Reverse Engineer from JDBC Connection チェックボックスを有効にします。Setup ボタンをクリックし、Use Existing をクリックして、hibernate.reveng.xml ファイルの場所（このデモでは src フォルダ内）を選択します。
4. Exporters タブで、Domain code (.java) と Hibernate XML Mappings (hbm.xml) をチェックします。
5. Run をクリックします。

前のステップのリバースエンジニアリング設定に基づいて、1 つ以上の POJO が作成されます。

マッピングタグの挿入

生成した各マッピングに対して、hibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを参照できるようにする必要があります。hibernate.cfg.xml を開き、以下のようにマッピングタグを挿入します:

  
    
      cdata.pipedrive.PipedriveDriver
    
    
      jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;
    
    
      org.hibernate.dialect.SQLServerDialect
    
    
    
    

SQL の実行

前のステップで作成したエンティティを使用して、Pipedrive のデータ のデータの検索と変更が可能になります:

import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
  public static void main(final String[] args) {
    Session session =  new
    Configuration().configure().buildSessionFactory().openSession();
    String SELECT = "FROM Deals D WHERE Value = :Value";
    Query q = session.createQuery(SELECT, Deals.class);
    q.setParameter("Value","50000");
    List<Deals> resultList = (List<Deals>) q.list();

    for(Deals s: resultList){
      System.out.println(s.getPersonName());
      System.out.println(s.getUserEmail());
    }
  }
}