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

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.util.controller.PFFunction
すべての実装インタフェース:
PFComponent, PFEventSource, PFProcessRequestEventSource, PFXMLSerializable, java.io.Serializable

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

関数コンポーネント
このコンポーネントは、複合コンポーネントにおいて、公開メソッドを新しく定義するために使います。 call()もしくはcallWithList()メソッドを実行すると処理要求イベントが発生し、その処理結果を 戻り値として返します。call()およびcallWithList()の実行に際して引数を指定することができ、 これらの引数はgetFirstArgument()、getSecondArgument()、getThirdArgument()、 getFourthArgument()、getFifthArgument()、getArgument()の 各メソッドで取得できます。

コンポーネントから発生するイベント

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

フィールドの概要
static int FUNCTION_CALL
          関数呼び出しイベント番号
 
コンストラクタの概要
PFFunction()
          コンストラクタ
 
メソッドの概要
 void addArgument(java.lang.Object arg)
          引数を追加する。
 void addPFProcessRequestListener(PFProcessRequestListener lis)
          引数で与えられたイベントリスナを登録し、 処理要求イベント発生時に処理を行う対象とする。
 java.lang.Object call()
          引数0の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1)
          引数1の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1, java.lang.Object arg2)
          引数2の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)
          引数3の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4)
          引数4の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5)
          引数5の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6)
          引数6の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6, java.lang.Object arg7)
          引数7の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6, java.lang.Object arg7, java.lang.Object arg8)
          引数8の関数を呼び出す。
 java.lang.Object call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6, java.lang.Object arg7, java.lang.Object arg8, java.lang.Object arg9)
          引数9の関数を呼び出す。
 java.lang.Object callWithCurrentArguments()
          現在設定されている引数で処理を呼び出す。
 java.lang.Object callWithList(PFObjectList args)
          引数をリストとして与えて関数を呼び出す。
 void clearAllArguments()
          すべての引数をクリアする。
 java.lang.Object getArgument(int index)
          インデックスを指定して引数を取得する(第一引数のインデックスは0)。
 PFObjectList getArgumentList()
          引数リストを取得する。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 java.lang.Object getEighthArgument()
          第八引数を取得する。
 java.lang.Object getFifthArgument()
          第五引数を取得する。
 java.lang.Object getFirstArgument()
          第一引数を取得する。
 java.lang.Object getFourthArgument()
          第四引数を取得する。
 java.lang.Object getNinthArgument()
          第九引数を取得する。
 java.util.Iterator getPFProcessRequestListenerList()
          処理要求イベントリスナ配列を取得する。
 java.lang.Object getSecondArgument()
          第二引数を取得する。
 java.lang.Object getSeventhArgument()
          第七引数を取得する。
 java.lang.Object getSixthArgument()
          第六引数を取得する。
 java.lang.Object getThirdArgument()
          第三引数を取得する。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 void localeUpdated()
          ロケール変更に対応する。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 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 writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

FUNCTION_CALL

public static final int FUNCTION_CALL
関数呼び出しイベント番号

関連項目:
定数フィールド値
コンストラクタの詳細

PFFunction

public PFFunction()
コンストラクタ

メソッドの詳細

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型コンポーネント転送要求に対する可否

getPFProcessRequestListenerList

public java.util.Iterator getPFProcessRequestListenerList()
処理要求イベントリスナ配列を取得する。

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

addPFProcessRequestListener

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

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

removePFProcessRequestListener

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

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

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

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

call

public java.lang.Object call()
                      throws PFSystemException
引数0の関数を呼び出す。

戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1)
                      throws PFSystemException
引数1の関数を呼び出す。

パラメータ:
arg1 - 第一引数
戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2)
                      throws PFSystemException
引数2の関数を呼び出す。

パラメータ:
arg1 - 第一引数
arg2 - 第二引数
戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3)
                      throws PFSystemException
引数3の関数を呼び出す。

パラメータ:
arg1 - 第一引数
arg2 - 第二引数
arg3 - 第三引数
戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4)
                      throws PFSystemException
