001/* 002 * Copyright (c) 2009 The openGion Project. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 013 * either express or implied. See the License for the specific language 014 * governing permissions and limitations under the License. 015 */ 016package org.opengion.hayabusa.db; 017 018import org.opengion.hayabusa.common.HybsSystemException; 019import org.opengion.hayabusa.resource.ResourceManager; 020import org.opengion.fukurou.db.ConnectionFactory; 021import org.opengion.fukurou.db.DBUtil; 022import org.opengion.fukurou.util.ApplicationInfo; 023 024import java.util.Locale ; 025 026import java.sql.DatabaseMetaData ; 027import java.sql.Connection; 028import java.sql.ResultSet; 029import java.sql.SQLException; 030 031/** 032 * 【検索】DatabaseMetaData の情報を検索するタグです。 033 * 034 * データベースに関する包括的な情報を提供する、DatabaseMetaData の内容を 035 * 表示する、タグです。テスト的に使用します。 036 * 037 * @og.formSample 038 * ●形式: 039 * ・<og:databaseMetaData /> 040 * ●body:なし 041 * 042 * ●使用例 043 * <og:databaseMetaData /> 044 * 045 * @og.group テーブル管理 046 * 047 * @version 4.0 048 * @author Kazuhiko Hasegawa 049 * @since JDK5.0, 050 */ 051public class DBMetaData { 052 private String dbid = null ; 053 private ResourceManager resource = null ; 054 private ApplicationInfo appInfo = null; // 3.8.7.0 (2006/12/15) 055 056 /** 057 * DatabaseMetaData を作成する時のDB接続IDを指定します。 058 * 059 * @param id データベース接続ID 060 */ 061 public void setDbid( final String id ) { 062 dbid = id; 063 } 064 065 /** 066 * リソースマネージャーをセットします。 067 * リソースマネージャーが設定されていない、または、所定のキーの DBColumn が 068 * リソースに存在しない場合は、デフォルトの DBColumn オブジェクトを作成します。 069 * 070 * @param resource リソースマネージャー 071 */ 072 public void setResourceManager( final ResourceManager resource ) { 073 this.resource = resource; 074 } 075 076 /** 077 * アクセスログ取得の為,ApplicationInfoオブジェクトを設定します。 078 * 079 * @og.rev 3.8.7.0 (2006/12/15) 新規追加 080 * 081 * @param appInfo アプリ情報オブジェクト 082 */ 083 public void setApplicationInfo( final ApplicationInfo appInfo ) { 084 this.appInfo = appInfo; 085 } 086 087 /** 088 * ResultSet より、DBTableModel を作成して返します。 089 * 090 * @param resultSet ResultSetオブジェクト 091 * 092 * @return 作成された DBTableModelオブジェクト 093 */ 094 private DBTableModel makeDBTableModel( final ResultSet resultSet ) { 095 096 String[][] data = DBUtil.resultToArray( resultSet,true ); // ヘッダー付き配列 097 098 DBTableModel table = DBTableModelUtil.newDBTable() ; 099 100 int numberOfColumns = data[0].length; 101 table.init( numberOfColumns ); 102 103 for(int column = 0; column < numberOfColumns; column++) { 104 String name = data[0][column].toUpperCase(Locale.JAPAN) ; 105 DBColumn clm = resource.makeDBColumn( name ); 106 table.setDBColumn( column,clm ); 107 } 108 109 // データ部の設定 110 for( int row=1; row<data.length; row++ ) { 111 table.addColumnValues( data[row] ); 112 } 113 return table ; 114 } 115 116 /** 117 * このデータベースで使用可能なスキーマ名を取得します。 118 * 結果はスキーマ名で順序付けられます。 119 * スキーマ列は次のようになります。 120 * 121 * ・<b>TABLE_SCHEM</b> String ⇒ スキーマ名 122 * ・<b>TABLE_CATALOG</b> String ⇒ カタログ名 (null の可能性がある) 123 * 124 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 125 * 126 * @return スキーマ名をDBTableModelオブジェクトにラップ 127 * @see java.sql.DatabaseMetaData#getSchemas() 128 */ 129 public DBTableModel getSchemas() { 130 final DBTableModel table ; 131 Connection conn = null ; 132 try { 133 conn = ConnectionFactory.connection( dbid,appInfo ); 134 DatabaseMetaData metaData = conn.getMetaData(); 135 // ====== table 求めの個所のみ、異なります。 136 table = makeDBTableModel( metaData.getSchemas() ); 137 // ====== ここまで 138 } 139 catch ( SQLException ex) { 140 ConnectionFactory.remove( conn,dbid ); 141 conn = null; 142 throw new HybsSystemException( ex ); 143 } 144 finally { 145 ConnectionFactory.close( conn,dbid ); 146// conn = null; 147 } 148 return table ; 149 } 150 151 /** 152 * 指定されたカタログで使用可能なテーブルに関する記述を取得します。 153 * カタログ、スキーマ、テーブル名および型の条件に一致するテーブルの記述だけが返されます。 154 * それらは、TABLE_TYPE、TABLE_SCHEM、TABLE_NAME によって順序付けられます。 155 * 156 * 各テーブルの記述には次の列があります。 157 * 158 * ・<b>TABLE_CAT</b> String ⇒ テーブルカタログ (null の可能性がある) 159 * ・<b>TABLE_SCHEM</b> String ⇒ テーブルスキーマ (null の可能性がある) 160 * ・<b>TABLE_NAME</b> String ⇒ テーブル名 161 * ・<b>TABLE_TYPE</b> String ⇒ テーブルの型。典型的な型は、"TABLE"、"VIEW"、"SYSTEM TABLE"、"GLOBAL TEMPORARY"、"LOCAL TEMPORARY"、"ALIAS"、"SYNONYM" である 162 * ・<b>REMARKS</b> String ⇒ テーブルに関する説明 163 * ・<b>TYPE_CAT</b> String ⇒ の型のカタログ (null の可能性がある) 164 * ・<b>TYPE_SCHEM</b> String ⇒ の型のスキーマ (null の可能性がある) 165 * ・<b>TYPE_NAME</b> String ⇒ の型名 (null の可能性がある) 166 * ・<b>SELF_REFERENCING_COL_NAME</b> String ⇒ 型付きテーブルの指定された「識別子」列の名前 (null の可能性がある) 167 * ・<b>REF_GENERATION</b> String ⇒ SELF_REFERENCING_COL_NAME の値の作成方法を指定する。値は、"SYSTEM"、"USER"、"DERIVED" (null の可能性がある) 168 * 169 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 170 * 171 * @param catalog カタログ名。(カタログ名と一致、"" はカタログなし、null は、カタログ名無条件) 172 * @param schema スキーマ名パターン。(スキーマ名と一致、"" はスキーマなし、null は、スキーマ名無条件) 173 * @param tableName テーブル名パターン。 174 * 175 * @return テーブルに関する記述をDBTableModelオブジェクトにラップ 176 * @see java.sql.DatabaseMetaData#getSchemas() 177 */ 178 public DBTableModel getTables( final String catalog, 179 final String schema, 180 final String tableName ) { 181 final DBTableModel table ; 182 Connection conn = null ; 183 try { 184 conn = ConnectionFactory.connection( dbid,appInfo ); 185 DatabaseMetaData metaData = conn.getMetaData(); 186 // ====== table 求めの個所のみ、異なります。 187 // types String[] 組み込むテーブルの型のリスト。null はすべての型を返す 188 table = makeDBTableModel( metaData.getTables(catalog, schema, tableName, null) ); 189 // ====== ここまで 190 } 191 catch ( SQLException ex) { 192 ConnectionFactory.remove( conn,dbid ); 193 conn = null; 194 throw new HybsSystemException( ex ); 195 } 196 finally { 197 ConnectionFactory.close( conn,dbid ); 198// conn = null; 199 } 200 return table ; 201 } 202 203 /** 204 * 指定されたカタログで使用可能なテーブル列の記述を取得します。 205 * カタログ、スキーマ、テーブル名、および列名の条件に一致する列の 206 * 記述だけが返されます。 207 * それらは、TABLE_SCHEM、TABLE_NAME、ORDINAL_POSITION によって順序付けられます。 208 * 各列の説明を次にします 209 * 210 * ・<b>TABLE_CAT</b> String ⇒ テーブルカタログ (null の可能性がある) 211 * ・<b>TABLE_SCHEM</b> String ⇒ テーブルスキーマ (null の可能性がある) 212 * ・<b>TABLE_NAME</b> String ⇒ テーブル名 213 * ・<b>COLUMN_NAME</b> String ⇒ 列名 214 * ・<b>DATA_TYPE</b> short ⇒ java.sql.Types からの SQL の型 215 * ・<b>TYPE_NAME</b> String ⇒ データソース依存の型名。UDT の場合、型名は完全指定 216 * ・<b>COLUMN_SIZE</b> int ⇒ 列サイズ。char や date の型については最大文字数、numeric や decimal の型については精度 217 * ・<b>BUFFER_LENGTH</b> - 未使用 218 * ・<b>DECIMAL_DIGITS</b> int ⇒ 小数点以下の桁数 219 * ・<b>NUM_PREC_RADIX</b> int ⇒ 基数 (通常は、10 または 2 のどちらか) 220 * ・<b>NULLABLE</b> int ⇒ NULL は許されるか 221 * ・<b>columnNoNulls</b> - NULL 値を許さない可能性がある 222 * ・<b>columnNullable</b> - 必ず NULL 値を許す 223 * ・<b>columnNullableUnknown</b> - NULL 値を許すかどうかは不明 224 * ・<b>REMARKS</b> String ⇒ コメント記述列 (null の可能性がある) 225 * ・<b>COLUMN_DEF</b> String ⇒ デフォルト値 (null の可能性がある) 226 * ・<b>SQL_DATA_TYPE</b> int ⇒ 未使用 227 * ・<b>SQL_DATETIME_SUB</b> int ⇒ 未使用 228 * ・<b>CHAR_OCTET_LENGTH</b> int ⇒ char の型については列の最大バイト数 229 * ・<b>ORDINAL_POSITION</b> int ⇒ テーブル中の列のインデックス (1 から始まる) 230 * ・<b>IS_NULLABLE</b> String ⇒ "NO" は、列は決して NULL 値を許さないことを意味する。"YES" は NULL 値を許す可能性があることを意味する。空の文字列は不明であることを意味する 231 * ・<b>SCOPE_CATLOG</b> String ⇒ 参照属性のスコープであるテーブルのカタログ (DATA_TYPE が REF でない場合は null) 232 * ・<b>SCOPE_SCHEMA</b> String ⇒ 参照属性のスコープであるテーブルのスキーマ (DATA_TYPE が REF でない場合は null) 233 * ・<b>SCOPE_TABLE</b> String ⇒ 参照属性のスコープであるテーブル名 (DATA_TYPE が REF でない場合は null) 234 * ・<b>SOURCE_DATA_TYPE</b> short ⇒ 個別の型またはユーザ生成 Ref 型、java.sql.Types の SQL 型のソースの型 (DATA_TYPE が DISTINCT またはユーザ生成 REF でない場合は null) 235 * 236 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 237 * 238 * @param catalog カタログ名。(カタログ名と一致、"" はカタログなし、null は、カタログ名無条件) 239 * @param schema スキーマ名パターン。(スキーマ名と一致、"" はスキーマなし、null は、スキーマ名無条件) 240 * @param tableName テーブル名パターン。 241 * @param columnName 列名パターン 242 * 243 * @return テーブル列の記述をDBTableModelオブジェクトにラップ 244 * @see java.sql.DatabaseMetaData#getSchemas() 245 */ 246 public DBTableModel getColumns( final String catalog, 247 final String schema, 248 final String tableName, 249 final String columnName ) { 250 final DBTableModel table ; 251 Connection conn = null ; 252 try { 253 conn = ConnectionFactory.connection( dbid,appInfo ); 254 DatabaseMetaData metaData = conn.getMetaData(); 255 // ====== table 求めの個所のみ、異なります。 256 table = makeDBTableModel( metaData.getColumns(catalog, schema, tableName, columnName) ); 257 // ====== ここまで 258 } 259 catch ( SQLException ex) { 260 ConnectionFactory.remove( conn,dbid ); 261 conn = null; 262 throw new HybsSystemException( ex ); 263 } 264 finally { 265 ConnectionFactory.close( conn,dbid ); 266// conn = null; 267 } 268 return table ; 269 } 270 271 /** 272 * 指定されたテーブルのインデックスと統計情報に関する記述を取得します。 273 * それらは、NON_UNIQUE、TYPE、INDEX_NAME、ORDINAL_POSITION によって順序付けされます。 274 * 各インデックス列の記述には次の列があります 275 * 276 * ・<b>TABLE_CAT</b> String ⇒ テーブルカタログ (null の可能性がある) 277 * ・<b>TABLE_SCHEM</b> String ⇒ テーブルスキーマ (null の可能性がある) 278 * ・<b>TABLE_NAME</b> String ⇒ テーブル名 279 * ・<b>NON_UNIQUE</b> boolean ⇒ インデックス値は一意でない値にできるか。TYPE が tableIndexStatistic の場合は false 280 * ・<b>INDEX_QUALIFIER</b> String ⇒ インデックスカタログ (null の可能性がある)。TYPE が tableIndexStatistic の場合は null 281 * ・<b>INDEX_NAME</b> String ⇒ インデックス名。TYPE が tableIndexStatistic の場合は null 282 * ・<b>TYPE</b> short ⇒ インデックスの型 283 * 284 * ・tableIndexStatistic - テーブルのインデックスの記述に連動して返されるテーブルの統計情報を識別する 285 * ・tableIndexClustered - クラスタ化されたインデックス 286 * ・tableIndexHashed - ハッシュ化されたインデックス 287 * ・tableIndexOther - インデックスのその他のスタイル 288 * 289 * ・<b>ORDINAL_POSITION</b> short ⇒ インデックス中の列シーケンス。TYPE が tableIndexStatistic の場合は 0 290 * ・<b>COLUMN_NAME</b> String ⇒ 列名。TYPE が tableIndexStatistic の場合は null 291 * ・<b>ASC_OR_DESC</b> String ⇒ 列ソートシーケンス、"A" ⇒ 昇順、"D" ⇒ 降順、 292 ソートシーケンスがサポートされていない場合は、null の可能性がある。TYPE が tableIndexStatistic の場合は null 293 * ・<b>CARDINALITY</b> int ⇒ TYPE が tableIndexStatistic の場合、テーブル中の列数。そうでない場合は、インデックス中の一意の値の数 294 * ・<b>PAGES</b> int ⇒ TYPE が tableIndexStatistic の場合、テーブルで使用されるページ数。そうでない場合は、現在のインデックスで使用されるページ数 295 * ・<b>FILTER_CONDITION</b> String ⇒ もしあれば、フィルタ条件 (null の可能性がある) 296 * 297 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 298 * 299 * @param catalog カタログ名。(カタログ名と一致、"" はカタログなし、null は、カタログ名無条件) 300 * @param schema スキーマ名パターン。(スキーマ名と一致、"" はスキーマなし、null は、スキーマ名無条件) 301 * @param tableName テーブル名。このデータベースに格納されたテーブル名と一致しなければならない 302 * @param unique true の場合は、一意の値のインデックスだけを返す。false の場合は、一意であるかどうかにかかわらずインデックスを返す 303 * @param approximate true の場合は、結果は概数またはデータ値から外れることもある。false の場合は、正確であることが要求される 304 * 305 * @return インデックスと統計情報に関する記述をDBTableModelオブジェクトにラップ 306 * @see java.sql.DatabaseMetaData#getSchemas() 307 */ 308 public DBTableModel getIndexInfo( final String catalog, 309 final String schema, 310 final String tableName, 311 final boolean unique, 312 final boolean approximate ) { 313 final DBTableModel table ; 314 Connection conn = null ; 315 try { 316 conn = ConnectionFactory.connection( dbid,appInfo ); 317 DatabaseMetaData metaData = conn.getMetaData(); 318 // ====== table 求めの個所のみ、異なります。 319 table = makeDBTableModel( metaData.getIndexInfo(catalog, schema, tableName, unique, approximate) ); 320 // ====== ここまで 321 } 322 catch ( SQLException ex) { 323 ConnectionFactory.remove( conn,dbid ); 324 conn = null; 325 throw new HybsSystemException( ex ); 326 } 327 finally { 328 ConnectionFactory.close( conn,dbid ); 329// conn = null; 330 } 331 return table ; 332 } 333 334 /** 335 * 指定されたカタログで使用可能なストアドプロシージャに関する記述を取得します。 336 * スキーマとプロシージャ名の条件に一致するプロシージャの記述だけが返されます。 337 * それらは、PROCEDURE_SCHEM と PROCEDURE_NAME によって順序付けられます。 338 * 339 * 各プロシージャの記述には次の列があります。 340 * 341 * ・PROCEDURE_CAT String ⇒ プロシージャカタログ (null の可能性がある) 342 * ・PROCEDURE_SCHEM String ⇒ プロシージャスキーマ (null の可能性がある) 343 * ・PROCEDURE_NAME String ⇒ プロシージャ名 344 * ・将来使用するための予約 345 * ・将来使用するための予約 346 * ・将来使用するための予約 347 * ・REMARKS String ⇒ プロシージャの説明文 348 * ・PROCEDURE_TYPE short ⇒ プロシージャの種類 349 * 350 * ・procedureResultUnknown - 結果を返す可能性がある 351 * ・procedureNoResult - 結果を返さない 352 * ・procedureReturnsResult - 結果を返す 353 * 354 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定 355 * 356 * @param catalog カタログ名。(カタログ名と一致、"" はカタログなし、null は、カタログ名無条件) 357 * @param schema スキーマ名パターン。(スキーマ名と一致、"" はスキーマなし、null は、スキーマ名無条件) 358 * @param procName プロシージャ名パターン。データベースに格納されたプロシージャ名と一致しなければならない 359 * 360 * @return ストアドプロシージャに関する記述をDBTableModelオブジェクトにラップ 361 * @see java.sql.DatabaseMetaData#getSchemas() 362 */ 363 public DBTableModel getProcedures( final String catalog, 364 final String schema, 365 final String procName ) { 366 final DBTableModel table ; 367 Connection conn = null ; 368 try { 369 conn = ConnectionFactory.connection( dbid,appInfo ); 370 DatabaseMetaData metaData = conn.getMetaData(); 371 // ====== table 求めの個所のみ、異なります。 372 table = makeDBTableModel( metaData.getProcedures(catalog, schema, procName) ); 373 // ====== ここまで 374 } 375 catch ( SQLException ex) { 376 ConnectionFactory.remove( conn,dbid ); 377 conn = null; 378 throw new HybsSystemException( ex ); 379 } 380 finally { 381 ConnectionFactory.close( conn,dbid ); 382// conn = null; 383 } 384 return table ; 385 } 386}