EntityCreatorプラグイン

translate this page to English.

データベースの実際のテーブルから列定義を読み込み、そのテーブルを表すエンティティ（ValueObject）クラスを生成するプラグインです。
各列のgetter/setterおよびequalsメソッド、cloneメソッド、簡単なDMLを実行するメソッドを生成します。
現在はOracle,PostgreSQL,MySQLに対応しています。

動作環境
インストール（DownLoad）
機能紹介
使用方法
著作権・配布・転載条件
免責事項
連絡先
バージョン履歴

1. 動作環境
   • Eclipse
     • 3.0および3.1での動作を確認しています（2.Xでは動作しません）。
   • Database Server
     • Oracle
       • 8.1.5および8.1.7での動作を確認しています。
     • PostgreSQL
       • 8.0で簡単にテストしました。
     • MySQL
       • 4.1.13で簡単にテストしました。
   • ClientOS
     • Windows2000でしかテストしていません。
       
2. インストール
   
   • asakura.eclipse.plugin.entityCreator.zipをダウンロードしてどこかに解凍し、解凍されたpuginsフォルダをEclipseをインストールしたフォルダにコピーしてください。
   • （重要）[Eclipseをインストールしたフォルダ]\plugins\asakura.eclipse.plugin.entityCreator_X.X.X\lib\の中に、使用するDB用のJDBCドライバ（Oracleならclasses12.jarなど）を配置して下さい。この手順を行わないとプラグインが動きません。
   • Eclipseを（再）起動します。
     
