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

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.util.variable.PFVariable
      拡張jp.go.aist.dmrc.platform.beans.util.variable.PFComponentVariable
すべての実装インタフェース:
PFComponent, PFDataSetEventSource, PFEventSource, PFXMLSerializable, java.io.Serializable

public class PFComponentVariable
extends PFVariable
implements PFXMLSerializable

コンポーネント(PFComponent)を格納する変数コンポーネント。

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

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

フィールドの概要
 
クラス jp.go.aist.dmrc.platform.beans.util.variable.PFVariable から継承したフィールド
PROPERTY_EXCEPTION_NULL
 
コンストラクタの概要
PFComponentVariable()
          デフォルトコンストラクタ
 
メソッドの概要
 void addInvokeMethodParameter(java.lang.String type, java.lang.Object param)
          起動メソッドに引数を追加する。
 boolean equalsVariable(java.lang.Object v0)
          格納されているコンポーネントとの一致判定を行う。
 PFComponent getChildComponent(java.lang.String className, java.lang.String key)
          条件を指定して子コンポーネントを取得する。
 java.util.Map getChildComponentMap(java.lang.String className)
          条件を指定して子コンポーネントのハッシュマップを取得する。
 PFObjectList getChildComponents(java.lang.String className, java.lang.String key)
          条件を指定して子コンポーネントのリストを取得する。
 java.lang.Class getClassVariable()
          格納されているコンポーネントのクラスを取得する。
 PFComponent getComponent()
          コンポーネントを取得する。
 int getComponentIDVariable()
          jp.go.aist.dmrc.platform.base.PFComponent.getComponentID()を呼び出す。
 java.lang.String getComponentKeyVariable()
          jp.go.aist.dmrc.platform.base.PFComponent.getComponentKey()を呼び出す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentNameVariable()
          jp.go.aist.dmrc.platform.base.PFComponent.getComponentName()を呼び出す。
 java.lang.String getComponentStringVariable()
          jp.go.aist.dmrc.platform.base.PFComponent.getComponentString()を呼び出す。
 java.lang.Object getDuplicateObject()
          格納されているオブジェクトの複製を返す。
 PFWindowComponent getWindowAncestor()
          格納されているコンポーネントの親ウィンドウを取得する。
 void initialize()
          初期化する。
 java.lang.Object invoke()
          起動メソッドを実行する。
 void localeUpdated()
          ロケール変更に対応する。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void setComponent(PFComponent comp)
          コンポーネントを設定する。
 void setComponentQuiet(PFComponent comp)
          コンポーネントを設定する(イベント発生なし)。
 void setInvokeMethodName(java.lang.String methodName)
          起動メソッド名を設定する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス jp.go.aist.dmrc.platform.beans.util.variable.PFVariable から継承したメソッド
addPFDataSetListener, getComponentID, getComponentKey, getComponentKeys, getComponentPublicName, getComponentString, getName, getObject, getPFDataSetListenerList, getResult, hasInstanceOf, hasResult, isAllowPullTransfer, isAllowPushTransfer, isAllowRemoteInvocation, isNull, removePFDataSetListener, setAllowPullTransfer, setAllowPushTransfer, setAllowRemoteInvocation, setComponentID, setComponentKey, setComponentKeys, setComponentPublicName, setName, setNull, setObject, setObjectQuiet, setResult
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFComponentVariable

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

メソッドの詳細

getComponentName

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

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

localeUpdated

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

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

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException

setComponent

public void setComponent(PFComponent comp)
                  throws PFException
コンポーネントを設定する。 データ設定イベントが発生する。

パラメータ:
comp - コンポーネント
例外:
PFException - イベント処理のエラー

setComponentQuiet

public void setComponentQuiet(PFComponent comp)
コンポーネントを設定する(イベント発生なし)。

パラメータ:
comp - コンポーネント

getComponent

public PFComponent getComponent()
コンポーネントを取得する。

戻り値:
コンポーネント

setInvokeMethodName

public void setInvokeMethodName(java.lang.String methodName)
                         throws PFComponentException
起動メソッド名を設定する。

パラメータ:
methodName - 起動メソッド名
例外:
PFComponentException - コンポーネントが未設定

addInvokeMethodParameter

public void addInvokeMethodParameter(java.lang.String type,
                                     java.lang.Object param)
                              throws PFComponentException
起動メソッドに引数を追加する。

パラメータ:
type - メソッド引数データ型の文字列表現
指定文字列表現
byte "byte"
char "char"
double "double"
float "float"
int "int"
long "long"
short "short"
boolean "boolean"
void "void"
String "String" ※クラス指定(java.lang.String)でも可
クラス(配列以外) クラス名(パッケージを含む完全指定)
配列 先頭に配列次元数の '[' 文字をつけた要素型名(下表参照)

