org.dbflute.outsidesql.executor

クラス AbstractOutsideSqlPagingExecutor<BEHAVIOR>

java.lang.Object

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

型パラメータ:

BEHAVIOR - The type of behavior.

直系の既知のサブクラス:

OutsideSqlAutoPagingExecutor, OutsideSqlManualPagingExecutor

public abstract class AbstractOutsideSqlPagingExecutor<BEHAVIOR>
extends Object

The paging executor of outside-SQL.

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected BehaviorCommandInvoker	_behaviorCommandInvoker The invoker of behavior command.
protected DBDef	_currentDBDef The current database definition.
protected OutsideSqlExecutorFactory	_outsideSqlExecutorFactory The factory of outside-SQL executor.
protected OutsideSqlOption	_outsideSqlOption The option of outside-SQL.
protected String	_tableDbName The DB name of table.

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
AbstractOutsideSqlPagingExecutor<BEHAVIOR>	configure(StatementConfig statementConfig) Configure statement JDBC options.
protected OutsideSqlBasicExecutor<BEHAVIOR>	createBasicExecutor()
protected BehaviorExceptionThrower	createBhvExThrower()
protected OutsideSqlEntityExecutor<BEHAVIOR>	createCountExecutor()
protected <ENTITY> PagingHandler<ENTITY>	createPagingHandler(String path, PagingBean pmb, Class<ENTITY> entityType)
protected <ENTITY> PagingInvoker<ENTITY>	createPagingInvoker(PagingBean pmb)
protected <ENTITY> ListResultBean<ENTITY>	doSelectList(String path, PagingBean pmb, Class<ENTITY> entityType)
protected <ENTITY> PagingResultBean<ENTITY>	doSelectPage(String path, PagingBean pmb, Class<ENTITY> entityType)
AbstractOutsideSqlPagingExecutor<BEHAVIOR>	formatSql() Set up format-SQL for this outside-SQL.
AbstractOutsideSqlPagingExecutor<BEHAVIOR>	removeBlockComment() Set up remove-block-comment for this outside-SQL.
AbstractOutsideSqlPagingExecutor<BEHAVIOR>	removeLineComment() Set up remove-line-comment for this outside-SQL.
<ENTITY> ListResultBean<ENTITY>	selectList(String path, PagingBean pmb, Class<ENTITY> entityType) Select list with paging by the outside-SQL.
<ENTITY> PagingResultBean<ENTITY>	selectPage(String path, PagingBean pmb, Class<ENTITY> entityType) Select page by the outside-SQL.
protected void	setupScrollableCursorIfNeeds()
protected <ENTITY> void	throwPagingCountSelectNotCountException(String path, PagingBean pmb, Class<ENTITY> entityType, EntityDuplicatedException e)

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

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

フィールドの詳細

_behaviorCommandInvoker

protected final BehaviorCommandInvoker _behaviorCommandInvoker

The invoker of behavior command. (NotNull)

_tableDbName

protected final String _tableDbName

The DB name of table. (NotNull)

_currentDBDef

protected final DBDef _currentDBDef

The current database definition. (NotNull)

_outsideSqlOption

protected final OutsideSqlOption _outsideSqlOption

The option of outside-SQL. (NotNull)

_outsideSqlExecutorFactory

protected final OutsideSqlExecutorFactory _outsideSqlExecutorFactory

The factory of outside-SQL executor. (NotNull)

コンストラクタの詳細

AbstractOutsideSqlPagingExecutor

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

メソッドの詳細

selectPage

public <ENTITY> PagingResultBean<ENTITY> selectPage(String path,
                                                    PagingBean pmb,
                                                    Class<ENTITY> entityType)

Select page by the outside-SQL. {FreeStyle Interface}
(both count-select and paging-select are executed)
This method can accept each element: path, parameter-bean(Object type), entity-type.

 String path = MemberBhv.PATH_selectSimpleMember;
 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberName_PrefixSearch("S");
 pmb.paging(20, 3); // 20 records per a page and current page number is 3
 Class<SimpleMember> entityType = SimpleMember.class;
 PagingResultBean<SimpleMember> page
     = memberBhv.outsideSql().manualPaging().selectPage(path, pmb, entityType);
 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.

パラメータ:

path - The path of SQL that executes count and paging. (NotNull)

pmb - The bean of paging parameter. (NotNull)

entityType - The type of result entity. (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.

doSelectPage

protected <ENTITY> PagingResultBean<ENTITY> doSelectPage(String path,
                                                         PagingBean pmb,
                                                         Class<ENTITY> entityType)

createPagingHandler

protected <ENTITY> PagingHandler<ENTITY> createPagingHandler(String path,
                                                             PagingBean pmb,
                                                             Class<ENTITY> entityType)

createCountExecutor

protected OutsideSqlEntityExecutor<BEHAVIOR> createCountExecutor()

throwPagingCountSelectNotCountException

protected <ENTITY> void throwPagingCountSelectNotCountException(String path,
                                                                PagingBean pmb,
                                                                Class<ENTITY> entityType,
                                                                EntityDuplicatedException e)

createPagingInvoker

protected <ENTITY> PagingInvoker<ENTITY> createPagingInvoker(PagingBean pmb)

setupScrollableCursorIfNeeds

protected void setupScrollableCursorIfNeeds()

selectList

public <ENTITY> ListResultBean<ENTITY> selectList(String path,
                                                  PagingBean pmb,
                                                  Class<ENTITY> entityType)

Select list with paging by the outside-SQL. {FreeStyle Interface}
(count-select is not executed, only paging-select)
This method can accept each element: path, parameter-bean(Object type), entity-type.

 String path = MemberBhv.PATH_selectSimpleMember;
 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberName_PrefixSearch("S");
 pmb.paging(20, 3); // 20 records per a page and current page number is 3
 Class<SimpleMember> entityType = SimpleMember.class;
 ListResultBean<SimpleMember> memberList
     = memberBhv.outsideSql().manualPaging().selectList(path, pmb, entityType);
 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.

パラメータ:

path - The path of SQL that executes count and paging. (NotNull)

pmb - The bean of paging parameter. (NotNull)

entityType - The type of result entity. (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.

doSelectList

protected <ENTITY> ListResultBean<ENTITY> doSelectList(String path,
                                                       PagingBean pmb,
                                                       Class<ENTITY> entityType)

createBasicExecutor

protected OutsideSqlBasicExecutor<BEHAVIOR> createBasicExecutor()

removeBlockComment

public AbstractOutsideSqlPagingExecutor<BEHAVIOR> removeBlockComment()

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

戻り値:

this. (NotNull)

removeLineComment

public AbstractOutsideSqlPagingExecutor<BEHAVIOR> removeLineComment()

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

戻り値:

this. (NotNull)

formatSql

public AbstractOutsideSqlPagingExecutor<BEHAVIOR> formatSql()

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

戻り値:

this. (NotNull)

configure

public AbstractOutsideSqlPagingExecutor<BEHAVIOR> configure(StatementConfig statementConfig)

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

パラメータ:

statementConfig - The configuration of statement. (NullAllowed)

戻り値:

this. (NotNull)

createBhvExThrower

protected BehaviorExceptionThrower createBhvExThrower()