org.dbflute.outsidesql.executor

クラス OutsideSqlTraditionalExecutor<BEHAVIOR>

java.lang.Object

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

型パラメータ:

BEHAVIOR - The type of behavior.

public class OutsideSqlTraditionalExecutor<BEHAVIOR>
extends Object

The traditional executor of outside-SQL.

導入されたバージョン:

1.1.0 (2014/10/13 Monday)

作成者:

jflute

フィールドのサマリー

フィールド

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

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected BehaviorExceptionThrower	createBhvExThrower()
int	execute(String path, Object pmb) Execute the outsideSql.
Object	selectCursor(String path, Object pmb, CursorHandler handler) Select the cursor of the entity by outside-SQL.
<ENTITY> OptionalEntity<ENTITY>	selectEntity(String path, Object pmb, Class<ENTITY> entityType) Select entity by the outside-SQL.
<ENTITY> ListResultBean<ENTITY>	selectList(String path, Object pmb, Class<ENTITY> entityType) Select the list of the entity by the outsideSql.
<ENTITY> PagingResultBean<ENTITY>	selectPage(String path, PagingBean pmb, Class<ENTITY> entityType) Select page by the outside-SQL.
<ENTITY> ListResultBean<ENTITY>	selectPagedListOnly(String path, PagingBean pmb, Class<ENTITY> entityType) Select list with paging by the outside-SQL.

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

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

フィールドの詳細

_basicExecutor

protected final OutsideSqlBasicExecutor<BEHAVIOR> _basicExecutor

The basic executor. (NotNull)

コンストラクタの詳細

OutsideSqlTraditionalExecutor

public OutsideSqlTraditionalExecutor(OutsideSqlBasicExecutor<BEHAVIOR> basicExecutor)

メソッドの詳細

selectEntity

public <ENTITY> OptionalEntity<ENTITY> selectEntity(String path,
                                                    Object pmb,
                                                    Class<ENTITY> entityType)

Select entity by the outside-SQL. {FreeStyle Interface}
This method can accept each element: path, parameter-bean(Object type), entity-type.

 String path = MemberBhv.PATH_selectSimpleMember;
 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 Class<SimpleMember> entityType = SimpleMember.class;
 SimpleMember member
     = memberBhv.outsideSql().entityHandling().selectEntity(path, pmb, entityType);
 if (member != null) {
     ... = member.get...();
 } else {
     ...
 }
 

型パラメータ:

ENTITY - The type of entity.

パラメータ:

path - The path of SQL file. (NotNull)

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

entityType - The type of entity. (NotNull)

戻り値:

The selected entity. (NullAllowed)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

EntityDuplicatedException - When the entity is duplicated.

selectList

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

Select the list of the entity by the outsideSql. {FreeStyle Interface}
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");
 Class<SimpleMember> entityType = SimpleMember.class;
 ListResultBean<SimpleMember> memberList
     = memberBhv.outsideSql().selectList(path, pmb, entityType);
 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.

パラメータ:

path - The path of SQL file. (NotNull)

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

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

selectPagedListOnly

public <ENTITY> ListResultBean<ENTITY> selectPagedListOnly(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.

selectCursor

public Object selectCursor(String path,
                           Object pmb,
                           CursorHandler handler)

Select the cursor of the entity by outside-SQL. {FreeStyle Interface}
This method can accept each element: path, parameter-bean(Object type), cursor-handler.

 String path = MemberBhv.PATH_selectSimpleMember;
 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberName_PrefixSearch("S");
 memberBhv.outsideSql().cursorHandling()
         .selectCursor(path, 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+
 

パラメータ:

path - The path of SQL file. (NotNull)

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

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(String path,
                   Object pmb)

Execute the outsideSql. (insert, update, delete, etc...) {FreeStyle Interface}
This method can accept each element: path, parameter-bean(Object type).

 String path = MemberBhv.PATH_selectSimpleMember;
 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 int count = memberBhv.outsideSql().execute(path, pmb);
 

パラメータ:

path - The path of SQL file. (NotNull)

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

戻り値:

The count of execution.

例外:

OutsideSqlNotFoundException - When the outsideSql is not found.

createBhvExThrower

protected BehaviorExceptionThrower createBhvExThrower()