jp.go.aist.dmrc.platform.base
クラス PFComponentBus

java.lang.Object
  jp.go.aist.dmrc.platform.base.PFComponentBus

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

java.io.Serializable, PFComponent, PFConstructBase, PFXMLSerializable, PFApplicationStartEventSource, PFApplicationTerminateEventSource, PFEventSource

public class PFComponentBus
extends java.lang.Object
implements PFConstructBase, PFApplicationStartEventSource, PFApplicationTerminateEventSource, PFXMLSerializable

コンポーネントバス。
プラットフォーム内のコンポーネントと コンポーネント間の接続関係を管理する。

関連項目:

直列化された形式

メソッドの概要

void	addComment(PFApplicationComment comment) 引数で与えられたアプリケーションコメントをプラットフォームに追加する。
void	addComment(PFApplicationComment comment, int index) 引数で与えられたアプリケーションコメントをプラットフォームに追加する。
void	addComponent(PFComponent component) 引数で与えられたコンポーネントをプラットフォームに追加する。
void	addComponent(PFComponent component, int index) 引数で与えられたコンポーネントをプラットフォームに追加する。
void	addPFApplicationStartListener(PFApplicationStartListener lis) 引数で与えられたイベントリスナを登録し、 アプリケーション開始イベント発生時に処理を行う対象とする。
void	addPFApplicationTerminateListener(PFApplicationTerminateListener lis) 引数で与えられたイベントリスナを登録し、 アプリケーション終了イベント発生時に処理を行う対象とする。
int	checkTheApplicationWasLocked() パスワードでロックされているかを確かめる.
void	clear() アプリケーション情報をクリアする。
void	clear(java.util.Stack stack) アプリケーション情報をクリアする。
void	clearAllHistory() 全ての履歴情報を削除する.
void	clearHistory(int index) 指定したインデックスの履歴情報を削除する.
void	clearHistory(java.lang.String key) 指定したキーの履歴情報と、それに連なる履歴情報を削除する.
boolean	contains(PFComponent comp) 指定されたコンポーネントを配下に含むかどうかをチェックする。
boolean	equals(java.lang.Object o) オブジェクトが同じかどうかチェックする。
int	getAllComponentCount() コメントを含むコンポーネント数を取得する。
java.util.Iterator	getAllComponentList() コメントを含むコンポーネントリストを取得する。
java.lang.String	getApplicationName() アプリケーション名称を取得する。
PFMultiLocaleString	getApplicationNames() 全ロケール分のアプリケーション名称を取得する。
PFComponent	getComponentAt(int index) 指定された位置のコンポーネントを取得する。
int	getComponentID() コンポーネントIDを取得する。
PFComponentInfo[]	getComponentInfos() プラットフォーム上のすべてのコンポーネント情報を取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
int	getContainComponentCount() コンポーネント数を取得する。
java.util.Iterator	getContainComponentList() コンポーネント配列を取得する。
boolean	getExecuteMode() 実行モードを取得する。
PFObjectList	getHistoryList() 履歴情報リストを取得する.
static PFComponentBus	getInstance() コンポーネントバスインスタンスを取得する。
PFConstructBase	getParentComponent(PFComponent comp) 指定されたコンポーネントの親構築ベースを取得する。
java.util.Stack	getParentComponentStack(PFComponent comp) 指定されたコンポーネントの親構築ベースのスタックを取得する。
java.util.Iterator	getPFApplicationStartListenerList() アプリケーション開始イベントリスナ配列を取得する。
java.util.Iterator	getPFApplicationTerminateListenerList() アプリケーション終了イベントリスナ配列を取得する。
void	informEventCompleted(jp.go.aist.dmrc.platform.util.PFComponentConnector connector) 階層内でのイベント完了を通知する。
void	informEventFired(jp.go.aist.dmrc.platform.util.PFComponentConnector connector) 階層内でのイベント発生を通知する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
boolean	isChild(PFComponent comp) 指定されたコンポーネントを直下に含むかどうかをチェックする。
void	localeUpdated() ロケール更新への対応を行う。
boolean	moveComment(PFApplicationComment comment, int i) コメントを移動する。
boolean	moveComponent(PFComponent component, int i) コンポーネントを移動する。
boolean	moveComponentToTop(int count) 最後尾のコンポーネントを先頭に移動する。
void	readXML(PFXMLLoader in) XML入力
void	registerHistory(jp.go.aist.dmrc.platform.base.PFHistoryInformation info) 履歴情報を登録する.
void	removeComment(PFApplicationComment comment) 引数で与えられたアプリケーションコメントをプラットフォームから削除する。
void	removeComponent(PFComponent component) 引数で与えられたコンポーネントをプラットフォームから削除する。
void	removeComponent(java.util.Stack baseStack, PFComponent component) 引数で与えられたコンポーネントをプラットフォームから削除する。
void	removePFApplicationStartListener(PFApplicationStartListener lis) 引数で与えられたイベントリスナを削除し、 アプリケーション開始イベント発生時に処理を行う対象から外す。
void	removePFApplicationTerminateListener(PFApplicationTerminateListener lis) 引数で与えられたイベントリスナを削除し、 アプリケーション終了イベント発生時に処理を行う対象から外す。
void	renumberComponentID() コンポーネントIDを振り直す。
void	save(java.io.File saveFile) アプリケーションをファイルに保存する。
PFComponent	searchComponent(int id) IDからコンポーネントを検索する。
jp.go.aist.dmrc.platform.base.PFHistoryInformationSearchResult	searchHistoryInfo(java.lang.String key) 指定したキーの履歴情報を検索する.
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setApplicationName(java.lang.String name) コンポーネント名称を設定する。
void	setApplicationNames(PFMultiLocaleString names) 全ロケール分のコンポーネントキーを設定する。
void	setComponentID(int id) コンポーネントIDを設定する。
void	setComponentKey(java.lang.String key) コンポーネントキーを設定する。
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
void	setExecuteMode(boolean mode) 実行モードを設定する。
static void	setInstance(PFComponentBus bus) コンポーネントバスインスタンスを設定する。
void	sortComponent() コンポーネントをID順に並べなおす。
void	startApplication() アプリケーションの開始を通知する。
static PFComponentBus	temporallyInstance() コンポーネントバスインスタンスを生成する。
void	terminateApplication() アプリケーションを終了する。
boolean	verifyPassword(java.lang.String readPass, java.lang.String inputPass) パスワードを照合する.
void	writeXML(PFXMLGenerator out) XML出力

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

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

