org.dbflute.outsidesql.executor

クラス OutsideSqlAutoPagingExecutor<BEHAVIOR>

java.lang.Object

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

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

型パラメータ:

BEHAVIOR - The type of behavior.

public class OutsideSqlAutoPagingExecutor<BEHAVIOR>
extends AbstractOutsideSqlPagingExecutor<BEHAVIOR>

The auto-paging (cursor-skip) executor of outside-SQL.

作成者:

jflute

フィールドのサマリー

クラスから継承されたフィールド org.dbflute.outsidesql.executor.AbstractOutsideSqlPagingExecutor

_behaviorCommandInvoker, _currentDBDef, _outsideSqlExecutorFactory, _outsideSqlOption, _tableDbName

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

コンストラクタ

コンストラクタと説明
OutsideSqlAutoPagingExecutor(BehaviorCommandInvoker behaviorCommandInvoker, String tableDbName, DBDef currentDBDef, OutsideSqlOption outsideSqlOption, OutsideSqlExecutorFactory outsideSqlExecutorFactory)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
OutsideSqlAutoPagingExecutor<BEHAVIOR>	configure(StatementConfig statementConfig) Configure statement JDBC options.
OutsideSqlAutoPagingExecutor<BEHAVIOR>	formatSql() Set up format-SQL for this outside-SQL.
OutsideSqlAutoPagingExecutor<BEHAVIOR>	removeBlockComment() Set up remove-block-comment for this outside-SQL.
OutsideSqlAutoPagingExecutor<BEHAVIOR>	removeLineComment() Set up remove-line-comment for this outside-SQL.
<ENTITY> ListResultBean<ENTITY>	selectList(AutoPagingHandlingPmb<BEHAVIOR,ENTITY> pmb) Select list with paging by the outside-SQL.
<ENTITY> PagingResultBean<ENTITY>	selectPage(AutoPagingHandlingPmb<BEHAVIOR,ENTITY> pmb) Select page by the outside-SQL.

クラスから継承されたメソッド org.dbflute.outsidesql.executor.AbstractOutsideSqlPagingExecutor

createBasicExecutor, createBhvExThrower, createCountExecutor, createPagingHandler, createPagingInvoker, doSelectList, doSelectPage, selectList, selectPage, setupScrollableCursorIfNeeds, throwPagingCountSelectNotCountException

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

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

コンストラクタの詳細

OutsideSqlAutoPagingExecutor

public OutsideSqlAutoPagingExecutor(BehaviorCommandInvoker behaviorCommandInvoker,
                                    String tableDbName,
                                    DBDef currentDBDef,
                                    OutsideSqlOption outsideSqlOption,
                                    OutsideSqlExecutorFactory outsideSqlExecutorFactory)

メソッドの詳細

selectPage

public <ENTITY> PagingResultBean<ENTITY> selectPage(AutoPagingHandlingPmb<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().manualPaging().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 SPB!
 -- !!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 auto-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.

selectList

public <ENTITY> ListResultBean<ENTITY> selectList(AutoPagingHandlingPmb<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().manualPaging().selectList(pmb);
 for (SimpleMember member : memberList) {
     ... = member.get...();
 }
 

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

 -- !df:pmb extends SPB!
 -- !!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 auto-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.

removeBlockComment

public OutsideSqlAutoPagingExecutor<BEHAVIOR> removeBlockComment()

Set up remove-block-comment for this outside-SQL.

オーバーライド:

removeBlockComment クラス内 AbstractOutsideSqlPagingExecutor<BEHAVIOR>

戻り値:

this. (NotNull)

removeLineComment

public OutsideSqlAutoPagingExecutor<BEHAVIOR> removeLineComment()

Set up remove-line-comment for this outside-SQL.

オーバーライド:

removeLineComment クラス内 AbstractOutsideSqlPagingExecutor<BEHAVIOR>

戻り値:

this. (NotNull)

formatSql

public OutsideSqlAutoPagingExecutor<BEHAVIOR> formatSql()

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

オーバーライド:

formatSql クラス内 AbstractOutsideSqlPagingExecutor<BEHAVIOR>

戻り値:

this. (NotNull)

configure

public OutsideSqlAutoPagingExecutor<BEHAVIOR> configure(StatementConfig statementConfig)

Configure statement JDBC options. (For example, queryTimeout, fetchSize, ...)

オーバーライド:

configure クラス内 AbstractOutsideSqlPagingExecutor<BEHAVIOR>

パラメータ:

statementConfig - The configuration of statement. (NullAllowed)

戻り値:

this. (NotNull)