概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

jp.go.aist.dmrc.platform.beans.util.variable
クラス PFVariable

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.util.variable.PFVariable
すべての実装インタフェース:
PFComponent, PFDataSetEventSource, PFEventSource, java.io.Serializable
直系の既知のサブクラス:
PFArithmeticOperatorVariable, PFBigDecimalVariable, PFBigIntegerVariable, PFBooleanVariable, PFByteVariable, PFCollectionVariable, PFColorVariable, PFComponentVariable, PFDateVariable, PFDimensionVariable, PFDoubleVariable, PFFishboneDiagramUserObjectVariable, PFFloatVariable, PFImageVariable, PFIntegerVariable, PFLongVariable, PFMapVariable, PFObjectNetworkEdgeVariable, PFObjectNetworkNodeVariable, PFObjectVariable, PFShortVariable, PFStringVariable
public abstract class PFVariable
extends java.lang.Object
implements PFComponent, PFDataSetEventSource

オブジェクトを格納する変数コンポーネントの最上位抽象クラス。

変数コンポーネントとは、それぞれが特定のクラスのインスタンスを変数として持ち、 ユーザがビルダー上でその変数にアクセスする処理を記述するためのコンポーネントである。 コンポーネント自体はシリアライズ可能であるが、変数として持つインスタンスは シリアライズされない。

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

変数に値がセットされた場合にデータ設定イベントが発生する。 特定の型のオブジェクトが正しくセットされるかどうかはサブクラス側で保証する必要がある。

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

フィールドの概要
protected static java.lang.String PROPERTY_EXCEPTION_NULL
           
protected static java.lang.String RESOURCE_NAME
           
 
コンストラクタの概要
PFVariable()
           
 
メソッドの概要
 void addPFDataSetListener(PFDataSetListener lis)
          引数で与えられたイベントリスナを登録し、 データ設定イベント発生時に処理を行う対象とする。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 java.lang.Object getDuplicateObject()
          格納されているオブジェクトの複製を返す。
 java.lang.String getName()
          格納されているオブジェクトの名前を取得する。
protected  java.lang.Object getObject()
          格納されているオブジェクトを返す。
 java.util.Iterator getPFDataSetListenerList()
          データ設定イベントリスナ配列を取得する。
 java.lang.Object getResult()
          処理結果のオブジェクトを返す。
 boolean hasInstanceOf(java.lang.String className)
          格納されているオブジェクトが指定したクラスのインスタンスかどうかを判定する。
 boolean hasResult()
          処理結果のオブジェクトの有無をチェックする。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 boolean isNull()
          変数が空(null)かチェック
 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 setName(java.lang.String str)
          格納されているオブジェクトに名前を設定する。
protected  void setNull()
          変数を空(null)にする。
protected  void setObject(java.lang.Object obj)
          オブジェクトを格納する。
protected  void setObjectQuiet(java.lang.Object obj)
          オブジェクトを格納する。
protected  void setResult(java.lang.Object res)
          処理結果のオブジェクトをセットする。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース jp.go.aist.dmrc.platform.base.PFComponent から継承したメソッド
getComponentName, localeUpdated
 

フィールドの詳細

RESOURCE_NAME

protected static final java.lang.String RESOURCE_NAME
関連項目:
定数フィールド値

PROPERTY_EXCEPTION_NULL

protected static final java.lang.String PROPERTY_EXCEPTION_NULL
関連項目:
定数フィールド値
コンストラクタの詳細

PFVariable

public PFVariable()
メソッドの詳細

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()

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

getPFDataSetListenerList

public java.util.Iterator getPFDataSetListenerList()
データ設定イベントリスナ配列を取得する。

定義:
インタフェース PFDataSetEventSource 内の getPFDataSetListenerList
戻り値:
イベントリスナイテレータ

addPFDataSetListener

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

定義:
インタフェース PFDataSetEventSource 内の addPFDataSetListener
パラメータ:
lis - 追加対象イベントリスナ

removePFDataSetListener

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

定義:
インタフェース PFDataSetEventSource 内の removePFDataSetListener
パラメータ:
lis - 削除対象イベントリスナ

setObject

protected void setObject(java.lang.Object obj)
                  throws PFException
オブジェクトを格納する。 このときデータ設定イベントが発生する。

パラメータ:
obj - 格納するオブジェクト
例外:
PFException - イベント処理のエラー

setObjectQuiet

protected void setObjectQuiet(java.lang.Object obj)
オブジェクトを格納する。 ただし、データ設定イベントが発生しない。

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

getObject

protected java.lang.Object getObject()
格納されているオブジェクトを返す。

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

getDuplicateObject

public java.lang.Object getDuplicateObject()
                                    throws PFComponentException
格納されているオブジェクトの複製を返す。 複製は内部的にシリアライズ・デシリアライズを実行することで達成される。 そのため、複製されるオブジェクトはデータを完全にコピーした別オブジェクトとなる。

戻り値:
複製されたオブジェクト
例外:
PFComponentException - シリアライズ失敗

setNull

protected void setNull()
変数を空(null)にする。 データ設定イベントは発生しない。

isNull

public boolean isNull()
変数が空(null)かチェック

戻り値:
論理値

getResult

public java.lang.Object getResult()
処理結果のオブジェクトを返す。

戻り値:
結果

setResult

protected void setResult(java.lang.Object res)
処理結果のオブジェクトをセットする。

パラメータ:
res - 結果

hasResult

public boolean hasResult()
処理結果のオブジェクトの有無をチェックする。

戻り値:
論理値

getName

public java.lang.String getName()
格納されているオブジェクトの名前を取得する。

戻り値:
名前

setName

public void setName(java.lang.String str)
格納されているオブジェクトに名前を設定する。

パラメータ:
str - 名前

hasInstanceOf

public boolean hasInstanceOf(java.lang.String className)
格納されているオブジェクトが指定したクラスのインスタンスかどうかを判定する。 上位クラスやインタフェースを指定した場合もtrueが返る。 変数が空の場合や指定したクラス名が無効な場合はfalseが返る。

パラメータ:
className - クラス名
戻り値:
真偽値
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド