634Labs - プログラミング・システム開発のあれこれ

O/Rデータベースマッピングフレームワーク

オブジェクト指向とリレーショナルデータベースを用いてシステムを開発すると、インピーダンス・ミスマッチ(Impedance Mismatch)と呼ばれるギャップが発生する。これはオブジェクト指向とリレーショナルデータベースとの考え方が異なるためである。
O/Rマッピングフレームワークとは、このギャップを軽減するためのフレームワークのことで、O/RのOはオブジェクト、Rはリレーショナルを意味している。

• 各種定義ファイルの相互自動生成。
• 基本的なデータベースアクセスクラスの自動生成。
• 自動生成したクラスの拡張化サポート。
• 多くのデータベースプロダクトに対応。

多くのデータベースプロダクトに対応。

いろいろな種類のデータベースに対応している。

直接対応していないデータベースに対しても、アダプタクラスを作成することで対応することが可能。

各種定義ファイルの相互自動生成。

Torqueでは、XMLファイルやSQL文などを利用した各種処理の自動化を実現している。
強く密接している定義ファイルは、片方のファイルからもう一方のファイルを自動生成できるような開発者の負荷を軽減するような機能がサポートされている。

基本的なデータベースアクセスクラスの自動生成。、自動生成したクラスの拡張化サポート。

Torqueはひとつのテーブルに対して４つのクラスを自動生成する。
それら４つのクラスを分類すると、テーブルの行を表すObject Modelクラスと、SQLがラップされているAssociated SQLクラスとなる。
Object ModelクラスとAssociated SQLクラスは共に、基底クラスとそれを継承するクラスのペアになっている。
基底クラスはテーブルに対する基本的な操作が実装されており、開発者が直接編集することは推奨されていない。
基底クラスの操作を拡張した処理を実現したいときは、継承クラスに処理を記述することになる。

検索

Criteria criteria = new Criteria();
List list = HumanPeer.doSelect(criteria);
System.out.println(list.size());

org.apache.torque.util.Criteriaクラスに様々な条件を設定することで、いろいろなアプローチで問い合わせを実行することができる（後述）

挿入

Human human = new Human();
human.setId("99");
human.setName("xyz");
HumanPeer.doInsert(human);

更新

Human human = new Human();
human.setId("99");
human.setName("wxyz");
HumanPeer.doUpdate(human);

削除

Human human = new Human();
human.setId("99");
HumanPeer.doDelete(human);

処理の基本的な流れ。

Criteria criteria = new Criteria();

criteria.add(条件);

EmpPeer.doSelect(criteria);

比較

where empid = ‘xxx’

criteria.add(EmpPeer.EMPID, (Object)"xxx", Criteria.EQUAL);

where empid <> ‘xxx’

criteria.add(EmpPeer.EMPID, (Object)"xxx", Criteria.NOT_EQUAL);

where empid < 999

criteria.add(EmpPeer.EMPID, (Object)"999", LESS_THAN);

where empid > 999

criteria.add(EmpPeer.EMPID, (Object)"999", GREATER_THAN);

where empid <= 999

criteria.add(EmpPeer.EMPID, (Object)"999", Criteria.LESS_EQUAL);

where empid >= 999

criteria.add(EmpPeer.EMPID, (Object)"999", Criteria.GREATER_EQUAL);

where empid is null

criteria.add(EmPeerp.EMPID, Criteria.ISNULL);

where empid is not null

criteria.add(EmpPeer.EMPID, Criteria.ISNOTNULL);

where empid like ‘%xxx’

criteria.add(EmpPeer.EMPID, (Object)"%xxx", Criteria.LIKE);

where empid in (’0′, ’1′)

criteria.add(EmpPeer.EMPID, (Object)new String[]{"0", "1"}, Criteria.IN);

Criteria.CUSTOMを利用することで、部分的な記述を行うこともできる。

where empid between ’0′ and ’1′

criteria.add(Emp.EMPID, (Object)(EmpPeer.EMPID + " BETWEEN '0' AND '1'"), Criteria.CUSTOM);

結合(Join)

// select emp.*, dept.* 〜
EmpPeer.addSelectColumns(criteria);
DeptPeer.addSelectColumns(criteria);

// where emp.empid = dept.empid
criteria.addJoin(EmpPeer.EMPID, DeptPeer.EMPID);

Torqueは外部結合には未対応。

ソート

昇順：Criteria.addAscendingOrderByColumn()メソッド
降順：Criteria.addDescendingOrderByColumn()メソッド

crit.addAscendingOrderByColumn(EmpPeer.EMPID);
crit.addDescendingOrderByColumn(EmpPeer.EMPID);

最大件数の設定

criteria.setLimit(1000);

distinct

Criteria criteria = new Criteria();
criteria.addSelectColumn(EmpTblPeer.SALARY);
criteria.addSelectColumn(EmpTblPeer.BONUS);
criteria.setDistinct();
List list = BasePeer.doSelect(criteria);
for(int i = 0; i < list.size(); i++){
    Record row = (Record)list.get(i);
    System.out.print(row.getValue(1) + row.getValue(2));
}

全データ

salary  bonus
--------------
100000	100000
100000	100000
100000	200000
300000	600000

実行結果

100000	100000
100000	200000
300000	600000

List uniqueList = EmpPeer.executeQuery("select * from emp");
List joinList = BasePeer.executeQuery("select emp.*, dept.* from emp, dept where emp.id = dept.id");
int result = BasePeer.executeStatement("delete from emp");

単一検索を行う場合、自動生成されたそれぞれのPeerクラスを利用する。結合して検索を行う場合、各PeerクラスのスーパークラスであるBasePeerクラスを利用することもできる。

また、問い合わせにはexecuteQuery()メソッドを利用し、追加・更新・削除にはexecuteStatement()メソッドを利用する。

トランザクションが更新ごとに孤立している例。

EmpPeer.doUpdate(new Emp());
DeptPeer.doInsert(new Dept());

各メソッドが実行される度に、コミットが実行される。

複数の更新がトランザクション管理されている例。

Connection con = Torque.getConnection();
try{
    EmpPeer.doUpdate(new Emp(), con);
    DeptPeer.doInsert(new Dept(), con);
    con.commit();
}catch(TorqueException e){
    con.rollback();
}finally{
    con.close();
}

con.commit()が実行された時点ですべての更新が実行される。

• Apache DB Project – torque
• 日本語訳