com.infoteria.asteria.flowlibrary2.mapper
クラス Function

java.lang.Object
  |
  +--com.infoteria.asteria.flowlibrary2.mapper.MappingItem
        |
        +--com.infoteria.asteria.flowlibrary2.mapper.Function

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

Cloneable, Comparable

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

MultiOutputFunction

public abstract class Function

extends MappingItem

マッパー関数の基底クラスです。

フィールドの概要

static int

LINK_UNBOUNDED MaxInputCountを無制限にする場合のシンボルです。

コンストラクタの概要

Function()
コンストラクタ

メソッドの概要

abstract void	execute(ExecuteContext context, Value[] in, Value out) マッパー関数の実行処理本体です。
String	getBaseDirectory()
abstract String	getFunctionName() マッパー関数名を返します。
List	getInputList() 入力のアイテムを保持するリストを返します。
int	getMaxInputCount() 接続可能な入力数のMaximum。
protected String	getMessage(String key) マッパー関数定義ファイルに定義したMessageを取得します。
protected String	getMessage(String key, Object o1) パラメータを置換してマッパー関数定義ファイルに定義したMessageを取得します。
protected String	getMessage(String key, Object o1, Object o2) パラメータを置換してマッパー関数定義ファイルに定義したMessageを取得します。
protected String	getMessage(String key, Object o1, Object o2, Object o3) パラメータを置換してマッパー関数定義ファイルに定義したMessageを取得します。
int	getMinInputCount() 接続可能な入力数のMinimum。
User	getOwner()
Value	getProperty(String name) nameに対応するプロパティ値を取得します。
Value	getProperty(String name, Value[] in, int no) nameに対応するプロパティ値を取得します。
boolean	getPropertyBoolean(String name) nameに対応するプロパティ値をbooleanとして取得します。
boolean	getPropertyBoolean(String name, Value[] in, int no) nameに対応するプロパティ値をbooleanとして取得します。
double	getPropertyDouble(String name) nameに対応するプロパティ値をdoubleとして取得します。
double	getPropertyDouble(String name, Value[] in, int no) nameに対応するプロパティ値をdoubleとして取得します。
long	getPropertyInteger(String name) nameに対応するプロパティ値をlongとして取得します。
long	getPropertyInteger(String name, Value[] in, int no) nameに対応するプロパティ値をlongとして取得します。
String	getPropertyString(String name) nameに対応するプロパティ値をStringとして取得します。
String	getPropertyString(String name, Value[] in, int no) nameに対応するプロパティ値をStringとして取得します。
MappingItem	getSubItem(String name)
void	init(MapperComponent mapper, ExecuteContext context)
protected abstract void	internalInit() マッパー関数の登録時に呼び出される初期化メソッドです。
protected void	postCompile()
protected void	registProperty(String name, Value.Type type, boolean required) プロパティを登録します。
protected void	registProperty(String name, Value.Type type, boolean required, Value def) プロパティを登録します。
void	setBaseDirectory(String s)
void	setOwner(User user)
void	term(MapperComponent mapper, ExecuteContext context)

クラス com.infoteria.asteria.flowlibrary2.mapper.MappingItem から継承したメソッド

beginMapping, endMapping, getName

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

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

インタフェース java.lang.Comparable から継承したメソッド

compareTo

フィールドの詳細

LINK_UNBOUNDED

public static final int LINK_UNBOUNDED

MaxInputCountを無制限にする場合のシンボルです。

コンストラクタの詳細

Function

public Function()

コンストラクタ

メソッドの詳細

getFunctionName

public abstract String getFunctionName()

マッパー関数名を返します。
マッパー関数名はFlowサーバ内で使用するすべての関数内でユニークでなければなりません。

internalInit

protected abstract void internalInit()

マッパー関数の登録時に呼び出される初期化メソッドです。
このメソッド内でプロパティの登録を行います。

getMinInputCount

public int getMinInputCount()

接続可能な入力数のMinimum。
デフォルトの実装は 1を返します。
必要に応じてサブクラスでオーバーライドしてください。

getMaxInputCount

public int getMaxInputCount()

接続可能な入力数のMaximum。
デフォルトの実装は 1を返します。
必要に応じてサブクラスでオーバーライドしてください。
接続可能数を無制限とする場合はLINK_UNBOUNDEDを返すようにします。

execute

public abstract void execute(ExecuteContext context,
                             Value[] in,
                             Value out)
                      throws MapperException

マッパー関数の実行処理本体です。

パラメータ:

context - 実行コンテキスト

in - 入力値の配列

out - 出力値。関数の計算結果はこのオブジェクトに対して設定します。

getInputList

public List getInputList()

入力のアイテムを保持するリストを返します。

オーバーライド:

クラス MappingItem 内の getInputList

registProperty

protected void registProperty(String name,
                              Value.Type type,
                              boolean required)

プロパティを登録します。
このメソッドはinternalInitメソッド内で実行します。

パラメータ:

name - プロパティ名

type - プロパティ値のデータ型

required - このプロパティが必須の場合はtrue

registProperty

protected void registProperty(String name,
                              Value.Type type,
                              boolean required,
                              Value def)

プロパティを登録します。
このメソッドはinternalInitメソッド内で実行します。

パラメータ:

name - プロパティ名

type - プロパティ値のデータ型

required - このプロパティが必須の場合はtrue

def - デフォルト値

init

public void init(MapperComponent mapper,
                 ExecuteContext context)
          throws MapperException

クラス MappingItem の記述:

MapperComponentのinitメソッド内で呼び出される初期化メソッドです。

オーバーライド:

クラス MappingItem 内の init

term

public void term(MapperComponent mapper,
                 ExecuteContext context)

クラス MappingItem の記述:

MapperComponentのtermメソッド内で呼び出される終末処理メソッドです。

オーバーライド:

クラス MappingItem 内の term

getProperty

public Value getProperty(String name)

nameに対応するプロパティ値を取得します。

パラメータ:

name - プロパティ名

戻り値:

nameに対応するプロパティがない場合はnull

getProperty

public Value getProperty(String name,
                         Value[] in,
                         int no)

nameに対応するプロパティ値を取得します。 ただし引数 inの個数が no値より大きい場合は in[no]の値をプロパティ値の替わりに返します。

パラメータ:

name - プロパティ名

in - 入力値の配列。executeメソッドの引数inをそのまま渡します。

no - 入力値でプロパティ値を置換する場合の入力値のインデックス

戻り値:

入力値の個数がnoよりも小さく、nameに対応するプロパティがない場合はnull

getPropertyString

public String getPropertyString(String name)

nameに対応するプロパティ値をStringとして取得します。

パラメータ:

name - プロパティ名

戻り値:

nameに対応するプロパティがない場合は""が返されるのでnullが返ることはありません。

getPropertyString

public String getPropertyString(String name,
                                Value[] in,
                                int no)

nameに対応するプロパティ値をStringとして取得します。 ただし引数 inの個数が no値より大きい場合は in[no]の値をプロパティ値の替わりに返します。

パラメータ:

name - プロパティ名

in - 入力値の配列。executeメソッドの引数inをそのまま渡します。

no - 入力値でプロパティ値を置換する場合の入力値のインデックス

戻り値:

対応する値がない場合は""が返されるのでnullが返ることはありません。

getPropertyInteger

public long getPropertyInteger(String name)

nameに対応するプロパティ値をlongとして取得します。

パラメータ:

name - プロパティ名

戻り値:

nameに対応するプロパティがない場合は0が返されます。

getPropertyInteger

public long getPropertyInteger(String name,
                               Value[] in,
                               int no)

nameに対応するプロパティ値をlongとして取得します。 ただし引数 inの個数が no値より大きい場合は in[no]の値をプロパティ値の替わりに返します。

パラメータ:

name - プロパティ名

in - 入力値の配列。executeメソッドの引数inをそのまま渡します。

no - 入力値でプロパティ値を置換する場合の入力値のインデックス

戻り値:

対応する値がない場合は0が返されます。

getPropertyDouble

public double getPropertyDouble(String name)

nameに対応するプロパティ値をdoubleとして取得します。

パラメータ:

name - プロパティ名

戻り値:

nameに対応するプロパティがない場合は0.0が返されます。

getPropertyDouble

public double getPropertyDouble(String name,
                                Value[] in,
                                int no)

nameに対応するプロパティ値をdoubleとして取得します。 ただし引数 inの個数が no値より大きい場合は in[no]の値をプロパティ値の替わりに返します。

パラメータ:

name - プロパティ名

in - 入力値の配列。executeメソッドの引数inをそのまま渡します。

no - 入力値でプロパティ値を置換する場合の入力値のインデックス

戻り値:

対応する値がない場合は0.0が返されます。

getPropertyBoolean

public boolean getPropertyBoolean(String name)

nameに対応するプロパティ値をbooleanとして取得します。

パラメータ:

name - プロパティ名

戻り値:

nameに対応するプロパティがない場合はfalseが返されます。

getPropertyBoolean

public boolean getPropertyBoolean(String name,
                                  Value[] in,
                                  int no)

nameに対応するプロパティ値をbooleanとして取得します。 ただし引数 inの個数が no値より大きい場合は in[no]の値をプロパティ値の替わりに返します。

パラメータ:

name - プロパティ名

in - 入力値の配列。executeメソッドの引数inをそのまま渡します。

no - 入力値でプロパティ値を置換する場合の入力値のインデックス

戻り値:

対応する値がない場合はfalseが返されます。

getMessage

protected String getMessage(String key)

マッパー関数定義ファイルに定義したMessageを取得します。

getMessage

protected String getMessage(String key,
                            Object o1)

パラメータを置換してマッパー関数定義ファイルに定義したMessageを取得します。

getMessage

protected String getMessage(String key,
                            Object o1,
                            Object o2)

パラメータを置換してマッパー関数定義ファイルに定義したMessageを取得します。

getMessage

protected String getMessage(String key,
                            Object o1,
                            Object o2,
                            Object o3)

パラメータを置換してマッパー関数定義ファイルに定義したMessageを取得します。

postCompile

protected void postCompile()
                    throws MapperException

getOwner

public User getOwner()

setOwner

public void setOwner(User user)

getBaseDirectory

public String getBaseDirectory()

setBaseDirectory

public void setBaseDirectory(String s)

getSubItem

public MappingItem getSubItem(String name)