com.infoteria.asteria.flowengine2.flow
クラス Component

java.lang.Object
  |
  +--com.infoteria.asteria.flowengine2.flow.Component
すべての実装インタフェース:
Cloneable
直系の既知のサブクラス:
SimpleComponent

public abstract class Component
extends Object
implements Cloneable

コンポーネントの基底クラス
すべてのコンポーネントに共通のプロパティとして「ExecuteCount」が最初から登録されています。


フィールドの概要
static int LOOP_CONTINUE
          executeLoopの返り値のシンボル、Loop処理を実行し、Loopは継続する
static int LOOP_END
          executeLoopの返り値のシンボル、Loop処理を実行し、Loopは終了した
static int LOOP_NOTHING
          executeLoopの返り値のシンボル、Loop処理を実行されなかった
static String STATE_DEFAULT
          デフォルトの出力State
 
コンストラクタの概要
protected Component()
          コンストラクタ
 
メソッドの概要
 Object clone()
          コンポーネントの複製を返します。
 void commit(ExecuteContext context)
          コミットの実行コードを記述します
 void endFlow(ExecuteContext context)
          個別のフロー実行終了時の処理を記述します
abstract  boolean execute(ExecuteContext context)
          コンポーネントの実行コードを記述します
 int executeLoop(ExecuteContext context)
          ループ処理の実行コードを記述します
protected  ComponentCompiler getCompiler()
          コンポーネントコンパイラを返します。
abstract  ComponentEntrance getComponentEntrance()
          入力コネクタセットを取得します
abstract  ComponentExit getComponentExit(String state)
          stateに対応する出力コネクタセットを取得します
abstract  String getComponentName()
          コンポーネントの登録名を取得します
 long getExecuteCount()
          コンポーネントの実行回数を返します。
 String getFullName()
          プロジェクト名、フロー名を含む完全なコンポーネント名を取得します
 String getLicenseStr()
          ライセンス文字列を返します。
 String getMessage(String key)
          コンポーネント定義ファイルに定義したMessageを取得します。
 String getMessage(String key, Object o1)
          パラメータを置換してコンポーネント定義ファイルに定義したMessageを取得します。
 String getMessage(String key, Object o1, Object o2)
          パラメータを置換してコンポーネント定義ファイルに定義したMessageを取得します。
 String getMessage(String key, Object o1, Object o2, Object o3)
          パラメータを置換してコンポーネント定義ファイルに定義したMessageを取得します。
protected  String getMessageResource(String cname, String key)
          ComponentManagerからメッセージリソースを取得します。
 String getName()
          コンポーネント名を取得します
 Property getProperty(int index)
          indexに対応するプロパティを取得します
 Property getProperty(String name)
          nameに対応するプロパティを取得します
 int getPropertyCount()
          登録されたプロパティの数を返します
 String getState()
          コンポーネントの出力Stateを取得します
コンポーネントは出力Stateごとに出力先を変更することができます。
abstract  String[] getStateArray()
          全ての出力Stateの配列を取得します
 void init(ExecuteContext context)
          初期化処理を記述します
 boolean isBreakPoint()
          このコンポーネントにブレイクポイントが設定されている場合trueを返します。
 boolean loopPossibility()
          このコンポーネントがループを生成する可能性がある場合は trueを返すようにオーバーライドします。
protected  void registProperty(Property property)
          コンポーネントにプロパティを登録します
 void rollback(ExecuteContext context)
          ロールバックの実行コードを記述します
 void setExceptionParam(FlowException e)
          コンポーネント実行中にExceptionが発生した場合に呼び出されるメソッドです。
 void term(ExecuteContext context)
          終了処理を記述します
 
クラス java.lang.Object から継承したメソッド
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

STATE_DEFAULT

public static final String STATE_DEFAULT
デフォルトの出力State

LOOP_END

public static final int LOOP_END
executeLoopの返り値のシンボル、Loop処理を実行し、Loopは終了した

LOOP_CONTINUE

