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 */ 016 package org.opengion.hayabusa.db; 017 018 import org.opengion.hayabusa.resource.ResourceManager; 019 import org.opengion.fukurou.util.ErrorMessage; 020 import org.opengion.fukurou.db.Transaction; 021 022 023 /** 024 * スãƒ??トメント文ã‚?execute() ã™ã‚‹äº‹ã«ã‚ˆã‚Š,ãƒ??タベã?スを検索ã—ãŸçµæžœã‚?DBTableModel ã« 025 * 割り当ã¦ã‚‹ã‚¤ãƒ³ã‚¿ãƒ¼ãƒ•ェースã§ã™ã? 026 * 実際ã«ã“ã?インターフェースを継承ã—ãŸã‚¯ãƒ©ã‚¹ã§ã¯ã€ãƒ‡ãƒ¼ã‚¿ãƒ™ã?ス以外㫠027 * フラãƒ?ƒˆãƒ•ァイルやXMLãƒ??ã‚¿ãªã©ã‚’èªã¿è¾¼ã‚“ã§ DBTableModel を作æ?ã•ã›ã‚? 028 * 様ãªå®Ÿè£?‚¯ãƒ©ã‚¹ã‚’作æ?ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã? 029 * 030 * @og.group ãƒ??タ表示 031 * @og.group ãƒ??ã‚¿ç·¨é›? 032 * 033 * @version 4.0 034 * @author Kazuhiko Hasegawa 035 * @since JDK5.0, 036 */ 037 public interface Query { 038 039 /** 040 * Queryã‚ªãƒ–ã‚¸ã‚§ã‚¯ãƒˆã‚’åˆæœŸåŒ–ã—ã¾ã™ã? 041 * ã“れã¯ã€QueryFactory ã®ãƒ—ã?ルã‹ã‚‰å–り出ã™ã¨ãã«(ã¾ãŸã?戻ã™ã¨ã?ã« 042 * åˆæœŸåŒ–ã™ã‚‹ã?ã«ä½¿ç”¨ã—ã¾ã™ã? 043 * 044 */ 045 void init() ; 046 047 /** 048 * スãƒ??トメント文å—å?ã‚’ã‚»ãƒ?ƒˆã—ã¾ã™ã? 049 * 050 * @param statement スãƒ??トメント文å—å? 051 * 052 */ 053 void setStatement( String statement ) ; 054 055 /** 056 * スãƒ??トメント文å—å?ã‚’å–りå?ã—ã¾ã™ã? 057 * 058 * @return スãƒ??トメント文å—å? 059 * 060 */ 061 String getStatement(); 062 063 /** 064 * クエリーを実行ã—ã¾ã™ã? 065 * ã‚»ãƒ?ƒˆã•れã¦ã?‚‹ã‚¹ãƒ??トメント文å—å?ã¨ãã?タイプãŒåˆã£ã¦ã?ªã??åˆã?, 066 * エラーã«ãªã‚Šã¾ã™ã? 067 * å®Ÿè¡Œçµæžœã¯ã€DBTableModel ã«ã‚»ãƒ?ƒˆã•れã¾ã™ã? 068 * 069 */ 070 void execute() ; 071 072 /** 073 * 引数é…å?付ã?クエリーを実行ã—ã¾ã™ã? 074 * 処ç??体ã?, #execute() ã¨åŒæ§˜ã«ã€å„サブクラスã®å®Ÿè£?«ä¾å˜ã—ã¾ã™ã? 075 * ã“れã¯ã€PreparedQuery ã§ä½¿ç”¨ã™ã‚‹å¼•æ•°ã‚’é?列ã§ã‚»ãƒ?ƒˆã™ã‚‹ã‚‚ã?ã§ã™ã? 076 * select * from emp where deptno = ? and job = ? ãªã©ã® PreparedQuery ã‚? 077 * { call xxxx( ?,?,? ) } ãªã©ã® CallableStatement ã® ? 部åˆ??引数ã‚? 078 * é ?•ªã«ã‚»ãƒ?ƒˆã—ã¦ã?ã¾ã™ã? 079 * 080 * @param args オブジェクトã?引数é…å? 081 */ 082 void execute( String[] args ) ; 083 084 /** 085 * 引数é…å?付ã?クエリーを実行ã—ã¾ã™ã? 086 * 処ç??体ã?, #execute() ã¨åŒæ§˜ã«ã€å„サブクラスã®å®Ÿè£?«ä¾å˜ã—ã¾ã™ã? 087 * ã“れã¯ã€PreparedQuery ã§ä½¿ç”¨ã™ã‚‹å¼•æ•°ã‚’é?列ã§ã‚»ãƒ?ƒˆã™ã‚‹ã‚‚ã?ã§ã™ã? 088 * select * from emp where deptno = ? and job = ? ãªã©ã® PreparedQuery ã® 089 * ? 部åˆ??引数ã‚? 090 * é ?•ªã«ã‚»ãƒ?ƒˆã—ã¦ã?ã¾ã™ã? 091 * 092 * @og.rev 4.0.0.0 (2005/01/31) æ–°è¦è¿½åŠ? 093 * 094 * @param keys オブジェクトã?ã‚ーé…å? 095 * @param args オブジェクトã?引数é…å? 096 */ 097 void execute( final String[] keys, final String[] args ) ; 098 099 /** 100 * 引数é…å?付ã?クエリーを実行ã—ã¾ã™ã? 101 * 処ç??体ã?, #execute() ã¨åŒæ§˜ã«ã€å„サブクラスã®å®Ÿè£?«ä¾å˜ã—ã¾ã™ã? 102 * ã“れã¯ã€PreparedQuery ã§ä½¿ç”¨ã™ã‚‹å¼•æ•°ã‚’é?列ã§ã‚»ãƒ?ƒˆã™ã‚‹ã‚‚ã?ã§ã™ã? 103 * select * from emp where deptno = ? and job = ? ãªã©ã® PreparedQuery ã® 104 * ? 部åˆ??引数ã‚? 105 * é ?•ªã«ã‚»ãƒ?ƒˆã—ã¦ã?ã¾ã™ã? 106 * 107 * @og.rev 4.0.0.0 (2005/01/31) 引数をã™ã¹ã¦å—ã‘å–ã£ã¦å®Ÿè¡Œã™ã‚‹ãƒ¡ã‚½ãƒ?ƒ‰ã‚’標準メソãƒ?ƒ‰ã¨ã—ã¦è¿½åŠ? 108 * 109 * @param names カラãƒ?(CSVå½¢å¼? 110 * @param dbArrayType アレイタイプåç§° 111 * @param sysArg DBSysArgé…å? 112 * @param userArg DBUserArgé…å? 113 */ 114 void execute( final String names,final String dbArrayType, 115 final DBSysArg[] sysArg,final DBUserArg[] userArg ) ; 116 117 /** 118 * 引数é…å?付ã?クエリーを実行ã—ã¾ã™ã? 119 * 処ç??体ã?, #execute() ã¨åŒæ§˜ã«ã€å„サブクラスã®å®Ÿè£?«ä¾å˜ã—ã¾ã™ã? 120 * ã“れã¯ã€PreparedQuery ã§ä½¿ç”¨ã™ã‚‹å¼•æ•°ã‚’é?列ã§ã‚»ãƒ?ƒˆã™ã‚‹ã‚‚ã?ã§ã™ã? 121 * select * from emp where deptno = ? and job = ? ãªã©ã® PreparedQuery ã® 122 * [カラãƒ?] 部åˆ??引数をã?DBTableModelã‹ã‚‰é ?•ªã«ã‚»ãƒ?ƒˆã—ã¦ã?ã¾ã™ã? 123 * 124 * @param rowNo é¸æŠžã•れãŸè¡Œç•ªå·é…å?(登録ã™ã‚‹å¯¾è±¡è¡? 125 * @param table DBTableModelオブジェクãƒ?登録ã™ã‚‹å…?ƒ‡ãƒ¼ã‚¿) 126 */ 127 void execute( final int[] rowNo, final DBTableModel table ) ; 128 129 /** 130 * コミットを行ã„ã¾ã™ã? 131 * 132 */ 133 void commit() ; 134 135 /** 136 * ãƒãƒ¼ãƒ«ãƒãƒƒã‚¯ã‚’行ã„ã¾ã™ã? 137 * 138 */ 139 void rollback() ; 140 141 /** 142 * 使用ã—㟠Statementオブジェクトをクãƒãƒ¼ã‚¹ã—ã?Connection オブジェクトを 143 * プã?ルã«è¿”ã—ã¾ã™ã? 144 * 145 */ 146 void close() ; 147 148 /** 149 * Connection オブジェクトを実際ã«ã‚¯ãƒãƒ¼ã‚º(ç ´æ£?ã—ã¾ã™ã? 150 * プã?ルã‹ã‚‰ã‚‚削除ã—ã¾ã™ã? 151 * 実行時エラーç‰ãŒç™ºç”Ÿã—ãŸã¨ãã«ã€ã“ã®ãƒ¡ã‚½ãƒ?ƒ‰ã‚’呼ã³å‡ºã—ã¾ã™ã? 152 * 153 */ 154 void realClose() ; 155 156 /** 157 * クエリーã®å®Ÿè¡Œçµæžœã‚’è¿”ã—ã¾ã™ã? 158 * クエリーãŒå¤±æ•—ã—ãŸå?åˆã‚„,CallableStatement ã®å‘¼ã³å‡ºã—ç‰ã§å®Ÿè¡Œä»¶æ•°ãŒæ?確ã§ãªã? 159 * å ´åˆã?, -1 ãŒè¿”ã•れã¾ã™ã? 160 * 161 * @return クエリーã®å®Ÿè¡Œä»¶æ•° 162 */ 163 int getExecuteCount() ; 164 165 /** 166 * å®Ÿè¡Œçµæžœã® DBTableModel ã‚’è¿”ã—ã¾ã™ã? 167 * 168 * @return DBTableModelオブジェクãƒ? 169 */ 170 DBTableModel getDBTableModel() ; 171 172 /** 173 * ãƒ??タベã?ã‚¹ã®æœ?¤§æ¤œç´¢ä»¶æ•°ã‚’è¿”ã—ã¾ã™ã? 174 * ãƒ??タベã?ス自体ã?検索ã¯,æŒ?®šã•れãŸSQLã®å…¨ä»¶ã‚’検索ã—ã¾ã™ãŒ, 175 * DBTableModelã®ãƒ??ã‚¿ã¨ã—ã¦ç™»éŒ²ã™ã‚‹æœ?¤§ä»¶æ•°ã‚’ã“ã®å€¤ã«è¨å®šã—ã¾ã™ã? 176 * サーãƒã?ã®ãƒ¡ãƒ¢ãƒªè³?ºã¨å¿œç”時間ã?確ä¿ã?為ã§ã™ã? 177 * 178 * @return æœ?¤§æ¤œç´¢ä»¶æ•° 179 */ 180 int getMaxRowCount() ; 181 182 /** 183 * ãƒ??タベã?ã‚¹ã®æœ?¤§æ¤œç´¢ä»¶æ•°ã‚’ã‚»ãƒ?ƒˆã—ã¾ã™ã? 184 * ãƒ??タベã?ス自体ã?検索ã¯,æŒ?®šã•れãŸSQLã®å…¨ä»¶ã‚’検索ã—ã¾ã™ãŒ, 185 * DBTableModelã®ãƒ??ã‚¿ã¨ã—ã¦ç™»éŒ²ã™ã‚‹æœ?¤§ä»¶æ•°ã‚’ã“ã®å€¤ã«è¨å®šã—ã¾ã™ã? 186 * サーãƒã?ã®ãƒ¡ãƒ¢ãƒªè³?ºã¨å¿œç”時間ã?確ä¿ã?為ã§ã™ã? 187 * 188 * @param maxRowCount æœ?¤§æ¤œç´¢ä»¶æ•° 189 */ 190 void setMaxRowCount( int maxRowCount ) ; 191 192 /** 193 * ãƒ??タベã?ã‚¹ã®æ¤œç´¢ã‚¹ã‚ãƒ??ä»¶æ•°ã‚’è¿”ã—ã¾ã™ã? 194 * ãƒ??タベã?ス自体ã?検索ã¯,æŒ?®šã•れãŸSQLã®å…¨ä»¶ã‚’検索ã—ã¾ã™ãŒ, 195 * DBTableModelã®ãƒ??ã‚¿ã¨ã—ã¦ã¯ã€ã‚¹ã‚ãƒ??ä»¶æ•°åˆ??登録ã•れã¾ã›ã‚“ã€? 196 * サーãƒã?ã®ãƒ¡ãƒ¢ãƒªè³?ºã¨å¿œç”時間ã?確ä¿ã?為ã§ã™ã? 197 * 198 * @return æœ?¤§æ¤œç´¢ä»¶æ•° 199 */ 200 int getSkipRowCount(); 201 202 /** 203 * ãƒ??タベã?ã‚¹ã®æ¤œç´¢ã‚¹ã‚ãƒ??ä»¶æ•°ã‚’ã‚»ãƒ?ƒˆã—ã¾ã™ã? 204 * ãƒ??タベã?ス自体ã?検索ã¯,æŒ?®šã•れãŸSQLã®å…¨ä»¶ã‚’検索ã—ã¾ã™ãŒ, 205 * DBTableModelã®ãƒ??ã‚¿ã¨ã—ã¦ã¯ã€ã‚¹ã‚ãƒ??ä»¶æ•°åˆ??登録ã•れã¾ã›ã‚“ã€? 206 * サーãƒã?ã®ãƒ¡ãƒ¢ãƒªè³?ºã¨å¿œç”時間ã?確ä¿ã?為ã§ã™ã? 207 * 208 * @param skipRowCount スã‚ãƒ??ä»¶æ•° 209 */ 210 void setSkipRowCount( int skipRowCount ); 211 212 /** 213 * ãƒ??タベã?ã‚¹ã®æŽ¥ç¶šå?IDã‚’ã‚»ãƒ?ƒˆã—ã¾ã™ã? 214 * シスãƒ?ƒ パラメータ ファイルã«å®šç¾©ã—ã¦ã‚ã‚‹ ãƒ??タベã?スè˜åˆ¥IDã«ã‚ˆã£ã¦ã€? 215 * 接続å?ã‚’å?り替ãˆã¾ã™ã? 216 * ã“ã?接続å?IDã‚’å?ã«,Connection オブジェクトを作æ?ã—ã¾ã™ã? 217 * 218 * @param connectionID 接続å?ID 219 * @og.rev 5.1.9.0 (2010/08/01) å»?¢ 220 */ 221 // void setConnectionID( String connectionID ) ; 222 223 /** 224 * ã‚¢ãƒ??ãƒ??トフラグをå–å¾—ã—ã¾ã™ã? 225 * ã“れã¯ã€Query ã§æ›´æ–°å‡¦ç?? SQL æ–?‚’実行ã—ãŸã¨ãã« true ã«ã‚»ãƒ?ƒˆã•れã¾ã™ã? 226 * 更新処ç?Œå®Ÿè¡Œï¼štrue / 検索処ç??ã¿?šfalse ã‚’å–å¾—ã§ãã¾ã™ã? 227 * 228 * @og.rev 2.1.2.3 (2002/12/02) ãƒ??タベã?ス更新時ã«ã€æ›´æ–°ãƒ•ラグをセãƒ?ƒˆã™ã‚‹ã‚ˆã†ã«å¤‰æ›´ 229 * @og.rev 4.0.0.0 (2007/07/20) メソãƒ?ƒ‰å変更( getUpdateFlag() â‡?isUpdate() ) 230 * 231 * @return ã‚¢ãƒ??ãƒ??トã•れãŸã‹ã©ã?‹( 更新処ç?¼štrue / 検索処ç?¼šfalse ) 232 */ 233 // boolean getUpdateFlag() ; 234 boolean isUpdate() ; 235 236 /** 237 * リソースマãƒãƒ¼ã‚¸ãƒ£ãƒ¼ã‚’ã‚»ãƒ?ƒˆã—ã¾ã™ã? 238 * ã“れã¯ã€è¨?ª?ãƒã‚±ãƒ¼ãƒ«)ã«å¿œã˜ã?DBColumn ã‚’ã‚らã‹ã˜ã‚è¨å®šã—ã¦ãŠã為㫠239 * å¿?¦ã§ã™ã? 240 * リソースマãƒãƒ¼ã‚¸ãƒ£ãƒ¼ãŒè¨å®šã•れã¦ã?ªã??ã¾ãŸã?ã€æ‰€å®šã?ã‚ー㮠DBColumn ã? 241 * リソースã«å˜åœ¨ã—ãªã??åˆã?ã€å?部㧠DBColumn オブジェクトを作æ?ã—ã¾ã™ã? 242 * 243 * @og.rev 4.0.0.0 (2005/01/31) lang â‡?ResourceManager ã¸å¤‰æ›´ 244 * 245 * @param resource リソースマãƒãƒ¼ã‚¸ãƒ£ãƒ¼ 246 */ 247 void setResourceManager( ResourceManager resource ) ; 248 249 /** 250 * アクセスãƒã‚°å–å¾—ã?為,ApplicationInfoオブジェクトをè¨å®šã—ã¾ã™ã? 251 * 252 * @og.rev 3.8.7.0 (2006/12/15) æ–°è¦è¿½åŠ? 253 * @og.rev 5.1.9.0 (2010/08/01) å»?¢ 254 * 255 * @param appInfo ApplicationInfo 256 */ 257 // void setApplicationInfo( ApplicationInfo appInfo ) ; 258 259 /** 260 * エラーコーãƒ?ã‚’å–å¾—ã—ã¾ã™ã? 261 * エラーコーãƒ?ã¯ã€ErrorMessage クラスã§è¦å®šã•れã¦ã?‚‹ã‚³ãƒ¼ãƒ‰ã§ã™ã? 262 * 263 * @return エラーコーãƒ? 264 */ 265 int getErrorCode() ; 266 267 /** 268 * エラーメãƒ?‚»ãƒ¼ã‚¸ã‚ªãƒ–ジェクãƒ?ã‚’å–å¾—ã—ã¾ã™ã? 269 * 270 * @return エラーメãƒ?‚»ãƒ¼ã‚¸ã‚ªãƒ–ジェクãƒ? 271 */ 272 ErrorMessage getErrorMessage() ; 273 274 /** 275 * Transactionオブジェクトを外部ã‹ã‚‰è¨å®šã—ã¾ã™ã? 276 * 277 * 通常ã¯ã€ConnectionFactory を使用ã—ã¦ã€å?部㧠Connection を作æ?ã—ã¾ã™ãŒã€? 278 * ä¸??ã®ãƒˆãƒ©ãƒ³ã‚¶ã‚¯ã‚·ãƒ§ãƒ³å‡¦ç?‚’実施ã™ã‚‹ã«ã¯ã€å¤–部ã‹ã‚‰ Transactionオブジェクトを 279 * を与ãˆã¦ã€ãã“ã‹ã‚‰ã?Connection ã‚’å–りå?ã™å¿?¦ãŒã‚りã¾ã™ã? 280 * 281 * ã“ã“ã§ã¯ã€å?部㮠connection ãŒå˜åœ¨ã—ãªã??åˆã«é™ã‚Šã€ã‚»ãƒ?ƒˆã‚’許å¯ã—ã¾ã™ã? 282 * 283 * @og.rev 5.1.9.0 (2010/08/01) æ–°è¦è¿½åŠ? 284 * 285 * @param connID 接続å?ID 286 * @param tran Transactionオブジェクãƒ? 287 */ 288 void setTransaction( final String connID , final Transaction tran ) ; 289 290 /** 291 * エãƒ?‚£ãƒ?ƒˆè¨å®šã‚ªãƒ–ジェクトをセãƒ?ƒˆã—ã¾ã™ã? 292 * 293 * @og.rev 5.3.6.0 (2011/06/01) æ–°è¦è¿½åŠ? 294 * 295 * @param config エãƒ?‚£ãƒ?ƒˆè¨å®šã‚ªãƒ–ジェクãƒ? 296 */ 297 void setEditConfig( final DBEditConfig config ); 298 }