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

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

public class PFRemoteComponent
extends java.lang.Object
implements PFComponent, PFXMLSerializable, PFComponentCooperationResultEventSource

コンポーネントごと参照するリモートコンポーネント.

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

コンストラクタの概要
PFRemoteComponent()
          コンストラクタ.
PFRemoteComponent(java.lang.String aPlatformName, java.lang.String aComponentPublicName, int aRemoteComponentID, PFObjectList aMethodList)
          コンストラクタ.
 
メソッドの概要
 void addComponentInfo(PFComponentInfo info)
          コンポーネント情報リストに、新規コンポーネント情報を追加する。
 void addPFComponentCooperationResultListener(PFComponentCooperationResultListener listener)
          引数で与えられたイベントリスナを登録し、 PFComponentCooperationResultイベント発生時に処理を行う対象とする.
 void doCallback(PFComponentCooperationResult result, int eventNo)
          コンポーネント連携の終了通知イベントを発行する.
 int getComponentID()
          コンポーネントIDを取得する.
 PFComponentInfo getComponentInfo(int index)
          指定したインデックスのコンポーネント情報を取得する.
 int getComponentInfoCount()
          コンポーネント情報リストの項目数を取得する.
 PFObjectList getComponentInfoList()
          コンポーネント情報リストを取得する.
 java.lang.String getComponentKey()
          コンポーネントキーを取得する.
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す.
 java.lang.String getComponentName()
          コンポーネント名称を取得する.
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する.
 boolean getIsAsync()
          同期/非同期フラグを取得する.
 java.util.Iterator getPFComponentCooperationResultListenerList()
          イベントリスナ配列を取得する.
 java.lang.String getPlatformName()
          連携先プラットフォーム名を取得する.
 int getRemoteComponentID()
          連携先コンポーネントIDを取得する.
 java.lang.String getRemoteComponentPublicName()
          連携先コンポーネント公開名を取得する.
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 void localeUpdated()
          ロケール更新への対応を行う.
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removeComponentInfo(int index)
          指定したインデックスのコンポーネント情報を削除する.
 void removePFComponentCooperationResultListener(PFComponentCooperationResultListener listener)
          引数で与えられたイベントリスナを削除し、 PFComponentCooperationResultイベント発生時に処理を行う対象から外す.
 void setAllowPullTransfer(boolean flag)
          他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowPushTransfer(boolean flag)
          他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowRemoteInvocation(boolean flag)
          他PFからのコンポーネント連携要求に対する可否属性を設定する.
 void setComponentID(int id)
          コンポーネントIDを設定する.
 void setComponentInfo(int index, PFComponentInfo info)
          指定したインデックスのコンポーネント情報を上書きする.
 void setComponentInfoList(PFObjectList list)
          コンポーネント情報リストを設定する.
 void setComponentKey(java.lang.String key)
          コンポーネントキーを設定する.
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する.
 void setComponentPublicName(java.lang.String publicName)
          コンポーネント公開名を設定する.
 void setIsAsync(boolean flag)
          同期/非同期フラグを設定する.
 void setPlatformName(java.lang.String aPlatformName)
          連携先プラットフォーム名を設定する.
 void setRemoteComponentID(int aRemoteCompID)
          連携先コンポーネントIDを設定する.
 void setRemoteComponentPublicName(java.lang.String aRemoteCompPName)
          連携先コンポーネント公開名を設定する.
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFRemoteComponent

public PFRemoteComponent()
コンストラクタ.


PFRemoteComponent

public PFRemoteComponent(java.lang.String aPlatformName,
                         java.lang.String aComponentPublicName,
                         int aRemoteComponentID,
                         PFObjectList aMethodList)
コンストラクタ.

パラメータ:
aPlatformName - 連携先プラットフォーム名
aComponentPublicName - 連携先コンポーネント公開名
aMethodList - メソッド情報リスト
メソッドの詳細

getComponentID

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

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID
関連項目:
setComponentID(int)

setComponentID

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

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID
関連項目:
getComponentID()

getComponentKey

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

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー
関連項目:
setComponentKey(String)

setComponentKey

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

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー
関連項目:
getComponentKey()

getComponentKeys

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

戻り値:
全ロケール分のコンポーネントキー
関連項目:
setComponentKeys(PFMultiLocaleString)

