org.dbflute.cbean.coption

クラス FunctionFilterOption

java.lang.Object

org.dbflute.cbean.coption.FunctionFilterOption

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

ParameterOption

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

ColumnConversionOption, DerivedReferrerOption, ScalarSelectOption

public class FunctionFilterOption
extends Object
implements ParameterOption

The option to filter by function.
You can filter an aggregate function by scalar function filters.

作成者:

jflute

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

ネストされたクラス

修飾子とタイプ	クラスと説明
protected static interface	FunctionFilterOption.ProcessCallback

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Map<String,Object>	_bindMap
protected List<FunctionFilterOption.ProcessCallback>	_callbackList
protected boolean	_databaseDB2
protected boolean	_databaseDerby
protected boolean	_databaseH2
protected boolean	_databaseMySQL
protected boolean	_databaseOracle
protected boolean	_databasePostgreSQL
protected boolean	_databaseSQLServer
protected boolean	_mayNullRevived
protected Object	_mysticBindingSnapshot
protected String	_parameterKey
protected String	_parameterMapPath
protected boolean	_removeCalcAlias
protected ColumnInfo	_targetColumnInfo
protected TimeZone	_timeZone The time-zone for filtering.
protected Object	_tmpTrunc
protected static String	DATE_TRUNC_DAY
protected static String	DATE_TRUNC_MONTH
protected static String	DATE_TRUNC_TIME

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	acceptParameterKey(String parameterKey, String parameterMapPath)
protected void	addProcessCallback(String functionKey, FunctionFilterOption.ProcessCallback callback)
protected void	assertCalculationColumnNumber(SpecifiedColumn specifiedColumn)
protected void	assertObjectNotNull(String variableName, Object value) Assert that the object is not null.
protected void	assertOptionValueNotNull(String keyword, Object value)
protected void	assertSpecifiedDreamCruiseTicket(SpecifiedColumn column)
protected String	buildAddedBindParameter(int index, Object addedValue, String propertyName)
protected String	buildAddedEmbeddedValueExp(Object addedValue)
protected String	buildBindParameter(Object bindKey)
protected String	buildDateAddExpType(String propertyName, String prefix, boolean plural)
protected String	buildDreamCruiseTicketStatement(Object value)
QueryDerivedReferrer	createQueryDerivedReferrer(SubQueryPath subQueryPath, ColumnRealNameProvider localRealNameProvider, ColumnSqlNameProvider subQuerySqlNameProvider, int subQueryLevel, SqlClause subQueryClause, String subQueryIdentity, DBMeta subQueryDBMeta, GearedCipherManager cipherManager, String mainSubQueryIdentity, String operand, Object value, String parameterPath)
SpecifyDerivedReferrer	createSpecifyDerivedReferrer(SubQueryPath subQueryPath, ColumnRealNameProvider localRealNameProvider, ColumnSqlNameProvider subQuerySqlNameProvider, int subQueryLevel, SqlClause subQueryClause, String subQueryIdentity, DBMeta subQueryDBMeta, GearedCipherManager cipherManager, String mainSubQueryIdentity, String aliasName)
protected void	doAddDay(Object addedDay)
protected void	doAddDay(Object addedDay, boolean minus)
protected void	doAddHour(Object addedHour)
protected void	doAddHour(Object addedHour, boolean minus)
protected void	doAddMinute(Object addedMinute)
protected void	doAddMinute(Object addedMinute, boolean minus)
protected void	doAddMonth(Object addedMonth)
protected void	doAddMonth(Object addedMonth, boolean minus)
protected void	doAddSecond(Object addedSecond)
protected void	doAddSecond(Object addedSecond, boolean minus)
protected void	doAddYear(Object addedYear)
protected void	doAddYear(Object addedYear, boolean minus)
protected void	doCoalesce(Object coalesce)
protected String	doProcessDateAdd(String functionExp, int index, Object addedValue, String propertyName, boolean minus)
protected String	doProcessDateAddDB2(String functionExp, int index, Object addedValue, String propertyName, boolean minus)
protected String	doProcessDateAddMySQL(String functionExp, int index, Object addedValue, String propertyName, boolean minus)
protected String	doProcessDateAddOracle(String functionExp, int index, Object addedValue, String propertyName, boolean minus)
protected String	doProcessDateAddPostgreSQL(String functionExp, int index, Object addedValue, String propertyName, boolean minus)
protected String	doProcessDateAddSQLServer(String functionExp, int index, Object addedValue, String propertyName, boolean minus)
protected String	doProcessTruncPurposeDateType(String functionExp)
protected String	doProcessTruncPurposeDateTypeDB2(String functionExp)
protected String	doProcessTruncPurposeDateTypeDefault(String functionExp)
protected String	doProcessTruncPurposeDateTypeMySQL(String functionExp)
protected String	doProcessTruncPurposeDateTypeOracle(String functionExp)
protected String	doProcessTruncPurposeDateTypePostgreSQL(String functionExp)
protected String	doProcessTruncPurposeDateTypeSQLServer(String functionExp)
protected String	doProcessTruncSimpleCase(String functionExp, int index, Object trunc)
protected void	doRound(Object round)
protected void	doTrunc(Object trunc)
protected void	doTruncDay()
protected void	doTruncMonth()
protected void	doTruncTime()
String	filterFunction(String functionExp) Filter the expression of function part.
Map<String,Object>	getBindMap()
protected TimeZone	getDBFluteSystemFinalTimeZone()
TimeZone	getTimeZone() Get the time-zone in this option basically for filtering.
Object	getTrunc()
protected boolean	hasMysticBinding()
protected boolean	hasSubQueryEndOnLastLine(String functionExp)
protected boolean	hasTargetColumnInfo()
protected boolean	isDatabaseDB2()
protected boolean	isDatabaseDerby()
protected boolean	isDatabaseH2()
protected boolean	isDatabaseMySQL()
protected boolean	isDatabaseOracle()
protected boolean	isDatabasePostgreSQL()
protected boolean	isDatabaseSQLServer()
protected boolean	isDateTruncDay()
protected boolean	isDateTruncMonth()
protected boolean	isDateTruncTime()
protected boolean	isDateTypeColumn()
protected boolean	isDreamCruiseTicket(Object value)
protected boolean	isJustDateTypeColumn()
protected boolean	isJustTimestampTypeColumn()
protected boolean	isJustTimeTypeColumn()
protected boolean	isOptionValueNullIgnored()
protected boolean	isPropertyAddDay(String propertyName)
protected boolean	isPropertyAddHour(String propertyName)
protected boolean	isPropertyAddMinute(String propertyName)
protected boolean	isPropertyAddMonth(String propertyName)
protected boolean	isPropertyAddSecond(String propertyName)
protected boolean	isPropertyAddYear(String propertyName)
protected boolean	isTruncNamedTruncate()
protected String	ln()
boolean	mayNullRevived()
protected String	processAddDay(String functionExp, int index, Object addedDay, boolean minus)
protected String	processAddHour(String functionExp, int index, Object addedHour, boolean minus)
protected String	processAddMinute(String functionExp, int index, Object addedMinute, boolean minus)
protected String	processAddMonth(String functionExp, int index, Object addedMonth, boolean minus)
protected String	processAddSecond(String functionExp, int index, Object addedSecond, boolean minus)
protected String	processAddYear(String functionExp, int index, Object addedYear, boolean minus)
protected String	processCalculation(String functionExp) Process calculation filters defined by sub-class.
protected String	processCoalesce(String functionExp, int index, Object coalesce)
protected String	processRound(String functionExp, int index, Object round)
protected String	processSimpleFunction(String functionExp, String functionName, String thirdArg, boolean leftArg, Object bindKey)
protected String	processTrunc(String functionExp, int index, Object trunc)
protected String	processVarious(String functionExp) Process various filters defined by user.
protected Object	registerBindParameter(int index, Object parameter)
protected void	setDatabaseDB2(boolean databaseDB2)
protected void	setDatabaseDerby(boolean databaseDerby)
protected void	setDatabaseH2(boolean databaseH2)
protected void	setDatabaseMySQL(boolean databaseMySQL)
protected void	setDatabaseOracle(boolean databaseOracle)
protected void	setDatabasePostgreSQL(boolean databasePostgreSQL)
protected void	setDatabaseSQLServer(boolean databaseSQLServer)
String	toString()
Object	xgetMysticBindingSnapshot()
ColumnInfo	xgetTargetColumnInfo()
void	xjudgeDatabase(SqlClause sqlClause)
void	xremoveCalcAlias()
void	xsetMysticBindingSnapshot(Object mysticBindingSnapshot)
void	xsetTargetColumnInfo(ColumnInfo targetColumnInfo)
FunctionFilterOption	zone(TimeZone timeZone) Set time-zone, basically for LocalDate conversion.

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

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

