jp.go.aist.dmrc.platform.beans.xml

クラス PFModelicaConverter

java.lang.Object

jp.go.aist.dmrc.platform.beans.xml.PFModelicaConverter

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

java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFEventSource

public class PFModelicaConverter
extends java.lang.Object
implements PFComponent, PFDataCreateEventSource, PFXMLSerializable

Modelica変換コンポーネント. モデリング言語ModelicaとXMLの変換を行うコンポーネント。

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PFModelicaConverter() コンポーネントを生成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addPFDataCreateListener(PFDataCreateListener lis) 引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。
org.w3c.dom.Document	convertModelicaToDOMTree(java.io.File file) Modelicaファイルを読み込んで、DOMツリーに変換する.
org.w3c.dom.Document	convertModelicaToDOMTree(java.lang.String filePath) Modelicaファイルを読み込んで、DOMツリーに変換する.
java.lang.String	convertModelicaToXML(java.io.File file) Modelicaファイルを読み込んで、XMLファイルへ変換する.
java.lang.String	convertModelicaToXML(java.lang.String filePath) Modelicaファイルを読み込んで、XMLファイルを出力する.
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
org.w3c.dom.Document	getDocument() 変換後のDOMツリーを取得する.
java.util.Iterator	getPFDataCreateListenerList() データ生成イベントリスナ配列を取得する。
java.lang.String	getXMLData() 変換後のXMLデータを取得する.
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
void	localeUpdated() ロケール変更に対応する。
void	readXML(PFXMLLoader in) XMLを入力する.
void	removePFDataCreateListener(PFDataCreateListener 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	writeXML(PFXMLGenerator out) XMLを出力する.

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

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

コンストラクタの詳細

PFModelicaConverter

public PFModelicaConverter()

コンポーネントを生成する。

メソッドの詳細

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

getPFDataCreateListenerList

public java.util.Iterator getPFDataCreateListenerList()

データ生成イベントリスナ配列を取得する。

定義:

getPFDataCreateListenerList インタフェース内 PFDataCreateEventSource

戻り値:

イベントリスナイテレータ

addPFDataCreateListener

public void addPFDataCreateListener(PFDataCreateListener lis)

引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。

定義:

addPFDataCreateListener インタフェース内 PFDataCreateEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFDataCreateListener

public void removePFDataCreateListener(PFDataCreateListener lis)

引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。

定義:

removePFDataCreateListener インタフェース内 PFDataCreateEventSource

パラメータ:

lis - 削除対象イベントリスナ

localeUpdated

public void localeUpdated()

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

定義:

localeUpdated インタフェース内 PFComponent

convertModelicaToXML

public java.lang.String convertModelicaToXML(java.lang.String filePath)
                                      throws PFComponentException

Modelicaファイルを読み込んで、XMLファイルを出力する.

パラメータ:

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

戻り値:

XMLデータ

例外:

PFComponentException - サポートしていない文字コードのファイルを扱おうとしたとき

PFComponentException - Modelicaファイルの読み込みに失敗したとき

PFComponentException - Modelicaのパースに失敗したとき

PFComponentException - XMLファイルの書き出しに失敗したとき

PFComponentException - イベントの生成に失敗したとき

convertModelicaToXML

public java.lang.String convertModelicaToXML(java.io.File file)
                                      throws PFComponentException

Modelicaファイルを読み込んで、XMLファイルへ変換する.

パラメータ:

file - Modelicaファイル

戻り値:

XMLデータ

例外:

PFComponentException - サポートしていない文字コードのファイルを扱おうとしたとき

PFComponentException - Modelicaファイルの読み込みに失敗したとき

PFComponentException - Modelicaのパースに失敗したとき

PFComponentException - XMLファイルの書き出しに失敗したとき

PFComponentException - イベントの生成に失敗したとき

getXMLData

public java.lang.String getXMLData()

変換後のXMLデータを取得する.

戻り値:

XMLデータ

convertModelicaToDOMTree

public org.w3c.dom.Document convertModelicaToDOMTree(java.lang.String filePath)
                                              throws PFComponentException

Modelicaファイルを読み込んで、DOMツリーに変換する.（ファイル出力はしない）

パラメータ:

filePath - Modelicaファイルパス

戻り値:

DOMツリー

例外:

PFComponentException - Modelicaファイルの読み込みに失敗したとき

PFComponentException - Modelicaのパースに失敗したとき

PFComponentException - サポートしていない文字コードのファイルを扱おうとしたとき

PFComponentException - イベントの生成に失敗したとき

convertModelicaToDOMTree

public org.w3c.dom.Document convertModelicaToDOMTree(java.io.File file)
                                              throws PFComponentException

Modelicaファイルを読み込んで、DOMツリーに変換する.（ファイル出力はしない）

パラメータ:

file - Modelicaファイル

戻り値:

DOMツリー

例外:

PFComponentException - Modelicaファイルの読み込みに失敗したとき

PFComponentException - Modelicaのパースに失敗したとき

PFComponentException - サポートしていない文字コードのファイルを扱おうとしたとき

PFComponentException - イベントの生成に失敗したとき

getDocument

public org.w3c.dom.Document getDocument()

変換後のDOMツリーを取得する.

戻り値:

DOMツリー

writeXML

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

XMLを出力する.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

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

例外:

java.io.IOException

readXML

public void readXML(PFXMLLoader in)

XMLを入力する.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

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