SqlClause (DBFlute Runtime 1.1.0-sp2-RC1 API)

既知の実装クラスのリスト:

AbstractSqlClause, SqlClauseDb2, SqlClauseDefault, SqlClauseDerby, SqlClauseFirebird, SqlClauseH2, SqlClauseMsAccess, SqlClauseMySql, SqlClauseOracle, SqlClausePostgreSql, SqlClauseSqlite, SqlClauseSqlServer, SqlClauseSybase
```
public interface SqlClause
```
The interface of SQL clause.

And this also has a role of a container for common info between the top level condition-bean and related condition-queries.

It has many histories... e.g. structures, method names, it might be hard to read but no big refactoring because the histories and memories are also documents.

作成者:

jflute

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	インタフェースと説明
`static interface`	`SqlClause.QueryUpdateSetCalculationHandler` The handler of calculation on set clause of query-update.

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`BASE_POINT_ALIAS_NAME` The alias name of base point table for on-query.
`static String`	`BASE_POINT_HANDLING_ENTITY_NO` The entity number of base point table for internal handling.
`static String`	`RELATION_PATH_DELIMITER` The delimiter of relation path.

メソッドのサマリー

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`void`	`acceptScalarSelectOption(ScalarSelectOption option)` Accept the option of scalar-select.
`void`	`addManualOrderToPreviousOrderByElement(ManualOrderOption manualOrderOption)`
`void`	`addNullsFirstToPreviousOrderBy()`
`void`	`addNullsLastToPreviousOrderBy()`
`void`	`addWhereClauseSimpleFilter(QueryClauseFilter whereClauseSimpleFilter)`
`void`	`adjustLikeSearchDBWay(LikeSearchOption option)` Adjust like-search of DB way.
`void`	`backupSpecifiedSelectColumn()` Back up specified select columns.
`void`	`backupWhereClauseOnBaseQuery()` Back up where clause on base query.
`void`	`beginOrScopeQuery()` Begin or-scope query.
`void`	`beginOrScopeQueryAndPart()` Begin or-scope query to and-part.
`boolean`	`canPagingCountLeastJoin()` Can it be paging count least join?
`boolean`	`canUseRelationCache(String relationPath)` Can it use the relation cache for entity mapping?
`void`	`changeAliasNameLimitSize(int aliasNameLimitSize)` Change limit size of alias name.
`void`	`changeToInnerJoin(String foreignAliasName)` Change the join type for the relation to inner join manually.
`void`	`checkNullOrEmptyQuery()` Check null-or-empty query.
`void`	`classifySelectClauseType(SelectClauseType selectClauseType)` Classify the type of select clause into specified type.
`void`	`clearBaseTableInlineWhereClause()`
`void`	`clearOrderBy()` Clear order-by information in this clause.
`void`	`clearOuterJoinInlineWhereClause()`
`void`	`clearSpecifiedDerivingSubQuery()` Clear specified deriving sub-query.
`void`	`clearSpecifiedSelectColumn()` Clear specified select columns.
`void`	`clearUnionQuery()`
`void`	`clearWhereClauseOnBaseQuery()` Clear where clauses on the base query.
`DBWay`	`dbway()` Get the DB way for this SQL clause.
`void`	`disableColumnNullObject()` Disable the handling of column null object.
`void`	`disableColumnNullObjectGearedToSpecify()` Disable the handling of column null object geared to specify.
`void`	`disableEmptyStringQuery()` Disable empty string query.
`void`	`disableInnerJoinAutoDetect()` Disable auto-detecting inner-join.
`void`	`disableOverridingQuery()` Disable overriding query.
`void`	`disablePagingAdjustment()` Disable paging adjustment.
`void`	`disablePagingCountLater()` Disable paging count-later that means counting after selecting.
`void`	`disablePagingCountLeastJoin()` Disable paging count-least-join, which means least joined on count select.
`void`	`disablePKOnlySelectForcedly()` Disable PK only select forcedly.
`void`	`disableSelectColumnCipher()` Disable select column cipher effective.
`void`	`disableSelectIndex()` Disable select index.
`void`	`disableStructuralPossibleInnerJoin()` Disable auto-detecting structural-possible inner-join.
`void`	`disableThatsBadTimingDetect()` Disable "that's-bad-timing" detect for compatible.
`void`	`disableWhereUsedInnerJoin()` Disable auto-detecting where-used inner-join.
`void`	`enableColumnNullObject()` Enable the handling of column null object.
`void`	`enableColumnNullObjectGearedToSpecify()` Enable the handling of column null object geared to specify.
`void`	`enableEmptyStringQuery()` Enable empty string query (means allowed).
`void`	`enableInnerJoinAutoDetect()` Enable to auto-detect joins that can be (all type) inner-join.
`void`	`enableOverridingQuery()` Enable overriding query (means allowed).
`void`	`enablePagingAdjustment()` Enable paging adjustment, e.g.
`void`	`enablePagingCountLater()` Enable paging count-later that means counting after selecting.
`void`	`enablePagingCountLeastJoin()` Enable paging count-least-join, which means least joined on count select.
`void`	`enablePKOnlySelectForcedly()` Enable PK only select forcedly effective, ignoring select clause setting and derived referrer.
`void`	`enableQueryUpdateForcedDirect()` Enable to use direct clause in query update forcedly (contains query delete).
`void`	`enableSelectColumnCipher()` Enable select column cipher effective.
`void`	`enableStructuralPossibleInnerJoin()` Enable to auto-detect joins that can be structure-possible inner-join.
`void`	`enableThatsBadTimingDetect()` Enable "that's-bad-timing" detect.
`void`	`enableWhereUsedInnerJoin()` Enable to auto-detect joins that can be where-used inner-join.
`void`	`endOrScopeQuery()` End or-scope query.
`void`	`endOrScopeQueryAndPart()` End or-scope query to and-part.
`void`	`exchangeFirstWhereClauseForLastOne()` Exchange first The clause of 'where' for last one.
`void`	`fetchFirst(int fetchSize)` Fetch first several rows only.
`void`	`fetchPage(int fetchPageNumber)` Fetch page.
`void`	`fetchScope(int fetchStartIndex, int fetchSize)` Fetch scope (skip first several rows, and fetch first rows).
`ColumnFunctionCipher`	`findColumnFunctionCipher(ColumnInfo columnInfo)` Find the cipher for the column.
`String`	`getBasePointAliasName()` Get the alias name for base point table.
`String`	`getClause()` Get the clause of all parts.
`String`	`getClauseFromWhereWithUnionTemplate()` Get from-where clause without select and orderBy and sqlSuffix.
`String`	`getClauseFromWhereWithWhereUnionTemplate()` Get from-where clause without select and orderBy and sqlSuffix as template.
`String`	`getClauseQueryDelete()`
`String`	`getClauseQueryInsert(Map<String,String> fixedValueQueryExpMap, SqlClause resourceSqlClause)`
`String`	`getClauseQueryUpdate(Map<String,Object> columnParameterMap)`
`Map<String,Object>`	`getColumnQueryObjectMap()` Get the map for ColumnQuery objects for parameter comment.
`String`	`getDerivedReferrerNestedAlias()` Get the alias name for derived column of nested DerivedReferrer.
`int`	`getFetchNarrowingLoopCount()` Get fetch-narrowing loop-count.
`int`	`getFetchNarrowingSkipStartIndex()` Get fetch-narrowing skip-start-index.
`int`	`getFetchPageNumber()` Get fetch page number.
`int`	`getFetchSize()` Get fetch size.
`int`	`getFetchStartIndex()` Get fetch start index.
`Map<String,Object>`	`getFreeParameterMap()` Get the map for free parameters for parameter comment.
`String`	`getFromBaseTableHint()` Get the clause of from-base-table.
`String`	`getFromClause()` Get the clause of 'from'.
`String`	`getFromHint()` Get the hint of 'from'.
`GearedCipherManager`	`getGearedCipherManager()` Get the manager of geared cipher.
`String`	`getInlineViewBasePointAlias()` Get the alias name for base point table on in-line view.
`int`	`getInScopeLimit()` Get the limit of inScope.
`List<HpInvalidQueryInfo>`	`getInvalidQueryList()` Get the list of invalid query.
`Set<ColumnInfo>`	`getLocalSpecifiedNullObjectColumnSet()` Get the set of column specified as null object for the local table.
`Map<String,Object>`	`getManualOrderParameterMap()` Get the map for ManualOrder parameters for parameter comment.
`String`	`getOrderByClause()` Get the clause of 'order-by'.
`OrderByClause`	`getOrderByComponent()`
`OrderByElement`	`getOrderByLastElement()` Get the last element of order-by.
`Map<String,LeftOuterJoinInfo>`	`getOuterJoinMap()` Get the information of left-outer-join.
`int`	`getPageEndIndex()` Get page end index.
`int`	`getPageStartIndex()` Get page start index.
`HpCBPurpose`	`getPurpose()` Get the purpose of the condition-bean. e.g.
`Set<ColumnInfo>`	`getRelationSpecifiedNullObjectColumnSet(String relationNoSuffix)` Get the set of column specified as null object for the relation.
`String`	`getScalarSelectColumnAlias()` Get the alias name for specified column of scalar-select.
`String`	`getSelectClause()` Get the clause of 'select'.
`Map<String,String>`	`getSelectColumnKeyNameMap()` Get the map of key name of select column by on-query name.
`Map<String,Map<String,SelectedRelationColumn>>`	`getSelectedRelationColumnMap()` Get the map of selected relation column.
`int`	`getSelectedRelationCount()` Get the count of selected relation.
`String`	`getSelectHint()` Get the hint of 'select'.
`Map<String,Map<String,Integer>>`	`getSelectIndexMap()` Get the map of select index by key name of select column.
`SpecifiedColumn`	`getSpecifiedColumnAsOne()` Get the only one specified column.
`String`	`getSpecifiedColumnDbNameAsOne()` Get the DB name of only one specified column.
`ColumnInfo`	`getSpecifiedColumnInfoAsOne()` Get the information of only one specified column.
`ColumnRealName`	`getSpecifiedColumnRealNameAsOne()` Get the real name of only one specified column.
`ColumnSqlName`	`getSpecifiedColumnSqlNameAsOne()` Get the SQL name of only one specified column.
`List<String>`	`getSpecifiedDerivingAliasList()` Get the list of alias for specified deriving sub-query.
`String`	`getSpecifiedDerivingAliasNameAsOne()` Get the alias name for specified deriving sub-query as specified one.
`SpecifiedColumn`	`getSpecifiedDerivingColumnAsOne()` Get the specified column for specified deriving sub-query as specified one.
`ColumnInfo`	`getSpecifiedDerivingColumnInfo(String aliasName)` Get the info of column for specified deriving sub-query by the alias name.
`ColumnInfo`	`getSpecifiedDerivingColumnInfoAsOne()` Get the info of column for specified deriving sub-query as specified one.
`HpDerivingSubQueryInfo`	`getSpecifiedDerivingInfo(String aliasName)` Get the info of specified deriving sub-query by the alias name.
`String`	`getSpecifiedDerivingSubQueryAsOne()` Get the clause of specified deriving sub-query as specified one.
`ColumnRealName`	`getSpecifiedResolvedColumnRealNameAsOne()` Get the real name of sub-query resolved column (specified or deriving) as specified one.
`ColumnSqlName`	`getSpecifiedResolvedColumnSqlNameAsOne()` Get the SQL name of definition resolved column (specified or deriving) as specified one.
`String`	`getSqlSuffix()` Get the suffix of SQL.
`int`	`getSubQueryLevel()` Get the hierarchy level of sub-query.
`String`	`getUnionQueryInlineViewAlias()` Get the alias name for in-line view of union-query.
`String`	`getUnionSelectClauseMark()`
`String`	`getUnionWhereClauseMark()`
`String`	`getUnionWhereFirstConditionMark()`
`String`	`getWhereClause()` Get the clause of 'where'.
`String`	`getWhereClauseMark()`
`String`	`getWhereFirstConditionMark()`
`void`	`handleSpecifiedSelectColumn(String tableAliasName, SpecifiedSelectColumnHandler columnHandler)` Handle the specified select column in the table.
`boolean`	`hasBaseTableInlineWhereClause()`
`boolean`	`hasOrderByClause()` Does it have order-by clauses?
`boolean`	`hasOuterJoin()` Does outer-join (at least one) exist?
`boolean`	`hasOuterJoinInlineWhereClause()`
`boolean`	`hasSelectedRelation(String foreignRelationPath)` Is the relation selected?
`boolean`	`hasSpecifiedDerivedOrderByClause()` Does it have order-by clauses as specified-derived order-by?
`boolean`	`hasSpecifiedDerivingSubQuery()` Does it have the specified deriving sub-query at least one?
`boolean`	`hasSpecifiedDerivingSubQuery(String aliasName)` Does it have the specified deriving sub-query by the alias name?
`boolean`	`hasSpecifiedSelectColumn(String tableAliasName)` Does it have specified select columns?
`boolean`	`hasSpecifiedSelectColumn(String tableAliasName, String columnDbName)` Does it have the specified select column?
`boolean`	`hasUnionQuery()`
`boolean`	`hasWhereClauseOnBaseQuery()` Does it have where clauses on the base query?
`void`	`ignoreNullOrEmptyQuery()` Ignore null-or-empty query.
`boolean`	`isColumnNullObjectAllowed()` Is the handling of column null object enabled?
`boolean`	`isCursorSelectByPagingAllowed()` Is cursor select by paging allowed?
`boolean`	`isEmptyStringQueryAllowed()` Is empty string allowed?
`boolean`	`isFetchNarrowingEffective()` Is fetch-narrowing effective?
`boolean`	`isFetchScopeEffective()` Is fetch scope effective?
`boolean`	`isFetchSizeSupported()` Is fetch size supported?
`boolean`	`isFetchStartIndexSupported()` Is fetch start index supported?
`boolean`	`isForSubQuery()` Is this SQL for sub-query?
`boolean`	`isLocked()` Is the clause object locked?
`boolean`	`isNullOrEmptyQueryChecked()` Is null-or-empty query checked?
`boolean`	`isOrScopeQueryAndPartEffective()` Is and-part of or-scope effective?
`boolean`	`isOrScopeQueryEffective()` Is or-scope query effective?
`boolean`	`isOverridingQueryAllowed()` Is overriding query allowed?
`boolean`	`isSelectedNextConnectingRelation(String foreignRelationPath)` Does the relation connect to selected next relation?
`boolean`	`isSelectedRelationEmpty()` Is the selected relation empty?
`boolean`	`isStructuralPossibleInnerJoinEnabled()` Does it allow to auto-detect structure-possible inner-join?
`boolean`	`isThatsBadTimingDetectAllowed()` Does it allow "that's-bad-timing" detect?
`boolean`	`isUnderOverRelation(String relationPath)` Is the relation under over-relation?
`boolean`	`isUseInScopeSubQueryForExistsReferrer()` Does it use in-scope sub-query for exists-referrer?
`boolean`	`isWhereUsedInnerJoinEnabled()` Does it allow to auto-detect where-used inner-join?
`void`	`lock()` Lock the clause object.
`void`	`lockForUpdate()` Lock selected records for update.
`String`	`processSubQueryIndent(String sql)`
`void`	`reflectWhereUsedToJoin(QueryUsedAliasInfo usedAliasInfo)` Reflect the information of where-used-to join.
`void`	`registerBaseTableInlineWhereClause(ColumnSqlName columnSqlName, ConditionKey key, ConditionValue value, ColumnFunctionCipher cipher, ConditionOption option)`
`void`	`registerBaseTableInlineWhereClause(String value)`
`void`	`registerClauseLazyReflector(ClauseLazyReflector clauseLazyReflector)` Register the lazy reflector of clause.
`String`	`registerColumnQueryObjectToThemeList(String themeKey, Object addedValue)` Register ColumnQuery object to theme list.
`void`	`registerFixedConditionLazyChecker(FixedConditionLazyChecker checker)` Register the lazy checker for the fixed condition.
`String`	`registerFreeParameterToThemeList(String themeKey, Object addedValue)` Register free parameter to theme list.
`String`	`registerManualOrderParameterToThemeList(String themeKey, Object addedValue)` Register ManualOrder parameter to theme list.
`void`	`registerOrderBy(String orderByProperty, boolean ascOrDesc, ColumnInfo columnInfo)`
`void`	`registerOuterJoin(String foreignAliasName, String foreignTableDbName, String localAliasName, String localTableDbName, Map<ColumnRealName,ColumnRealName> joinOnMap, String relationPath, ForeignInfo foreignInfo, String fixedCondition, FixedConditionResolver fixedConditionResolver)` Register outer-join.
`void`	`registerOuterJoinFixedInline(String foreignAliasName, String foreignTableDbName, String localAliasName, String localTableDbName, Map<ColumnRealName,ColumnRealName> joinOnMap, String relationPath, ForeignInfo foreignInfo, String fixedCondition, FixedConditionResolver fixedConditionResolver)` Register outer-join using in-line view for fixed-conditions.
`void`	`registerOuterJoinInlineWhereClause(String foreignAliasName, ColumnSqlName columnSqlName, ConditionKey key, ConditionValue value, ColumnFunctionCipher cipher, ConditionOption option, boolean onClause)`
`void`	`registerOuterJoinInlineWhereClause(String foreignAliasName, String clause, boolean onClause)`
`void`	`registerSelectedRelation(String foreignTableAliasName, String localTableDbName, String foreignPropertyName, String localRelationPath, String foreignRelationPath)` Register selected relation.
`void`	`registerSpecifiedDerivedOrderBy(String orderByProperty, boolean ascOrDesc)`
`void`	`registerUnionQuery(UnionClauseProvider unionClauseProvider, boolean unionAll)`
`void`	`registerWhereClause(ColumnRealName columnRealName, ConditionKey key, ConditionValue value, ColumnFunctionCipher cipher, ConditionOption option, String usedAliasName)` Register 'where' clause.
`void`	`registerWhereClause(QueryClause clause, QueryUsedAliasInfo... usedAliasInfos)` Register 'where' clause.
`void`	`registerWhereClause(String clause, String usedAliasName)` Register 'where' clause.
`void`	`registerWhereClause(String clause, String usedAliasName, boolean noWayInner)` Register 'where' clause.
`String`	`resolveJoinAliasName(String relationPath, int nestLevel)` Resolve alias name for join table.
`int`	`resolveRelationNo(String localTableName, String foreignPropertyName)` Resolve relation no.
`String`	`resolveSubQueryBeginMark(String subQueryIdentity)`
`String`	`resolveSubQueryEndMark(String subQueryIdentity)`
`void`	`restoreSpecifiedSelectColumn()` Restore specified select columns if backup exists.
`void`	`restoreWhereClauseOnBaseQuery()` Restore where clause on base query if backup exists.
`void`	`reviveFetchScope()` Revive fetch-scope from suppressed status.
`void`	`reviveOrderBy()` Revive order-by from suppressed status.
`void`	`rollbackSelectClauseType()` Roll-back the type of select clause into previous one.
`void`	`saveInvalidQuery(HpInvalidQueryInfo invalidQueryInfo)` Save the invalid query.
`void`	`setPurpose(HpCBPurpose purpose)` Set the purpose of the condition-bean. e.g.
`void`	`setupForSubQuery(int subQueryLevel)` Set up this SQL for sub-query.
`void`	`specifyDerivingSubQuery(HpDerivingSubQueryInfo subQueryInfo)` Specify deriving sub-query for DerivedReferrer.
`void`	`specifySelectColumn(SpecifiedColumn specifiedColumn)` Specify select columns.
`void`	`suppressFetchScope()` Suppress fetch-scope.
`void`	`suppressOrderBy()` Suppress order-by temporarily.
`String`	`translateSelectedRelationPathToPropName(String foreignRelationPath)` Translate selected relation path (foreignRelationPath: relationNoSuffix) to relation property name (foreignPropertyName).
`String`	`translateSelectedRelationPathToTableAlias(String foreignRelationPath)` Translate selected relation path (foreignRelationPath: relationNoSuffix) to foreign table alias name (foreignTableAliasName).
`void`	`unlock()` Unlock the clause object.
`void`	`useInScopeSubQueryForExistsReferrer()` Use in-scope sub-query for exists-referrer.

- フィールドの詳細
  - RELATION_PATH_DELIMITER
```
static final String RELATION_PATH_DELIMITER
```
    The delimiter of relation path. The relation path is e.g. _0_3
    
    関連項目:
    
    定数フィールド値
  - BASE_POINT_ALIAS_NAME
```
static final String BASE_POINT_ALIAS_NAME
```
    The alias name of base point table for on-query.
    
    関連項目:
    
    定数フィールド値
  - BASE_POINT_HANDLING_ENTITY_NO
```
static final String BASE_POINT_HANDLING_ENTITY_NO
```
    The entity number of base point table for internal handling.
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - getSubQueryLevel
```
int getSubQueryLevel()
```
    Get the hierarchy level of sub-query.
    
    戻り値:
    
    The hierarchy level of sub-query. (NotMinus: if zero, not for sub-query)
  - setupForSubQuery
```
void setupForSubQuery(int subQueryLevel)
```
    Set up this SQL for sub-query.
    
    パラメータ:
    
    subQueryLevel - The hierarchy level of sub-query. (NotMinus: if zero, not for sub-query)
  - isForSubQuery
```
boolean isForSubQuery()
```
    Is this SQL for sub-query?
    
    戻り値:
    
    The determination, true or false.
  - getClause
```
String getClause()
```
    Get the clause of all parts.