フィールドの詳細

DATE_TRUNC_MONTH

protected static final String DATE_TRUNC_MONTH

関連項目:

定数フィールド値

DATE_TRUNC_DAY

protected static final String DATE_TRUNC_DAY

関連項目:

定数フィールド値

DATE_TRUNC_TIME

protected static final String DATE_TRUNC_TIME

関連項目:

定数フィールド値

_bindMap

protected Map<String,Object> _bindMap

_callbackList

protected List<FunctionFilterOption.ProcessCallback> _callbackList

_parameterKey

protected String _parameterKey

_parameterMapPath

protected String _parameterMapPath

_targetColumnInfo

protected ColumnInfo _targetColumnInfo

_mysticBindingSnapshot

protected Object _mysticBindingSnapshot

_tmpTrunc

protected Object _tmpTrunc

_mayNullRevived

protected boolean _mayNullRevived

_removeCalcAlias

protected boolean _removeCalcAlias

_databaseMySQL

protected boolean _databaseMySQL

_databasePostgreSQL

protected boolean _databasePostgreSQL

_databaseOracle

protected boolean _databaseOracle

_databaseDB2

protected boolean _databaseDB2

_databaseSQLServer

protected boolean _databaseSQLServer

_databaseH2

protected boolean _databaseH2

_databaseDerby

