jp.go.aist.dmrc.platform.beans.datacooperation
クラス PFComponentCooperationComponent

java.lang.Object
  jp.go.aist.dmrc.platform.beans.datacooperation.PFComponentCooperationComponent

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

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

public class PFComponentCooperationComponent

extends java.lang.Object

implements PFComponent, PFComponentCooperationResultEventSource, PFXMLSerializable

コンポーネント連携機能を実装するクラス.

関連項目:

直列化された形式

コンストラクタの概要

PFComponentCooperationComponent()
コンストラクタ.

PFComponentCooperationComponent(PFComponentInfo aComponentInfo)
コンストラクタ.

メソッドの概要

void	addPFComponentCooperationResultListener(PFComponentCooperationResultListener listener) 引数で与えられたイベントリスナを登録し、 PFComponentCooperationResultイベント発生時に処理を行う対象とする.
void	doCallback(PFComponentCooperationResult result, int eventNo) コンポーネント連携の終了通知イベントを発行する.
java.lang.String[]	getArgType() 引数の型名の配列を取得する.
java.lang.String	getBrokerName() ブローカ名を取得する.
int	getComponentID() コンポーネントIDを取得する.
java.lang.String	getComponentKey() コンポーネントキーを取得する.
java.lang.String	getComponentName() コンポーネント名称を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する.
boolean	getIsAsync() 同期・非同期制御フラグを取得する.
boolean	getIsLight() 簡素版フラグを取得する.
java.lang.String	getMethodName() メソッド名を取得する.
java.lang.String	getMethodString() メソッド表示文字列（引数含む）を取得する.
java.util.Iterator	getPFComponentCooperationResultListenerList() イベントリスナ配列を取得する.
java.lang.String	getPlatformName() プラットフォーム名を取得する.
int	getRemoteComponentID() リモートでのコンポーネントIDを取得する.
java.lang.String	getReturnType() 戻り値の型名を取得する.
void	localeUpdated() ロケール更新への対応を行う.
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	removePFComponentCooperationResultListener(PFComponentCooperationResultListener listener) 引数で与えられたイベントリスナを削除し、 PFComponentCooperationResultイベント発生時に処理を行う対象から外す.
void	setArgType(java.lang.String[] aArgType) 引数の型名の配列を設定する.
void	setBrokerName(java.lang.String aBrokerName) ブローカ名を設定する.
void	setComponentID(int id) コンポーネントIDを設定する.
void	setComponentInfo(PFComponentInfo info) コンポーネント情報を設定する.
void	setComponentInfo(java.lang.String aBrokerName, java.lang.String aPlatformName, java.lang.String aComponentName, int aComponentID, java.lang.String aComponentKey, java.lang.String aMethodName, java.lang.String aReturnType, java.lang.String aArgTypes) コンポーネント情報を設定する.
void	setComponentInfo(java.lang.String aBrokerName, java.lang.String aPlatformName, java.lang.String aComponentName, int aComponentID, java.lang.String aComponentKey, java.lang.String aMethodName, java.lang.String aReturnType, java.lang.String[] aArgType) コンポーネント情報を設定する.
void	setComponentKey(java.lang.String key) コンポーネントキーを設定する.
void	setComponentName(java.lang.String name) コンポーネント名称を設定する.
void	setIsAsync(boolean flag) 同期・非同期制御フラグを設定する.
void	setIsLight(boolean flag) 簡素版フラグを設定する.
void	setMethodName(java.lang.String aMethodName) メソッド名を設定する.
void	setPlatformName(java.lang.String aPlatformName) プラットフォーム名を設定する.
void	setRemoteComponentID(int newRemoteComponentID) リモートでのコンポーネントIDを設定する.
void	setReturnType(java.lang.String aReturnType) 戻り値の型名を設定する.
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

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

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

コンストラクタの詳細

PFComponentCooperationComponent

public PFComponentCooperationComponent(PFComponentInfo aComponentInfo)

コンストラクタ.

パラメータ:

aComponentInfo - 連携対象のコンポーネント情報

PFComponentCooperationComponent

public PFComponentCooperationComponent()

コンストラクタ.

メソッドの詳細

setComponentInfo

public void setComponentInfo(PFComponentInfo info)

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

パラメータ:

info - コンポーネント情報

setComponentInfo

public void setComponentInfo(java.lang.String aBrokerName,
                             java.lang.String aPlatformName,
                             java.lang.String aComponentName,
                             int aComponentID,
                             java.lang.String aComponentKey,
                             java.lang.String aMethodName,
                             java.lang.String aReturnType,
                             java.lang.String[] aArgType)

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

パラメータ:

aBrokerName - ブローカ名

aPlatformName - プラットフォーム名

aComponentName - コンポーネント名

aComponentID - リモートでのコンポーネントID

aComponentKey - コンポーネントキー

aMethodName - メソッド名

aReturnType - 戻り値の型名

aArgType - 引数の型名（配列）

setComponentInfo

public void setComponentInfo(java.lang.String aBrokerName,
                             java.lang.String aPlatformName,
                             java.lang.String aComponentName,
                             int aComponentID,
                             java.lang.String aComponentKey,
                             java.lang.String aMethodName,
                             java.lang.String aReturnType,
                             java.lang.String aArgTypes)

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

パラメータ:

aBrokerName - ブローカ名

aPlatformName - プラットフォーム名

aComponentName - コンポーネント名

aComponentID - リモートでのコンポーネントID

aComponentKey - コンポーネントキー

aMethodName - メソッド名

aReturnType - 戻り値の型名

aArgTypes - 引数の型名（カンマ区切りで列挙）

getBrokerName

public java.lang.String getBrokerName()

ブローカ名を取得する.

戻り値:

ブローカ名

setBrokerName

public void setBrokerName(java.lang.String aBrokerName)

ブローカ名を設定する.

パラメータ:

aBrokerName - ブローカ名

getPlatformName

public java.lang.String getPlatformName()

プラットフォーム名を取得する.

戻り値:

プラットフォーム名

setPlatformName

public void setPlatformName(java.lang.String aPlatformName)

プラットフォーム名を設定する.

パラメータ:

aPlatformName - プラットフォーム名

getRemoteComponentID

public int getRemoteComponentID()

リモートでのコンポーネントIDを取得する.

戻り値:

コンポーネントID

setRemoteComponentID

public void setRemoteComponentID(int newRemoteComponentID)

リモートでのコンポーネントIDを設定する.

パラメータ:

newRemoteComponentID - 設定後のコンポーネントID

getMethodName

public java.lang.String getMethodName()

メソッド名を取得する.

戻り値:

メソッド名

setMethodName

public void setMethodName(java.lang.String aMethodName)

メソッド名を設定する.

パラメータ:

aMethodName -

getArgType

public java.lang.String[] getArgType()

引数の型名の配列を取得する.

戻り値:

引数の型名の配列

setArgType

public void setArgType(java.lang.String[] aArgType)

引数の型名の配列を設定する.

パラメータ:

aArgType -

getReturnType

public java.lang.String getReturnType()

戻り値の型名を取得する.

戻り値:

戻り値の型名

setReturnType

public void setReturnType(java.lang.String aReturnType)

戻り値の型名を設定する.

パラメータ:

aReturnType -

getIsAsync

public boolean getIsAsync()

同期・非同期制御フラグを取得する.

戻り値:

同期・非同期制御フラグ

関連項目:

setIsAsync(boolean)

setIsAsync

public void setIsAsync(boolean flag)

同期・非同期制御フラグを設定する.

パラメータ:

flag - 同期・非同期制御フラグ

関連項目:

getIsAsync()

getIsLight

public boolean getIsLight()

簡素版フラグを取得する.

戻り値:

簡素版かどうかを表すフラグ

関連項目:

setIsLight(boolean)

setIsLight

public void setIsLight(boolean flag)

簡素版フラグを設定する.

パラメータ:

flag - 簡素版かどうかを表すフラグ

関連項目:

getIsLight()

getMethodString

public java.lang.String getMethodString()

メソッド表示文字列（引数含む）を取得する.

戻り値:

メソッド文字列

getComponentName

public java.lang.String getComponentName()

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

定義:

インタフェース PFComponent 内の getComponentName

戻り値:

コンポーネント名

setComponentName

public void setComponentName(java.lang.String name)

コンポーネント名称を設定する.

パラメータ:

name - コンポーネント名

関連項目:

getComponentName()

getComponentKey

public java.lang.String getComponentKey()

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

定義:

インタフェース PFComponent 内の getComponentKey

戻り値:

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

関連項目:

setComponentKey(java.lang.String)

setComponentKey

public void setComponentKey(java.lang.String key)

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

定義:

インタフェース PFComponent 内の setComponentKey

パラメータ:

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

関連項目:

getComponentKey()

getComponentID

public int getComponentID()

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

定義:

インタフェース PFComponent 内の getComponentID

戻り値:

コンポーネントID

関連項目:

setComponentID(int)

setComponentID

public void setComponentID(int id)

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

定義:

インタフェース PFComponent 内の setComponentID

パラメータ:

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

関連項目:

getComponentID()

getComponentString

public java.lang.String getComponentString()

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

定義:

インタフェース PFComponent 内の getComponentString

戻り値:

文字列表現

localeUpdated

public void localeUpdated()

ロケール更新への対応を行う.

定義:

インタフェース PFComponent 内の localeUpdated

getPFComponentCooperationResultListenerList

public java.util.Iterator getPFComponentCooperationResultListenerList()

インタフェース PFComponentCooperationResultEventSource の記述:

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

定義:

インタフェース PFComponentCooperationResultEventSource 内の getPFComponentCooperationResultListenerList

戻り値:

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

addPFComponentCooperationResultListener

public void addPFComponentCooperationResultListener(PFComponentCooperationResultListener listener)

インタフェース PFComponentCooperationResultEventSource の記述:

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

定義:

インタフェース PFComponentCooperationResultEventSource 内の addPFComponentCooperationResultListener

パラメータ:

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

関連項目:

PFComponentCooperationResultEventSource.removePFComponentCooperationResultListener(jp.go.aist.dmrc.platform.datacooperation.interfaces.PFComponentCooperationResultListener)

removePFComponentCooperationResultListener

public void removePFComponentCooperationResultListener(PFComponentCooperationResultListener listener)

インタフェース PFComponentCooperationResultEventSource の記述:

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

定義:

インタフェース PFComponentCooperationResultEventSource 内の removePFComponentCooperationResultListener

パラメータ:

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

関連項目:

PFComponentCooperationResultEventSource.addPFComponentCooperationResultListener(jp.go.aist.dmrc.platform.datacooperation.interfaces.PFComponentCooperationResultListener)

doCallback

public void doCallback(PFComponentCooperationResult result,
                       int eventNo)
                throws PFDataCooperationComponentCooperationException

コンポーネント連携の終了通知イベントを発行する.

パラメータ:

result - 連携結果

例外:

PFDataCooperationComponentCooperationException - エラーが発生した場合

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