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

クラス PFComponentAccessor

java.lang.Object

jp.go.aist.dmrc.platform.beans.util.reflect.PFComponentAccessor

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

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

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

同一階層に配置されたコンポーネントの検索、メソッド起動を行うコンポーネント。

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

• 処理要求イベント

  トリガー	処理要求データ	イベント番号
  invoke()、invoke(PFObjectList)で起動を試みた メソッドが存在しなかったとき（引数データ型自動設定）	起動メソッドデータ (コンポーネントKEY、メソッド名、 引数群を要素とするPFObjectList)	1
  invoke()、invokeWithTypeSpecified(PFObjectList)で 起動を試みたメソッドが存在しなかったとき（引数データ型指定）	起動メソッドデータ (コンポーネントKEY、メソッド名、 引数データ型＆引数群を要素とするPFObjectList)	2

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
PFComponentAccessor() コンポーネントを生成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addParameter(java.lang.Class type, java.lang.Object param) 起動するメソッドの引数を、データ型を指定して追加する。
void	addParameter(java.lang.Object param) 起動するメソッドの引数を追加する。
void	addParameter(java.lang.String type, java.lang.Object param) 起動するメソッドの引数を、データ型を文字列で指定して追加する。
void	addParameters(PFObjectList params) 起動するメソッドの引数をリストで追加する。
void	addParametersWithTypeSpecified(PFObjectList params) 起動するメソッドの引数を、データ型を指定してリストで追加する。
void	addPFProcessRequestListener(PFProcessRequestListener lis) 引数で与えられたイベントリスナを登録し、 処理要求イベント発生時に処理を行う対象とする。
void	clearParameterList() 起動するメソッドの引数リストを空にする。
PFComponent	getComponentByKey(java.lang.String key) 指定したKEYを持つコンポーネントを１つ取得する。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
PFObjectList	getComponentsByKey(java.lang.String key) 指定したKEYを持つコンポーネントをすべて取得する。
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
java.util.Iterator	getPFProcessRequestListenerList() 処理要求イベントリスナ配列を取得する。
java.lang.Object	getResult() 起動メソッド実行結果を取得する。
PFComponent	getSelctedComponent() 選択されているコンポーネントを１つ取得する。
java.lang.String	getSelectedComponentKey() 選択されているコンポーネントのKEYを取得する。
PFObjectList	getSelectedComponents() 選択されているコンポーネントのリストを取得する。
java.lang.Object	invoke() 起動メソッドを実行する。
java.lang.Object	invoke(PFObjectList methodData) 起動メソッドデータをリストで設定して実行する。
java.lang.Object	invokeWithRequestEvent(PFProcessRequestEvent event) 起動メソッドデータを処理要求イベントで設定して実行する。
java.lang.Object	invokeWithTypeSpecified(PFObjectList methodData) 起動メソッドデータを、引数データ型を指定してリストで設定し、実行する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
void	localeUpdated() ロケール変更に対応する。
void	readXML(PFXMLLoader in) XMLを入力する.
void	removePFProcessRequestListener(PFProcessRequestListener lis) 引数で与えられたイベントリスナを削除し、 処理要求イベント発生時に処理を行う対象から外す。
void	selectComponentByKey(java.lang.String key) KEYを指定してコンポーネントを選択する。
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	setInvokeMethod(PFObjectList methodData) 起動メソッドデータをリストで設定する。
void	setInvokeMethodWithTypeSpecified(PFObjectList methodData) 起動メソッドデータを、引数データ型を指定して、リストで設定する。
void	setMethodName(java.lang.String method) 起動するメソッド名を設定する。
void	setParameterList(PFObjectList params) 起動するメソッドの引数リストを設定する。
void	setParameterListWithTypeSpecified(PFObjectList params) 起動するメソッドの引数リストを、引数の型とともに設定する。
void	writeXML(PFXMLGenerator out) XMLを出力する.

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

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

コンストラクタの詳細

PFComponentAccessor

public PFComponentAccessor()

コンポーネントを生成する。

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

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

定義:

getComponentName インタフェース内 PFComponent

戻り値:

コンポーネント名

getComponentKey

public java.lang.String getComponentKey()

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

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する。

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()

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

戻り値:

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

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

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

パラメータ:

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

getComponentID

public int getComponentID()

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

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

setComponentID

public void setComponentID(int id)

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

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

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

getComponentString

public java.lang.String getComponentString()

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

定義:

getComponentString インタフェース内 PFComponent

戻り値:

文字列表現

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 - 削除対象イベントリスナ

localeUpdated

public void localeUpdated()

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

定義:

localeUpdated インタフェース内 PFComponent

writeXML

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

XMLを出力する.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

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

例外:

java.io.IOException

readXML

public void readXML(PFXMLLoader in)

XMLを入力する.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

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

getComponentByKey

public PFComponent getComponentByKey(java.lang.String key)

指定したKEYを持つコンポーネントを１つ取得する。

パラメータ:

key - 取得するコンポーネントのKEY

getComponentsByKey

public PFObjectList getComponentsByKey(java.lang.String key)

指定したKEYを持つコンポーネントをすべて取得する。

パラメータ:

key - 取得するコンポーネントのKEY

selectComponentByKey

public void selectComponentByKey(java.lang.String key)

KEYを指定してコンポーネントを選択する。

パラメータ:

key - 選択するコンポーネントのKEY

getSelectedComponents

public PFObjectList getSelectedComponents()

選択されているコンポーネントのリストを取得する。

戻り値:

選択されているコンポーネントのリスト

getSelctedComponent

public PFComponent getSelctedComponent()

選択されているコンポーネントを１つ取得する。

戻り値:

選択されているコンポーネント

getSelectedComponentKey

public java.lang.String getSelectedComponentKey()

選択されているコンポーネントのKEYを取得する。

戻り値:

選択されているコンポーネントのKEY

setMethodName

public void setMethodName(java.lang.String method)

起動するメソッド名を設定する。 引数リストはクリアされる。

パラメータ:

method - 起動するメソッド名

setParameterList

public void setParameterList(PFObjectList params)

起動するメソッドの引数リストを設定する。

パラメータ:

params - 引数リスト

setParameterListWithTypeSpecified

public void setParameterListWithTypeSpecified(PFObjectList params)
                                       throws PFComponentException

起動するメソッドの引数リストを、引数の型とともに設定する。 リストは、[<引数の型>,<引数>,...]として与える。 引数の型は、データ型を表す文字列あるいはClassオブジェクトで指定することができる。 データ型を表す文字列は、クラスのフルパス名の他、以下の表現を使うことができる。

型	指定文字列表現
byte	"byte"
char	"char"
double	"double"
float	"float"
int	"int"
long	"long"
short	"short"
boolean	"boolean"
void	"void"
String	"String" ※クラス指定(java.lang.String)でも可
クラス（配列以外）	クラス名（パッケージを含む完全指定）
配列	先頭に配列次元数の '[' 文字をつけた要素型名（下表参照）

配列要素データ型	要素型文字列表現	例（2次元配列の場合）
byte	'B'	"[[B"
char	'C'	"[[C"
double	'D'	"[[D"
float	'F'	"[[F"
int	'I'	"[[I"
long	'L'	"[[L"
short	'S'	"[[S"
boolean	'Z'	"[[Z"
void	'V'	"[[V"
クラス	'Lclass_name;'	"[[Ljava.lang.String;"

パラメータ:

params - 型指定をともなう引数リスト

例外:

PFComponentException - 不正なデータ型指定

clearParameterList

public void clearParameterList()

起動するメソッドの引数リストを空にする。

addParameter

public void addParameter(java.lang.Object param)

起動するメソッドの引数を追加する。

パラメータ:

param - 引数

addParameter

public void addParameter(java.lang.String type,
                         java.lang.Object param)
                  throws PFComponentException

起動するメソッドの引数を、データ型を文字列で指定して追加する。 データ型を表す文字列は、クラスのフルパス名の他、以下の表現を使うことができる。

型	指定文字列表現
byte	"byte"
char	"char"
double	"double"
float	"float"
int	"int"
long	"long"
short	"short"
boolean	"boolean"
void	"void"
String	"String" ※クラス指定(java.lang.String)でも可
クラス（配列以外）	クラス名（パッケージを含む完全指定）
配列	先頭に配列次元数の '[' 文字をつけた要素型名（下表参照）

配列要素データ型	要素型文字列表現	例（2次元配列の場合）
byte	'B'	"[[B"
char	'C'	"[[C"
double	'D'	"[[D"
float	'F'	"[[F"
int	'I'	"[[I"
long	'L'	"[[L"
short	'S'	"[[S"
boolean	'Z'	"[[Z"
void	'V'	"[[V"
クラス	'Lclass_name;'	"[[Ljava.lang.String;"

パラメータ:

type - 引数の型

param - 引数

例外:

PFComponentException - 不正なデータ型指定

addParameter

public void addParameter(java.lang.Class type,
                         java.lang.Object param)