protected boolean _databaseDerby

_timeZone

protected TimeZone _timeZone

The time-zone for filtering. (NullAllowed: if null, default zone)

コンストラクタの詳細

FunctionFilterOption

public FunctionFilterOption()

メソッドの詳細

doCoalesce

protected void doCoalesce(Object coalesce)

doRound

protected void doRound(Object round)

doTrunc

protected void doTrunc(Object trunc)

doTruncMonth

protected void doTruncMonth()

doTruncDay

protected void doTruncDay()

doTruncTime

protected void doTruncTime()

doAddYear

protected void doAddYear(Object addedYear)

doAddYear

protected void doAddYear(Object addedYear,
                         boolean minus)

doAddMonth

protected void doAddMonth(Object addedMonth)

doAddMonth

protected void doAddMonth(Object addedMonth,
                          boolean minus)

doAddDay

protected void doAddDay(Object addedDay)

doAddDay

protected void doAddDay(Object addedDay,
                        boolean minus)

doAddHour

protected void doAddHour(Object addedHour)

doAddHour

protected void doAddHour(Object addedHour,
                         boolean minus)

doAddMinute

protected void doAddMinute(Object addedMinute)

doAddMinute

protected void doAddMinute(Object addedMinute,
                           boolean minus)

doAddSecond

protected void doAddSecond(Object addedSecond)

doAddSecond

protected void doAddSecond(Object addedSecond,
                           boolean minus)

filterFunction

public String filterFunction(String functionExp)

Filter the expression of function part.
For example, an expression is like: max(foo.FOO_DATE), sum(bar.BAR_PRICE), ...

パラメータ:

functionExp - The expression of function part that is not filtered. (NotNull)

戻り値:

The filtered expression. (NotNull)

addProcessCallback

protected void addProcessCallback(String functionKey,
                                  FunctionFilterOption.ProcessCallback callback)

processCoalesce

protected String processCoalesce(String functionExp,
                                 int index,
                                 Object coalesce)

processRound

protected String processRound(String functionExp,
                              int index,
                              Object round)

processTrunc

protected String processTrunc(String functionExp,
                              int index,
                              Object trunc)

doProcessTruncPurposeDateType

protected String doProcessTruncPurposeDateType(String functionExp)

doProcessTruncPurposeDateTypeMySQL

protected String doProcessTruncPurposeDateTypeMySQL(String functionExp)

doProcessTruncPurposeDateTypePostgreSQL

protected String doProcessTruncPurposeDateTypePostgreSQL(String functionExp)

doProcessTruncPurposeDateTypeOracle

protected String doProcessTruncPurposeDateTypeOracle(String functionExp)

doProcessTruncPurposeDateTypeDB2

protected String doProcessTruncPurposeDateTypeDB2(String functionExp)

doProcessTruncPurposeDateTypeSQLServer

protected String doProcessTruncPurposeDateTypeSQLServer(String functionExp)

doProcessTruncPurposeDateTypeDefault

protected String doProcessTruncPurposeDateTypeDefault(String functionExp)

isDateTruncMonth

protected boolean isDateTruncMonth()

isDateTruncDay

protected boolean isDateTruncDay()

isDateTruncTime

protected boolean isDateTruncTime()

doProcessTruncSimpleCase

protected String doProcessTruncSimpleCase(String functionExp,
                                          int index,
                                          Object trunc)

