jp.go.aist.dmrc.platform.beans.xml
クラス PFXmlTransformer

java.lang.Object
  jp.go.aist.dmrc.platform.beans.xml.PFXmlTransformer

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

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

直系の既知のサブクラス:

PFLabeledObjectListXmlTransformer

public class PFXmlTransformer

extends java.lang.Object

implements PFComponent, PFDataSetEventSource, PFXMLSerializable

XML関連の処理を行う基本コンポーネント。

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

• データ設定イベント

  トリガー	対象データ	イベント番号
  readByDOM メソッド呼出	読み込まれたDOMツリー (Document)	（なし）

一部の機能(readByDOM(String,String)メソッド呼び出し)を実現するためには、 XMLパーサとしてXercesを使用する必要がある。

利用方法は、(JREフォルダ)/lib/ext/にXerces関連のJARファイル (例えばxml-apis.jarとxercesImpl.jar)を置いて、Platform.iniに javax.xml.parsers.DocumentBuilderFactory=org.apache.xerces.jaxp.DocumentBuilderFactoryImplを追加する。

標準のXMLパーサを使用した場合はこのメソッド呼び出しで例外が発生する。

関連項目:

直列化された形式

コンストラクタの概要

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

メソッドの概要

void	addPFDataSetListener(PFDataSetListener lis) 引数で与えられたイベントリスナを登録し、 データ設定イベント発生時に処理を行う対象とする。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
org.w3c.dom.Document	getDocument() DOMツリーを取得する。
PFObjectTree	getObjectTree() DOMツリーからPFObjectTreeを作成する
java.util.Iterator	getPFDataSetListenerList() データ設定イベントリスナ配列を取得する。
java.lang.String	getValueByPath(PFObjectList pathList) DOMツリー内のノードの値をパス(リスト形式)指定で取得する
java.lang.String	getValueByPath(java.lang.String path) DOMツリー内のノードの値をパス(文字列形式)指定で取得する
void	localeUpdated() ロケール変更に対応する。
void	readByDOM(java.lang.String filename) XMLファイルからDOMツリーを作成する。
void	readByDOM(java.lang.String filename, java.lang.String schemafile) XMLファイルとXML SchemaファイルからDOMツリーを作成する。
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	removePFDataSetListener(PFDataSetListener lis) 引数で与えられたイベントリスナを削除し、 データ設定イベント発生時に処理を行う対象から外す。
void	setComponentID(int id) コンポーネントIDを設定する。
void	setComponentKey(java.lang.String key) コンポーネントのキー情報を設定する
void	setComponentKeys(PFMultiLocaleString keys) 全ロケール分のコンポーネントキーを設定する。
protected void	setDocument(org.w3c.dom.Document doc) DOMツリーを設定する。
void	transformByXSLT(java.lang.String xmlfile, java.lang.String xsltfile, java.lang.String target) 入力とするXMLファイルからXSLファイルを指定して特定のファイルに書き出す。
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

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

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

コンストラクタの詳細

PFXmlTransformer

public PFXmlTransformer()

デフォルトコンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する。

定義:

インタフェース PFComponent 内の getComponentName

戻り値:

コンポーネント名

関連項目:

PFComponent.getComponentName()

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

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 - 削除対象イベントリスナ

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

getDocument

public org.w3c.dom.Document getDocument()

DOMツリーを取得する。

戻り値:

DOMツリー

setDocument

protected void setDocument(org.w3c.dom.Document doc)

DOMツリーを設定する。

パラメータ:

doc - DOMツリー

readByDOM

public void readByDOM(java.lang.String filename)
               throws PFException

XMLファイルからDOMツリーを作成する。 作成に成功した場合にデータ設定イベントが発生する。

パラメータ:

filename - XMLファイル名

例外:

PFException - DOMツリーの作成またはイベント生成の失敗

readByDOM

public void readByDOM(java.lang.String filename,
                      java.lang.String schemafile)
               throws PFException

XMLファイルとXML SchemaファイルからDOMツリーを作成する。 作成に成功した場合にデータ設定イベントが発生する。

XMLパーサとしてXercesを利用することを前提としている。 標準のパーサを用いた場合は例外が発生する。

パラメータ:

filename - XMLファイル名

schemafile - スキーマ(XML Schema)ファイル名

例外:

PFException - DOMツリーの作成またはイベント生成の失敗

transformByXSLT

public void transformByXSLT(java.lang.String xmlfile,
                            java.lang.String xsltfile,
                            java.lang.String target)
                     throws PFComponentException

入力とするXMLファイルからXSLファイルを指定して特定のファイルに書き出す。

パラメータ:

xmlfile - 入力XMLファイル名

xsltfile - XSLファイル名

target - 出力ファイル名

例外:

PFComponentException - ファイル入出力または変換の失敗

getValueByPath

public java.lang.String getValueByPath(java.lang.String path)

DOMツリー内のノードの値をパス(文字列形式)指定で取得する

パラメータ:

path - パス文字列

戻り値:

値文字列

getValueByPath

public java.lang.String getValueByPath(PFObjectList pathList)

DOMツリー内のノードの値をパス(リスト形式)指定で取得する

パラメータ:

pathList - パスリスト

戻り値:

値文字列

getObjectTree

public PFObjectTree getObjectTree()

DOMツリーからPFObjectTreeを作成する

戻り値:

ツリー