メソッドの詳細

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 - コンポーネントキー文字列

getComponentID

public int getComponentID()

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

定義:

インタフェース PFComponent 内の getComponentID

戻り値:

コンポーネントID

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する。
ComponentBusのコンポーネントIDは0に固定するため、このメソッドは何もしない。

定義:

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

localeUpdated

public void localeUpdated()

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

定義:

インタフェース PFComponent 内の localeUpdated

getInstance

public static PFComponentBus getInstance()

コンポーネントバスインスタンスを取得する。 コンポーネントバスはアプリケーション内で唯一のインスタンスとし、 コンストラクタは提供しないため、 コンポーネントバスインスタンスの取得はすべてこのメソッドで行う。

戻り値:

コンポーネントバス

temporallyInstance

public static PFComponentBus temporallyInstance()

コンポーネントバスインスタンスを生成する。

戻り値:

コンポーネントバス

setInstance

public static void setInstance(PFComponentBus bus)

コンポーネントバスインスタンスを設定する。

パラメータ:

bus - コンポーネントバス

getPFApplicationStartListenerList

public java.util.Iterator getPFApplicationStartListenerList()

アプリケーション開始イベントリスナ配列を取得する。

定義:

インタフェース PFApplicationStartEventSource 内の getPFApplicationStartListenerList

戻り値:

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

addPFApplicationStartListener

public void addPFApplicationStartListener(PFApplicationStartListener lis)

