jp.go.aist.dmrc.platform.beans.util.controller
クラス PFForCountController

java.lang.Object
  上位を拡張 jp.go.aist.dmrc.platform.beans.util.controller.PFForCountController
すべての実装されたインタフェース:
java.io.Serializable, PFComponent, PFXMLSerializable, PFActionEventSource, PFEventSource

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

繰り返し処理コンポーネント。
開始値〜(増分値)〜終了値を設定してください。

このコンポーネントからアクションイベントが発生します。
イベント番号は現在値です。

関連項目:
直列化された形式

コンストラクタの概要
PFForCountController()
          コンストラクタ。
 
メソッドの概要
 void addPFActionListener(PFActionListener lis)
          引数で与えられたイベントリスナを登録し、 アクションイベント発生時に処理を行う対象とする。
 void call()
          処理実行。
 void call(int begin, boolean beginContains, int end, boolean endContains, int step)
          処理実行。
 void call(int begin, int end, boolean endContains, int step)
          処理実行。
 void call(int begin, int end, int step)
          処理実行。
protected  boolean firePFActionPerformed(PFActionEvent event)
          アクションイベントをリスナーに通知する。
 int getBegin()
          開始値を取得する。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 int getCurrent()
          現在値を取得する。
 int getEnd()
          終了値を取得する。
 java.util.Iterator getPFActionListenerList()
          イベントリスナ配列を取得する。
 int getStep()
          増分値を取得する。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 boolean isBeginContains()
          開始値のときにも処理を行なうかどうかを取得する。
 boolean isContinueWhenErrorOccurred()
          エラーが発生したときも処理を継続するかどうかを取得する。
 boolean isEndContains()
          終了値のときにも処理を行なうかどうかを取得する。
 void localeUpdated()
          ロケール更新への対応を行う。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removePFActionListener(PFActionListener lis)
          引数で与えられたイベントリスナを削除し、 アクションイベント発生時に処理を行う対象から外す。
 void setAllowPullTransfer(boolean flag)
          他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowPushTransfer(boolean flag)
          他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowRemoteInvocation(boolean flag)
          他PFからのコンポーネント連携要求に対する可否属性を設定する.
 void setBegin(int begin)
          開始値を設定する。
 void setBegin(int begin, boolean contains)
          開始値を設定する。
 void setBeginContains(boolean contains)
          開始値のときにも処理を行なうかどうかを設定する。
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントキーを設定する。
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 void setComponentPublicName(java.lang.String publicName)
          コンポーネント公開名を設定する.
 void setContinueWhenErrorOccurred(boolean cont)
          エラーが発生したときも処理を継続するかどうかを設定する。
 void setEnd(int end)
          終了値を設定する。
 void setEnd(int end, boolean contains)
          終了値を設定する。
 void setEndContains(boolean contains)
          終了値のときにも処理を行なうかどうかを設定する。
 void setParam(int begin, boolean beginContains, int end, boolean endContains, int step)
          開始値、終了値、増分値をまとめて設定する。
 void setParam(int begin, int end, boolean endContains, int step)
          開始値、終了値、増分値をまとめて設定する。
 void setParam(int begin, int end, int step)
          開始値、終了値、増分値をまとめて設定する。
 void setStep(int step)
          増分値を設定する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFForCountController

public PFForCountController()
コンストラクタ。

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー文字列

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントキーを設定する。

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID

setComponentID

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

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()
コンポーネント公開名を取得する.

定義:
インタフェース PFComponent 内の getComponentPublicName
戻り値:
コンポーネント公開名

setComponentPublicName

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

定義:
インタフェース PFComponent 内の setComponentPublicName
パラメータ:
publicName - 設定するコンポーネント公開名
例外:
PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

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

定義:
インタフェース PFComponent 内の isAllowRemoteInvocation
戻り値:
コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowRemoteInvocation
パラメータ:
flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

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

定義:
インタフェース PFComponent 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

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

定義:
インタフェース PFComponent 内の setAllowPullTransfer
パラメータ:
flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

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

定義:
インタフェース PFComponent 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性

setAllowPushTransfer

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

定義:
インタフェース PFComponent 内の setAllowPushTransfer
パラメータ:
flag - Push型コンポーネント転送要求に対する可否

getPFActionListenerList

public java.util.Iterator getPFActionListenerList()
イベントリスナ配列を取得する。

定義:
インタフェース PFActionEventSource 内の getPFActionListenerList
戻り値:
イベントリスナイテレータ

addPFActionListener

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

定義:
インタフェース PFActionEventSource 内の addPFActionListener
パラメータ:
lis - 追加対象イベントリスナ

removePFActionListener

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

定義:
インタフェース PFActionEventSource 内の removePFActionListener
パラメータ:
lis - 削除対象イベントリスナ

