org.dbflute.cbean.ckey

クラス ConditionKey

java.lang.Object

org.dbflute.cbean.ckey.ConditionKey

すべての実装されたインタフェース:

Serializable

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

ConditionKeyEqual, ConditionKeyGreaterEqual, ConditionKeyGreaterThan, ConditionKeyInScope, ConditionKeyIsNotNull, ConditionKeyIsNull, ConditionKeyLessEqual, ConditionKeyLessThan, ConditionKeyLikeSearch, ConditionKeyNotEqual, ConditionKeyNotInScope

public abstract class ConditionKey
extends Object
implements Serializable

The abstract class of condition-key.

作成者:

jflute

関連項目:

直列化された形式

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

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	ConditionKey.BindClauseResult

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected String	_conditionKey The key name of the condition.
protected String	_operand The string of operand, used in SQL.
static ConditionKey	CK_EQUAL The condition key of equal.
static ConditionKey	CK_GREATER_EQUAL The condition key of greaterEqual.
static ConditionKey	CK_GREATER_EQUAL_OR_IS_NULL The condition key of greaterEqual with orIsNull.
static ConditionKey	CK_GREATER_THAN The condition key of greaterThan.
static ConditionKey	CK_GREATER_THAN_OR_IS_NULL The condition key of greaterThan with orIsNull.
static ConditionKey	CK_IN_SCOPE The condition key of inScope.
static ConditionKey	CK_IS_NOT_NULL The condition key of isNotNull.
static ConditionKey	CK_IS_NULL The condition key of isNull.
static ConditionKey	CK_IS_NULL_OR_EMPTY The condition key of isNullOrEmpty.
static ConditionKey	CK_LESS_EQUAL The condition key of lessEqual.
static ConditionKey	CK_LESS_EQUAL_OR_IS_NULL The condition key of lessEqual with orIsNull.
static ConditionKey	CK_LESS_THAN The condition key of lessThan.
static ConditionKey	CK_LESS_THAN_OR_IS_NULL The condition key of lessThan with orIsNull.
static ConditionKey	CK_LIKE_SEARCH The condition key of likeSearch.
static ConditionKey	CK_NOT_EQUAL_STANDARD The condition key of notEqual as standard.
static ConditionKey	CK_NOT_EQUAL_TRADITION The condition key of notEqual as tradition.
static ConditionKey	CK_NOT_IN_SCOPE The condition key of notInScope.
static ConditionKey	CK_NOT_LIKE_SEARCH The condition key of notLikeSearch.
protected static Object	DUMMY_OBJECT Dummy-object for IsNull and IsNotNull and so on...
protected static ConditionKeyPrepareResult	RESULT_DUPLICATE_QUERY
protected static ConditionKeyPrepareResult	RESULT_INVALID_QUERY
protected static ConditionKeyPrepareResult	RESULT_NEW_QUERY
protected static ConditionKeyPrepareResult	RESULT_OVERRIDING_QUERY

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

コンストラクタ

コンストラクタと説明
ConditionKey()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addWhereClause(ConditionValue.QueryModeProvider provider, List<QueryClause> conditionList, ColumnRealName columnRealName, ConditionValue cvalue, ColumnFunctionCipher cipher, ConditionOption option) Add where clause.
protected QueryClause	buildBindClause(ColumnRealName columnRealName, String location, ColumnFunctionCipher cipher, ConditionOption option) Build bind clause.
protected QueryClause	buildBindClauseOrIsNull(ColumnRealName columnRealName, String location, ColumnFunctionCipher cipher, ConditionOption option) Build bind clause with orIsNull condition.
protected String	buildBindVariableExp(String location, ConditionOption option)
protected QueryClause	buildClauseWithoutValue(ColumnRealName columnRealName) Build clause without value.
protected ConditionKeyPrepareResult	chooseResultAlreadyExists(boolean equalValue)
protected ConditionKeyPrepareResult	chooseResultListQuery(Object value)
protected ConditionKeyPrepareResult	chooseResultNonFixedQuery(Object value)
protected ConditionKeyPrepareResult	chooseResultNonValue(ConditionValue cvalue)
protected ConditionKey.BindClauseResult	createBindClauseResult(ColumnRealName columnExp, String bindExp, ConditionOption option)
protected abstract void	doAddWhereClause(List<QueryClause> conditionList, ColumnRealName columnRealName, ConditionValue cvalue, ColumnFunctionCipher cipher, ConditionOption option) Do adding where clause.
protected String	doBuildBindClause(ColumnRealName columnRealName, String location, ColumnFunctionCipher cipher, ConditionOption option)
protected abstract ConditionKeyPrepareResult	doPrepareQuery(ConditionValue cvalue, Object value)
protected ColumnRealName	doResolveCompoundColumn(ConditionOption option, SpecifiedColumn specifiedColumn)
protected abstract void	doSetupConditionValue(ConditionValue cvalue, Object value, String location, ConditionOption option) Do setting up condition value.
protected String	extractExtOperand(ConditionOption option)
protected String	getBindVariableDummyValue()
String	getConditionKey() Get condition-key.
String	getOperand() Get operand.
protected boolean	hasCalculationColumn(ColumnRealName columnRealName, ConditionOption option)
protected boolean	hasColumnCollaboration(ColumnRealName columnRealName, ConditionOption option)
protected boolean	hasCompoundColumn(ColumnRealName columnRealName, ConditionOption option)
protected boolean	isBindEncryptAllowed(ColumnRealName columnRealName, ConditionOption option, boolean nonInvertible)
protected boolean	isInvalidListQuery(Object value)
protected boolean	isInvalidNonFixedQuery(Object value)
abstract boolean	isNullaleKey() Is the condition key null-able?
protected boolean	isOutOfBindEncryptConditionKey()
protected boolean	isPossibleBindEncryptConditionKey()
protected abstract boolean	needsOverrideValue(ConditionValue cvalue) Does it need to override the existing value to register the value?
ConditionKeyPrepareResult	prepareQuery(ConditionValue.QueryModeProvider provider, ConditionValue cvalue, Object value) Prepare the query of the condition value to register the condition.
protected ConditionKey.BindClauseResult	resolveBindClause(ColumnRealName columnRealName, String location, ColumnFunctionCipher cipher, ConditionOption option)
protected ColumnRealName	resolveCalculationColumn(ColumnRealName columnRealName, ConditionOption option)
protected ColumnRealName	resolveCompoundColumn(ColumnRealName baseRealName, ConditionOption option)
protected String	resolveOperand(ConditionOption option)
protected ColumnRealName	resolveOptionalColumn(ColumnRealName columnExp, ConditionOption option)
protected String	resolveRearOption(ConditionOption option)
protected QueryClauseArranger	resolveWhereClauseArranger(ConditionOption option)
void	setupConditionValue(ConditionValue.QueryModeProvider provider, ConditionValue cvalue, Object value, String location, ConditionOption option) Setup condition value.
protected ColumnRealName	toColumnRealName(String columnSqlName)
String	toString()

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

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

フィールドの詳細

CK_EQUAL

public static final ConditionKey CK_EQUAL

The condition key of equal.

CK_NOT_EQUAL_STANDARD

public static final ConditionKey CK_NOT_EQUAL_STANDARD

The condition key of notEqual as standard.

CK_NOT_EQUAL_TRADITION

public static final ConditionKey CK_NOT_EQUAL_TRADITION

The condition key of notEqual as tradition.

CK_GREATER_THAN

public static final ConditionKey CK_GREATER_THAN

The condition key of greaterThan.

CK_GREATER_THAN_OR_IS_NULL

public static final ConditionKey CK_GREATER_THAN_OR_IS_NULL

The condition key of greaterThan with orIsNull.

CK_LESS_THAN

public static final ConditionKey CK_LESS_THAN

The condition key of lessThan.

CK_LESS_THAN_OR_IS_NULL

public static final ConditionKey CK_LESS_THAN_OR_IS_NULL

The condition key of lessThan with orIsNull.

CK_GREATER_EQUAL

public static final ConditionKey CK_GREATER_EQUAL

The condition key of greaterEqual.

CK_GREATER_EQUAL_OR_IS_NULL

public static final ConditionKey CK_GREATER_EQUAL_OR_IS_NULL

The condition key of greaterEqual with orIsNull.

CK_LESS_EQUAL

public static final ConditionKey CK_LESS_EQUAL

The condition key of lessEqual.

CK_LESS_EQUAL_OR_IS_NULL

public static final ConditionKey CK_LESS_EQUAL_OR_IS_NULL

The condition key of lessEqual with orIsNull.

CK_IN_SCOPE

public static final ConditionKey CK_IN_SCOPE

The condition key of inScope.

CK_NOT_IN_SCOPE

public static final ConditionKey CK_NOT_IN_SCOPE

The condition key of notInScope.

CK_LIKE_SEARCH

public static final ConditionKey CK_LIKE_SEARCH

The condition key of likeSearch.

CK_NOT_LIKE_SEARCH

