jp.go.aist.dmrc.platform.beans.util.variable

クラス PFVariableImplementer

java.lang.Object

jp.go.aist.dmrc.platform.beans.util.variable.PFVariableImplementer

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

java.io.Serializable, PFComponent, PFXMLSerializable

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

変数コンポーネント機能実装コンポーネント

このコンポーネントは、変数コンポーネントの機能実装部分のプログラムを 生成します。変数コンポーネントに格納するクラスの完全名およびプログラムの 出力先ファイルを指定すると、そのクラスの公開メソッドを呼び出すプログラムを 書き出します。

注意事項

• 変数コンポーネントには、割り当てられたオブジェクトを取得するために getObject(){return(割り当てられたオブジェクト);}という メソッドを実装する必要があります。
• 変数コンポーネントは、メソッドの返値に一時的に保持し、それをあとから取り出せ るように実装します。そのために、変数コンポーネントには、メソッドの返値を一時的に 保持するメソッドとしてsetResult(java.lang.Object result)、 保持されたメソッド返値を取得するメソッドとして getResult(){return(保持されたメソッド返値);}を実装する必要があります。 ここでresultはメソッドの返値です。メソッドの返値が基本データ型の場合、それらは 対応するオブジェクトに変換されます。
• 返値の型が、変数コンポーネントに格納するオブジェクトの型と同じになる メソッドについては、返値をそのまま返すメソッドのほかに、返値を格納された オブジェクトと置き換えるメソッドも生成します。そのために、変数コンポーネントには、 オブジェクトを設定するsetObject(Object obj)

コンポーネントから発生するイベント
ありません。

関連項目:

直列化された形式

コンストラクタの概要

コンストラクタ

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

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
java.lang.String	getCode() 最後に生成したプログラムコードを取得する。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
int	getIndent() Javaソースコードのインデント幅を取得する。
java.lang.String	implementProgram(java.lang.String className) クラスを指定して変数コンポーネント機能実装部分のプログラムを 生成する。
java.lang.String	implementProgram(java.lang.String clsName, java.io.File file) クラスを指定して変数コンポーネント機能実装部分のプログラムを 生成する。
java.lang.String	implementProgram(java.lang.String clsName, java.lang.String filePath) クラスを指定して変数コンポーネント機能実装部分のプログラムを 生成する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
void	localeUpdated() ロケール変更に対応する。
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
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	setIndent(int idnt) Javaソースコードのインデント幅を設定する。
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

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

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

コンストラクタの詳細

PFVariableImplementer

public PFVariableImplementer()

コンストラクタ

メソッドの詳細

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

戻り値:

文字列表現

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

localeUpdated

public void localeUpdated()

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

定義:

localeUpdated インタフェース内 PFComponent

readXML

public void readXML(PFXMLLoader in)

コンポーネントのXML入力.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

コンポーネントのXML出力.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException

implementProgram

public java.lang.String implementProgram(java.lang.String clsName,
                                java.lang.String filePath)
                                  throws PFSystemException,
                                         PFComponentException

クラスを指定して変数コンポーネント機能実装部分のプログラムを 生成する。結果の出力先をファイル名で指定する。

パラメータ:

clsName - クラスの完全名

filePath - ファイルのフルパス名

戻り値:

プログラムコード

例外:

PFSystemException

PFComponentException

implementProgram

public java.lang.String implementProgram(java.lang.String clsName,
                                java.io.File file)
                                  throws PFSystemException,
                                         PFComponentException

クラスを指定して変数コンポーネント機能実装部分のプログラムを 生成する。結果の出力先をファイルオブジェクトで指定する。

パラメータ:

clsName - クラスの完全名

file - ファイル

戻り値:

プログラムコード

例外:

PFSystemException

PFComponentException

implementProgram

public java.lang.String implementProgram(java.lang.String className)
                                  throws PFSystemException,
                                         PFComponentException

クラスを指定して変数コンポーネント機能実装部分のプログラムを 生成する。

パラメータ:

className - クラスの完全名

戻り値:

プログラムコード

例外:

PFSystemException

PFComponentException

getCode

public java.lang.String getCode()

最後に生成したプログラムコードを取得する。

戻り値:

プログラムコード

setIndent

public void setIndent(int idnt)

Javaソースコードのインデント幅を設定する。

パラメータ:

idnt - インデント幅

getIndent

public int getIndent()

Javaソースコードのインデント幅を取得する。

戻り値:

インデント幅