OutsideSqlContext (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.outsidesql.OutsideSqlContext

public class OutsideSqlContext
extends Object

The context of outside-SQL.

作成者:: jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected boolean`	`_autoPagingLogging`
`protected CursorHandler`	`_cursorHandler` The handler of cursor select.
`protected DBMetaProvider`	`_dbmetaProvider` The provider of DB meta.
`protected boolean`	`_formatSql`
`protected boolean`	`_internalDebug`
`protected boolean`	`_limitByCursorForcedly`
`protected String`	`_methodName` The command name of outsideSql e.g. outsideSql executor's method.
`protected boolean`	`_nonSpecifiedColumnAccessAllowed`
`protected boolean`	`_offsetByCursorForcedly`
`protected OutsideSqlFilter`	`_outsideSqlFilter`
`protected String`	`_outsideSqlPackage` The package of outside-SQL.
`protected String`	`_outsideSqlPath` The path of outside-SQL.
`protected Object`	`_parameterBean` The instance of specified parameter bean.
`protected boolean`	`_removeBlockComment`
`protected boolean`	`_removeLineComment`
`protected Class<?>`	`_resultType` The data type of outsideSql result, e.g.
`protected StatementConfig`	`_statementConfig` The configuration of statement.
`protected String`	`_tableDbName` The DB name of table for using behavior-SQL-path.

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

コンストラクタ
コンストラクタと説明

OutsideSqlContext(DBMetaProvider dbmetaProvider, String outsideSqlPackage)

コンストラクタ
コンストラクタと説明
`OutsideSqlContext(DBMetaProvider dbmetaProvider, String outsideSqlPackage)`

メソッドのサマリー

All Methods Static Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected String`	`buildBehaviorSqlPackageName()`
`protected String`	`buildDbmsPath(String standardPath, String dbmsSuffix)`
`static void`	`clearOutsideSqlContextOnThread()` Clear the context of outside-SQL on thread.
`protected Reader`	`createInputStreamReader(InputStream ins, String encoding)`
`protected String`	`doReadOutsideSqlWithAliasSuffix(String standardPath, String sqlFileEncoding, String dbmsSuffix)`
`protected String`	`doReadPlainOutsideSql(String sqlFileEncoding, String dbmsSuffix, String standardPath)`
`static String`	`generateSpecifiedOutsideSqlUniqueKey(String methodName, String path, Object pmb, OutsideSqlOption option, Class<?> resultType)`
`CursorHandler`	`getCursorHandler()`
`String`	`getMethodName()`
`static OutsideSqlContext`	`getOutsideSqlContextOnThread()` Get outside-SQL context on thread.
`OutsideSqlFilter`	`getOutsideSqlFilter()`
`String`	`getOutsideSqlPath()`
`Object`	`getParameterBean()`
`Class<?>`	`getResultType()`
`StatementConfig`	`getStatementConfig()`
`String`	`getTableDbName()`
`boolean`	`isAutoPagingLogging()`
`protected boolean`	`isBehaviorQueryPathEnabled()`
`static boolean`	`isExistOutsideSqlContextOnThread()` Is existing the context of outside-SQL on thread?
`protected boolean`	`isExistResource(String path)`
`boolean`	`isFormatSql()`
`boolean`	`isInternalDebug()`
`boolean`	`isLimitByCursorForcedly()`
`boolean`	`isNonSpecifiedColumnAccessAllowed()`
`boolean`	`isOffsetByCursorForcedly()`
`boolean`	`isProcedure()`
`boolean`	`isRemoveBlockComment()`
`boolean`	`isRemoveLineComment()`
`boolean`	`isSpecifiedOutsideSql()`
`protected static String`	`ln()`
`protected String`	`mergeBehaviorSqlPackage(String behaviorType, String outsideSqlPackage)`
`String`	`readFilteredOutsideSql(String sqlFileEncoding, String dbmsSuffix)` Read outside-SQL with filter.
`protected String`	`readPlainOutsideSql(String sqlFileEncoding, String dbmsSuffix)` Read outside-SQL without filter.
`String`	`readText(Reader reader)`
`protected String`	`readText(String path, String sqlFileEncoding)`
`protected String`	`removeInitialUnicodeBomIfNeeds(String sqlFileEncoding, String sql)`
`protected String`	`replaceOutsideSqlBindCharacterOnLineComment(String sql)`
`protected static String`	`replaceString(String text, String fromText, String toText)`
`void`	`setAutoPagingLogging(boolean autoPagingLogging)`
`void`	`setCursorHandler(CursorHandler handler)`
`void`	`setFormatSql(boolean formatSql)`
`void`	`setInternalDebug(boolean internalDebug)`
`void`	`setLimitByCursorForcedly(boolean limitByCursorForcedly)`
`void`	`setMethodName(String methodName)`
`void`	`setNonSpecifiedColumnAccessAllowed(boolean nonSpecifiedColumnAccessAllowed)`
`void`	`setOffsetByCursorForcedly(boolean offsetByCursorForcedly)`
`static void`	`setOutsideSqlContextOnThread(OutsideSqlContext outsideSqlContext)` Set outside-SQL context on thread.
`void`	`setOutsideSqlFilter(OutsideSqlFilter outsideSqlFilter)`
`void`	`setOutsideSqlPath(String outsideSqlPath)`
`void`	`setParameterBean(Object parameterBean)`
`void`	`setRemoveBlockComment(boolean removeBlockComment)`
`void`	`setRemoveLineComment(boolean removeLineComment)`
`void`	`setResultType(Class<?> resultType)`
`void`	`setStatementConfig(StatementConfig statementConfig)`
`void`	`setTableDbName(String tableDbName)`
`void`	`setupBehaviorQueryPathIfNeeds()`
`static void`	`throwOutsideSqlNotFoundException(String path)`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細
- _dbmetaProvider
```
protected final DBMetaProvider _dbmetaProvider
```
  The provider of DB meta. (NotNull)
- _outsideSqlPackage
```
protected final String _outsideSqlPackage
```
  The package of outside-SQL. (NullAllowed: if null, use behavior package path)
- _outsideSqlPath
```
protected String _outsideSqlPath
```
  The path of outside-SQL. (The mark of specified outside-SQL)
- _parameterBean
```
protected Object _parameterBean
```
  The instance of specified parameter bean. (NullAllowed: but almost not-null)
- _resultType
```
protected Class<?> _resultType
```
  The data type of outsideSql result, e.g. Entity, Integer. (basically NotNull)
- _cursorHandler
```
protected CursorHandler _cursorHandler
```
  The handler of cursor select. (NullAllowed: when not cursor)
- _methodName
```
protected String _methodName
```
  The command name of outsideSql e.g. outsideSql executor's method. (basically NotNull)
- _statementConfig
```
protected StatementConfig _statementConfig
```
  The configuration of statement. (NullAllowed)
- _tableDbName
```
protected String _tableDbName
```
  The DB name of table for using behavior-SQL-path. (NullAllowed)
- _offsetByCursorForcedly
```
protected boolean _offsetByCursorForcedly
```
- _limitByCursorForcedly
```
protected boolean _limitByCursorForcedly
```
- _autoPagingLogging
```
protected boolean _autoPagingLogging
```
- _outsideSqlFilter
```
protected OutsideSqlFilter _outsideSqlFilter
```
- _removeBlockComment
```
protected boolean _removeBlockComment
```
- _removeLineComment
```
protected boolean _removeLineComment
```
- _formatSql
```
protected boolean _formatSql
```
- _nonSpecifiedColumnAccessAllowed
```
protected boolean _nonSpecifiedColumnAccessAllowed
```
- _internalDebug
```
protected boolean _internalDebug
```

コンストラクタの詳細
- OutsideSqlContext
```
public OutsideSqlContext(DBMetaProvider dbmetaProvider,
                         String outsideSqlPackage)
```
  パラメータ:
  
  dbmetaProvider - The provider of DB meta. (NotNull)
  
  outsideSqlPackage - The package of outside SQL. (NullAllowed: If null, use behavior package path)

メソッドの詳細

getOutsideSqlContextOnThread
```
public static OutsideSqlContext getOutsideSqlContextOnThread()
```
Get outside-SQL context on thread.

戻り値:

The context of outside-SQL. (NullAllowed)

setOutsideSqlContextOnThread
```
public static void setOutsideSqlContextOnThread(OutsideSqlContext outsideSqlContext)
```
Set outside-SQL context on thread.

パラメータ:

outsideSqlContext - The context of outside-SQL. (NotNull)

isExistOutsideSqlContextOnThread
```
public static boolean isExistOutsideSqlContextOnThread()
```
Is existing the context of outside-SQL on thread?

戻り値:

The determination, true or false.

clearOutsideSqlContextOnThread
```
public static void clearOutsideSqlContextOnThread()
```
Clear the context of outside-SQL on thread.

generateSpecifiedOutsideSqlUniqueKey

public static String generateSpecifiedOutsideSqlUniqueKey(String methodName,
                                                          String path,
                                                          Object pmb,
                                                          OutsideSqlOption option,
                                                          Class<?> resultType)

throwOutsideSqlNotFoundException

public static void throwOutsideSqlNotFoundException(String path)

readFilteredOutsideSql
```
public String readFilteredOutsideSql(String sqlFileEncoding,
                                     String dbmsSuffix)
```
Read outside-SQL with filter. Required attribute is 'outsideSqlPath'.

パラメータ:

sqlFileEncoding - The encoding of SQL file. (NotNull)

dbmsSuffix - The suffix of DBMS. (NotNull)

戻り値:

The filtered outside-SQL. (NotNull)

例外:

OutsideSqlNotFoundException - When the SQL is not found.

replaceOutsideSqlBindCharacterOnLineComment

protected String replaceOutsideSqlBindCharacterOnLineComment(String sql)

readPlainOutsideSql
```
protected String readPlainOutsideSql(String sqlFileEncoding,
                                     String dbmsSuffix)
```
Read outside-SQL without filter. Required attribute is 'outsideSqlPath'.

パラメータ:

sqlFileEncoding - The encoding of SQL file. (NotNull)

dbmsSuffix - The suffix of DBMS. (NotNull)

戻り値:

The text of SQL. (NotNull)

例外:

OutsideSqlNotFoundException - When the SQL is not found.

doReadPlainOutsideSql

protected String doReadPlainOutsideSql(String sqlFileEncoding,
                                       String dbmsSuffix,
                                       String standardPath)

doReadOutsideSqlWithAliasSuffix

protected String doReadOutsideSqlWithAliasSuffix(String standardPath,
                                                 String sqlFileEncoding,
                                                 String dbmsSuffix)

buildDbmsPath

protected String buildDbmsPath(String standardPath,
                               String dbmsSuffix)

removeInitialUnicodeBomIfNeeds

protected String removeInitialUnicodeBomIfNeeds(String sqlFileEncoding,
                                                String sql)

setupBehaviorQueryPathIfNeeds

public void setupBehaviorQueryPathIfNeeds()

buildBehaviorSqlPackageName

protected String buildBehaviorSqlPackageName()

mergeBehaviorSqlPackage

protected String mergeBehaviorSqlPackage(String behaviorType,
                                         String outsideSqlPackage)

isBehaviorQueryPathEnabled

protected boolean isBehaviorQueryPathEnabled()

isSpecifiedOutsideSql

public boolean isSpecifiedOutsideSql()

isProcedure
```
public boolean isProcedure()
```

isExistResource

protected boolean isExistResource(String path)

readText

protected String readText(String path,
                          String sqlFileEncoding)

createInputStreamReader

protected Reader createInputStreamReader(InputStream ins,
                                         String encoding)
                                  throws IOException

例外:: IOException

readText

public String readText(Reader reader)
                throws IOException

例外:: IOException

replaceString

protected static String replaceString(String text,
                                      String fromText,
                                      String toText)

ln
```
protected static String ln()
```

getOutsideSqlPath
```
public String getOutsideSqlPath()
```

setOutsideSqlPath

public void setOutsideSqlPath(String outsideSqlPath)

getParameterBean
```
public Object getParameterBean()
```

setParameterBean

public void setParameterBean(Object parameterBean)

getResultType
```
public Class<?> getResultType()
```

setResultType

public void setResultType(Class<?> resultType)

getCursorHandler

public CursorHandler getCursorHandler()

setCursorHandler

public void setCursorHandler(CursorHandler handler)

getMethodName
```
public String getMethodName()
```

setMethodName

public void setMethodName(String methodName)

getStatementConfig

public StatementConfig getStatementConfig()

setStatementConfig

public void setStatementConfig(StatementConfig statementConfig)

getTableDbName
```
public String getTableDbName()
```

setTableDbName

public void setTableDbName(String tableDbName)

isOffsetByCursorForcedly

public boolean isOffsetByCursorForcedly()

setOffsetByCursorForcedly

public void setOffsetByCursorForcedly(boolean offsetByCursorForcedly)

isLimitByCursorForcedly

public boolean isLimitByCursorForcedly()

setLimitByCursorForcedly

public void setLimitByCursorForcedly(boolean limitByCursorForcedly)

isAutoPagingLogging
```
public boolean isAutoPagingLogging()
```

setAutoPagingLogging

public void setAutoPagingLogging(boolean autoPagingLogging)

getOutsideSqlFilter

public OutsideSqlFilter getOutsideSqlFilter()

setOutsideSqlFilter

public void setOutsideSqlFilter(OutsideSqlFilter outsideSqlFilter)

isRemoveBlockComment
```
public boolean isRemoveBlockComment()
```

setRemoveBlockComment

public void setRemoveBlockComment(boolean removeBlockComment)

isRemoveLineComment
```
public boolean isRemoveLineComment()
```

setRemoveLineComment

public void setRemoveLineComment(boolean removeLineComment)

isFormatSql
```
public boolean isFormatSql()
```

setFormatSql

public void setFormatSql(boolean formatSql)

isNonSpecifiedColumnAccessAllowed

public boolean isNonSpecifiedColumnAccessAllowed()

setNonSpecifiedColumnAccessAllowed

public void setNonSpecifiedColumnAccessAllowed(boolean nonSpecifiedColumnAccessAllowed)

isInternalDebug
```
public boolean isInternalDebug()
```

setInternalDebug

public void setInternalDebug(boolean internalDebug)

クラス OutsideSqlContext

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

_dbmetaProvider

_outsideSqlPackage

_outsideSqlPath

_parameterBean

_resultType

_cursorHandler

_methodName

_statementConfig

_tableDbName

_offsetByCursorForcedly

_limitByCursorForcedly

_autoPagingLogging

_outsideSqlFilter

_removeBlockComment

_removeLineComment

_formatSql

_nonSpecifiedColumnAccessAllowed

_internalDebug

コンストラクタの詳細

OutsideSqlContext

メソッドの詳細

getOutsideSqlContextOnThread

setOutsideSqlContextOnThread

isExistOutsideSqlContextOnThread

clearOutsideSqlContextOnThread

generateSpecifiedOutsideSqlUniqueKey

throwOutsideSqlNotFoundException

readFilteredOutsideSql

replaceOutsideSqlBindCharacterOnLineComment

readPlainOutsideSql

doReadPlainOutsideSql

doReadOutsideSqlWithAliasSuffix

buildDbmsPath

removeInitialUnicodeBomIfNeeds

setupBehaviorQueryPathIfNeeds

buildBehaviorSqlPackageName

mergeBehaviorSqlPackage

isBehaviorQueryPathEnabled

isSpecifiedOutsideSql

isProcedure

isExistResource

readText

createInputStreamReader

readText

replaceString

ln

getOutsideSqlPath

setOutsideSqlPath

getParameterBean

setParameterBean

getResultType

setResultType

getCursorHandler

setCursorHandler

getMethodName

setMethodName

getStatementConfig

setStatementConfig

getTableDbName

setTableDbName

isOffsetByCursorForcedly

setOffsetByCursorForcedly

isLimitByCursorForcedly

setLimitByCursorForcedly

isAutoPagingLogging

setAutoPagingLogging

getOutsideSqlFilter

setOutsideSqlFilter

isRemoveBlockComment

setRemoveBlockComment

isRemoveLineComment

setRemoveLineComment

isFormatSql

setFormatSql