jp.co.intra_mart.foundation.viewcreator.model.formula.funcimpl

クラス AbstractFunctionImplementation

java.lang.Object

jp.co.intra_mart.foundation.viewcreator.model.formula.funcimpl.AbstractFunctionImplementation

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

FunctionImplementation

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

FunctionArray, FunctionAvg, FunctionConcatenate, FunctionCount, FunctionCountIf, FunctionDataViewCode, FunctionDataViewName, FunctionDate, FunctionDateTimeDurationFormat, FunctionEval, FunctionFormat, FunctionGetViewCreatorSystemParameter, FunctionIF, FunctionLen, FunctionMax, FunctionMin, FunctionNumber, FunctionSecureParameter, FunctionString, FunctionSubstitute, FunctionSubstring, FunctionSubtract, FunctionSum, FunctionSumIf, FunctionSwitch, FunctionSwitchMulti, FunctionTimezone, FunctionToday, FunctionViewColumnValues

public abstract class AbstractFunctionImplementation
extends Object
implements FunctionImplementation

関数(Function)クラスの実装で汎用的に利用可能なユーティリティを提供する抽象クラスです。

導入されたバージョン:

8.0.4

バージョン:

8.0.14

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected static String	VICE_INQUIRY_NAME 副問い合わせ用のエイリアスとして使用します。

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	checkArgumentCount(int expect, List<ArgumentElement> elements) 要素数を調べます。
protected double	executeBySql(String functionName, Arguments args) SQL関数を実行して結果を取得します。
protected double	executeBySql(String functionName, String args, List<FixedValue> params) SQL関数を実行して結果を取得します。
protected static boolean	existNullElement(List<ArgumentElement> elements) 要素の中にnull値が含まれて否かどうかを調べます。
protected FixedValue	expand(ArgumentElement element) 計算式要素を実行して結果を取得します。
protected jp.co.intra_mart.foundation.viewcreator.model.formula.funcimpl.ExpandedSQLANDParameters	expand4SQLEvalStatement(List<ArgumentElement> elements, String tableName)
protected jp.co.intra_mart.foundation.viewcreator.model.formula.funcimpl.ExpandedSQLANDParameters	expand4SQLEvalStatement(List<ArgumentElement> elements, String tableName, ViewCreatorData vcdata) SQL用の評価式文字列へ展開します。
protected String	getColumnCode(String fieldName) カラムを特定可能な文字列（キャプションなど）から、SQL(SELECT文)で使用されるエイリアス名（カラムコード）を取得します。
protected String	getColumnCode(String fieldName, ViewCreatorData vcdata) カラムを特定可能な文字列（キャプションなど）から、SQL(SELECT文)で使用されるエイリアス名（カラムコード）を取得します。
protected Connection	getConnection() データベース接続オブジェクトを取得します。
protected ViewCreatorData	getData() ViewCreatorの設定データを取得します。
protected Subtotal	getSubTotal(String fieldName) 指定されたフィールドの小計データを取得します。
void	init(ViewCreatorData viewcreatordata) 関数の初期化。
protected static void	setData2Statement(PreparedStatement stmt, List<FixedValue> params) プリペアドステートメントにデータをセットします。

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

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

インタフェースから継承されたメソッド jp.co.intra_mart.foundation.viewcreator.formula.FunctionImplementation

execute, getName

フィールドの詳細

VICE_INQUIRY_NAME

protected static final String VICE_INQUIRY_NAME

副問い合わせ用のエイリアスとして使用します。

関連項目:

定数フィールド値

コンストラクタの詳細

AbstractFunctionImplementation

public AbstractFunctionImplementation()

メソッドの詳細

existNullElement

protected static boolean existNullElement(List<ArgumentElement> elements)

要素の中にnull値が含まれて否かどうかを調べます。

パラメータ:

elements - 要素の配列

戻り値:

true:null値が含まれている false:null値が含まれていない

setData2Statement

protected static void setData2Statement(PreparedStatement stmt,
                                        List<FixedValue> params)
                                 throws SQLException

プリペアドステートメントにデータをセットします。

パラメータ:

stmt - セット対象プリペアドステートメント

params - セットするデータの配列

例外:

SQLException - データのセットに失敗した場合にスローされます

init

public final void init(ViewCreatorData viewcreatordata)

インタフェースからコピーされた説明: FunctionImplementation

関数の初期化。 ViewCreatorの設定データをセットします。

定義:

init インタフェース内 FunctionImplementation

パラメータ:

viewcreatordata - ViewCreator設定データ

checkArgumentCount

protected void checkArgumentCount(int expect,
                                  List<ArgumentElement> elements)
                           throws FunctionExecuteException

要素数を調べます。
要素の数が期待値と異なる場合や、null要素が含まれている場合は例外がスローされます。

パラメータ:

expect - 期待値

elements - 要素の配列

例外:

FunctionExecuteException - チェックの結果エラーが発見された場合スローされます

executeBySql

protected double executeBySql(String functionName,
                              Arguments args)
                       throws SQLException,
                              FunctionExecuteException

SQL関数を実行して結果を取得します。引数には変数のみを渡すことができます。
渡された変数はSQL上で利用されるエイリアス名に変換されて実行されます。

パラメータ:

functionName - SQL関数名

args - 関数の引数

戻り値:

実行結果

例外:

SQLException - SQLの実行に失敗した場合にスローされます

FunctionExecuteException - 引数の要素を変数として扱えなかった場合にスローさえれます

executeBySql

protected double executeBySql(String functionName,
                              String args,
                              List<FixedValue> params)
                       throws SQLException

SQL関数を実行して結果を取得します。
引数にはSELECT文中でそのまま利用可能な形のデータを渡します。

パラメータ:

functionName - SQL関数名

args - SQL関数の引数

params - argsの中で指定した ? に対してプリペアドステートメントでセットする値の配列

戻り値:

実行結果

例外:

SQLException - SQLの実行に失敗した場合にスローされます

expand

protected FixedValue expand(ArgumentElement element)
                     throws FunctionExecuteException

計算式要素を実行して結果を取得します。

パラメータ:

element - 要素の配列に分解済みの計算式

戻り値:

展開結果

例外:

FunctionExecuteException - 展開に失敗した場合にスローされます。

expand4SQLEvalStatement

protected jp.co.intra_mart.foundation.viewcreator.model.formula.funcimpl.ExpandedSQLANDParameters expand4SQLEvalStatement(List<ArgumentElement> elements,
                                                                                                                          String tableName)
                                                                                                                   throws FunctionExecuteException,
                                                                                                                          FormulaSymtaxException

例外:

FunctionExecuteException

FormulaSymtaxException

expand4SQLEvalStatement

protected jp.co.intra_mart.foundation.viewcreator.model.formula.funcimpl.ExpandedSQLANDParameters expand4SQLEvalStatement(List<ArgumentElement> elements,
                                                                                                                          String tableName,
                                                                                                                          ViewCreatorData vcdata)
                                                                                                                   throws FunctionExecuteException,
                                                                                                                          FormulaSymtaxException

SQL用の評価式文字列へ展開します。

パラメータ:

elements - 要素の配列

tableName - テーブル名として使用する文字列

戻り値:

SQL文の中で使用可能な評価式とSQLステートメントに設定するパラメータの配列

例外:

FunctionExecuteException - 使用できない要素が含まれていた場合にスローされます

FormulaSymtaxException - 式の構造が不正な場合にスローされます

getColumnCode

protected String getColumnCode(String fieldName)

カラムを特定可能な文字列（キャプションなど）から、SQL(SELECT文)で使用されるエイリアス名（カラムコード）を取得します。
カラムが特定できなかった場合は渡された文字列をそのまま返します。

パラメータ:

fieldName - キャプション文字列もしくはテーブル上のフィールド名（物理名）

戻り値:

検索した結果取得されたカラムのカラムコード

getColumnCode

protected String getColumnCode(String fieldName,
                               ViewCreatorData vcdata)

カラムを特定可能な文字列（キャプションなど）から、SQL(SELECT文)で使用されるエイリアス名（カラムコード）を取得します。
カラムが特定できなかった場合は渡された文字列をそのまま返します。

パラメータ:

fieldName - キャプション文字列もしくはテーブル上のフィールド名（物理名）

vcdata - ViewCreator設定データ

戻り値:

検索した結果取得されたカラムのカラムコード

getConnection

protected Connection getConnection()
                            throws SQLException

データベース接続オブジェクトを取得します。
このメソッドを利用して取得した接続オブジェクトは、関数の実装クラス内で確実にcloseしてください。

戻り値:

データベース接続オブジェクト

例外:

SQLException - 接続に失敗した場合にスローされます

getData

protected ViewCreatorData getData()

ViewCreatorの設定データを取得します。

戻り値:

設定データ

getSubTotal

protected Subtotal getSubTotal(String fieldName)
                        throws VCResourceException

指定されたフィールドの小計データを取得します。
このメソッドは外部データソースを利用しているクエリのときのみ利用できます。

パラメータ:

fieldName - 小計を取得する対象フィールド名

戻り値:

小計データ

例外:

VCResourceException - 小計の取得に失敗した場合にスローされます