引数で与えられたイベントリスナを登録し、 アプリケーション開始イベント発生時に処理を行う対象とする。

定義:

インタフェース PFApplicationStartEventSource 内の addPFApplicationStartListener

パラメータ:

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

removePFApplicationStartListener

public void removePFApplicationStartListener(PFApplicationStartListener lis)

引数で与えられたイベントリスナを削除し、 アプリケーション開始イベント発生時に処理を行う対象から外す。

定義:

インタフェース PFApplicationStartEventSource 内の removePFApplicationStartListener

パラメータ:

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

getPFApplicationTerminateListenerList

public java.util.Iterator getPFApplicationTerminateListenerList()

アプリケーション終了イベントリスナ配列を取得する。

定義:

インタフェース PFApplicationTerminateEventSource 内の getPFApplicationTerminateListenerList

戻り値:

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

addPFApplicationTerminateListener

public void addPFApplicationTerminateListener(PFApplicationTerminateListener lis)

引数で与えられたイベントリスナを登録し、 アプリケーション終了イベント発生時に処理を行う対象とする。

定義:

インタフェース PFApplicationTerminateEventSource 内の addPFApplicationTerminateListener

パラメータ:

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

removePFApplicationTerminateListener

public void removePFApplicationTerminateListener(PFApplicationTerminateListener lis)

引数で与えられたイベントリスナを削除し、 アプリケーション終了イベント発生時に処理を行う対象から外す。

定義:

インタフェース PFApplicationTerminateEventSource 内の removePFApplicationTerminateListener

パラメータ:

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

addComponent

public void addComponent(PFComponent component)

引数で与えられたコンポーネントをプラットフォームに追加する。 同時にコンポーネントにプラットフォーム内で一意のIDを設定する。

定義:

インタフェース PFConstructBase 内の addComponent

パラメータ:

component - 追加対象コンポーネント

addComponent

public void addComponent(PFComponent component,
                         int index)

引数で与えられたコンポーネントをプラットフォームに追加する。 同時にコンポーネントにプラットフォーム内で一意のIDを設定する。

定義:

インタフェース PFConstructBase 内の addComponent

パラメータ:

component - 追加対象コンポーネント

index - 追加位置

removeComponent

public void removeComponent(PFComponent component)
                     throws PFRuntimeException

引数で与えられたコンポーネントをプラットフォームから削除する。

定義:

インタフェース PFConstructBase 内の removeComponent

パラメータ:

component - 削除対象コンポーネント

例外:

PFRuntimeException - コンポーネント削除不可

removeComponent

public void removeComponent(java.util.Stack baseStack,
                            PFComponent component)
                     throws PFRuntimeException

引数で与えられたコンポーネントをプラットフォームから削除する。

定義:

インタフェース PFConstructBase 内の removeComponent

パラメータ:

baseStack - アプリケーション階層

component - 削除対象コンポーネント

例外:

PFRuntimeException - コンポーネント削除不可

moveComponent

public boolean moveComponent(PFComponent component,
                             int i)

コンポーネントを移動する。

定義:

インタフェース PFConstructBase 内の moveComponent

パラメータ:

component - 移動対象コンポーネント

i - 移動先

戻り値:

移動があったかどうか

moveComponentToTop

public boolean moveComponentToTop(int count)

最後尾のコンポーネントを先頭に移動する。

定義:

インタフェース PFConstructBase 内の moveComponentToTop

パラメータ:

count - 移動数

戻り値:

移動があったかどうか

addComment

public void addComment(PFApplicationComment comment)

引数で与えられたアプリケーションコメントをプラットフォームに追加する。

定義:

インタフェース PFConstructBase 内の addComment

パラメータ:

comment - 追加対象コメント

addComment

public void addComment(PFApplicationComment comment,
                       int index)

引数で与えられたアプリケーションコメントをプラットフォームに追加する。

定義:

インタフェース PFConstructBase 内の addComment

パラメータ:

comment - 追加対象コメント

index - 追加位置

removeComment

public void removeComment(PFApplicationComment comment)

