About

ドキュメント

Javadocs

プロジェクト文書

Built by Maven

概要

Doma Toolsは、Domaを使った開発をサーポートするEclipseプラグインです。 Eclipse 3.5 以上、JDK 6 以上の環境で動作します。

Doma Toolsを利用すると、次のことが可能です。

  • Daoのメソッドから対応するSQLファイルへのジャンプ
  • SQLファイルから対応するDaoのメソッドへのジャンプ
  • SQLファイルの変更をトリガーとしたDaoクラスの自動ビルド
  • ウィザードによるSQLファイルの作成

インストール

Doma Toolsは、以下の更新サイトからインストールできます。

プラグインの一般的なインストール方法についてはEclipseプラグインを参照ください。

Domaを利用するには、Doma本体のjarファイルを別途セットアップしてください。

事前条件

以下で述べる「SQLファイル」とは拡張子が「sql」であるファイルを示し、 「スクリプトファイル」とは拡張子が「script」であるファイルを示します。

SQLファイルとスクリプトファイルは、Eclipse内のエディタで開くように設定してください。

使用方法

Daoインタフェースは@Daoが注釈されている場合のみ認識されます。

DaoインタフェースをJavaエディタで開いている場合

メソッドを選択して右クリックし、「Doma」 - 「Jump to SQL File」 と選択するとSQLファイルもしくはスクリプトファイルへジャンプします。 ファイルが存在しない場合は、ファイル作成のダイアログが開きます。

スクリプトファイルへのジャンプは、メソッドに@Scriptが注釈されている場合に限り起こります。 それ以外では、SQLファイルへジャンプします。

DaoインタフェースのメソッドをOutline View等で選択している場合

メソッドを選択して右クリックし、「Doma」 - 「Jump to SQL File」 と選択するとSQLファイルもしくはスクリプトファイルへジャンプします。 ファイルが存在しない場合は、ファイル作成のダイアログが開きます。

スクリプトファイルへのジャンプは、メソッドに@Scriptが注釈されている場合に限り起こります。 それ以外では、SQLファイルへジャンプします。

SQLファイルもしくはスクリプトファイルをテキストエディタで開いている場合

エディタ上で右クリックし、「Doma」 - 「Jump to Dao」 と選択するとDaoインタフェースへジャンプします。 対応するDaoインタフェースがない場合、何もおきません。

SQLファイルもしくはスクリプトファイルを変更すると、対応するDaoクラスがビルドされます。 Daoインタフェースのビルドにより、aptのコード検証が行われます。

SQLファイルもしくはスクリプトファイルをPackage Explorer View等で選択している場合

SQLファイルもしくはスクリプトファイルを右クリックし、「Doma」 - 「Jump to Dao」 と選択するとDaoインタフェースへジャンプします。 対応するDaoインタフェースがない場合、何もおきません。