isTruncNamedTruncate

protected boolean isTruncNamedTruncate()

processAddYear

protected String processAddYear(String functionExp,
                                int index,
                                Object addedYear,
                                boolean minus)

processAddMonth

protected String processAddMonth(String functionExp,
                                 int index,
                                 Object addedMonth,
                                 boolean minus)

processAddDay

protected String processAddDay(String functionExp,
                               int index,
                               Object addedDay,
                               boolean minus)

processAddHour

protected String processAddHour(String functionExp,
                                int index,
                                Object addedHour,
                                boolean minus)

processAddMinute

protected String processAddMinute(String functionExp,
                                  int index,
                                  Object addedMinute,
                                  boolean minus)

processAddSecond

protected String processAddSecond(String functionExp,
                                  int index,
                                  Object addedSecond,
                                  boolean minus)

doProcessDateAdd

protected String doProcessDateAdd(String functionExp,
                                  int index,
                                  Object addedValue,
                                  String propertyName,
                                  boolean minus)

doProcessDateAddMySQL

protected String doProcessDateAddMySQL(String functionExp,
                                       int index,
                                       Object addedValue,
                                       String propertyName,
                                       boolean minus)

doProcessDateAddPostgreSQL

protected String doProcessDateAddPostgreSQL(String functionExp,
                                            int index,
                                            Object addedValue,
                                            String propertyName,
                                            boolean minus)

doProcessDateAddOracle

protected String doProcessDateAddOracle(String functionExp,
                                        int index,
                                        Object addedValue,
                                        String propertyName,
                                        boolean minus)

doProcessDateAddDB2

protected String doProcessDateAddDB2(String functionExp,
                                     int index,
                                     Object addedValue,
                                     String propertyName,
                                     boolean minus)

doProcessDateAddSQLServer

protected String doProcessDateAddSQLServer(String functionExp,
                                           int index,
                                           Object addedValue,
                                           String propertyName,
                                           boolean minus)

buildDateAddExpType

protected String buildDateAddExpType(String propertyName,
                                     String prefix,
                                     boolean plural)

isPropertyAddYear

protected boolean isPropertyAddYear(String propertyName)

isPropertyAddMonth

protected boolean isPropertyAddMonth(String propertyName)

isPropertyAddDay

protected boolean isPropertyAddDay(String propertyName)

isPropertyAddHour

protected boolean isPropertyAddHour(String propertyName)

isPropertyAddMinute

protected boolean isPropertyAddMinute(String propertyName)

isPropertyAddSecond

protected boolean isPropertyAddSecond(String propertyName)

buildAddedBindParameter

protected String buildAddedBindParameter(int index,
                                         Object addedValue,
                                         String propertyName)

buildAddedEmbeddedValueExp

protected String buildAddedEmbeddedValueExp(Object addedValue)

processCalculation

protected String processCalculation(String functionExp)

Process calculation filters defined by sub-class. (for extension)

パラメータ:

functionExp - The expression of derived function. (NotNull)

戻り値:

The filtered expression. (NotNull)

processVarious

protected String processVarious(String functionExp)

Process various filters defined by user. (for extension)

パラメータ:

functionExp - The expression of derived function. (NotNull)

戻り値:

The filtered expression. (NotNull)

acceptParameterKey

public void acceptParameterKey(String parameterKey,
                               String parameterMapPath)

定義:

acceptParameterKey インタフェース内 ParameterOption

createSpecifyDerivedReferrer

public SpecifyDerivedReferrer createSpecifyDerivedReferrer(SubQueryPath subQueryPath,
                                                           ColumnRealNameProvider localRealNameProvider,
                                                           ColumnSqlNameProvider subQuerySqlNameProvider,
                                                           int subQueryLevel,
                                                           SqlClause subQueryClause,
                                                           String subQueryIdentity,
                                                           DBMeta subQueryDBMeta,
                                                           GearedCipherManager cipherManager,
                                                           String mainSubQueryIdentity,
                                                           String aliasName)

createQueryDerivedReferrer

public QueryDerivedReferrer createQueryDerivedReferrer(SubQueryPath subQueryPath,
                                                       ColumnRealNameProvider localRealNameProvider,
                                                       ColumnSqlNameProvider subQuerySqlNameProvider,
                                                       int subQueryLevel,
                                                       SqlClause subQueryClause,
                                                       String subQueryIdentity,
                                                       DBMeta subQueryDBMeta,
                                                       GearedCipherManager cipherManager,
                                                       String mainSubQueryIdentity,
                                                       String operand,
                                                       Object value,
                                                       String parameterPath)