public static final ConditionKey CK_NOT_LIKE_SEARCH

The condition key of notLikeSearch.

CK_IS_NULL

public static final ConditionKey CK_IS_NULL

The condition key of isNull.

CK_IS_NULL_OR_EMPTY

public static final ConditionKey CK_IS_NULL_OR_EMPTY

The condition key of isNullOrEmpty.

CK_IS_NOT_NULL

public static final ConditionKey CK_IS_NOT_NULL

The condition key of isNotNull.

DUMMY_OBJECT

protected static final Object DUMMY_OBJECT

Dummy-object for IsNull and IsNotNull and so on...

RESULT_NEW_QUERY

protected static final ConditionKeyPrepareResult RESULT_NEW_QUERY

RESULT_INVALID_QUERY

protected static final ConditionKeyPrepareResult RESULT_INVALID_QUERY

RESULT_OVERRIDING_QUERY

protected static final ConditionKeyPrepareResult RESULT_OVERRIDING_QUERY

RESULT_DUPLICATE_QUERY

protected static final ConditionKeyPrepareResult RESULT_DUPLICATE_QUERY

_conditionKey

protected String _conditionKey

The key name of the condition. (NotNull: initialized in constructor of sub-class)

_operand

protected String _operand

The string of operand, used in SQL. (NotNull: initialized in constructor of sub-class)

コンストラクタの詳細

ConditionKey

public ConditionKey()

メソッドの詳細

prepareQuery

public ConditionKeyPrepareResult prepareQuery(ConditionValue.QueryModeProvider provider,
                                              ConditionValue cvalue,
                                              Object value)

Prepare the query of the condition value to register the condition.

パラメータ:

provider - The provider of query mode. (NotNull)

cvalue - The object of condition value. (NotNull)

value - The value of the condition. (NotNull)

戻り値:

The result of the preparation for the condition key. (NotNull)

doPrepareQuery

protected abstract ConditionKeyPrepareResult doPrepareQuery(ConditionValue cvalue,
                                                            Object value)

chooseResultAlreadyExists

protected ConditionKeyPrepareResult chooseResultAlreadyExists(boolean equalValue)

chooseResultNonValue

protected ConditionKeyPrepareResult chooseResultNonValue(ConditionValue cvalue)

chooseResultNonFixedQuery

protected ConditionKeyPrepareResult chooseResultNonFixedQuery(Object value)

isInvalidNonFixedQuery

protected boolean isInvalidNonFixedQuery(Object value)

chooseResultListQuery

protected ConditionKeyPrepareResult chooseResultListQuery(Object value)

isInvalidListQuery

protected boolean isInvalidListQuery(Object value)

needsOverrideValue

protected abstract boolean needsOverrideValue(ConditionValue cvalue)

Does it need to override the existing value to register the value?
This should be called in CallbackProcessor for e.g. in-line query

パラメータ:

cvalue - The object of condition value. (NotNull)

戻り値:

The determination, true or false.

addWhereClause

public void addWhereClause(ConditionValue.QueryModeProvider provider,
                           List<QueryClause> conditionList,
                           ColumnRealName columnRealName,
                           ConditionValue cvalue,
                           ColumnFunctionCipher cipher,
                           ConditionOption option)

Add where clause.

パラメータ:

provider - The provider of query mode. (NotNull)

conditionList - The list of condition. (NotNull)

columnRealName - The real name of column. (NotNull)

cvalue - The object of condition value. (NotNull)

cipher - The cipher of column by function. (NullAllowed)

option - The option of condition. (NullAllowed)

doAddWhereClause

protected abstract void doAddWhereClause(List<QueryClause> conditionList,
                                         ColumnRealName columnRealName,
                                         ConditionValue cvalue,
                                         ColumnFunctionCipher cipher,
                                         ConditionOption option)

Do adding where clause.

パラメータ:

conditionList - The list of condition. (NotNull)

columnRealName - The real name of column. (NotNull)

cvalue - The object of condition value. (NotNull)

cipher - The cipher of column by function. (NullAllowed)

option - The option of condition. (NullAllowed)

setupConditionValue

public void setupConditionValue(ConditionValue.QueryModeProvider provider,
                                ConditionValue cvalue,
                                Object value,
                                String location,
                                ConditionOption option)

Setup condition value.

パラメータ:

provider - The provider of query mode. (NotNull)

cvalue - The object of condition value. (NotNull)

value - The native value of condition. (NullAllowed)

location - The location on parameter comment. (NotNull)

option - Condition option. (NullAllowed)

doSetupConditionValue

protected abstract void doSetupConditionValue(ConditionValue cvalue,
                                              Object value,
                                              String location,
                                              ConditionOption option)

Do setting up condition value.

パラメータ:

cvalue - The object of condition value. (NotNull)

value - The native value of condition. (NullAllowed)

location - The location on parameter comment. (NotNull)

option - The option of condition. (NullAllowed)

buildBindClause

protected QueryClause buildBindClause(ColumnRealName columnRealName,
                                      String location,
                                      ColumnFunctionCipher cipher,
                                      ConditionOption option)

Build bind clause.

パラメータ:

columnRealName - The real name of column. (NotNull)

location - The location on parameter comment. (NotNull)

cipher - The cipher of column by function. (NullAllowed)

option - The option of condition. (NullAllowed)

戻り値:

The query clause as bind clause. (NotNull)

buildBindClauseOrIsNull

protected QueryClause buildBindClauseOrIsNull(ColumnRealName columnRealName,
                                              String location,
                                              ColumnFunctionCipher cipher,
                                              ConditionOption option)

Build bind clause with orIsNull condition.

パラメータ:

columnRealName - The real name of column. (NotNull)

location - The location on parameter comment. (NotNull)

cipher - The cipher of column by function. (NullAllowed)

option - The option of condition. (NullAllowed)

戻り値:

The query clause as bind clause. (NotNull)

doBuildBindClause

protected String doBuildBindClause(ColumnRealName columnRealName,
                                   String location,
                                   ColumnFunctionCipher cipher,
                                   ConditionOption option)

buildClauseWithoutValue

protected QueryClause buildClauseWithoutValue(ColumnRealName columnRealName)

Build clause without value. (basically for isNull, isNotNull)

パラメータ:

columnRealName - The real name of column. (NotNull)

戻り値:

The query clause as bind clause. (NotNull)

resolveBindClause

protected ConditionKey.BindClauseResult resolveBindClause(ColumnRealName columnRealName,
                                                          String location,
                                                          ColumnFunctionCipher cipher,
                                                          ConditionOption option)

isBindEncryptAllowed

protected boolean isBindEncryptAllowed(ColumnRealName columnRealName,
                                       ConditionOption option,
                                       boolean nonInvertible)

buildBindVariableExp

protected String buildBindVariableExp(String location,
                                      ConditionOption option)

getBindVariableDummyValue

protected String getBindVariableDummyValue()

isOutOfBindEncryptConditionKey

protected boolean isOutOfBindEncryptConditionKey()

isPossibleBindEncryptConditionKey

protected boolean isPossibleBindEncryptConditionKey()

toColumnRealName

protected ColumnRealName toColumnRealName(String columnSqlName)

createBindClauseResult

protected ConditionKey.BindClauseResult createBindClauseResult(ColumnRealName columnExp,
                                                               String bindExp,
                                                               ConditionOption option)

resolveOperand

protected String resolveOperand(ConditionOption option)

extractExtOperand

protected String extractExtOperand(ConditionOption option)

resolveRearOption

protected String resolveRearOption(ConditionOption option)

resolveWhereClauseArranger

protected QueryClauseArranger resolveWhereClauseArranger(ConditionOption option)

resolveOptionalColumn

protected ColumnRealName resolveOptionalColumn(ColumnRealName columnExp,
                                               ConditionOption option)

hasColumnCollaboration

protected boolean hasColumnCollaboration(ColumnRealName columnRealName,
                                         ConditionOption option)

hasCalculationColumn

protected boolean hasCalculationColumn(ColumnRealName columnRealName,
                                       ConditionOption option)

resolveCalculationColumn

protected ColumnRealName resolveCalculationColumn(ColumnRealName columnRealName,
                                                  ConditionOption option)

hasCompoundColumn

protected boolean hasCompoundColumn(ColumnRealName columnRealName,
                                    ConditionOption option)

resolveCompoundColumn

protected ColumnRealName resolveCompoundColumn(ColumnRealName baseRealName,
                                               ConditionOption option)

doResolveCompoundColumn

protected ColumnRealName doResolveCompoundColumn(ConditionOption option,
                                                 SpecifiedColumn specifiedColumn)

isNullaleKey

public abstract boolean isNullaleKey()

Is the condition key null-able? (basically for join determination)

戻り値:

The determination, true or false.

toString

public String toString()

オーバーライド:

toString クラス内 Object

戻り値:

View-string of condition key information.

getConditionKey

public String getConditionKey()

Get condition-key.

戻り値:

Condition-key.

getOperand

public String getOperand()

Get operand.

戻り値:

Operand.