引数で与えられたアプリケーションコメントをプラットフォームから削除する。

定義:

インタフェース PFConstructBase 内の removeComment

パラメータ:

comment - 削除対象コメント

moveComment

public boolean moveComment(PFApplicationComment comment,
                           int i)

コメントを移動する。

定義:

インタフェース PFConstructBase 内の moveComment

パラメータ:

comment - 移動対象コメント

i - 移動先

戻り値:

移動があったかどうか

sortComponent

public void sortComponent()

コンポーネントをID順に並べなおす。

定義:

インタフェース PFConstructBase 内の sortComponent

renumberComponentID

public void renumberComponentID()

コンポーネントIDを振り直す。

定義:

インタフェース PFConstructBase 内の renumberComponentID

getContainComponentList

public java.util.Iterator getContainComponentList()

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

定義:

インタフェース PFConstructBase 内の getContainComponentList

戻り値:

コンポーネント配列

getContainComponentCount

public int getContainComponentCount()

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

定義:

インタフェース PFConstructBase 内の getContainComponentCount

戻り値:

コンポーネント数

getComponentAt

public PFComponent getComponentAt(int index)

指定された位置のコンポーネントを取得する。

定義:

インタフェース PFConstructBase 内の getComponentAt

パラメータ:

index - 取得位置

戻り値:

コンポーネント

getAllComponentList

public java.util.Iterator getAllComponentList()

コメントを含むコンポーネントリストを取得する。

定義:

インタフェース PFConstructBase 内の getAllComponentList

戻り値:

コンポーネントリスト

getAllComponentCount

public int getAllComponentCount()

コメントを含むコンポーネント数を取得する。

定義:

インタフェース PFConstructBase 内の getAllComponentCount

戻り値:

コンポーネント数

getApplicationName

public java.lang.String getApplicationName()

アプリケーション名称を取得する。

戻り値:

アプリケーション名称

setApplicationName

public void setApplicationName(java.lang.String name)

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

パラメータ:

name - アプリケーション名称

getApplicationNames

public PFMultiLocaleString getApplicationNames()

全ロケール分のアプリケーション名称を取得する。

戻り値:

全ロケール分のアプリケーション名称

setApplicationNames

public void setApplicationNames(PFMultiLocaleString names)

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

パラメータ:

names - 全ロケール分のアプリケーション名称

getComponentInfos

public PFComponentInfo[] getComponentInfos()

プラットフォーム上のすべてのコンポーネント情報を取得する。 リモートコンポーネントの情報は含まれない。

戻り値:

全プラットフォーム情報

save

public void save(java.io.File saveFile)
          throws java.io.FileNotFoundException,
                 java.io.IOException

アプリケーションをファイルに保存する。

定義:

インタフェース PFConstructBase 内の save

パラメータ:

saveFile - 保存先ファイル

例外:

java.io.FileNotFoundException - ファイルが見つからない

java.io.IOException - ファイル出力に失敗

clear

public void clear()

アプリケーション情報をクリアする。

定義:

インタフェース PFConstructBase 内の clear

clear

public void clear(java.util.Stack stack)

アプリケーション情報をクリアする。

定義:

インタフェース PFConstructBase 内の clear

パラメータ:

stack - コンポーネント階層

setExecuteMode

public void setExecuteMode(boolean mode)

実行モードを設定する。

パラメータ:

mode - 実行中はtrue、開発中（ビルダー上）はfalse

getExecuteMode

public boolean getExecuteMode()

実行モードを取得する。

戻り値:

実行中はtrue、開発中（ビルダー上）はfalse

startApplication

public void startApplication()
                      throws PFMethodException,
                             PFRuntimeException,
                             PFDataCooperationException

アプリケーションの開始を通知する。

例外:

PFMethodException

PFRuntimeException

PFDataCooperationException

terminateApplication

public void terminateApplication()
                          throws PFMethodException,
                                 PFRuntimeException,
                                 PFDataCooperationException

アプリケーションを終了する。

例外:

PFMethodException

PFRuntimeException

PFDataCooperationException

searchComponent

public PFComponent searchComponent(int id)

IDからコンポーネントを検索する。

定義:

インタフェース PFConstructBase 内の searchComponent

パラメータ:

id - 検索するコンポーネントのID

戻り値:

検索されたコンポーネント（ない場合NULL）

equals

public boolean equals(java.lang.Object o)

オブジェクトが同じかどうかチェックする。

オーバーライド:

クラス java.lang.Object 内の equals

パラメータ:

o - チェック対象オブジェクト

戻り値:

同じ場合TRUE、それ以外はFALSE

verifyPassword

public boolean verifyPassword(java.lang.String readPass,
                              java.lang.String inputPass)

パスワードを照合する.

定義:

インタフェース PFConstructBase 内の verifyPassword

パラメータ:

readPass - 読み込んだパスワード

inputPass - 入力されたパスワード

戻り値:

一致したらtrue

checkTheApplicationWasLocked

public int checkTheApplicationWasLocked()

パスワードでロックされているかを確かめる.

定義:

インタフェース PFConstructBase 内の checkTheApplicationWasLocked

戻り値:

ロック機能が無効な場合は-2、 ロックされていない場合には-1、 最上位層がロックされている場合には0、 下位層にロックが含まれている場合には1

getHistoryList

public PFObjectList getHistoryList()

履歴情報リストを取得する.

registerHistory

public void registerHistory(jp.go.aist.dmrc.platform.base.PFHistoryInformation info)

履歴情報を登録する.

パラメータ:

info - 履歴情報

clearAllHistory

public void clearAllHistory()

全ての履歴情報を削除する.

clearHistory

public void clearHistory(int index)

指定したインデックスの履歴情報を削除する.

パラメータ:

index - 削除対象のインデックス

clearHistory

public void clearHistory(java.lang.String key)

指定したキーの履歴情報と、それに連なる履歴情報を削除する.

パラメータ:

key - 削除対象のコンポーネント公開名

searchHistoryInfo

public jp.go.aist.dmrc.platform.base.PFHistoryInformationSearchResult searchHistoryInfo(java.lang.String key)

指定したキーの履歴情報を検索する.

パラメータ:

key - 検索対象のコンポーネント公開名

戻り値:

検索結果情報

isChild

public boolean isChild(PFComponent comp)

指定されたコンポーネントを直下に含むかどうかをチェックする。

定義:

インタフェース PFConstructBase 内の isChild

パラメータ:

comp - コンポーネント

戻り値:

含む場合true

contains

public boolean contains(PFComponent comp)

指定されたコンポーネントを配下に含むかどうかをチェックする。

パラメータ:

comp - コンポーネント

戻り値:

含む場合true

getParentComponent

public PFConstructBase getParentComponent(PFComponent comp)

指定されたコンポーネントの親構築ベースを取得する。

パラメータ:

comp - コンポーネント

戻り値:

親構築ベース

getParentComponentStack

public java.util.Stack getParentComponentStack(PFComponent comp)

指定されたコンポーネントの親構築ベースのスタックを取得する。

パラメータ:

comp - コンポーネント

戻り値:

親構築ベースのスタック

writeXML

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

XML出力

定義:

インタフェース PFXMLSerializable 内の writeXML

パラメータ:

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

例外:

java.io.IOException

readXML

public void readXML(PFXMLLoader in)

XML入力

定義:

インタフェース PFXMLSerializable 内の readXML

パラメータ:

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

informEventFired

public void informEventFired(jp.go.aist.dmrc.platform.util.PFComponentConnector connector)

階層内でのイベント発生を通知する。

定義:

インタフェース PFConstructBase 内の informEventFired

パラメータ:

connector - 発生イベントのコンポーネントコネクタ

informEventCompleted

public void informEventCompleted(jp.go.aist.dmrc.platform.util.PFComponentConnector connector)

階層内でのイベント完了を通知する。

定義:

インタフェース PFConstructBase 内の informEventCompleted

パラメータ:

connector - 発生イベントのコンポーネントコネクタ