mayNullRevived

public boolean mayNullRevived()

zone

public FunctionFilterOption zone(TimeZone timeZone)

Set time-zone, basically for LocalDate conversion.
Normally you don't need to set this, you can adjust other ways.
(DBFlute system's time-zone is used as default)
And it should be called before e.g. coalesce()

パラメータ:

timeZone - The time-zone for filtering. (NullAllowed: if null, default zone)

戻り値:

this. (NotNull)

getTimeZone

public TimeZone getTimeZone()

Get the time-zone in this option basically for filtering.

戻り値:

The time-zone for filtering. (NotNull: if no setting, system zone)

getDBFluteSystemFinalTimeZone

protected TimeZone getDBFluteSystemFinalTimeZone()

processSimpleFunction

protected String processSimpleFunction(String functionExp,
                                       String functionName,
                                       String thirdArg,
                                       boolean leftArg,
                                       Object bindKey)

hasSubQueryEndOnLastLine

protected boolean hasSubQueryEndOnLastLine(String functionExp)

buildBindParameter

protected String buildBindParameter(Object bindKey)

registerBindParameter

protected Object registerBindParameter(int index,
                                       Object parameter)

hasTargetColumnInfo

protected boolean hasTargetColumnInfo()

hasMysticBinding

protected boolean hasMysticBinding()

isDateTypeColumn

protected boolean isDateTypeColumn()

isJustDateTypeColumn

protected boolean isJustDateTypeColumn()

isJustTimestampTypeColumn

protected boolean isJustTimestampTypeColumn()

isJustTimeTypeColumn

protected boolean isJustTimeTypeColumn()

isDreamCruiseTicket

protected boolean isDreamCruiseTicket(Object value)

buildDreamCruiseTicketStatement

protected String buildDreamCruiseTicketStatement(Object value)

assertObjectNotNull

protected void assertObjectNotNull(String variableName,
                                   Object value)

Assert that the object is not null.

パラメータ:

variableName - The check name of variable for message. (NotNull)

value - The checked value. (NotNull)

例外:

IllegalArgumentException - When the argument is null.

assertCalculationColumnNumber

protected void assertCalculationColumnNumber(SpecifiedColumn specifiedColumn)

assertSpecifiedDreamCruiseTicket

protected void assertSpecifiedDreamCruiseTicket(SpecifiedColumn column)

assertOptionValueNotNull

protected void assertOptionValueNotNull(String keyword,
                                        Object value)

isOptionValueNullIgnored

protected boolean isOptionValueNullIgnored()

ln

protected final String ln()

toString

public String toString()

オーバーライド:

toString クラス内 Object

getBindMap

public Map<String,Object> getBindMap()

xgetTargetColumnInfo

public ColumnInfo xgetTargetColumnInfo()

xsetTargetColumnInfo

public void xsetTargetColumnInfo(ColumnInfo targetColumnInfo)

xgetMysticBindingSnapshot

public Object xgetMysticBindingSnapshot()

xsetMysticBindingSnapshot

public void xsetMysticBindingSnapshot(Object mysticBindingSnapshot)

getTrunc

public Object getTrunc()

xremoveCalcAlias

public void xremoveCalcAlias()

xjudgeDatabase

public void xjudgeDatabase(SqlClause sqlClause)

isDatabaseMySQL

protected boolean isDatabaseMySQL()

setDatabaseMySQL

protected void setDatabaseMySQL(boolean databaseMySQL)

isDatabasePostgreSQL

protected boolean isDatabasePostgreSQL()

setDatabasePostgreSQL

protected void setDatabasePostgreSQL(boolean databasePostgreSQL)

isDatabaseOracle

protected boolean isDatabaseOracle()

setDatabaseOracle

protected void setDatabaseOracle(boolean databaseOracle)

isDatabaseDB2

protected boolean isDatabaseDB2()

setDatabaseDB2

protected void setDatabaseDB2(boolean databaseDB2)

isDatabaseSQLServer

protected boolean isDatabaseSQLServer()

setDatabaseSQLServer

protected void setDatabaseSQLServer(boolean databaseSQLServer)

isDatabaseH2

protected boolean isDatabaseH2()

setDatabaseH2

protected void setDatabaseH2(boolean databaseH2)

isDatabaseDerby

protected boolean isDatabaseDerby()

setDatabaseDerby

protected void setDatabaseDerby(boolean databaseDerby)