```
 select [base-table-columns], [join-table-columns]
   from [base-table] left outer join [join-table] [join-alias] on [join-condition]
  where [base-table].[column] = [value] and [join-alias].[column] is null
  order by [base-table].[column] asc, [join-alias].[column] desc
  for update
 
```
    戻り値:
    
    The clause of all parts. (NotNull)
  - getClauseFromWhereWithUnionTemplate
```
String getClauseFromWhereWithUnionTemplate()
```
    Get from-where clause without select and orderBy and sqlSuffix.
    Basically for subQuery and selectCount.
    You should handle UnionSelectClauseMark and UnionWhereClauseMark and UnionWhereFirstConditionMark in clause.
    
    戻り値:
    
    The 'from-where' clause(contains union) without 'select' and 'orderBy' and 'sqlSuffix'. (NotNull)
  - getClauseFromWhereWithWhereUnionTemplate
```
String getClauseFromWhereWithWhereUnionTemplate()
```
    Get from-where clause without select and orderBy and sqlSuffix as template.
    Basically for subQuery and selectCount.
    You should handle UnionSelectClauseMark and UnionWhereClauseMark and UnionWhereFirstConditionMark and WhereClauseMark and WhereFirstConditionMark in clause.
    
    戻り値:
    
    The 'from-where' clause(contains union) without 'select' and 'orderBy' and 'sqlSuffix'. (NotNull)
  - getSelectClause
```
String getSelectClause()
```
    Get the clause of 'select'. This is an internal method.
    
    戻り値:
    
    The clause of select. {[select ...] from table...} (NotNull)
  - getSelectIndexMap
```
Map<String,Map<String,Integer>> getSelectIndexMap()
```
    Get the map of select index by key name of select column.
    map:{entityNo(e.g. loc00 or _0_3) = map:{selectColumnKeyName = selectIndex}}
    
    戻り値:
    
    The map of select index. (NullAllowed: null means lazy-loaded not yet or select index is disabled)
  - getSelectColumnKeyNameMap
```
Map<String,String> getSelectColumnKeyNameMap()
```
    Get the map of key name of select column by on-query name.
    map:{onQueryAlias = selectColumnKeyName}}
    
    戻り値:
    
    The map of key name. (NullAllowed: null means lazy-loaded not yet or select index is disabled)
  - changeAliasNameLimitSize
```
void changeAliasNameLimitSize(int aliasNameLimitSize)
```
    Change limit size of alias name.
    
    パラメータ:
    
    aliasNameLimitSize - The limit size of alias name. (NotMinus, NotZero)
  - disableSelectIndex
```
void disableSelectIndex()
```
    Disable select index.
  - getSelectHint
```
String getSelectHint()
```
    Get the hint of 'select'. This is an internal method.
    
    戻り値:
    
    The hint of 'select'. {select [select-hint] * from table...} (NotNull)
  - getFromClause
```
String getFromClause()
```
    Get the clause of 'from'. This is an internal method.
    
    戻り値:
    
    The clause of 'from'. (NotNull)
  - getFromBaseTableHint
```
String getFromBaseTableHint()
```
    Get the clause of from-base-table. This is an internal method.
    
    戻り値:
    
    The hint of from-base-table. {select * from table [from-base-table-hint] where ...} (NotNull)
  - getFromHint
```
String getFromHint()
```
    Get the hint of 'from'. This is an internal method.
    
    戻り値:
    
    The hint of 'from'. {select * from table left outer join ... on ... [from-hint] where ...} (NotNull)
  - getWhereClause
```
String getWhereClause()
```
    Get the clause of 'where'. This is an internal method.
    
    戻り値:
    
    The clause of 'where'. (NotNull)
  - getOrderByClause
```
String getOrderByClause()
```
    Get the clause of 'order-by'. This is an internal method.
    
    戻り値:
    
    The clause of 'order-by'. (NotNull)
  - getSqlSuffix
```
String getSqlSuffix()
```
    Get the suffix of SQL. This is an internal method.
    
    戻り値:
    
    The suffix of SQL. {select * from table where ... order by ... [sql-suffix]} (NotNull)
  - registerSelectedRelation
```
void registerSelectedRelation(String foreignTableAliasName,
                              String localTableDbName,
                              String foreignPropertyName,
                              String localRelationPath,
                              String foreignRelationPath)
```
    Register selected relation.
    
    パラメータ:
    
    foreignTableAliasName - The alias name of foreign table. (NotNull)
    
    localTableDbName - The table DB name of local. (NotNull)
    
    foreignPropertyName - The property name of foreign table. (NotNull)
    
    localRelationPath - The path of local relation. (NullAllowed)
    
    foreignRelationPath - The path of foreign relation, same as relation No suffix. e.g. _3, _7_2 (NotNull)
  - translateSelectedRelationPathToPropName
```
String translateSelectedRelationPathToPropName(String foreignRelationPath)
```
    Translate selected relation path (foreignRelationPath: relationNoSuffix) to relation property name (foreignPropertyName).
    
    パラメータ:
    
    foreignRelationPath - The relation path of foreign property (relationNoSuffix). e.g. _3, _7_2 (NotNull)
    
    戻り値:
    
    The name of foreign property, (foreignPropertyName). (NotNull)
  - translateSelectedRelationPathToTableAlias
```
String translateSelectedRelationPathToTableAlias(String foreignRelationPath)
```
    Translate selected relation path (foreignRelationPath: relationNoSuffix) to foreign table alias name (foreignTableAliasName).
    
    パラメータ:
    
    foreignRelationPath - The relation path of foreign property (relationNoSuffix). e.g. _3, _7_2 (NotNull)
    
    戻り値:
    
    The alias name of foreign table (foreignTableAliasName). (NotNull)
  - getSelectedRelationCount
```
int getSelectedRelationCount()
```
    Get the count of selected relation.
    
    戻り値:
    
    The integer of count. (NotMinus)
  - isSelectedRelationEmpty
```
boolean isSelectedRelationEmpty()
```
    Is the selected relation empty?
    
    戻り値:
    
    The determination, true or false.
  - hasSelectedRelation
