jp.go.aist.dmrc.platform.beans.util.controller

クラス PFWhileCountController

java.lang.Object

jp.go.aist.dmrc.platform.beans.util.controller.PFWhileCountController

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

java.io.Serializable, PFComponent, PFXMLSerializable, PFActionEventSource, PFEventSource, PFProcessRequestEventSource

public class PFWhileCountController
extends java.lang.Object
implements PFComponent, PFProcessRequestEventSource, PFActionEventSource, PFXMLSerializable

繰り返し処理(While)コンポーネント。while文またはdo while文に対応する。 条件が真である間繰り返し処理を行い、1回のループごとにアクションイベントを発生させる。 条件判定は、1回のループごとに発生する処理要求イベントの戻り値の評価か、 または処理要求イベントの発生が終了した時点のContinued属性の評価で行う。

条件の設定の仕方によっては無限ループに陥るので、注意を要する。

このコンポーネントから以下のイベントが発生する。

• アクションイベント

  トリガー	イベント番号
  callメソッド呼出	0



• 処理要求イベント

  トリガー	処理要求データ	イベント番号
  callメソッド呼出	(なし)	0

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
PFWhileCountController() デフォルトコンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addPFActionListener(PFActionListener lis) 引数で与えられたイベントリスナを登録し、 アクションイベント発生時に処理を行う対象とする。
void	addPFProcessRequestListener(PFProcessRequestListener lis) 引数で与えられたイベントリスナを登録し、 処理要求イベント発生時に処理を行う対象とする。
void	call() 処理実行。
void	call(int begin, int step) 処理実行(詳細指定)。
protected boolean	firePFActionPerformed(PFActionEvent event) アクションイベントをリスナーに通知する。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
int	getCurrent() ループ回数の現在値を取得する。
java.util.Iterator	getPFActionListenerList() イベントリスナ配列を取得する。
java.util.Iterator	getPFProcessRequestListenerList() 処理要求イベントリスナ配列を取得する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
boolean	isContinued() ループを続行するかどうかを取得する。
boolean	isContinueWhenErrorOccurred() エラーが発生したときも処理を継続するかどうかを取得する。
boolean	isDoWhileType() 条件の評価を後(do-while型)にするかどうかを取得する。
void	localeUpdated() ロケール変更に対応する。
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	removePFActionListener(PFActionListener lis) 引数で与えられたイベントリスナを削除し、 アクションイベント発生時に処理を行う対象から外す。
void	removePFProcessRequestListener(PFProcessRequestListener lis) 引数で与えられたイベントリスナを削除し、 処理要求イベント発生時に処理を行う対象から外す。
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setComponentID(int id) コンポーネントIDを設定する。
void	setComponentKey(java.lang.String key) コンポーネントのキー情報を設定する
void	setComponentKeys(PFMultiLocaleString keys) 全ロケール分のコンポーネントキーを設定する。
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
void	setContinued(boolean value) ループを続行するかどうかを設定する。
void	setContinueWhenErrorOccurred(boolean cont) エラーが発生したときも処理を継続するかどうかを設定する。
void	setDoWhileType(boolean value) 条件の評価を後(do-while型)にするかどうかを設定する。
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

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

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

コンストラクタの詳細

PFWhileCountController

public PFWhileCountController()

デフォルトコンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する。

定義:

getComponentName インタフェース内 PFComponent

戻り値:

コンポーネント名

関連項目:

PFComponent.getComponentName()

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する。

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー文字列

関連項目:

PFComponent.getComponentKey()

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントのキー情報を設定する

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - 設定するコンポーネントのキー

関連項目:

PFComponent.setComponentKey(java.lang.String)

getComponentKeys

public PFMultiLocaleString getComponentKeys()

全ロケール分のコンポーネントキーを返す。

戻り値:

全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

全ロケール分のコンポーネントキーを設定する。

パラメータ:

keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()

コンポーネントIDを取得する。

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

関連項目:

PFComponent.getComponentID()

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

id - 設定するコンポーネントID

関連項目:

PFComponent.setComponentID(int)

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:

getComponentString インタフェース内 PFComponent

戻り値:

コンポーネントの文字列表現を返す。

関連項目:

PFComponent.getComponentString()

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

getComponentPublicName インタフェース内 PFComponent

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

setComponentPublicName インタフェース内 PFComponent

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

isAllowRemoteInvocation インタフェース内 PFComponent

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