public static final int LOOP_CONTINUE
executeLoopの返り値のシンボル、Loop処理を実行し、Loopは継続する

LOOP_NOTHING

public static final int LOOP_NOTHING
executeLoopの返り値のシンボル、Loop処理を実行されなかった
コンストラクタの詳細

Component

protected Component()
コンストラクタ
メソッドの詳細

getComponentName

public abstract String getComponentName()
コンポーネントの登録名を取得します

getState

public String getState()
コンポーネントの出力Stateを取得します
コンポーネントは出力Stateごとに出力先を変更することができます。

getComponentEntrance

public abstract ComponentEntrance getComponentEntrance()
入力コネクタセットを取得します

getComponentExit

public abstract ComponentExit getComponentExit(String state)
stateに対応する出力コネクタセットを取得します

getStateArray

public abstract String[] getStateArray()
全ての出力Stateの配列を取得します

getName

public String getName()
コンポーネント名を取得します

getFullName

public String getFullName()
プロジェクト名、フロー名を含む完全なコンポーネント名を取得します

execute

public abstract boolean execute(ExecuteContext context)
                         throws FlowException
コンポーネントの実行コードを記述します

executeLoop

public int executeLoop(ExecuteContext context)
                throws FlowException
ループ処理の実行コードを記述します

commit

public void commit(ExecuteContext context)
            throws FlowException
コミットの実行コードを記述します

rollback

public void rollback(ExecuteContext context)
              throws FlowException
ロールバックの実行コードを記述します

init

public void init(ExecuteContext context)
          throws FlowException
初期化処理を記述します

endFlow

public void endFlow(ExecuteContext context)
個別のフロー実行終了時の処理を記述します

term

public void term(ExecuteContext context)
終了処理を記述します

loopPossibility

public boolean loopPossibility()
このコンポーネントがループを生成する可能性がある場合は trueを返すようにオーバーライドします。
デフォルトではfalseを返します。

registProperty

protected void registProperty(Property property)
コンポーネントにプロパティを登録します

getProperty

public Property getProperty(String name)
nameに対応するプロパティを取得します

getPropertyCount

public int getPropertyCount()
登録されたプロパティの数を返します

getProperty

public Property getProperty(int index)
indexに対応するプロパティを取得します

setExceptionParam

public void setExceptionParam(FlowException e)
コンポーネント実行中にExceptionが発生した場合に呼び出されるメソッドです。
Exceptionに対してExceptionParamを設定する場合はオーバーライドして引数のExceptionに対してExceptionParamを設定します。

getMessageResource

protected String getMessageResource(String cname,
                                    String key)
ComponentManagerからメッセージリソースを取得します。

getMessage

public String getMessage(String key)
コンポーネント定義ファイルに定義したMessageを取得します。

getMessage

public String getMessage(String key,
                         Object o1)
パラメータを置換してコンポーネント定義ファイルに定義したMessageを取得します。

getMessage

public String getMessage(String key,
                         Object o1,
                         Object o2)
パラメータを置換してコンポーネント定義ファイルに定義したMessageを取得します。

getMessage

public String getMessage(String key,
                         Object o1,
                         Object o2,
                         Object o3)
パラメータを置換してコンポーネント定義ファイルに定義したMessageを取得します。

clone

public Object clone()
コンポーネントの複製を返します。
このメソッドは Class#newInstanceメソッドを用いて実装されています。
オーバーライド:
クラス Object 内の clone

getCompiler

protected ComponentCompiler getCompiler()
コンポーネントコンパイラを返します。
標準のコンパイラではなく自作のコンパイラを使用する場合はオーバーライドします。

getExecuteCount

public long getExecuteCount()
コンポーネントの実行回数を返します。

getLicenseStr

public String getLicenseStr()
ライセンス文字列を返します。
コンポーネントがライセンスチェックを行う場合はオーバーライドしてチェックする文字列を返します。

isBreakPoint

public boolean isBreakPoint()
このコンポーネントにブレイクポイントが設定されている場合trueを返します。