jp.go.aist.dmrc.platform.beans.util
クラス PFTimer

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

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

タイマーコンポーネント。
タイマーコンポーネントから発生するイベントは以下のとおり。

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

コンストラクタの概要
PFTimer()
          デフォルト間隔(1秒)のタイマーを生成する。
PFTimer(int delay)
          指定間隔のタイマーを生成する。
 
メソッドの概要
 void addPFActionListener(PFActionListener lis)
          引数で与えられたイベントリスナを登録し、 アクションイベント発生時に処理を行う対象とする。
protected  void 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 getDelay()
          タイマー発生間隔を取得する。
 int getInitialDelay()
          初期遅延時間を返す。
 java.util.Iterator getPFActionListenerList()
          イベントリスナ配列を取得する。
protected  void init()
          タイマーを初期化する。
protected  void initEventListener()
          タイマーイベント初期化処理。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 boolean isRepeats()
          タイマーイベントを繰り返し発生させるかどうかを返す。
 boolean isRunning()
          タイマーが動作しているかどうかを返す。
 void localeUpdated()
          ロケール更新への対応を行う。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removePFActionListener(PFActionListener lis)
          引数で与えられたイベントリスナを削除し、 アクションイベント発生時に処理を行う対象から外す。
 void restart()
          タイマーを再起動する。
 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 setDelay(int delay)
          タイマー発生間隔を設定する。
 void setInitialDelay(int delay)
          初期遅延時間を設定する。
 void setRepeats(boolean repeat)
          タイマーイベントを繰り返し発生させるかどうかを設定する。
 void start()
          タイマーを開始する。
 void stop()
          タイマーを停止する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFTimer

public PFTimer()
デフォルト間隔(1秒)のタイマーを生成する。


PFTimer

public PFTimer(int delay)
指定間隔のタイマーを生成する。

パラメータ:
delay - 間隔(ミリ秒)
メソッドの詳細

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 void firePFActionPerformed(PFActionEvent event)
アクションイベントをリスナーに通知する。

パラメータ:
event - アクションイベント

localeUpdated

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

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

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

init

protected void init()
タイマーを初期化する。


initEventListener

protected void initEventListener()
タイマーイベント初期化処理。


getDelay

public int getDelay()
タイマー発生間隔を取得する。

戻り値:
タイマー間隔(ミリ秒)
関連項目:
setDelay(int)

setDelay

public void setDelay(int delay)
タイマー発生間隔を設定する。
ただし初期遅延時間については別途設定してください。

パラメータ:
delay - タイマー間隔(ミリ秒)
関連項目:
getDelay()

getInitialDelay

public int getInitialDelay()
初期遅延時間を返す。

戻り値:
初期遅延時間(ミリ秒)
関連項目:
setInitialDelay(int)

setInitialDelay

public void setInitialDelay(int delay)
初期遅延時間を設定する。
初期遅延時間とは、タイマー開始から一回目のイベント発生までの時間のことである。

パラメータ:
delay - 初期遅延時間(ミリ秒)
関連項目:
getInitialDelay()

isRepeats

public boolean isRepeats()
タイマーイベントを繰り返し発生させるかどうかを返す。

戻り値:
タイマーイベントを繰り返し発生させるかどうか
関連項目:
setRepeats(boolean)

setRepeats

public void setRepeats(boolean repeat)
タイマーイベントを繰り返し発生させるかどうかを設定する。
falseの場合、開始から初期遅延時間後にタイマーイベントを1回発生させて停止しますが、 このとき停止アクションイベントは発生しません。

パラメータ:
repeat - タイマーイベントを繰り返し発生させるかどうか
関連項目:
isRepeats()

isRunning

public boolean isRunning()
タイマーが動作しているかどうかを返す。

戻り値:
タイマー動作有無

start

public void start()
タイマーを開始する。


restart

public void restart()
タイマーを再起動する。


stop

public void stop()
タイマーを停止する。