setAllowRemoteInvocation インタフェース内 PFComponent

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPullTransfer インタフェース内 PFComponent

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPullTransfer インタフェース内 PFComponent

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPushTransfer インタフェース内 PFComponent

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPushTransfer インタフェース内 PFComponent

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

getPFProcessRequestListenerList

public java.util.Iterator getPFProcessRequestListenerList()

処理要求イベントリスナ配列を取得する。

定義:

getPFProcessRequestListenerList インタフェース内 PFProcessRequestEventSource

戻り値:

イベントリスナイテレータ

addPFProcessRequestListener

public void addPFProcessRequestListener(PFProcessRequestListener lis)

引数で与えられたイベントリスナを登録し、 処理要求イベント発生時に処理を行う対象とする。

定義:

addPFProcessRequestListener インタフェース内 PFProcessRequestEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFProcessRequestListener

public void removePFProcessRequestListener(PFProcessRequestListener lis)

引数で与えられたイベントリスナを削除し、 処理要求イベント発生時に処理を行う対象から外す。

定義:

removePFProcessRequestListener インタフェース内 PFProcessRequestEventSource

パラメータ:

lis - 削除対象イベントリスナ

getPFActionListenerList

public java.util.Iterator getPFActionListenerList()

イベントリスナ配列を取得する。

定義:

getPFActionListenerList インタフェース内 PFActionEventSource

戻り値:

イベントリスナイテレータ

addPFActionListener

public void addPFActionListener(PFActionListener lis)

引数で与えられたイベントリスナを登録し、 アクションイベント発生時に処理を行う対象とする。

定義:

addPFActionListener インタフェース内 PFActionEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFActionListener

public void removePFActionListener(PFActionListener lis)

引数で与えられたイベントリスナを削除し、 アクションイベント発生時に処理を行う対象から外す。

定義:

removePFActionListener インタフェース内 PFActionEventSource

パラメータ:

lis - 削除対象イベントリスナ

localeUpdated

public void localeUpdated()

ロケール変更に対応する。

定義:

localeUpdated インタフェース内 PFComponent

関連項目:

PFComponent.localeUpdated()

readXML

public void readXML(PFXMLLoader in)

コンポーネントのXML入力.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

コンポーネントのXML出力.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException

getCurrent

public int getCurrent()

ループ回数の現在値を取得する。
ただし、処理中でないときは不定値が返る。

戻り値:

現在値

isContinueWhenErrorOccurred

public boolean isContinueWhenErrorOccurred()

エラーが発生したときも処理を継続するかどうかを取得する。

戻り値:

エラーが発生したときも処理を継続する場合true

setContinueWhenErrorOccurred

public void setContinueWhenErrorOccurred(boolean cont)

エラーが発生したときも処理を継続するかどうかを設定する。

パラメータ:

cont - エラーが発生したときも処理を継続する場合true

isDoWhileType

public boolean isDoWhileType()

条件の評価を後(do-while型)にするかどうかを取得する。

戻り値:

do-while型の場合 true

setDoWhileType

public void setDoWhileType(boolean value)

条件の評価を後(do-while型)にするかどうかを設定する。

パラメータ:

value - do-while型の場合 true

isContinued

public boolean isContinued()

ループを続行するかどうかを取得する。

戻り値:

ループを続行する場合 true

setContinued

public void setContinued(boolean value)

ループを続行するかどうかを設定する。

パラメータ:

value - ループを続行する場合 true

call

public void call()
          throws PFException

処理実行。
1回のループごとにアクションイベントが発生する。 条件判定は、1回のループごとに発生する処理要求イベントの戻り値の評価か、 または処理要求イベントの発生が終了した時点のContinued属性の評価で行う。 ループカウンタは0から開始して1ずつ増加する。

例外:

PFException - イベント処理エラーまたは再帰呼出された場合

call

public void call(int begin,
                 int step)
          throws PFException

処理実行(詳細指定)。
1回のループごとにアクションイベントが発生する。 条件判定は、1回のループごとに発生する処理要求イベントの戻り値の評価か、 または処理要求イベントの発生が終了した時点のContinued属性の評価で行う。 ループカウンタの初期値と増分を指定することができる。

パラメータ:

begin - ループカウンタの初期値

step - ループカウンタの増分

例外:

PFException - イベント処理エラーまたは再帰呼出された場合

firePFActionPerformed

protected boolean firePFActionPerformed(PFActionEvent event)
                                 throws PFException

アクションイベントをリスナーに通知する。

パラメータ:

event - アクションイベント

戻り値:

エラーが発生しなかった場合true

例外:

PFException - イベント処理エラー