setComponentKeys

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

パラメータ:
keys - 全ロケール分のコンポーネントキー
関連項目:
getComponentKeys()

getComponentName

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

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

getComponentPublicName

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

定義:
インタフェース PFComponent 内の getComponentPublicName
戻り値:
コンポーネント公開名
関連項目:
setComponentPublicName(String)

setComponentPublicName

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

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

getComponentString

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

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

isAllowRemoteInvocation

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

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

setAllowRemoteInvocation

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

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

isAllowPullTransfer

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

定義:
インタフェース PFComponent 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性
関連項目:
setAllowPullTransfer(boolean)

setAllowPullTransfer

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

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

isAllowPushTransfer

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

定義:
インタフェース PFComponent 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性
関連項目:
setAllowPushTransfer(boolean)

setAllowPushTransfer

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

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

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)

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

getPlatformName

public java.lang.String getPlatformName()
連携先プラットフォーム名を取得する.

戻り値:
連携先プラットフォーム名
関連項目:
setPlatformName(String)

setPlatformName

public void setPlatformName(java.lang.String aPlatformName)
連携先プラットフォーム名を設定する.

パラメータ:
aPlatformName - 連携先プラットフォーム名
関連項目:
getPlatformName()

getRemoteComponentPublicName

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

戻り値:
連携先コンポーネント公開名
関連項目:
setRemoteComponentPublicName(String)

setRemoteComponentPublicName

public void setRemoteComponentPublicName(java.lang.String aRemoteCompPName)
連携先コンポーネント公開名を設定する.

パラメータ:
aRemoteCompPName - 連携先コンポーネント公開名
関連項目:
getRemoteComponentPublicName()

getRemoteComponentID

public int getRemoteComponentID()
連携先コンポーネントIDを取得する.

戻り値:
連携先コンポーネントID
関連項目:
setRemoteComponentID(int)

setRemoteComponentID

public void setRemoteComponentID(int aRemoteCompID)
連携先コンポーネントIDを設定する.

パラメータ:
aRemoteCompID - 連携先コンポーネントID
関連項目:
getRemoteComponentID()

getComponentInfoList

public PFObjectList getComponentInfoList()
コンポーネント情報リストを取得する.

戻り値:
コンポーネント情報リスト
関連項目:
setComponentInfoList(PFObjectList)

setComponentInfoList

public void setComponentInfoList(PFObjectList list)
コンポーネント情報リストを設定する.

パラメータ:
list - コンポーネント情報リスト
関連項目:
getComponentInfoList()

getIsAsync

public boolean getIsAsync()
同期/非同期フラグを取得する.

戻り値:
同期/非同期フラグ
関連項目:
setIsAsync(boolean)

setIsAsync

public void setIsAsync(boolean flag)
同期/非同期フラグを設定する.

パラメータ:
flag - 同期/非同期フラグ
関連項目:
getIsAsync()

getComponentInfoCount

public int getComponentInfoCount()
コンポーネント情報リストの項目数を取得する.

戻り値:
コンポーネント情報リストの項目数

getComponentInfo

public PFComponentInfo getComponentInfo(int index)
指定したインデックスのコンポーネント情報を取得する.

パラメータ:
index - インデックス
戻り値:
コンポーネント情報

addComponentInfo

public void addComponentInfo(PFComponentInfo info)
コンポーネント情報リストに、新規コンポーネント情報を追加する。 コンポーネント情報に不備がある場合や、既にリストにある情報と同じ場合は追加されない.

パラメータ:
info - コンポーネント情報

removeComponentInfo

public void removeComponentInfo(int index)
指定したインデックスのコンポーネント情報を削除する.

パラメータ:
index - インデックス

setComponentInfo

public void setComponentInfo(int index,
                             PFComponentInfo info)
指定したインデックスのコンポーネント情報を上書きする.

パラメータ:
index - インデックス
info - コンポーネント情報

doCallback

public void doCallback(PFComponentCooperationResult result,
                       int eventNo)
                throws PFDataCooperationComponentCooperationException
コンポーネント連携の終了通知イベントを発行する.

パラメータ:
result - 連携結果
例外:
PFDataCooperationComponentCooperationException - エラーが発生した場合