firePFActionPerformed

protected boolean firePFActionPerformed(PFActionEvent event)
アクションイベントをリスナーに通知する。

パラメータ:
event - アクションイベント
戻り値:
エラーが発生しなかった場合true

localeUpdated

public void localeUpdated()
ロケール更新への対応を行う。

定義:
インタフェース PFComponent 内の localeUpdated

isBeginContains

public boolean isBeginContains()
開始値のときにも処理を行なうかどうかを取得する。

戻り値:
処理を行なう場合true

setBeginContains

public void setBeginContains(boolean contains)
開始値のときにも処理を行なうかどうかを設定する。

パラメータ:
contains - 処理を行なう場合true

getBegin

public int getBegin()
開始値を取得する。

戻り値:
開始値

setBegin

public void setBegin(int begin)
開始値を設定する。

パラメータ:
begin - 開始値

setBegin

public void setBegin(int begin,
                     boolean contains)
開始値を設定する。

パラメータ:
begin - 開始値
contains - 開始値のときにも処理を行なう場合true

isEndContains

public boolean isEndContains()
終了値のときにも処理を行なうかどうかを取得する。

戻り値:
処理を行なう場合true

setEndContains

public void setEndContains(boolean contains)
終了値のときにも処理を行なうかどうかを設定する。

パラメータ:
contains - 処理を行なう場合true

getEnd

public int getEnd()
終了値を取得する。

戻り値:
終了値

setEnd

public void setEnd(int end)
終了値を設定する。

パラメータ:
end - 終了値

setEnd

public void setEnd(int end,
                   boolean contains)
終了値を設定する。

パラメータ:
end - 終了値
contains - 終了値のときにも処理を行なう場合true

getStep

public int getStep()
増分値を取得する。

戻り値:
増分値

setStep

public void setStep(int step)
増分値を設定する。

パラメータ:
step - 増分値

getCurrent

public int getCurrent()
現在値を取得する。
処理中ではないときは不定値が返るので、注意してください。

戻り値:
現在値

isContinueWhenErrorOccurred

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

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

setContinueWhenErrorOccurred

public void setContinueWhenErrorOccurred(boolean cont)
エラーが発生したときも処理を継続するかどうかを設定する。

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

setParam

public void setParam(int begin,
                     int end,
                     int step)
開始値、終了値、増分値をまとめて設定する。
開始値・終了値のときにも処理が行なわれる。

パラメータ:
begin - 開始値
end - 終了値
step - 増分値

setParam

public void setParam(int begin,
                     int end,
                     boolean endContains,
                     int step)
開始値、終了値、増分値をまとめて設定する。
開始値のときにも処理が行なわれる。

パラメータ:
begin - 開始値
end - 終了値
endContains - 終了値のときにも処理を行なう場合true
step - 増分値

setParam

public void setParam(int begin,
                     boolean beginContains,
                     int end,
                     boolean endContains,
                     int step)
開始値、終了値、増分値をまとめて設定する。

パラメータ:
begin - 開始値
beginContains - 開始値のときにも処理を行なう場合true
end - 終了値
endContains - 終了値のときにも処理を行なう場合true
step - 増分値

call

public void call(int begin,
                 int end,
                 int step)
          throws PFComponentException
処理実行。
開始値・終了値のときにも処理は行なわれる。
アクションイベントが発生する。

パラメータ:
begin - 開始値
end - 終了値
step - 増分値
例外:
PFComponentException - 再帰呼出された場合
PFComponentException - 無限ループになる可能性がある場合
PFComponentException - 増分値が0の場合

call

public void call(int begin,
                 int end,
                 boolean endContains,
                 int step)
          throws PFComponentException
処理実行。
開始値のときにも処理は行なわれる。
アクションイベントが発生する。

パラメータ:
begin - 開始値
end - 終了値
endContains - 終了値のときにも処理を行なう場合true
step - 増分値
例外:
PFComponentException - 再帰呼出された場合
PFComponentException - 無限ループになる可能性がある場合
PFComponentException - 増分値が0の場合

call

public void call(int begin,
                 boolean beginContains,
                 int end,
                 boolean endContains,
                 int step)
          throws PFComponentException
処理実行。
アクションイベントが発生する。

パラメータ:
begin - 開始値
beginContains - 開始値のときにも処理を行なう場合true
end - 終了値
endContains - 終了値のときにも処理を行なう場合true
step - 増分値
例外:
PFComponentException - 再帰呼出された場合
PFComponentException - 無限ループになる可能性がある場合
PFComponentException - 増分値が0の場合

call

public void call()
          throws PFComponentException
処理実行。
アクションイベントが発生する。

例外:
PFComponentException - 再帰呼出された場合
PFComponentException - 無限ループになる可能性がある場合
PFComponentException - 増分値が0の場合

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException