ea2ddl-gen/dbflute/templates/om/java/allcommon/cbean/outsidesql/executor/OutsideSqlCursorExecutor.vm

   1 ${database.allClassCopyright}package ${glPackageBaseCommonCBeanOutsidesqlExecutor};\r
   2 \r
   3 import ${glPackageBaseCommonJdbc}.${glCursorHandlerName};\r
   4 import ${glPackageBaseCommonCBeanOutsidesql}.${glOutsideSqlDaoName};\r
   5 import ${glPackageBaseCommonCBeanOutsidesql}.${glOutsideSqlOptionName};\r
   6 import ${glPackageBaseCommonJdbc}.${glStatementConfig};\r
   7 \r
   8 /**\r
   9  * The cursor executor of outside-sql.\r
  10  * @param <PARAMETER_BEAN> The type of parameter-bean.\r
  11  * @author ${database.ClassAuthor}\r
  12  */\r
  13 public class ${glOutsideSqlCursorExecutorName}<PARAMETER_BEAN> {\r
  14 \r
  15     // ===================================================================================\r
  16     //                                                                           Attribute\r
  17     //                                                                           =========\r
  18     protected final ${glOutsideSqlDaoName} _outsideSqlDao;\r
  19 \r
  20     protected final ${glOutsideSqlOptionName} _outsideSqlOption;\r
  21 \r
  22     // ===================================================================================\r
  23     //                                                                         Constructor\r
  24     //                                                                         ===========\r
  25     public ${glOutsideSqlCursorExecutorName}(${glOutsideSqlDaoName} outsideSqlDao, ${glOutsideSqlOptionName} outsideSqlOption) {\r
  26         this._outsideSqlDao = outsideSqlDao;\r
  27         this._outsideSqlOption = outsideSqlOption;\r
  28     }\r
  29 \r
  30     // ===================================================================================\r
  31     //                                                                              Select\r
  32     //                                                                              ======\r
  33     /**\r
  34      * Select the cursor of the entity.\r
  35      * @param path The path of SQL file. (NotNull)\r
  36      * @param pmb The parameter-bean. Allowed types are Bean object and Map object. (Nullable)\r
  37      * @param handler The handler of cursor. (NotNull)\r
  38      * @return The result object that the cursor handler returns. (Nullable)\r
  39      * @exception ${glPackageBaseCommonException}.${glOutsideSqlNotFoundException} When the outside-sql is not found.\r
  40      */\r
  41     public Object selectCursor(String path, PARAMETER_BEAN pmb, ${glCursorHandlerName} handler) {\r
  42         return _outsideSqlDao.selectCursor(path, pmb, _outsideSqlOption, handler);\r
  43     }\r
  44 \r
  45     // ===================================================================================\r
  46     //                                                                              Option\r
  47     //                                                                              ======\r
  48     public ${glOutsideSqlCursorExecutorName}<PARAMETER_BEAN> dynamicBinding() {\r
  49         _outsideSqlOption.dynamicBinding();\r
  50         return this;\r
  51     }\r
  52 \r
  53     public ${glOutsideSqlCursorExecutorName}<PARAMETER_BEAN> configure(${glStatementConfig} statementConfig) {\r
  54                 _outsideSqlOption.setStatementConfig(statementConfig);\r
  55         return this;\r
  56     }\r
  57 }\r