|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object jp.go.aist.dmrc.platform.beans.io.PFProperties
public class PFProperties
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 |
コンストラクタの詳細 |
---|
public PFProperties()
メソッドの詳細 |
---|
public java.lang.String getComponentName()
PFComponent
内の getComponentName
public java.lang.String getComponentKey()
PFComponent
内の getComponentKey
public void setComponentKey(java.lang.String key)
PFComponent
内の setComponentKey
key
- コンポーネントキーpublic PFMultiLocaleString getComponentKeys()
public void setComponentKeys(PFMultiLocaleString keys)
keys
- 全ロケール分のコンポーネントキーpublic int getComponentID()
PFComponent
内の getComponentID
public void setComponentID(int id)
PFComponentBus
から設定される。
各コンポーネント内では操作しないこと。
PFComponent
内の setComponentID
id
- 設定するコンポーネントIDpublic java.lang.String getComponentString()
PFComponent
内の getComponentString
public java.util.Iterator getPFDataSetListenerList()
PFDataSetEventSource
内の getPFDataSetListenerList
public void addPFDataSetListener(PFDataSetListener lis)
PFDataSetEventSource
内の addPFDataSetListener
lis
- 追加対象イベントリスナpublic void removePFDataSetListener(PFDataSetListener lis)
PFDataSetEventSource
内の removePFDataSetListener
lis
- 削除対象イベントリスナpublic java.util.Iterator getPFDataCreateListenerList()
PFDataCreateEventSource
内の getPFDataCreateListenerList
public void addPFDataCreateListener(PFDataCreateListener lis)
PFDataCreateEventSource
内の addPFDataCreateListener
lis
- 追加対象イベントリスナpublic void removePFDataCreateListener(PFDataCreateListener lis)
PFDataCreateEventSource
内の removePFDataCreateListener
lis
- 削除対象イベントリスナpublic void localeUpdated()
PFComponent
内の localeUpdated
public java.lang.String getComponentPublicName()
PFComponent
内の getComponentPublicName
public void setComponentPublicName(java.lang.String publicName) throws PFComponentException
PFComponent
内の setComponentPublicName
publicName
- 設定するコンポーネント公開名
PFComponentException
- 規約に反する名前が設定されようとした場合public boolean isAllowRemoteInvocation()
PFComponent
内の isAllowRemoteInvocation
public void setAllowRemoteInvocation(boolean flag)
PFComponent
内の setAllowRemoteInvocation
flag
- コンポーネント連携要求に対する可否public boolean isAllowPullTransfer()
PFComponent
内の isAllowPullTransfer
public void setAllowPullTransfer(boolean flag)
PFComponent
内の setAllowPullTransfer
flag
- Pull型コンポーネント転送要求に対する可否public boolean isAllowPushTransfer()
PFComponent
内の isAllowPushTransfer
public void setAllowPushTransfer(boolean flag)
PFComponent
内の setAllowPushTransfer
flag
- Push型コンポーネント転送要求に対する可否public void setMap(java.util.Map map) throws PFMethodException, PFRuntimeException
map
- java.util.Mapオブジェクト
PFMethodException
- イベント生成に失敗したとき
PFRuntimeException
- イベント生成に失敗したときpublic void readFile(PFFile fileComponent) throws PFComponentException, PFMethodException, PFRuntimeException
fileComponent
- プロパティファイルに対応したPFFileコンポーネント
PFComponentException
- ファイル読み込みに失敗したとき
PFMethodException
- イベント生成に失敗したとき
PFRuntimeException
- イベント生成に失敗したときpublic void readFile(java.io.File file) throws PFComponentException, PFMethodException, PFRuntimeException
file
- プロパティファイルに対応したファイル
PFComponentException
- ファイル読み込みに失敗したとき
PFMethodException
- イベント生成に失敗したとき
PFRuntimeException
- イベント生成に失敗したときpublic void readFile(java.lang.String fileName) throws PFComponentException, PFMethodException, PFRuntimeException
fileName
- プロパティファイルに対応したファイル名
PFComponentException
- ファイル読み込みに失敗したとき
PFMethodException
- イベント生成に失敗したとき
PFRuntimeException
- イベント生成に失敗したときpublic void store(java.io.File file, java.lang.String header) throws PFComponentException
file
- 出力先ファイルのファイルheader
- ファイル先頭に出力するヘッダ
PFComponentException
- ファイル出力に失敗した場合public void store(java.lang.String fileName, java.lang.String header) throws PFComponentException
file
- 出力先ファイルのファイル名header
- ファイル先頭に出力するヘッダ
PFComponentException
- ファイル出力に失敗した場合public java.lang.String getProperty(java.lang.String key)
key
- プロパティ名
public java.lang.String getProperty(java.lang.String key, java.lang.String defaultValue)
key
- プロパティ名defaultValue
- プロパティが存在しない場合のデフォルト値
public PFObjectList getPropertyNames()
public java.util.Map getProperties()
public void setProperty(java.lang.String name, java.lang.String value) throws PFMethodException, PFRuntimeException
name
- プロパティ名value
- プロパティの値
PFMethodException
- イベント生成に失敗したとき
PFRuntimeException
- イベント生成に失敗したときpublic void store(PFFile fileComponent, java.lang.String header) throws PFComponentException
fileComponent
- 出力先ファイルのPFFileコンポーネントheader
- ファイル先頭に出力するヘッダ
PFComponentException
- ファイル出力に失敗した場合public void writeXML(PFXMLGenerator out) throws java.io.IOException
PFXMLSerializable
内の writeXML
out
- XML出力ユーティリティ
java.io.IOException
public void readXML(PFXMLLoader in)
PFXMLSerializable
内の readXML
in
- XML入力ユーティリティ
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |