org.dbflute.outsidesql.executor

クラス OutsideSqlAllFacadeExecutor<BEHAVIOR>

java.lang.Object

org.dbflute.outsidesql.executor.OutsideSqlAllFacadeExecutor<BEHAVIOR>

型パラメータ:

BEHAVIOR - The type of behavior.

public class OutsideSqlAllFacadeExecutor<BEHAVIOR>
extends Object

The all facade executor of outside-SQL.

 // main style 
 memberBhv.outideSql().selectEntity(pmb); // OptionalEntity
 memberBhv.outideSql().selectList(pmb); // ListResultBean
 memberBhv.outideSql().selectPage(pmb); // PagingResultBean
 memberBhv.outideSql().selectPagedListOnly(pmb); // ListResultBean
 memberBhv.outideSql().selectCursor(pmb, handler); // (by handler)
 memberBhv.outideSql().execute(pmb); // int (updated count)
 memberBhv.outideSql().call(pmb); // void (pmb has OUT parameters)

 // traditional style 
 memberBhv.outideSql().traditionalStyle().selectEntity(path, pmb, entityType);
 memberBhv.outideSql().traditionalStyle().selectList(path, pmb, entityType);
 memberBhv.outideSql().traditionalStyle().selectPage(path, pmb, entityType);
 memberBhv.outideSql().traditionalStyle().selectPagedListOnly(path, pmb, entityType);
 memberBhv.outideSql().traditionalStyle().selectCursor(path, pmb, handler);
 memberBhv.outideSql().traditionalStyle().execute(path, pmb);

 // options 
 memberBhv.outideSql().removeBlockComment().selectList()
 memberBhv.outideSql().removeLineComment().selectList()
 memberBhv.outideSql().formatSql().selectList()
 

導入されたバージョン:

1.1.0 (2014/10/13)

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected OutsideSqlBasicExecutor<BEHAVIOR>	_basicExecutor The basic executor of outside-SQL.

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
OutsideSqlAllFacadeExecutor(OutsideSqlBasicExecutor<BEHAVIOR> basicExecutor)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	assertStatementConfigNotDuplicated(StatementConfigCall<StatementConfig> configCall)
void	call(ProcedurePmb pmb) Call the procedure.
OutsideSqlAllFacadeExecutor<BEHAVIOR>	configure(StatementConfigCall<StatementConfig> confLambda) Configure statement JDBC options. e.g. queryTimeout, fetchSize, ...
protected BehaviorExceptionThrower	createBhvExThrower()
protected StatementConfig	createStatementConfig(StatementConfigCall<StatementConfig> configCall)
int	execute(ExecuteHandlingPmb<BEHAVIOR> pmb) Execute the outsideSql.
OutsideSqlAllFacadeExecutor<BEHAVIOR>	formatSql() Set up format-SQL for this outsideSql.
protected StatementConfig	newStatementConfig()
OutsideSqlAllFacadeExecutor<BEHAVIOR>	removeBlockComment() Set up remove-block-comment for this outsideSql.
OutsideSqlAllFacadeExecutor<BEHAVIOR>	removeLineComment() Set up remove-line-comment for this outsideSql.
<ENTITY> Object	selectCursor(CursorHandlingPmb<BEHAVIOR,ENTITY> pmb, CursorHandler handler) Select the cursor of the entity by outside-SQL.
<ENTITY> OptionalEntity<ENTITY>	selectEntity(EntityHandlingPmb<BEHAVIOR,ENTITY> pmb) Select entity by the outside-SQL.
<ENTITY> ListResultBean<ENTITY>	selectList(ListHandlingPmb<BEHAVIOR,ENTITY> pmb) Select the list of the entity by the outsideSql.
<ENTITY> PagingResultBean<ENTITY>	selectPage(PagingHandlingPmb<BEHAVIOR,ENTITY> pmb) Select page by the outside-SQL.
<ENTITY> ListResultBean<ENTITY>	selectPagedListOnly(PagingHandlingPmb<BEHAVIOR,ENTITY> pmb) Select list with paging by the outside-SQL.
OutsideSqlTraditionalExecutor<BEHAVIOR>	traditionalStyle()
OutsideSqlBasicExecutor<BEHAVIOR>	xbasicExecutor()

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

_basicExecutor

protected final OutsideSqlBasicExecutor<BEHAVIOR> _basicExecutor

The basic executor of outside-SQL. (NotNull)

コンストラクタの詳細

OutsideSqlAllFacadeExecutor

public OutsideSqlAllFacadeExecutor(OutsideSqlBasicExecutor<BEHAVIOR> basicExecutor)

メソッドの詳細

selectEntity

public <ENTITY> OptionalEntity<ENTITY> selectEntity(EntityHandlingPmb<BEHAVIOR,ENTITY> pmb)

Select entity by the outside-SQL. {Typed Interface}
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path and entity-type.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 SimpleMember member
     = memberBhv.outsideSql().selectEntity(pmb);
 if (member != null) {
     ... = member.get...();
 } else {
     ...
 }
 

型パラメータ:

ENTITY - The type of entity.

パラメータ:

pmb - The typed parameter-bean for entity handling. (NotNull)

戻り値:

The optional entity selected by the outside-SQL. (NotNull: if no data, returns empty entity)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

EntityDuplicatedException - When the entity is duplicated.

selectList

public <ENTITY> ListResultBean<ENTITY> selectList(ListHandlingPmb<BEHAVIOR,ENTITY> pmb)

Select the list of the entity by the outsideSql. {Typed Interface}
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path and entity-type.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberName_PrefixSearch("S");
 ListResultBean<SimpleMember> memberList
     = memberBhv.outsideSql().selectList(pmb);
 for (SimpleMember member : memberList) {
     ... = member.get...();
 }
 

It needs to use customize-entity and parameter-bean. The way to generate them is following:

 -- #df:entity#
 -- !df:pmb!
 -- !!Integer memberId!!
 -- !!String memberName!!
 -- !!...!!
 

型パラメータ:

ENTITY - The type of entity for element.

パラメータ:

pmb - The typed parameter-bean for list handling. (NotNull)

戻り値:

The result bean of selected list. (NotNull)

例外:

OutsideSqlNotFoundException - When the outsideSql is not found.

DangerousResultSizeException - When the result size is over the specified safety size.

selectPage

public <ENTITY> PagingResultBean<ENTITY> selectPage(PagingHandlingPmb<BEHAVIOR,ENTITY> pmb)

Select page by the outside-SQL. {Typed Interface}
(both count-select and paging-select are executed)
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path and entity-type.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberName_PrefixSearch("S");
 pmb.paging(20, 3); // 20 records per a page and current page number is 3
 PagingResultBean<SimpleMember> page
     = memberBhv.outsideSql().selectPage(pmb);
 int allRecordCount = page.getAllRecordCount();
 int allPageCount = page.getAllPageCount();
 boolean isExistPrePage = page.isExistPrePage();
 boolean isExistNextPage = page.isExistNextPage();
 ...
 for (SimpleMember member : page) {
     ... = member.get...();
 }
 

The parameter-bean needs to extend SimplePagingBean. The way to generate it is following:

 -- !df:pmb extends Paging!
 -- !!Integer memberId!!
 -- !!...!!
 

You can realize by pagingBean's isPaging() method on your 'Parameter Comment'. It returns false when it executes Count. And it returns true when it executes Paging.

 e.g. ManualPaging and MySQL
 /*IF pmb.isPaging()*/
 select member.MEMBER_ID
      , member.MEMBER_NAME
      , memberStatus.MEMBER_STATUS_NAME
 -- ELSE select count(*)
 /*END*/
   from MEMBER member
     /*IF pmb.isPaging()*/
     left outer join MEMBER_STATUS memberStatus
       on member.MEMBER_STATUS_CODE = memberStatus.MEMBER_STATUS_CODE
     /*END*/
  /*BEGIN*/
  where
    /*IF pmb.memberId != null*/
    member.MEMBER_ID = /*pmb.memberId*/'123'
    /*END*/
    /*IF pmb.memberName != null*/
    and member.MEMBER_NAME like /*pmb.memberName*/'Billy%'
    /*END*/
  /*END*/
  /*IF pmb.isPaging()*/
  order by member.UPDATE_DATETIME desc
  /*END*/
  /*IF pmb.isPaging()*/
  limit /*pmb.pageStartIndex*/80, /*pmb.fetchSize*/20
  /*END*/
 

型パラメータ:

ENTITY - The type of entity.

パラメータ:

pmb - The typed parameter-bean for paging handling. (NotNull)

戻り値:

The result bean of paging. (NotNull)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

DangerousResultSizeException - When the result size is over the specified safety size.

selectPagedListOnly

public <ENTITY> ListResultBean<ENTITY> selectPagedListOnly(PagingHandlingPmb<BEHAVIOR,ENTITY> pmb)

Select list with paging by the outside-SQL. {Typed Interface}
(count-select is not executed, only paging-select)
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path and entity-type.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberName_PrefixSearch("S");
 pmb.paging(20, 3); // 20 records per a page and current page number is 3
 ListResultBean<SimpleMember> memberList
     = memberBhv.outsideSql().selectPagedListOnly(pmb);
 for (SimpleMember member : memberList) {
     ... = member.get...();
 }
 

The parameter-bean needs to extend SimplePagingBean. The way to generate it is following:

 -- !df:pmb extends Paging!
 -- !!Integer memberId!!
 -- !!...!!
 

You don't need to use pagingBean's isPaging() method on your 'Parameter Comment'.

 e.g. ManualPaging and MySQL 
 select member.MEMBER_ID
      , member.MEMBER_NAME
      , memberStatus.MEMBER_STATUS_NAME
   from MEMBER member
     left outer join MEMBER_STATUS memberStatus
       on member.MEMBER_STATUS_CODE = memberStatus.MEMBER_STATUS_CODE
  /*BEGIN*/
  where
    /*IF pmb.memberId != null*/
    member.MEMBER_ID = /*pmb.memberId*/'123'
    /*END*/
    /*IF pmb.memberName != null*/
    and member.MEMBER_NAME like /*pmb.memberName*/'Billy%'
    /*END*/
  /*END*/
  order by member.UPDATE_DATETIME desc
  limit /*pmb.pageStartIndex*/80, /*pmb.fetchSize*/20
 

型パラメータ:

ENTITY - The type of entity.

パラメータ:

pmb - The typed parameter-bean for paging handling. (NotNull)

戻り値:

The result bean of paged list. (NotNull)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

DangerousResultSizeException - When the result size is over the specified safety size.

selectCursor

public <ENTITY> Object selectCursor(CursorHandlingPmb<BEHAVIOR,ENTITY> pmb,
                                    CursorHandler handler)

Select the cursor of the entity by outside-SQL. {Typed Interface}
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberName_PrefixSearch("S");
 memberBhv.outsideSql().selectCursor(pmb, new PurchaseSummaryMemberCursorHandler() {
     protected Object fetchCursor(PurchaseSummaryMemberCursor cursor) throws SQLException {
         while (cursor.next()) {
             Integer memberId = cursor.getMemberId();
             String memberName = cursor.getMemberName();
             ...
         }
         return null;
     }
 });
 

It needs to use type-safe-cursor instead of customize-entity. The way to generate it is following:

 -- #df:entity#
 -- +cursor+
 

型パラメータ:

ENTITY - The type of entity, might be void.

パラメータ:

pmb - The typed parameter-bean for cursor handling. (NotNull)

handler - The handler of cursor called back with result set. (NotNull)

戻り値:

The result object that the cursor handler returns. (NullAllowed)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

execute

public int execute(ExecuteHandlingPmb<BEHAVIOR> pmb)

Execute the outsideSql. (insert, update, delete, etc...) {Typed Interface}
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 int count = memberBhv.outsideSql().execute(pmb);
 

パラメータ:

pmb - The parameter-bean. Allowed types are Bean object and Map object. (NullAllowed)

戻り値:

The count of execution.

例外:

OutsideSqlNotFoundException - When the outsideSql is not found.

call

public void call(ProcedurePmb pmb)

Call the procedure.

 SpInOutParameterPmb pmb = new SpInOutParameterPmb();
 pmb.setVInVarchar("foo");
 pmb.setVInOutVarchar("bar");
 memberBhv.outsideSql().call(pmb);
 String outVar = pmb.getVOutVarchar();
 

It needs to use parameter-bean for procedure (ProcedurePmb). The way to generate is to set the option of DBFlute property and execute Sql2Entity.

パラメータ:

pmb - The parameter-bean for procedure. (NotNull)

traditionalStyle

public OutsideSqlTraditionalExecutor<BEHAVIOR> traditionalStyle()

removeBlockComment

public OutsideSqlAllFacadeExecutor<BEHAVIOR> removeBlockComment()

Set up remove-block-comment for this outsideSql.

戻り値:

this. (NotNull)

removeLineComment

public OutsideSqlAllFacadeExecutor<BEHAVIOR> removeLineComment()

Set up remove-line-comment for this outsideSql.

戻り値:

this. (NotNull)

formatSql

public OutsideSqlAllFacadeExecutor<BEHAVIOR> formatSql()

Set up format-SQL for this outsideSql.
(For example, empty lines removed)

戻り値:

this. (NotNull)

configure

public OutsideSqlAllFacadeExecutor<BEHAVIOR> configure(StatementConfigCall<StatementConfig> confLambda)

Configure statement JDBC options. e.g. queryTimeout, fetchSize, ... (only one-time call)

 memberBhv.outsideSql().configure(conf -> conf.queryTimeout(3)).selectList(...);
 

パラメータ:

confLambda - The callback for configuration of statement. (NotNull)

戻り値:

this. (NotNull)

assertStatementConfigNotDuplicated

protected void assertStatementConfigNotDuplicated(StatementConfigCall<StatementConfig> configCall)

createStatementConfig

protected StatementConfig createStatementConfig(StatementConfigCall<StatementConfig> configCall)

newStatementConfig

protected StatementConfig newStatementConfig()

createBhvExThrower

protected BehaviorExceptionThrower createBhvExThrower()

xbasicExecutor

public OutsideSqlBasicExecutor<BEHAVIOR> xbasicExecutor()