```
boolean hasSelectedRelation(String foreignRelationPath)
```
    Is the relation selected?
    
    パラメータ:
    
    foreignRelationPath - The path of foreign relation, same as relation No suffix. e.g. _3, _7_2 (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - getSelectedRelationColumnMap
```
Map<String,Map<String,SelectedRelationColumn>> getSelectedRelationColumnMap()
```
    Get the map of selected relation column.
    Basically internal but public for analyzing.
    
    戻り値:
    
    The map of selected relation column. map:{foreignTableAliasName : map:{columnName : selectedRelationColumn}} (NotNull)
  - isSelectedNextConnectingRelation
```
boolean isSelectedNextConnectingRelation(String foreignRelationPath)
```
    Does the relation connect to selected next relation?
    
    パラメータ:
    
    foreignRelationPath - The path of foreign relation, same as relation No suffix. e.g. _3, _7_2 (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - registerOuterJoin
```
void registerOuterJoin(String foreignAliasName,
                       String foreignTableDbName,
                       String localAliasName,
                       String localTableDbName,
                       Map<ColumnRealName,ColumnRealName> joinOnMap,
                       String relationPath,
                       ForeignInfo foreignInfo,
                       String fixedCondition,
                       FixedConditionResolver fixedConditionResolver)
```
    Register outer-join.
    The fixed-conditions are located on on-clause.
    
    パラメータ:
    
    foreignAliasName - The alias name of foreign table. {left outer join [foreignTableDbName] [foreignAliasName]} (NotNull, Unique)
    
    foreignTableDbName - The DB name of foreign table. {left outer join [foreignTableDbName] [foreignAliasName]} (NotNull)
    
    localAliasName - The alias name of local table. {[localTableDbName] [localAliasName] left outer join} (NotNull)
    
    localTableDbName - The DB name of local table. {[localTableDbName] [localAliasName] left outer join} (NotNull)
    
    joinOnMap - The map of join condition on on-clause. (NotNull)
    
    relationPath - The path of relation. e.g. _1_3 (NotNull)
    
    foreignInfo - The information of foreign relation corresponding to this join. (NotNull)
    
    fixedCondition - The fixed condition on on-clause. (NullAllowed: if null, means no fixed condition)
    
    fixedConditionResolver - The resolver for variables on fixed-condition. (NullAllowed)
  - registerOuterJoinFixedInline
```
void registerOuterJoinFixedInline(String foreignAliasName,
                                  String foreignTableDbName,
                                  String localAliasName,
                                  String localTableDbName,
                                  Map<ColumnRealName,ColumnRealName> joinOnMap,
                                  String relationPath,
                                  ForeignInfo foreignInfo,
                                  String fixedCondition,
                                  FixedConditionResolver fixedConditionResolver)
```
    Register outer-join using in-line view for fixed-conditions.
    The fixed-conditions are located on in-line view.
    
    パラメータ:
    
    foreignAliasName - The alias name of foreign table. {left outer join [foreignTableDbName] [foreignAliasName]} (NotNull, Unique)
    
    foreignTableDbName - The DB name of foreign table. {left outer join [foreignTableDbName] [foreignAliasName]} (NotNull)
    
    localAliasName - The alias name of local table. {[localTableDbName] [localAliasName] left outer join} (NotNull)
    
    localTableDbName - The DB name of local table. {[localTableDbName] [localAliasName] left outer join} (NotNull)
    
    joinOnMap - The map of join condition on on-clause. (NotNull)
    
    relationPath - The path of relation. e.g. _1_3 (NotNull)
    
    foreignInfo - The information of foreign relation corresponding to this join. (NotNull)
    
    fixedCondition - The fixed condition on in-line view. (NullAllowed: if null, means no fixed condition)
    
    fixedConditionResolver - The resolver for variables on fixed-condition. (NullAllowed)
  - registerFixedConditionLazyChecker
```
void registerFixedConditionLazyChecker(FixedConditionLazyChecker checker)
```
    Register the lazy checker for the fixed condition.
    This is called when building SQL clause.
    
    パラメータ:
    
    checker - The callback instance of checker. (NotNull)
  - getOuterJoinMap
```
Map<String,LeftOuterJoinInfo> getOuterJoinMap()
```
    Get the information of left-outer-join.
    Basically internal but public for analyzing.
    
    戻り値:
    
    The map of left-outer-join info. map:{ foreignAliasName : leftOuterJoinInfo } (NotNull)
  - hasOuterJoin
```
boolean hasOuterJoin()
```
    Does outer-join (at least one) exist? (contains inner-join)
    
    戻り値:
    
    The determination, true or false.
  - canUseRelationCache
```
boolean canUseRelationCache(String relationPath)
```
    Can it use the relation cache for entity mapping?
    
    パラメータ:
    
    relationPath - The path of relation. e.g. _1_3 (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - isUnderOverRelation
```
boolean isUnderOverRelation(String relationPath)
```
    Is the relation under over-relation?
    
    パラメータ:
    
    relationPath - The path of relation. e.g. _1_3 (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - changeToInnerJoin
```
void changeToInnerJoin(String foreignAliasName)
```
    Change the join type for the relation to inner join manually.
    
    パラメータ:
    
    foreignAliasName - The foreign alias name of join table. (NotNull and Unique per invoking method)
  - enableInnerJoinAutoDetect
```
void enableInnerJoinAutoDetect()
```
    Enable to auto-detect joins that can be (all type) inner-join.
    You should call this before registrations of where clause. (actually you can call before selecting but it's a fixed specification for user)
  - disableInnerJoinAutoDetect
```
void disableInnerJoinAutoDetect()
```
    Disable auto-detecting inner-join.
    You should call this before registrations of where clause.
  - enableStructuralPossibleInnerJoin
```
void enableStructuralPossibleInnerJoin()
```
    Enable to auto-detect joins that can be structure-possible inner-join.
    You should call this before registrations of where clause. (actually you can call before selecting but it's a fixed specification for user)
  - disableStructuralPossibleInnerJoin
```
void disableStructuralPossibleInnerJoin()
```
    Disable auto-detecting structural-possible inner-join.
    You should call this before registrations of where clause.
  - isStructuralPossibleInnerJoinEnabled
```
boolean isStructuralPossibleInnerJoinEnabled()
```
    Does it allow to auto-detect structure-possible inner-join?
    
    戻り値:
    
    Determination. (true or false)
  - enableWhereUsedInnerJoin
```
void enableWhereUsedInnerJoin()
```
    Enable to auto-detect joins that can be where-used inner-join.
    You should call this before registrations of where clause.
  - disableWhereUsedInnerJoin
```
void disableWhereUsedInnerJoin()
```
    Disable auto-detecting where-used inner-join. You should call this before registrations of where clause.
  - isWhereUsedInnerJoinEnabled
```
boolean isWhereUsedInnerJoinEnabled()
```
    Does it allow to auto-detect where-used inner-join?
    
    戻り値:
    
    Determination. (true or false)
  - registerWhereClause
```
void registerWhereClause(ColumnRealName columnRealName,
                         ConditionKey key,
                         ConditionValue value,
                         ColumnFunctionCipher cipher,
                         ConditionOption option,
                         String usedAliasName)
```
    Register 'where' clause.
    
    パラメータ:
    
    columnRealName - The real name of column. {[alias-name].[column-name]}. (NotNull)
    
    key - The key of condition. (NotNull)
    
    value - The value of condition. (NotNull)
    
    cipher - The cipher of column by function. (NullAllowed)
    
    option - The option of condition. (NullAllowed)
    
    usedAliasName - The alias name of table used on the where clause. (NotNull)
  - registerWhereClause
```
void registerWhereClause(String clause,
                         String usedAliasName)
```
    Register 'where' clause.
    The join of the alias, if it's a relation condition, may have a chance to be inner-join.
    
    パラメータ:
    
    clause - The string clause of 'where'. (NotNull)
    
    usedAliasName - The alias name of table used on the where clause. (NotNull)
  - registerWhereClause
```
void registerWhereClause(String clause,
                         String usedAliasName,
                         boolean noWayInner)
```
    Register 'where' clause.
    You can control the inner-join possibility.
    
    パラメータ:
    
    clause - The string clause of 'where'. (NotNull)
    
    usedAliasName - The alias name of table used on the where clause. (NotNull)
    
    noWayInner - No way, to be inner-join for the join of the alias?
  - registerWhereClause
```
void registerWhereClause(QueryClause clause,
                         QueryUsedAliasInfo... usedAliasInfos)
```
    Register 'where' clause.
    You can control the inner-join possibility.
    
    パラメータ:
    
    clause - The string clause of 'where'. (NotNull)
    
    usedAliasInfos - The array of information of used alias, contains no-way-inner determination. (NotNull, NotEmpty)
  - reflectWhereUsedToJoin
```
void reflectWhereUsedToJoin(QueryUsedAliasInfo usedAliasInfo)
```
    Reflect the information of where-used-to join.
    Basically interface for DreamCruise.
    
    パラメータ:
    
    usedAliasInfo - The information of used alias, contains no-way-inner determination. (NotNull, NotEmpty)
  - exchangeFirstWhereClauseForLastOne
```
void exchangeFirstWhereClauseForLastOne()
```
    Exchange first The clause of 'where' for last one.
  - hasWhereClauseOnBaseQuery
```
boolean hasWhereClauseOnBaseQuery()
```
    Does it have where clauses on the base query?
    Clauses on union queries and in-line views are not concerned.
    
    戻り値:
    
    The determination, true or false.
  - backupWhereClauseOnBaseQuery
```
void backupWhereClauseOnBaseQuery()
```
    Back up where clause on base query.
    You can restore it later.
  - restoreWhereClauseOnBaseQuery
```
void restoreWhereClauseOnBaseQuery()
```
    Restore where clause on base query if backup exists.
    You should call this after backup.
  - clearWhereClauseOnBaseQuery
```
void clearWhereClauseOnBaseQuery()
```
    Clear where clauses on the base query.
    Clauses on union queries and in-line views are not concerned.
  - registerBaseTableInlineWhereClause
```
void registerBaseTableInlineWhereClause(ColumnSqlName columnSqlName,
                                        ConditionKey key,
                                        ConditionValue value,
                                        ColumnFunctionCipher cipher,
                                        ConditionOption option)
```
  - registerBaseTableInlineWhereClause
```
void registerBaseTableInlineWhereClause(String value)
```
  - hasBaseTableInlineWhereClause
```
boolean hasBaseTableInlineWhereClause()
```
  - clearBaseTableInlineWhereClause
```
void clearBaseTableInlineWhereClause()
```
  - registerOuterJoinInlineWhereClause
```
void registerOuterJoinInlineWhereClause(String foreignAliasName,
                                        ColumnSqlName columnSqlName,
                                        ConditionKey key,
                                        ConditionValue value,
                                        ColumnFunctionCipher cipher,
                                        ConditionOption option,
                                        boolean onClause)
```
  - registerOuterJoinInlineWhereClause
```
void registerOuterJoinInlineWhereClause(String foreignAliasName,
                                        String clause,
                                        boolean onClause)
```
  - hasOuterJoinInlineWhereClause
```
boolean hasOuterJoinInlineWhereClause()
```
  - clearOuterJoinInlineWhereClause
```
void clearOuterJoinInlineWhereClause()
```
  - beginOrScopeQuery
```
void beginOrScopeQuery()
```
    Begin or-scope query.
  - endOrScopeQuery
```
void endOrScopeQuery()
```
    End or-scope query.
  - beginOrScopeQueryAndPart
```
void beginOrScopeQueryAndPart()
```
    Begin or-scope query to and-part.
  - endOrScopeQueryAndPart
```
void endOrScopeQueryAndPart()
```
    End or-scope query to and-part.
  - isOrScopeQueryEffective
```
boolean isOrScopeQueryEffective()
```
    Is or-scope query effective?
    
    戻り値:
    
    The determination, true or false.
  - isOrScopeQueryAndPartEffective
```
boolean isOrScopeQueryAndPartEffective()
```
    Is and-part of or-scope effective?
    
    戻り値:
    
    The determination, true or false.
  - getOrderByComponent
```
OrderByClause getOrderByComponent()
```
    戻り値:
    
    The object of order-by clause. (NotNull)
  - getOrderByLastElement
```
OrderByElement getOrderByLastElement()
```
    Get the last element of order-by.
    
    戻り値:
    
    The order-by element object. (NullAllowed: when no order-by)
  - clearOrderBy
```
void clearOrderBy()
```
    Clear order-by information in this clause.
  - suppressOrderBy
```
void suppressOrderBy()
```
    Suppress order-by temporarily.
  - reviveOrderBy
```
void reviveOrderBy()
```
    Revive order-by from suppressed status.
    You can call when not suppressed, only reloaded.
  - registerOrderBy
```
void registerOrderBy(String orderByProperty,
                     boolean ascOrDesc,
                     ColumnInfo columnInfo)
```
    パラメータ:
    
    orderByProperty - Order-by-property. 'aliasName.columnSqlName/aliasName.columnSqlName/...' (NotNull)
    
    ascOrDesc - Is it ascend or descend?
    
    columnInfo - The information of the column for the order. (NotNull)
  - registerSpecifiedDerivedOrderBy
```
void registerSpecifiedDerivedOrderBy(String orderByProperty,
                                     boolean ascOrDesc)
```
    パラメータ:
    
    orderByProperty - Order-by-property. 'aliasName.columnSqlName/aliasName.columnSqlName/...' (NotNull)
    
    ascOrDesc - Is it ascend or descend?
  - addNullsFirstToPreviousOrderBy
```
void addNullsFirstToPreviousOrderBy()
```
  - addNullsLastToPreviousOrderBy
```
void addNullsLastToPreviousOrderBy()
```
  - addManualOrderToPreviousOrderByElement
```
void addManualOrderToPreviousOrderByElement(ManualOrderOption manualOrderOption)
```
  - hasOrderByClause
```
boolean hasOrderByClause()
```
    Does it have order-by clauses?
    Whether effective or not has no influence.
    
    戻り値:
    
    The determination, true or false.
  - hasSpecifiedDerivedOrderByClause
```
boolean hasSpecifiedDerivedOrderByClause()
```
    Does it have order-by clauses as specified-derived order-by?
    Whether effective or not has no influence.
    
    戻り値:
    
    The determination, true or false.
  - registerUnionQuery
```
void registerUnionQuery(UnionClauseProvider unionClauseProvider,
                        boolean unionAll)
```
  - hasUnionQuery
```
boolean hasUnionQuery()
```
  - clearUnionQuery
```
void clearUnionQuery()
```
  - fetchFirst
```
void fetchFirst(int fetchSize)
```
    Fetch first several rows only.
    
    パラメータ:
    
    fetchSize - The size of fetching. (NotMinus)
  - fetchScope
```
void fetchScope(int fetchStartIndex,
                int fetchSize)
```
    Fetch scope (skip first several rows, and fetch first rows).
    
    パラメータ:
    
    fetchStartIndex - The index of fetch-start. 0 origin. (NotMinus)
    
    fetchSize - The size of fetching from start index. (NotMinus)
  - fetchPage
```
void fetchPage(int fetchPageNumber)
```
    Fetch page.
    When you invoke this, it is normally necessary to invoke 'fetchFirst()' or 'fetchScope()' ahead of that. But you also can use default-fetch-size without invoking 'fetchFirst()' or 'fetchScope()'. If you invoke this, your SQL returns [fetch-size] records from [fetch-start-index] calculated by [fetch-page-number].
    
    パラメータ:
    
    fetchPageNumber - The number of fetch page. 1 origin. (NotMinus, NotZero: if minus or zero, set one)
  - getFetchStartIndex
```
int getFetchStartIndex()
```
    Get fetch start index.
    
    戻り値:
    
    Fetch start index.
  - getFetchSize
```
int getFetchSize()
```
    Get fetch size.
    
    戻り値:
    
    Fetch size.
  - getFetchPageNumber
```
int getFetchPageNumber()
```
    Get fetch page number.
    
    戻り値:
    
    Fetch page number.
  - getPageStartIndex
```
int getPageStartIndex()
```
    Get page start index.
    
    戻り値:
    
    Page start index. 0 origin. (NotMinus)
  - getPageEndIndex
```
int getPageEndIndex()
```
    Get page end index.
    
    戻り値:
    
    Page end index. 0 origin. (NotMinus)
  - suppressFetchScope
```
void suppressFetchScope()
```
    Suppress fetch-scope.
  - reviveFetchScope
```
void reviveFetchScope()
```
    Revive fetch-scope from suppressed status.
    You can call when not suppressed, only reloaded.
  - isFetchScopeEffective
```
boolean isFetchScopeEffective()
```
    Is fetch scope effective?
    
    戻り値:
    
    The determination, true or false.
  - isFetchStartIndexSupported
```
boolean isFetchStartIndexSupported()
```
    Is fetch start index supported?
    
    戻り値:
    
    The determination, true or false.
  - isFetchSizeSupported
```
boolean isFetchSizeSupported()
```
    Is fetch size supported?
    
    戻り値:
    
    The determination, true or false.
  - isFetchNarrowingEffective
```
boolean isFetchNarrowingEffective()
```
    Is fetch-narrowing effective?
    
    戻り値:
    
    Determiantion.
  - getFetchNarrowingSkipStartIndex
```
int getFetchNarrowingSkipStartIndex()
```
    Get fetch-narrowing skip-start-index.
    
    戻り値:
    
    Skip-start-index.
  - getFetchNarrowingLoopCount
```
int getFetchNarrowingLoopCount()
```
    Get fetch-narrowing loop-count.
    
    戻り値:
    
    Loop-count.
  - lockForUpdate
```
void lockForUpdate()
```
    Lock selected records for update.
    If you invoke this, your SQL lock target records for update. It depends whether this method supports this on the database type.
  - getBasePointAliasName
```
String getBasePointAliasName()
```
    Get the alias name for base point table.
    
    戻り値:
    
    The string name for alias. (NotNull)
  - resolveJoinAliasName
```
String resolveJoinAliasName(String relationPath,
                            int nestLevel)
```
    Resolve alias name for join table.
    
    パラメータ:
    
    relationPath - The path of relation. e.g. _1_3 (NotNull)
    
    nestLevel - The nest level of condition query.
    
    戻り値:
    
    The resolved name. (NotNull)
  - resolveRelationNo
```
int resolveRelationNo(String localTableName,
                      String foreignPropertyName)
```
    Resolve relation no.
    
    パラメータ:
    
    localTableName - The name of local table. (NotNull)
    
    foreignPropertyName - The property name of foreign relation. (NotNull)
    
    戻り値:
    
    The resolved relation No.
  - getInlineViewBasePointAlias
```
String getInlineViewBasePointAlias()
```
    Get the alias name for base point table on in-line view.
    
    戻り値:
    
    The string name for alias. (NotNull)
  - getUnionQueryInlineViewAlias
```
String getUnionQueryInlineViewAlias()
```
    Get the alias name for in-line view of union-query.
    
    戻り値:
    
    The string name for alias. (NotNull)
  - getDerivedReferrerNestedAlias
```
String getDerivedReferrerNestedAlias()
```
    Get the alias name for derived column of nested DerivedReferrer.
    
    戻り値:
    
    The string name for alias. (NotNull)
  - getScalarSelectColumnAlias
```
String getScalarSelectColumnAlias()
```
    Get the alias name for specified column of scalar-select.
    
    戻り値:
    
    The string name for alias. (NotNull)
  - getWhereClauseMark
```
String getWhereClauseMark()
```
  - getWhereFirstConditionMark
```
String getWhereFirstConditionMark()
```
  - getUnionSelectClauseMark
```
String getUnionSelectClauseMark()
```
  - getUnionWhereClauseMark
```
String getUnionWhereClauseMark()
```
  - getUnionWhereFirstConditionMark
```
String getUnionWhereFirstConditionMark()
```
  - addWhereClauseSimpleFilter
```
void addWhereClauseSimpleFilter(QueryClauseFilter whereClauseSimpleFilter)
```
  - resolveSubQueryBeginMark
```
String resolveSubQueryBeginMark(String subQueryIdentity)
```
  - resolveSubQueryEndMark
```
String resolveSubQueryEndMark(String subQueryIdentity)
```
  - processSubQueryIndent
```
String processSubQueryIndent(String sql)
```
  - specifySelectColumn
```
void specifySelectColumn(SpecifiedColumn specifiedColumn)
```
    Specify select columns.
    It is overridden when the specified column has already been specified.
    
    パラメータ:
    
    specifiedColumn - The info about column specification. (NotNull)
  - hasSpecifiedSelectColumn
```
boolean hasSpecifiedSelectColumn(String tableAliasName)
```
    Does it have specified select columns?
    
    パラメータ:
    
    tableAliasName - The alias name of table. (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - hasSpecifiedSelectColumn
```
boolean hasSpecifiedSelectColumn(String tableAliasName,
                                 String columnDbName)
```
    Does it have the specified select column?
    
    パラメータ:
    
    tableAliasName - The alias name of table. (NotNull)
    
    columnDbName - The DB name of column. (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - handleSpecifiedSelectColumn
```
void handleSpecifiedSelectColumn(String tableAliasName,
                                 SpecifiedSelectColumnHandler columnHandler)
```
    Handle the specified select column in the table.
    
    パラメータ:
    
    tableAliasName - The alias name of table. (NotNull)
    
    columnHandler - The handler of the specified column. (NotNull)
  - backupSpecifiedSelectColumn
```
void backupSpecifiedSelectColumn()
```
    Back up specified select columns.
    You can restore it later.
  - restoreSpecifiedSelectColumn
```
void restoreSpecifiedSelectColumn()
```
    Restore specified select columns if backup exists.
    You should call this after backup.
  - clearSpecifiedSelectColumn
```
void clearSpecifiedSelectColumn()
```
    Clear specified select columns.
  - getSpecifiedColumnAsOne
```
SpecifiedColumn getSpecifiedColumnAsOne()
```
    Get the only one specified column.
    
    戻り値:
    
    The instance as specified column. (NullAllowed: if not found or duplicated, returns null)
  - getSpecifiedColumnDbNameAsOne
```
String getSpecifiedColumnDbNameAsOne()
```
    Get the DB name of only one specified column.
    
    戻り値:
    
    The instance as string. (NullAllowed: if not found or duplicated, returns null)
  - getSpecifiedColumnInfoAsOne
```
ColumnInfo getSpecifiedColumnInfoAsOne()
```
    Get the information of only one specified column.
    
    戻り値:
    
    The instance as type for information of column. (NullAllowed: if not found or duplicated, returns null)
  - getSpecifiedColumnRealNameAsOne
```
ColumnRealName getSpecifiedColumnRealNameAsOne()
```
    Get the real name of only one specified column.
    
    戻り値:
    
    The instance as type for real name of column. (NullAllowed: if not found or duplicated, returns null)
  - getSpecifiedColumnSqlNameAsOne
```
ColumnSqlName getSpecifiedColumnSqlNameAsOne()
```
    Get the SQL name of only one specified column.
    
    戻り値:
    
    The instance as type for SQL name of column. (NullAllowed: if not found or duplicated, returns null)
  - specifyDerivingSubQuery
```
void specifyDerivingSubQuery(HpDerivingSubQueryInfo subQueryInfo)
```
    Specify deriving sub-query for DerivedReferrer.
    It is overridden when the specified column has already been specified.
    The aliasName is allowed to be null for (Specify)DerivedReferrer to be used in other functions.
    
    パラメータ:
    
    subQueryInfo - The info about deriving sub-query. (NotNull: aliasName is allowed to be null)
  - hasSpecifiedDerivingSubQuery
```
boolean hasSpecifiedDerivingSubQuery()
```
    Does it have the specified deriving sub-query at least one?
    
    戻り値:
    
    the determination, true or false.
  - hasSpecifiedDerivingSubQuery
```
boolean hasSpecifiedDerivingSubQuery(String aliasName)
```
    Does it have the specified deriving sub-query by the alias name?
    
    パラメータ:
    
    aliasName - The alias name of specified deriving sub-query. (NotNull)
    
    戻り値:
    
    the determination, true or false.
  - getSpecifiedDerivingAliasList
```
List<String> getSpecifiedDerivingAliasList()
```
    Get the list of alias for specified deriving sub-query.
    
    戻り値:
    
    The list of alias. (NotNull: if no deriving, empty list)
  - getSpecifiedDerivingInfo
```
HpDerivingSubQueryInfo getSpecifiedDerivingInfo(String aliasName)
```
    Get the info of specified deriving sub-query by the alias name.
    
    パラメータ:
    
    aliasName - The alias name of specified deriving sub-query. (NotNull)
    
    戻り値:
    
    The info of specified deriving sub-query. (NullAlowed: if not found)
  - getSpecifiedDerivingColumnInfo
```
ColumnInfo getSpecifiedDerivingColumnInfo(String aliasName)
```
    Get the info of column for specified deriving sub-query by the alias name.
    
    パラメータ:
    
    aliasName - The alias name of specified deriving sub-query. (NotNull)
    
    戻り値:
    
    The info of column. (NullAlowed: if not found)
  - clearSpecifiedDerivingSubQuery
```
void clearSpecifiedDerivingSubQuery()
```
    Clear specified deriving sub-query.
  - getSpecifiedDerivingColumnAsOne
```
SpecifiedColumn getSpecifiedDerivingColumnAsOne()
```
    Get the specified column for specified deriving sub-query as specified one.
    
    戻り値:
    
    The instance as specified column. (NullAlowed: if not found or not one)
  - getSpecifiedDerivingColumnInfoAsOne
```
ColumnInfo getSpecifiedDerivingColumnInfoAsOne()
```
    Get the info of column for specified deriving sub-query as specified one.
    
    戻り値:
    
    The instance as column info. (NullAlowed: if not found or not one)
  - getSpecifiedDerivingAliasNameAsOne
```
String getSpecifiedDerivingAliasNameAsOne()
```
    Get the alias name for specified deriving sub-query as specified one.
    
    戻り値:
    
    The string for the alias name. (NullAlowed: if not found or not one)
  - getSpecifiedDerivingSubQueryAsOne
```
String getSpecifiedDerivingSubQueryAsOne()
```
    Get the clause of specified deriving sub-query as specified one.
    
    戻り値:
    
    The string for the clause. (NullAlowed: if not found or not one)
  - getSpecifiedResolvedColumnSqlNameAsOne
```
ColumnSqlName getSpecifiedResolvedColumnSqlNameAsOne()
```
    Get the SQL name of definition resolved column (specified or deriving) as specified one.
    
    戻り値:
    
    The object of SQL name. (NullAllowed: if not found or not one)
  - getSpecifiedResolvedColumnRealNameAsOne
```
ColumnRealName getSpecifiedResolvedColumnRealNameAsOne()
```
    Get the real name of sub-query resolved column (specified or deriving) as specified one.
    And the SpecifyCalculation is resolved here.
    
    戻り値:
    
    The object of real name. (NullAllowed: if not found or not one)
  - checkNullOrEmptyQuery
```
void checkNullOrEmptyQuery()
```
    Check null-or-empty query.
    The default is ignored, but public default is checked by DBFluteConfig
  - ignoreNullOrEmptyQuery
```
void ignoreNullOrEmptyQuery()
```
    Ignore null-or-empty query.
  - isNullOrEmptyQueryChecked
```
boolean isNullOrEmptyQueryChecked()
```
    Is null-or-empty query checked?
    
    戻り値:
    
    The determination, true or false.
  - getInvalidQueryList
```
List<HpInvalidQueryInfo> getInvalidQueryList()
```
    Get the list of invalid query. (basically for logging)
    
    戻り値:
    
    The list of invalid query. (NotNull, ReadOnly)
  - saveInvalidQuery
```
void saveInvalidQuery(HpInvalidQueryInfo invalidQueryInfo)
```
    Save the invalid query.
    
    パラメータ:
    
    invalidQueryInfo - The information of invalid query. (NotNull)
  - enableEmptyStringQuery
```
void enableEmptyStringQuery()
```
    Enable empty string query (means allowed). (default is disabled, means checked)
  - disableEmptyStringQuery
```
void disableEmptyStringQuery()
```
    Disable empty string query. (back to default)
  - isEmptyStringQueryAllowed
```
boolean isEmptyStringQueryAllowed()
```
    Is empty string allowed?
    
    戻り値:
    
    The determination, true or false.
  - enableOverridingQuery
```
void enableOverridingQuery()
```
    Enable overriding query (means allowed). (default is disabled, means checked)
  - disableOverridingQuery
```
void disableOverridingQuery()
```
    Disable overriding query. (back to default)
  - isOverridingQueryAllowed
```
boolean isOverridingQueryAllowed()
```
    Is overriding query allowed?
    
    戻り値:
    
    The determination, true or false.
  - classifySelectClauseType
```
void classifySelectClauseType(SelectClauseType selectClauseType)
```
    Classify the type of select clause into specified type.
    
    パラメータ:
    
    selectClauseType - The type of select clause. (NotNull)
  - rollbackSelectClauseType
```
void rollbackSelectClauseType()
```
    Roll-back the type of select clause into previous one. If it has no change, classify its type into default type.
  - getColumnQueryObjectMap
```
Map<String,Object> getColumnQueryObjectMap()
```
    Get the map for ColumnQuery objects for parameter comment. {Internal}
    
    戻り値:
    
    The map for ColumnQuery objects. (NullAllowed: if null, means no object)
  - registerColumnQueryObjectToThemeList
```
String registerColumnQueryObjectToThemeList(String themeKey,
                                            Object addedValue)
```
    Register ColumnQuery object to theme list. {Internal}
    
    パラメータ:
    
    themeKey - The key for the object. (NotNull)
    
    addedValue - The value added to theme list for the object. (NotNull)
    
    戻り値:
    
    The expression for binding. (NotNull)
  - getManualOrderParameterMap
```
Map<String,Object> getManualOrderParameterMap()
```
    Get the map for ManualOrder parameters for parameter comment. {Internal}
    
    戻り値:
    
    The map for ManualOrder parameters. (NullAllowed: if null, means no parameter)
  - registerManualOrderParameterToThemeList
```
String registerManualOrderParameterToThemeList(String themeKey,
                                               Object addedValue)
```
    Register ManualOrder parameter to theme list. {Internal}
    
    パラメータ:
    
    themeKey - The theme as key for the parameter. (NotNull)
    
    addedValue - The value added to theme list for the parameter. (NullAllowed)
    
    戻り値:
    
    The expression for binding. (NotNull)
  - getFreeParameterMap
```
Map<String,Object> getFreeParameterMap()
```
    Get the map for free parameters for parameter comment. {Internal}
    
    戻り値:
    
    The map for free parameters. (NullAllowed: if null, means no parameter)
  - registerFreeParameterToThemeList
```
String registerFreeParameterToThemeList(String themeKey,
                                        Object addedValue)
```
    Register free parameter to theme list. {Internal}
    
    パラメータ:
    
    themeKey - The theme as key for the parameter. (NotNull)
    
    addedValue - The value added to theme list for the parameter. (NullAllowed)
    
    戻り値:
    
    The expression for binding. (NotNull)
  - getGearedCipherManager
```
GearedCipherManager getGearedCipherManager()
```
    Get the manager of geared cipher.
    
    戻り値:
    
    The instance of manager. (NullAllowed: when no geared cipher)
  - findColumnFunctionCipher
```
ColumnFunctionCipher findColumnFunctionCipher(ColumnInfo columnInfo)
```
    Find the cipher for the column.
    
    パラメータ:
    
    columnInfo - The column info for cipher. (NotNull)
    
    戻り値:
    
    The cipher for the column. (NullAllowed: when no geared cipher or the column is not cipher target)
  - enableSelectColumnCipher
```
void enableSelectColumnCipher()
```
    Enable select column cipher effective.
    The default is enabled (if cipher manager is set) so this method is called after disabling.
  - disableSelectColumnCipher
```
void disableSelectColumnCipher()
```
    Disable select column cipher effective.
    basically for queryInsert().
  - acceptScalarSelectOption
```
void acceptScalarSelectOption(ScalarSelectOption option)
```
    Accept the option of scalar-select.
    
    パラメータ:
    
    option - The instance of option object. (NullAllowed: if null, also clear existing option)
  - enablePagingAdjustment
```
void enablePagingAdjustment()
```
    Enable paging adjustment, e.g. PagingCountLater, PagingCountLeastJoin, effective.
    The options might be on by default so the adjustments are off normally.
  - disablePagingAdjustment
```
void disablePagingAdjustment()
```
    Disable paging adjustment.
  - enablePagingCountLater
```
void enablePagingCountLater()
```
    Enable paging count-later that means counting after selecting.
    And you should also make paging adjustment effective to enable this.
    This option is copy of condition-bean's one for clause adjustment, e.g. MySQL found_rows().
    The default is disabled, but public default is enabled by DBFluteConfig.
  - disablePagingCountLater
```
void disablePagingCountLater()
```
    Disable paging count-later that means counting after selecting.
    You should call this before execution of selectPage().
  - enablePagingCountLeastJoin
```
void enablePagingCountLeastJoin()
```
    Enable paging count-least-join, which means least joined on count select.
    And you should also make paging adjustment effective to enable this.
    The default is disabled, but public default is enabled by DBFluteConfig.
  - disablePagingCountLeastJoin
```
void disablePagingCountLeastJoin()
```
    Disable paging count-least-join, which means least joined on count select.
    You should call this before execution of selectPage().
  - canPagingCountLeastJoin
```
boolean canPagingCountLeastJoin()
```
    Can it be paging count least join?
    
    戻り値:
    
    The determination, true or false.
  - enablePKOnlySelectForcedly
```
void enablePKOnlySelectForcedly()
```
    Enable PK only select forcedly effective, ignoring select clause setting and derived referrer.
    Basically for PagingSelectAndQuerySplit.
  - disablePKOnlySelectForcedly
```
void disablePKOnlySelectForcedly()
```
    Disable PK only select forcedly.
    Basically for PagingSelectAndQuerySplit.
  - registerClauseLazyReflector
```
void registerClauseLazyReflector(ClauseLazyReflector clauseLazyReflector)
```
    Register the lazy reflector of clause.
    
    パラメータ:
    
    clauseLazyReflector - The instance of reflector. (NotNull)
  - getClauseQueryInsert
```
String getClauseQueryInsert(Map<String,String> fixedValueQueryExpMap,
                            SqlClause resourceSqlClause)
```
    パラメータ:
    
    fixedValueQueryExpMap - The map of query expression for fixed values. (NotNull)
    
    resourceSqlClause - The SQL clause for resource. (NotNull)
    
    戻り値:
    
    The clause of query-insert. (NotNull)
  - getClauseQueryUpdate
```
String getClauseQueryUpdate(Map<String,Object> columnParameterMap)
```
    パラメータ:
    
    columnParameterMap - The map of column parameters. The parameter may be handler. (NotNull)
    
    戻り値:
    
    The clause of query-update. (NullAllowed: If columnParameterMap is empty, return null)
  - getClauseQueryDelete
```
String getClauseQueryDelete()
```
    戻り値:
    
    The clause of query-delete. (NotNull)
  - enableQueryUpdateForcedDirect
```
void enableQueryUpdateForcedDirect()
```
    Enable to use direct clause in query update forcedly (contains query delete). You cannot use join, sub-query, union and so on, by calling this.
    So you may have the painful SQLException by this, attention!
  - getPurpose
```
HpCBPurpose getPurpose()
```
    Get the purpose of the condition-bean. e.g. NORMAL_USE, EXISTS_REFERRER
    
    戻り値:
    
    The instance of purpose object for condition-bean. (NotNull)
  - setPurpose
```
void setPurpose(HpCBPurpose purpose)
```
    Set the purpose of the condition-bean. e.g. NORMAL_USE, EXISTS_REFERRER
    
    パラメータ:
    
    purpose - The instance of purpose object for condition-bean. (NotNull)
  - isLocked
```
boolean isLocked()
```
    Is the clause object locked? e.g. true if in sub-query process and check allowed
    Java8 cannot use the same name as lambda argument with already existing name in the scope.
```
 cb.query().existsPurchaseList(subCB -> {
     subCB.query().existsPurchaseDetailList(subCB -> { // *NG
     });
 });
 
```
    You should rename it, however the other condition-bean might be called. So it is necessary to check it, and condition-bean has lock.
    
    While, you can suppress it by option for compatible. (if suppressed, always returns false)
    戻り値:
    
    The determination, true or false.
  - lock
```
void lock()
```
    Lock the clause object.
    Only saving lock status here, you should rightly check by this status.
  - unlock
```
void unlock()
```
    Unlock the clause object.
  - enableThatsBadTimingDetect
```
void enableThatsBadTimingDetect()
```
    Enable "that's-bad-timing" detect.
  - disableThatsBadTimingDetect
```
void disableThatsBadTimingDetect()
```
    Disable "that's-bad-timing" detect for compatible.
    If disabled, isLocked() always returns false.
  - isThatsBadTimingDetectAllowed
```
boolean isThatsBadTimingDetectAllowed()
```
    Does it allow "that's-bad-timing" detect?
    
    戻り値:
    
    The determination, true or false.
  - getInScopeLimit
```
int getInScopeLimit()
```
    Get the limit of inScope.
    
    戻り値:
    
    The limit of inScope. (If it's zero or minus, it means no limit)
  - adjustLikeSearchDBWay
```
void adjustLikeSearchDBWay(LikeSearchOption option)
```
    Adjust like-search of DB way.
    
    パラメータ:
    
    option - The option of like-search to adjust. (NotNull)
  - isCursorSelectByPagingAllowed
```
boolean isCursorSelectByPagingAllowed()
```
    Is cursor select by paging allowed?
    
    戻り値:
    
    The determination, true or false.
  - useInScopeSubQueryForExistsReferrer
```
void useInScopeSubQueryForExistsReferrer()
```
    Use in-scope sub-query for exists-referrer. (save-only attribute)
  - isUseInScopeSubQueryForExistsReferrer
```
boolean isUseInScopeSubQueryForExistsReferrer()
```
    Does it use in-scope sub-query for exists-referrer?
    
    戻り値:
    
    The determination, true or false.
  - enableColumnNullObject
```
void enableColumnNullObject()
```
    Enable the handling of column null object. (default is disabled)
  - disableColumnNullObject
```
void disableColumnNullObject()
```
    Disable the handling of column null object. (back to default)
  - isColumnNullObjectAllowed
```
boolean isColumnNullObjectAllowed()
```
    Is the handling of column null object enabled?
    
    戻り値:
    
    The determination, true or false.
  - enableColumnNullObjectGearedToSpecify
```
void enableColumnNullObjectGearedToSpecify()
```
    Enable the handling of column null object geared to specify. (default is disabled, means checked)
  - disableColumnNullObjectGearedToSpecify
```
void disableColumnNullObjectGearedToSpecify()
```
    Disable the handling of column null object geared to specify. (back to default)
  - getLocalSpecifiedNullObjectColumnSet
```
Set<ColumnInfo> getLocalSpecifiedNullObjectColumnSet()
```
    Get the set of column specified as null object for the local table.
    Basically for synchronization with non-specified access check.
    
    戻り値:
    
    The set of column info. (NotNull, EmptyAllowed)
  - getRelationSpecifiedNullObjectColumnSet
```
Set<ColumnInfo> getRelationSpecifiedNullObjectColumnSet(String relationNoSuffix)
```
    Get the set of column specified as null object for the relation.
    Basically for synchronization with non-specified access check.
    
    パラメータ:
    
    relationNoSuffix - The suffix of relation No, same as foreign relation path. (NotNull)
    
    戻り値:
    
    The set of column info. (NotNull, EmptyAllowed)
  - dbway
```
DBWay dbway()
```
    Get the DB way for this SQL clause.
    
    戻り値:
    
    The instance of DB way. (NotNull)

インタフェース SqlClause

ネストされたクラスのサマリー

フィールドのサマリー

メソッドのサマリー

フィールドの詳細

RELATION_PATH_DELIMITER

BASE_POINT_ALIAS_NAME

BASE_POINT_HANDLING_ENTITY_NO

メソッドの詳細

getSubQueryLevel

setupForSubQuery

isForSubQuery

getClause

getClauseFromWhereWithUnionTemplate

getClauseFromWhereWithWhereUnionTemplate

getSelectClause

getSelectIndexMap

getSelectColumnKeyNameMap

changeAliasNameLimitSize

disableSelectIndex

getSelectHint

getFromClause

getFromBaseTableHint

getFromHint

getWhereClause

getOrderByClause

getSqlSuffix

registerSelectedRelation

translateSelectedRelationPathToPropName

translateSelectedRelationPathToTableAlias

getSelectedRelationCount

isSelectedRelationEmpty

hasSelectedRelation

getSelectedRelationColumnMap

isSelectedNextConnectingRelation

registerOuterJoin

registerOuterJoinFixedInline

registerFixedConditionLazyChecker

getOuterJoinMap

hasOuterJoin

canUseRelationCache

isUnderOverRelation

changeToInnerJoin

enableInnerJoinAutoDetect

disableInnerJoinAutoDetect

enableStructuralPossibleInnerJoin

disableStructuralPossibleInnerJoin

isStructuralPossibleInnerJoinEnabled

enableWhereUsedInnerJoin

disableWhereUsedInnerJoin

isWhereUsedInnerJoinEnabled

registerWhereClause

registerWhereClause

registerWhereClause

registerWhereClause

reflectWhereUsedToJoin

exchangeFirstWhereClauseForLastOne

hasWhereClauseOnBaseQuery

backupWhereClauseOnBaseQuery

restoreWhereClauseOnBaseQuery

clearWhereClauseOnBaseQuery

registerBaseTableInlineWhereClause

registerBaseTableInlineWhereClause

hasBaseTableInlineWhereClause

clearBaseTableInlineWhereClause

registerOuterJoinInlineWhereClause

registerOuterJoinInlineWhereClause

hasOuterJoinInlineWhereClause

clearOuterJoinInlineWhereClause

beginOrScopeQuery

endOrScopeQuery

beginOrScopeQueryAndPart

endOrScopeQueryAndPart

isOrScopeQueryEffective

isOrScopeQueryAndPartEffective

getOrderByComponent

getOrderByLastElement

clearOrderBy

suppressOrderBy

reviveOrderBy