配列要素データ型 要素型文字列表現 例(2次元配列の場合)
byte 'B' "[[B"
char 'C' "[[C"
double 'D' "[[D"
float 'F' "[[F"
int 'I' "[[I"
long 'L' "[[L"
short 'S' "[[S"
boolean 'Z' "[[Z"
void 'V' "[[V"
クラス 'Lclass_name;' "[[Ljava.lang.String;"
param - メソッド引数データ
例外:
PFComponentException - コンポーネントか起動メソッドが未設定

invoke

public java.lang.Object invoke()
                        throws PFException
起動メソッドを実行する。

戻り値:
起動メソッドの戻り値
例外:
PFComponentException - コンポーネントか起動メソッドが未設定またはメソッド実行の失敗
PFException

getDuplicateObject

public java.lang.Object getDuplicateObject()
                                    throws PFComponentException
格納されているオブジェクトの複製を返す。 複製は内部的にシリアライズ・デシリアライズを実行することで達成される。 そのため、複製されるオブジェクトはデータを完全にコピーした別オブジェクトとなる。 ただし、イベント処理に関しては階層を与えないと複製できないため、このメソッド でイベント処理の情報は完全に複製されない。

オーバーライド:
クラス PFVariable 内の getDuplicateObject
戻り値:
複製されたオブジェクト
例外:
PFComponentException - シリアライズ失敗

getChildComponentMap

public java.util.Map getChildComponentMap(java.lang.String className)
条件を指定して子コンポーネントのハッシュマップを取得する。 格納しているコンポーネントがアプリケーションおよび複合コンポーネント以外の場合と、 指定した条件に一致するコンポーネントがない場合には空のマップを返す。 クラス名の条件を指定しない場合にはnullまたは空文字を引数に指定する。 コンポーネントのキーをハッシュマップのキーとするが、キーが一致するものに関しては 最初に格納されたもののみを保持する。

パラメータ:
className - クラス名
戻り値:
子コンポーネントのマップ

getChildComponents

public PFObjectList getChildComponents(java.lang.String className,
                                       java.lang.String key)
条件を指定して子コンポーネントのリストを取得する。 格納しているコンポーネントがアプリケーションおよび複合コンポーネント以外の場合と、 指定した条件に一致するコンポーネントがない場合には空のリストを返す。 クラス名とキーの条件を指定しない場合にはnullまたは空文字を引数に指定する。

パラメータ:
className - クラス名
key - キー
戻り値:
子コンポーネントのリスト

getChildComponent

public PFComponent getChildComponent(java.lang.String className,
                                     java.lang.String key)
条件を指定して子コンポーネントを取得する。 格納しているコンポーネントがアプリケーションおよび複合コンポーネント以外の場合と、 指定した条件に一致するコンポーネントがない場合にはnullを返す。 一致するコンポーネントが複数ある場合には最初に一致したものを返す。 クラス名とキーの条件を指定しない場合にはnullまたは空文字を引数に指定する。

パラメータ:
className - クラス名
key - キー
戻り値:
子コンポーネント

getClassVariable

public java.lang.Class getClassVariable()
                                 throws PFException
格納されているコンポーネントのクラスを取得する。

戻り値:
格納されているコンポーネントのクラス
例外:
PFException - 変数が空のとき発生

equalsVariable

public boolean equalsVariable(java.lang.Object v0)
                       throws PFException
格納されているコンポーネントとの一致判定を行う。

パラメータ:
v0 - java.lang.Object
戻り値:
論理値
例外:
PFException - 変数が空のとき発生

getWindowAncestor

public PFWindowComponent getWindowAncestor()
                                    throws PFComponentException
格納されているコンポーネントの親ウィンドウを取得する。 格納されているコンポーネントが画面部品以外の場合や、親ウィンドウが存在しない場合は nullが返る。

戻り値:
親ウィンドウ
例外:
PFComponentException - 変数が空のとき発生

initialize

public void initialize()
初期化する。 データ設定イベントは発生しない。


getComponentNameVariable

public java.lang.String getComponentNameVariable()
                                          throws PFException
jp.go.aist.dmrc.platform.base.PFComponent.getComponentName()を呼び出す。

戻り値:
java.lang.String
例外:
PFException

getComponentKeyVariable

public java.lang.String getComponentKeyVariable()
                                         throws PFException
jp.go.aist.dmrc.platform.base.PFComponent.getComponentKey()を呼び出す。

戻り値:
java.lang.String
例外:
PFException

getComponentIDVariable

public int getComponentIDVariable()
                           throws PFException
jp.go.aist.dmrc.platform.base.PFComponent.getComponentID()を呼び出す。

戻り値:
int
例外:
PFException

getComponentStringVariable

public java.lang.String getComponentStringVariable()
                                            throws PFException
jp.go.aist.dmrc.platform.base.PFComponent.getComponentString()を呼び出す。

戻り値:
java.lang.String
例外:
PFException