3. 機能紹介
   
   • getter/setterの自動生成
     • 元になるテーブルの項目に対応するprivateなフィールド、及びそのgetter/setterを自動生成します。
       DBの列型に対応するJavaのクラスは基本的にjava.sql.ResultSetMetaData#getColumnClassNameから決定していますが、DBの列が5桁以下の整数値の場合は強制的にintにマッピングできます（後述の「5桁以下の整数値列はint型にマッピングする」をチェックした場合）。
       
       
     • フィールド、getter、setterにコメントを自動で挿入します。
       DBがOracleで テーブルの列にコメント（COMMENT ON COLUMN　・・・）がつけてある場合はそのコメントが、ない場合やDBがOracleでない場合は列名がコメントに反映されます。
       

       	注意	例 （VARCHAR2で列名がID、コメントがユーザーIDだった場合）
       フィールド	Eclipseのコードスタイル設定でフィールドの接頭辞、接尾辞が指定してある場合はそれが反映されます。	private String _ID = null; //ユーザーID
       getter	Eclipseのコードテンプレート設定を反映します。	/** * ユーザーIDを取得します。 * @return ユーザーID */ public String getID() { return nullCase(_ID); }
       setter	Eclipseのコードテンプレート設定を反映します。	/** * ユーザーIDを設定します。 * @param id ユーザーID */ public void setID(String id) { _ID = id; }

       
       
   • equalsメソッドを生成します。
     

     /**
      * equalsメソッド
      
      * 全ての項目の値が同一の場合にtrueを返します。 
      * @return 全ての項目の値が同一の場合にtrue
      */
     public boolean equals(Object obj) {
     	if (!(obj instanceof UserAccount))
     		return false;
     	UserAccount target = (UserAccount) obj;
     	if (!getID().equals(target.getID()))
     		return false;
     	if (!getNAME().equals(target.getNAME()))
     		return false;
     	if (!getAGE().equals(target.getAGE()))
     		return false;
     	if (!getBIRTHDAY().equals(target.getBIRTHDAY()))
     		return false;
     	return true;
     }
     

   • デフォルトコンストラクタ・コピーコンストラクタを生成します。（無条件でデフォルトコンストラクタを作るので、親クラスにデフォルトコンストラクタがない場合はコンパイルエラーになるクラスが生成されます(;´д｀)。）
     

     /**
      * デフォルトコンストラクタ 
      */
     public UserAccount() {
     	super();
     }
     
     /**
      * コピーコンストラクタ 
      * @param original コピー元のオリジナル
      */
     public UserAccount(UserAccount original) {
     	this();
     	setID(original.getID());
     	setNAME(original.getNAME());
     	setAGE(original.getAGE());
     	setBIRTHDAY(original.getBIRTHDAY());
     }
     

   • cloneメソッドを生成します。
     

     /**
      * Cloneメソッド 
      * @return このインスタンスのディープコピー
      */
     protected Object clone() {
     	return new UserAccount(this);
     }
     

   • toStringメソッドを生成します。
     

     /**
      * toStringメソッド
      
      * このインスタンスの全ての項目の値を書き出します。 
      */
     public String toString() {
     	StringBuffer buf = new StringBuffer();
     	buf.append("getID=" + getID() + ":");
     	buf.append("getNAME=" + getNAME() + ":");
     	buf.append("getAGE=" + getAGE() + ":");
     	buf.append("getBIRTHDAY=" + getBIRTHDAY() + ":");
     	return buf.toString();
     }
     

   • DAO系のメソッド（以下）を生成します。
     • setValueFromResultSetメソッド
       ResultSetから値を取得してエンティティにセットするメソッドです。テーブルの列が多い場合このコーディングはウンザリするものだと思うので、他からも使えるようにメソッド化してあります。
       

       /**
        * ResultSetから取得した値をエンティティにセットするUtilメソッドです。
        * SELECT * FROM [TABLE名]の結果のResultSetを引数に渡して下さい。
        *
        * @param rs SELECT * FROM [テーブル名]の結果のResultSet
        * @throws SQLException 何かエラーが発生した場合
        */
       public void setValueFromResultSet(ResultSet rs) throws SQLException {
       	setID(rs.getString("ID"));
       	setNAME(rs.getString("NAME"));
       	setAGE(rs.getBigDecimal("AGE"));
       	setBIRTHDAY(rs.getTimestamp("BIRTHDAY"));
       }
       

     • selectメソッド（テーブルにPKが設定されている場合のみ生成）
       エンティティのPK項目に値をセットしてこのメソッドを実行すると、テーブルから対応する行のデータを取得します。
       

       /**
        * このエンティティのPK項目に設定されている値を条件に、DBからそれ以外の値を取得します。
        *
        * @param conn DB接続 このコネクションはメソッド内でクローズしませんので、
        *             使用する側でクローズや必要であればコミットを行って下さい。
        * @return データが取得できた場合はtrueを返します。
        * @throws SQLException 何かエラーが発生した場合
        */
       public boolean select(Connection conn) throws SQLException {
       	boolean ret = false;
       	PreparedStatement stmt = conn.prepareStatement("SELECT * FROM USER_ACCOUNT WHERE 1=1 AND ID = ? ");
       	stmt.setString(1, getID());
       	ResultSet rs = stmt.executeQuery();
       	if (rs.next()) {
       		setValueFromResultSet(rs);
       		ret = true;
       	}
       	rs.close();
       	stmt.close();
       	return ret;
       }
       

     • insertメソッド
       現在のエンティティの値をテーブルにINSERTします。
       

       /**
        * このエンティティに設定されている値をDBにINSERTします。
        *
        * @param conn DB接続 このコネクションはメソッド内でクローズしませんので、使用する側でクローズや必要であればコミットを行って下さい。
        * @return 追加されたレコード件数
        * @throws SQLException 何かエラーが発生した場合
        */
       public int insert(Connection conn) throws SQLException {
       	PreparedStatement stmt = conn.prepareStatement("INSERT INTO USER_ACCOUNT ("
       	 + "ID,NAME,AGE,BIRTHDAY) VALUES (" + "?,?,?,?)");
       	stmt.setString(1, getID());
       	stmt.setString(2, getNAME());
       	stmt.setBigDecimal(3, getAGE());
       	stmt.setTimestamp(4, getBIRTHDAY());
       	int ret = stmt.executeUpdate();
       	stmt.close();
       	return ret;
       }
       

     • updateメソッド（テーブルにPKが設定されている場合のみ生成）
       現在のエンティティのPK項目の値を条件に、現在のエンティティの値でテーブルの該当行をUPDATEします。
       

       /**
        * このエンティティのPK項目に設定されている値を条件に、このエンティティの値をDBにUPDATEします。
        *
        * @param conn DB接続 このコネクションはメソッド内でクローズしませんので、使用する側でクローズや必要であればコミットを行って下さい。
        * @return 更新されたレコード件数
        * @throws SQLException 何かエラーが発生した場合
        */
       public int update(Connection conn) throws SQLException {
       	PreparedStatement stmt = conn.prepareStatement("UPDATE USER_ACCOUNT SET " + "ID = ?,NAME = ?,AGE = ?,BIRTHDAY = ?"
       	 + " WHERE 1=1 AND ID = ? ");
       	stmt.setString(1, getID());
       	stmt.setString(2, getNAME());
       	stmt.setBigDecimal(3, getAGE());
       	stmt.setTimestamp(4, getBIRTHDAY());
       	stmt.setString(5, getID());
       	int ret = stmt.executeUpdate();
       	stmt.close();
       	return ret;
       }
       

     • deleteメソッド（テーブルにPKが設定されている場合のみ生成）
       現在のエンティティのPK項目の値を条件に、テーブルの該当行をDELETEします。
       

       /**
        * このエンティティのPK項目に設定されている値を条件に、DBからデータをDELETEします。
        *
        * @param conn DB接続 このコネクションはメソッド内でクローズしませんので、使用する側でクローズや必要であればコミットを行って下さい。
        * @return 削除されたレコード件数
        * @throws SQLException 何かエラーが発生した場合
        */
       public int delete(Connection conn) throws SQLException {
       	PreparedStatement stmt = conn.prepareStatement("DELETE FROM USER_ACCOUNT " + "" + "WHERE 1=1 AND ID = ? ");
       	stmt.setString(1, getID());
       	int ret = stmt.executeUpdate();
       	stmt.close();
       	return ret;
       }
       

4. 使用方法
   • Eclipseのメニューから[ファイル]-[新規]-[その他]をクリックして下さい。
     
   • 新規ウィザードを選択する画面が表示されますので、[その他]の中の[エンティティクラス]を選択し、[次へ]をクリックして下さい。
     
     
     
     
   • 新規エンティティクラスの作成画面が表示されます。以下の項目を入力し、[終了]をクリックして下さい。
     
     クラス名など（ソースフォルダー〜インターフェースまで）は新規クラス作成ウィザードと同様です。適当に入力して下さい。
     対象DB・・・今から接続するDBをOracle、PostgreSQL、MySQLより選択して下さい。
     DB URL・・・jdbc:subprotocol:subname 形式のデータベース URL。Oracleの場合なら普通は「jdbc:oracle:thin:@<ServerName>:1521:<SID>」。
     ユーザー名・・・データベースのユーザー名。
     パスワード ・・・上記ユーザーのパスワード。
     テーブル名・・・エンティティクラスの元となるテーブル名。
     5桁以下の整数値列はint型にマッピングする・・・大抵の場合は数値列はBigDecimalにマッピングされてしまうので、桁数が少ないからintでよい場合にチェックして下さい。
     エンティティのgetterがnullを返さないようにする・・・チェックすると、内部値がnullの場合でも、getXXXメソッドがnullを返さないようにします（内部値がnullの場合、Stringの場合は""を、BigDecimalの場合はnew BigDecimal(0)を返すようになります。）
     DAO系メソッドを生成する・・・チェックすると、DAO系のメソッドを生成します。
     
     
     
     
   • 以上でエンティティクラスが生成されます。
     
     ※（ヒント） エンティティに追加のコーディングをする場合は、生成されたクラスは直接編集せずに、そのクラスのサブクラスを作成してそちらをいじった方がメンテナンス性がよいかと思います（テーブル定義が変更された場合に、生成されたクラスに追加のコーディングがしてあると再生成が大変です。）
     
5. 著作権・配布・転載条件
   
   • 本ソフトの著作権は、作者が所有しています。
   • 本ソフトは営利を目的としない再配布は原則として自由です。作者の許可を必要としません。
   • 本ソフトの営利目的を伴う再配布については（雑誌・商品などに添付して再配布する場合）、事前に電子メールで作者までご一報ください。
     
6. 免責事項
   
   • 作者は、本ソフトを使用して生じた障害，損害については一切の責任を負いかねます。
   • 作者は、本ソフトウェアの修正及びバージョンアップの義務を負いかねます。
     
7. 連絡先
   
   • ご意見・ご要望・苦情などはこちらまでお願いします。
     • 掲示板
     • kanoasa＠infoseek.jp（スパム防止の為@を大文字にしています。）
8. バージョン履歴
   • V.0.1.0　2005/07/21
     βバージョンを公開
   • V.0.2.0　2005/07/29
     • 対応DBにMySQL、PostgreSQLを追加
     • エンティティ生成の際、以下のオプションを選択できるようにした。
       • 5桁以下の数値列をintにマッピング
       • getterがnullを返さないように
       • DAO系メソッドの生成
   • V.0.2.1　2005/08/09
     • 対象DBがOracleでテーブル名を小文字で入力した場合、列コメントがエンティティクラスのJavaDocに反映されないバグを修正。
   • V0.2.2　2005/12/01
     • 国際化対応(英語のみ)