jp.go.aist.dmrc.platform.beans.util.entity
クラス PFEntity

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.util.entity.PFEntity
すべての実装インタフェース:
PFComponent, PFXMLSerializable, java.io.Serializable
直系の既知のサブクラス:
PFLabeledObjectListEntity

public class PFEntity
extends java.lang.Object
implements PFComponent, PFXMLSerializable

オブジェクトの実体を格納するコンポーネント。

オブジェクトへのアクセスは、原則としてPFVariableによって行う。

オブジェクトはPFLabeledObjectを介して格納され、名前と型を指定することができる。

このコンポーネントからはイベントが発生しない。

変数コンポーネントと異なり、格納されたオブジェクトも含めてシリアライズされる。 アプリケーション内のデータをビルダー上で集中管理することを念頭に導入された。

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

コンストラクタの概要
PFEntity()
          デフォルトコンストラクタ
 
メソッドの概要
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 java.lang.Object getData()
          格納しているオブジェクトを返す。
 java.lang.String getName()
          オブジェクトの名前を取得する。
 java.lang.String getType()
          オブジェクトの型名を取得する。
 boolean hasData()
          オブジェクトが格納されているかチェックする。
 void localeUpdated()
          ロケール変更に対応する。
 void read(java.lang.String filename)
          ファイル名を指定してシリアライズデータを読み込む。
 void readXML(PFXMLLoader loader)
          XML入力時の追加処理を行う。
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントのキー情報を設定する
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
protected  void setData(java.lang.Object o)
          オブジェクトを格納する。
 void setEntity(java.lang.Object obj)
          オブジェクトを設定する。
 void setEntity(java.lang.String name, java.lang.Object obj)
          オブジェクトに名前を付けて設定する。
 void setEntity(java.lang.String name, java.lang.Object obj, java.lang.String type)
          オブジェクトに名前と型名を付けて設定する。
 void setName(java.lang.String name)
          オブジェクトの名前を設定する。
 void setType(java.lang.String type)
          オブジェクトの型名を設定する。
 void write(java.lang.String filename)
          ファイル名を指定してシリアライズデータを書き出す。
 void writeXML(PFXMLGenerator generator)
          XML出力時の追加処理を行う。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFEntity

public PFEntity()
デフォルトコンストラクタ

メソッドの詳細

getComponentName

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

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名
関連項目:
PFComponent.getComponentName()

getComponentKey

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

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

setComponentKey

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

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - 設定するコンポーネントのキー
関連項目:
PFComponent.setComponentKey(java.lang.String)

getComponentKeys

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

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

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

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

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

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

setComponentID

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

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

getComponentString

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

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
コンポーネントの文字列表現を返す。
関連項目:
PFComponent.getComponentString()

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated
関連項目:
PFComponent.localeUpdated()

readXML

public void readXML(PFXMLLoader loader)
XML入力時の追加処理を行う。

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
loader - XML入力

writeXML

public void writeXML(PFXMLGenerator generator)
XML出力時の追加処理を行う。

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
generator - XML出力

setEntity

public void setEntity(java.lang.String name,
                      java.lang.Object obj,
                      java.lang.String type)
               throws PFComponentException
オブジェクトに名前と型名を付けて設定する。

パラメータ:
name - 名前
obj - オブジェクト
type - 型名
例外:
PFComponentException - 例外(サブクラス用)

setEntity

public void setEntity(java.lang.String name,
                      java.lang.Object obj)
               throws PFComponentException
オブジェクトに名前を付けて設定する。 型名としてクラス名が付けられる。

パラメータ:
name - 名前
obj - オブジェクト
例外:
PFComponentException - 例外(サブクラス用)

setEntity

public void setEntity(java.lang.Object obj)
               throws PFComponentException
オブジェクトを設定する。 名前は空文字列、型名はクラス名となる。

パラメータ:
obj - オブジェクト
例外:
PFComponentException - 例外(サブクラス用)

getData

public java.lang.Object getData()
格納しているオブジェクトを返す。

戻り値:
格納しているオブジェクト

setData

protected void setData(java.lang.Object o)
オブジェクトを格納する。

パラメータ:
o - 格納するオブジェクト

getName

public java.lang.String getName()
オブジェクトの名前を取得する。

戻り値:
名前

setName

public void setName(java.lang.String name)
オブジェクトの名前を設定する。

パラメータ:
name - 名前

getType

public java.lang.String getType()
オブジェクトの型名を取得する。

戻り値:
型名

setType

public void setType(java.lang.String type)
オブジェクトの型名を設定する。

パラメータ:
type - 型名

hasData

public boolean hasData()
オブジェクトが格納されているかチェックする。

戻り値:
論理値

write

public void write(java.lang.String filename)
           throws PFComponentException
ファイル名を指定してシリアライズデータを書き出す。

パラメータ:
filename - ファイル名
例外:
PFComponentException - データ書き込み失敗

read

public void read(java.lang.String filename)
          throws PFComponentException
ファイル名を指定してシリアライズデータを読み込む。 読み込まれたデータの型が異なる場合は例外が発生する。

パラメータ:
filename - ファイル名
例外:
PFComponentException - データ読み込み失敗または型が異なる場合