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()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名

getComponentKey

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

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー

setComponentKey

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

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー

getComponentKeys

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

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

setComponentKeys

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

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

getComponentID

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

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID

setComponentID

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

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID

getComponentString

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

定義:
インタフェース 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型コンポーネント転送要求に対する可否

getPFDataCreateListenerList

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

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

addPFDataCreateListener

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

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

removePFDataCreateListener

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

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

localeUpdated

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

定義:
インタフェース PFComponent 内の localeUpdated

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を出力する.

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

readXML

public void readXML(PFXMLLoader in)
XMLを入力する.

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