引数4の関数を呼び出す。

パラメータ:
arg1 - 第一引数
arg2 - 第二引数
arg3 - 第三引数
arg4 - 第四引数
戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5)
                      throws PFSystemException
引数5の関数を呼び出す。

パラメータ:
arg1 - 第一引数
arg2 - 第二引数
arg3 - 第三引数
arg4 - 第四引数
arg5 - 第五引数
戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5,
                             java.lang.Object arg6)
                      throws PFSystemException
引数6の関数を呼び出す。

パラメータ:
arg1 - 第一引数
arg2 - 第二引数
arg3 - 第三引数
arg4 - 第四引数
arg5 - 第五引数
arg6 - 第六引数
戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5,
                             java.lang.Object arg6,
                             java.lang.Object arg7)
                      throws PFSystemException
引数7の関数を呼び出す。

パラメータ:
arg1 - 第一引数
arg2 - 第二引数
arg3 - 第三引数
arg4 - 第四引数
arg5 - 第五引数
arg6 - 第六引数
arg7 - 第七引数
戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5,
                             java.lang.Object arg6,
                             java.lang.Object arg7,
                             java.lang.Object arg8)
                      throws PFSystemException
引数8の関数を呼び出す。

パラメータ:
arg1 - 第一引数
arg2 - 第二引数
arg3 - 第三引数
arg4 - 第四引数
arg5 - 第五引数
arg6 - 第六引数
arg7 - 第七引数
arg8 - 第八引数
戻り値:
関数戻り値
例外:
PFSystemException

call

public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5,
                             java.lang.Object arg6,
                             java.lang.Object arg7,
                             java.lang.Object arg8,
                             java.lang.Object arg9)
                      throws PFSystemException
引数9の関数を呼び出す。

パラメータ:
arg1 - 第一引数
arg2 - 第二引数
arg3 - 第三引数
arg4 - 第四引数
arg5 - 第五引数
arg6 - 第六引数
arg7 - 第七引数
arg8 - 第八引数
arg9 - 第九引数
戻り値:
関数戻り値
例外:
PFSystemException

callWithList

public java.lang.Object callWithList(PFObjectList args)
                              throws PFSystemException
引数をリストとして与えて関数を呼び出す。

パラメータ:
args - 引数リスト
戻り値:
関数戻り値
例外:
PFSystemException

getFirstArgument

public java.lang.Object getFirstArgument()
第一引数を取得する。

戻り値:
第一引数

getSecondArgument

public java.lang.Object getSecondArgument()
第二引数を取得する。

戻り値:
第二引数

getThirdArgument

public java.lang.Object getThirdArgument()
第三引数を取得する。

戻り値:
第三引数

getFourthArgument

public java.lang.Object getFourthArgument()
第四引数を取得する。

戻り値:
第四引数

getFifthArgument

public java.lang.Object getFifthArgument()
第五引数を取得する。

戻り値:
第五引数

getSixthArgument

public java.lang.Object getSixthArgument()
第六引数を取得する。

戻り値:
第六引数

getSeventhArgument

public java.lang.Object getSeventhArgument()
第七引数を取得する。

戻り値:
第七引数

getEighthArgument

public java.lang.Object getEighthArgument()
第八引数を取得する。

戻り値:
第七引数

getNinthArgument

public java.lang.Object getNinthArgument()
第九引数を取得する。

戻り値:
第九引数

getArgument

public java.lang.Object getArgument(int index)
インデックスを指定して引数を取得する(第一引数のインデックスは0)。

パラメータ:
index - 引数のインデックス
戻り値:
引数

getArgumentList

public PFObjectList getArgumentList()
引数リストを取得する。

戻り値:
引数リスト

clearAllArguments

public void clearAllArguments()
すべての引数をクリアする。


addArgument

public void addArgument(java.lang.Object arg)
引数を追加する。

パラメータ:
arg - 追加する引数

callWithCurrentArguments

public java.lang.Object callWithCurrentArguments()
                                          throws PFSystemException
現在設定されている引数で処理を呼び出す。

例外:
PFSystemException

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