jp.go.aist.dmrc.platform.beans.io

クラス PFProperties

java.lang.Object

jp.go.aist.dmrc.platform.beans.io.PFProperties

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

java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFDataSetEventSource, PFEventSource

public class PFProperties
extends java.lang.Object
implements PFComponent, PFDataCreateEventSource, PFDataSetEventSource, PFXMLSerializable

Propertiesクラスへのアクセスを提供するコンポーネント。

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

• データ設定イベント

  トリガ	対象データ	イベント番号
  データ一括設定(setMap実行時)	設定されたデータ Map	0
  データ設定(setProperty実行時)	データが設定されたキー String	1

• データ生成イベント

  トリガ	対象データ	イベント番号
  データ読み込み(readFile実行時)	読み込まれたデータ Map	0

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
PFProperties() コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addPFDataCreateListener(PFDataCreateListener lis) 引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。
void	addPFDataSetListener(PFDataSetListener lis) 引数で与えられたイベントリスナを登録し、 データ設定イベント発生時に処理を行う対象とする。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
java.util.Iterator	getPFDataCreateListenerList() データ生成イベントリスナ配列を取得する。
java.util.Iterator	getPFDataSetListenerList() データ設定イベントリスナ配列を取得する。
java.util.Map	getProperties() 登録されたプロパティとその値の一覧をMapオブジェクトで取得する。
java.lang.String	getProperty(java.lang.String key) 指定された名前のプロパティを取得する。
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) 指定された名前のプロパティを取得する。
PFObjectList	getPropertyNames() 登録されたプロパティ名の一覧をPFObjectListオブジェクトで取得する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
void	localeUpdated() ロケール変更に対応する。
void	readFile(java.io.File file) 指定されたファイルからプロパティを読み込む。
void	readFile(PFFile fileComponent) 指定されたファイルからプロパティを読み込む。
void	readFile(java.lang.String fileName) 指定されたファイルからプロパティを読み込む。
void	readXML(PFXMLLoader in) XMLを入力する.
void	removePFDataCreateListener(PFDataCreateListener lis) 引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。
void	removePFDataSetListener(PFDataSetListener 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	setMap(java.util.Map map) Mapオブジェクトからプロパティを設定する。
void	setProperty(java.lang.String name, java.lang.String value) プロパティの値を設定する。
void	store(java.io.File file, java.lang.String header) プロパティをファイルに出力する。
void	store(PFFile fileComponent, java.lang.String header) プロパティをファイルに出力する。
void	store(java.lang.String fileName, java.lang.String header) プロパティをファイルに出力する。
void	writeXML(PFXMLGenerator out) XMLを出力する.

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

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

コンストラクタの詳細

PFProperties

public PFProperties()

コンストラクタ。

メソッドの詳細

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

戻り値:

文字列表現

getPFDataSetListenerList

public java.util.Iterator getPFDataSetListenerList()

データ設定イベントリスナ配列を取得する。

定義:

getPFDataSetListenerList インタフェース内 PFDataSetEventSource

戻り値:

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

addPFDataSetListener

public void addPFDataSetListener(PFDataSetListener lis)

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

定義:

addPFDataSetListener インタフェース内 PFDataSetEventSource

パラメータ:

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

removePFDataSetListener

public void removePFDataSetListener(PFDataSetListener lis)

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

定義:

removePFDataSetListener インタフェース内 PFDataSetEventSource

パラメータ:

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

getPFDataCreateListenerList

public java.util.Iterator getPFDataCreateListenerList()

データ生成イベントリスナ配列を取得する。

定義:

getPFDataCreateListenerList インタフェース内 PFDataCreateEventSource

戻り値:

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

addPFDataCreateListener

public void addPFDataCreateListener(PFDataCreateListener lis)

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

定義:

addPFDataCreateListener インタフェース内 PFDataCreateEventSource

パラメータ:

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

removePFDataCreateListener

public void removePFDataCreateListener(PFDataCreateListener lis)

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

定義:

removePFDataCreateListener インタフェース内 PFDataCreateEventSource

パラメータ:

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

localeUpdated

public void localeUpdated()

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

定義:

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

setMap

public void setMap(java.util.Map map)
            throws PFMethodException,
                   PFRuntimeException

Mapオブジェクトからプロパティを設定する。データ設定イベントが生成される

パラメータ:

map - java.util.Mapオブジェクト

例外:

PFMethodException - イベント生成に失敗したとき

PFRuntimeException - イベント生成に失敗したとき

readFile

public void readFile(PFFile fileComponent)
              throws PFComponentException,
                     PFMethodException,
                     PFRuntimeException

指定されたファイルからプロパティを読み込む。データ生成イベントが生成される

パラメータ:

fileComponent - プロパティファイルに対応したPFFileコンポーネント

例外:

PFComponentException - ファイル読み込みに失敗したとき

PFMethodException - イベント生成に失敗したとき

PFRuntimeException - イベント生成に失敗したとき

readFile

public void readFile(java.io.File file)
              throws PFComponentException,
                     PFMethodException,
                     PFRuntimeException

指定されたファイルからプロパティを読み込む。データ生成イベントが生成される

パラメータ:

file - プロパティファイルに対応したファイル

例外:

PFComponentException - ファイル読み込みに失敗したとき

PFMethodException - イベント生成に失敗したとき

PFRuntimeException - イベント生成に失敗したとき

readFile

public void readFile(java.lang.String fileName)
              throws PFComponentException,
                     PFMethodException,
                     PFRuntimeException

指定されたファイルからプロパティを読み込む。データ生成イベントが生成される

パラメータ:

fileName - プロパティファイルに対応したファイル名

例外:

PFComponentException - ファイル読み込みに失敗したとき

PFMethodException - イベント生成に失敗したとき

PFRuntimeException - イベント生成に失敗したとき

store

public void store(java.io.File file,
                  java.lang.String header)
           throws PFComponentException

プロパティをファイルに出力する。

パラメータ:

file - 出力先ファイルのファイル

header - ファイル先頭に出力するヘッダ

例外:

PFComponentException - ファイル出力に失敗した場合

store

public void store(java.lang.String fileName,
                  java.lang.String header)
           throws PFComponentException

プロパティをファイルに出力する。

パラメータ:

file - 出力先ファイルのファイル名

header - ファイル先頭に出力するヘッダ

例外:

PFComponentException - ファイル出力に失敗した場合

getProperty

public java.lang.String getProperty(java.lang.String key)

指定された名前のプロパティを取得する。

パラメータ:

key - プロパティ名

戻り値:

プロパティの値。存在しない場合はnull

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)

指定された名前のプロパティを取得する。プロパティが存在しない場合は指定されたデフォルト値を返す。

パラメータ:

key - プロパティ名

defaultValue - プロパティが存在しない場合のデフォルト値

戻り値:

プロパティの値

getPropertyNames

public PFObjectList getPropertyNames()

登録されたプロパティ名の一覧をPFObjectListオブジェクトで取得する。

戻り値:

プロパティ名の一覧

getProperties

public java.util.Map getProperties()

登録されたプロパティとその値の一覧をMapオブジェクトで取得する。

戻り値:

プロパティとその値の一覧を格納したMap

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws PFMethodException,
                        PFRuntimeException

プロパティの値を設定する。データ設定イベントが生成される。

パラメータ:

name - プロパティ名

value - プロパティの値

例外:

PFMethodException - イベント生成に失敗したとき

PFRuntimeException - イベント生成に失敗したとき

store

public void store(PFFile fileComponent,
                  java.lang.String header)
           throws PFComponentException

プロパティをファイルに出力する。

パラメータ:

fileComponent - 出力先ファイルのPFFileコンポーネント

header - ファイル先頭に出力するヘッダ

例外:

PFComponentException - ファイル出力に失敗した場合

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入力ユーティリティ