起動するメソッドの引数を、データ型を指定して追加する。

パラメータ:

type - 引数のデータ型

param - 引数

addParameters

public void addParameters(PFObjectList params)

起動するメソッドの引数をリストで追加する。

パラメータ:

params - 引数リスト

addParametersWithTypeSpecified

public void addParametersWithTypeSpecified(PFObjectList params)
                                    throws PFComponentException

起動するメソッドの引数を、データ型を指定してリストで追加する。 リストは、[<引数の型>,<引数>,...]として与える。 引数の型は、データ型を表す文字列あるいはClassオブジェクトで指定することができる。 データ型を表す文字列は、クラスのフルパス名の他、以下の表現を使うことができる。

型	指定文字列表現
byte	"byte"
char	"char"
double	"double"
float	"float"
int	"int"
long	"long"
short	"short"
boolean	"boolean"
void	"void"
String	"String" ※クラス指定(java.lang.String)でも可
クラス（配列以外）	クラス名（パッケージを含む完全指定）
配列	先頭に配列次元数の '[' 文字をつけた要素型名（下表参照）

配列要素データ型	要素型文字列表現	例（2次元配列の場合）
byte	'B'	"[[B"
char	'C'	"[[C"
double	'D'	"[[D"
float	'F'	"[[F"
int	'I'	"[[I"
long	'L'	"[[L"
short	'S'	"[[S"
boolean	'Z'	"[[Z"
void	'V'	"[[V"
クラス	'Lclass_name;'	"[[Ljava.lang.String;"

パラメータ:

params - データ型指定をともなう引数リスト

例外:

PFComponentException - 不正なデータ型指定

setInvokeMethod

public void setInvokeMethod(PFObjectList methodData)

起動メソッドデータをリストで設定する。 このリストは、コンポーネントKEY、起動メソッド名、引数群を要素とする。

パラメータ:

methodData - 起動メソッドデータ

setInvokeMethodWithTypeSpecified

public void setInvokeMethodWithTypeSpecified(PFObjectList methodData)
                                      throws PFComponentException

起動メソッドデータを、引数データ型を指定して、リストで設定する。 このリストは、コンポーネントKEY、起動メソッド名、引数データ型＆引数群を要素とする。

パラメータ:

methodData - 起動メソッドデータ

例外:

PFComponentException

invoke

public java.lang.Object invoke(PFObjectList methodData)
                        throws PFException

起動メソッドデータをリストで設定して実行する。 このリストは、コンポーネントKEY、起動メソッド名、引数群を要素とする。 起動するメソッドが存在しないときには、起動メソッドデータを 内包データとする処理要求イベントを発生する。

パラメータ:

methodData - 起動メソッドデータ

戻り値:

起動メソッド実行結果

例外:

PFException

invokeWithTypeSpecified

public java.lang.Object invokeWithTypeSpecified(PFObjectList methodData)
                                         throws PFException

起動メソッドデータを、引数データ型を指定してリストで設定し、実行する。 このリストは、コンポーネントKEY、起動メソッド名、引数データ型＆引数群を要素とする。 起動するメソッドが存在しないときには、起動メソッドデータを 内包データとする処理要求イベントを発生する。

パラメータ:

methodData - 起動メソッドデータ

戻り値:

起動メソッド実行結果

例外:

PFException

invokeWithRequestEvent

public java.lang.Object invokeWithRequestEvent(PFProcessRequestEvent event)
                                        throws PFException

起動メソッドデータを処理要求イベントで設定して実行する。 イベント発生元コンポーネントがPFComponentAccessorでないときは何もしない。 処理要求イベントの内包データは以下の通りであり、 このコンポーネントが発生する処理要求イベントも同様の内包データを持つ。

内包データ種別	データ
イベント発生元コンポーネント	イベントを発生した元々のPFComponentAccessor
処理要求データ	コンポーネントKEY、起動メソッド名、引数情報からなるPFObjectList
イベント番号	引数データ型を指定しないとき1、指定するとき2

パラメータ:

event - 処理要求イベント

戻り値:

起動メソッド実行結果

例外:

PFException

invoke

public java.lang.Object invoke()
                        throws PFException

起動メソッドを実行する。 起動するメソッドが存在しないときには、起動メソッドデータを 内包データとする処理要求イベントを発生する。 起動メソッドデータは、コンポーネントKEY、起動メソッド名、引数群を要素とするリストである。

戻り値:

起動メソッド実行結果

例外:

PFException

getResult

public java.lang.Object getResult()

起動メソッド実行結果を取得する。

戻り値:

起動メソッド実行結果