org.dbflute.outsidesql.executor

クラス OutsideSqlCursorExecutor<BEHAVIOR>

java.lang.Object

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

型パラメータ:

BEHAVIOR - The type of behavior.

public class OutsideSqlCursorExecutor<BEHAVIOR>
extends Object

The cursor executor of outside-SQL.

作成者:

jflute

フィールドのサマリー

フィールド

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

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

コンストラクタ

コンストラクタと説明
OutsideSqlCursorExecutor(BehaviorCommandInvoker behaviorCommandInvoker, String tableDbName, DBDef currentDBDef, OutsideSqlOption outsideSqlOption, OutsideSqlContextFactory outsideSqlContextFactory, OutsideSqlFilter outsideSqlFilter, OutsideSqlExecutorFactory outsideSqlExecutorFactory)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
OutsideSqlCursorExecutor<BEHAVIOR>	configure(StatementConfig statementConfig) Configure statement JDBC options.
protected BehaviorCommand<Object>	createSelectCursorCommand(String path, Object pmb, CursorHandler handler)
protected Object	doSelectCursor(String path, Object pmb, CursorHandler handler)
OutsideSqlCursorExecutor<BEHAVIOR>	formatSql() Set up format-SQL for this outside-SQL.
protected <RESULT> RESULT	invoke(BehaviorCommand<RESULT> behaviorCommand) Invoke the command of behavior.
protected OutsideSqlSelectCursorCommand	newOutsideSqlSelectCursorCommand()
OutsideSqlCursorExecutor<BEHAVIOR>	removeBlockComment() Set up remove-block-comment for this outside-SQL.
OutsideSqlCursorExecutor<BEHAVIOR>	removeLineComment() Set up remove-line-comment for this outside-SQL.
<ENTITY> Object	selectCursor(CursorHandlingPmb<BEHAVIOR,ENTITY> pmb, CursorHandler handler) Select the cursor of the entity by outside-SQL.
Object	selectCursor(String path, Object pmb, CursorHandler handler) Select the cursor of the entity by outside-SQL.
protected OutsideSqlSelectCursorCommand	xsetupCommand(OutsideSqlSelectCursorCommand cmd, String path, Object pmb, CursorHandler handler)

クラスから継承されたメソッド 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 DBDef _currentDBDef

The current database definition. (NotNull)

_outsideSqlOption

protected final OutsideSqlOption _outsideSqlOption

The option of outside-SQL. (NotNull)

_outsideSqlContextFactory

protected final OutsideSqlContextFactory _outsideSqlContextFactory

The factory of outside-SQL context. (NotNull)

_outsideSqlFilter

protected final OutsideSqlFilter _outsideSqlFilter

The filter of outside-SQL. (NullAllowed)

_outsideSqlExecutorFactory

protected final OutsideSqlExecutorFactory _outsideSqlExecutorFactory

The factory of outside-SQL executor. (NotNull)

コンストラクタの詳細

OutsideSqlCursorExecutor

public OutsideSqlCursorExecutor(BehaviorCommandInvoker behaviorCommandInvoker,
                                String tableDbName,
                                DBDef currentDBDef,
                                OutsideSqlOption outsideSqlOption,
                                OutsideSqlContextFactory outsideSqlContextFactory,
                                OutsideSqlFilter outsideSqlFilter,
                                OutsideSqlExecutorFactory outsideSqlExecutorFactory)

メソッドの詳細

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().cursorHandling()
         .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.

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.

doSelectCursor

protected Object doSelectCursor(String path,
                                Object pmb,
                                CursorHandler handler)

createSelectCursorCommand

protected BehaviorCommand<Object> createSelectCursorCommand(String path,
                                                            Object pmb,
                                                            CursorHandler handler)

newOutsideSqlSelectCursorCommand

protected OutsideSqlSelectCursorCommand newOutsideSqlSelectCursorCommand()

xsetupCommand

protected OutsideSqlSelectCursorCommand xsetupCommand(OutsideSqlSelectCursorCommand cmd,
                                                      String path,
                                                      Object pmb,
                                                      CursorHandler handler)

invoke

protected <RESULT> RESULT invoke(BehaviorCommand<RESULT> behaviorCommand)

Invoke the command of behavior.

型パラメータ:

RESULT - The type of result.

パラメータ:

behaviorCommand - The command of behavior. (NotNull)

戻り値:

The instance of result. (NullAllowed)

removeBlockComment

public OutsideSqlCursorExecutor<BEHAVIOR> removeBlockComment()

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

戻り値:

this. (NotNull)

removeLineComment

public OutsideSqlCursorExecutor<BEHAVIOR> removeLineComment()

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

戻り値:

this. (NotNull)

formatSql

public OutsideSqlCursorExecutor<BEHAVIOR> formatSql()

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

戻り値:

this. (NotNull)

configure

public OutsideSqlCursorExecutor<BEHAVIOR> configure(StatementConfig statementConfig)

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

パラメータ:

statementConfig - The configuration of statement. (NullAllowed)

戻り値:

this. (NotNull)