javax.xml.transform
クラス TransformerFactory

java.lang.Object
  |
  +--javax.xml.transform.TransformerFactory

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

SAXTransformerFactory

public abstract class TransformerFactory

extends Object

TransformerFactory インスタンスを使用して、Transformer および Templates オブジェクトを作成することができます。

どのファクトリ実装を作成するかを決めるシステムプロパティの名前は javax.xml.transform.TransformerFactory です。このプロパティは、TransformerFactory 抽象クラスの具象サブクラスを命名します。このプロパティが定義されていない場合は、プラットフォームのデフォルトが使用されます。

TransformerFactory クラスの実装は、スレッドセーフであることは保証「されません」。複数のスレッドから TransformerFactory が使用されるかどうかの確認はユーザアプリケーションで行います。別の方法として、アプリケーションはスレッド当たり TransformerFactory の 1 つのインスタンスを持つことができます。ファクトリのインスタンスが複数のスレッドで同時に使用されなければ、アプリケーションはファクトリの同じインスタンスを使用して Transformer または Templates の 1 つ以上のインスタンスを取得することができます。

コンストラクタの概要

protected

TransformerFactory() デフォルトのコンストラクタが意図的に保護されます。

メソッドの概要

abstract Source	getAssociatedStylesheet(Source source, String media, String title, String charset) xml-stylesheet の処理命令 (http://www.w3.org/TR/xml-stylesheet/ を参照) によりソースパラメータで指定されたドキュメントに関連付けられた、指定された基準に一致するスタイルシート仕様を取得します。
abstract Object	getAttribute(String name) ユーザが基本となる実装の特定の属性を取り出すことができるようにします。
abstract ErrorListener	getErrorListener() TransformerFactory のエラーイベントハンドラを取得します。
abstract boolean	getFeature(String name) 機能の値を検索します。
abstract URIResolver	getURIResolver() document()、xsl:import、または xsl:includeSet で使用される URI を解決するために変換時にデフォルトで使用されるオブジェクトを取得します。
static TransformerFactory	newInstance() TransformerFactory の新しいインスタンスを取得します。
abstract Templates	newTemplates(Source source) Source を処理して、ソースのコンパイル表現である Templates オブジェクトにします。
abstract Transformer	newTransformer() 結果へのソースのコピーを実行する新しい Transformer オブジェクトを作成します。
abstract Transformer	newTransformer(Source source) Source を Transformer オブジェクトに処理します。
abstract void	setAttribute(String name, Object value) ユーザが基本となる実装に特定の属性を設定できるようにします。
abstract void	setErrorListener(ErrorListener listener) TransformerFactory のエラーイベントリスナーを設定します。
abstract void	setURIResolver(URIResolver resolver) xsl:import または xsl:includeSet で使用される URI を解決するために変換時にデフォルトで使用されるオブジェクトを設定します。

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

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

コンストラクタの詳細

TransformerFactory

protected TransformerFactory()

デフォルトのコンストラクタが意図的に保護されます。

メソッドの詳細

newInstance

public static TransformerFactory newInstance()
                                      throws TransformerFactoryConfigurationError

TransformerFactory の新しいインスタンスを取得します。この static メソッドは新しいファクトリインスタンスを作成します。このメソッドは次の順序のルックアップ手順で、ロードする TransformerFactory 実装クラスを判定します。

• javax.xml.transform.TransformerFactory システムプロパティを使用する
• JRE ディレクトリ内のプロパティファイル lib/jaxp.properties を使用する。この構成ファイルは標準の java.util.Properties 形式であり、上記のように定義されたシステムプロパティであるキーを持つ実装クラスの完全指定の名前を含む
• 可能であれば、JAR 仕様で詳細に説明されているサービス API を使用して、クラス名を判定する。サービス API は、実行時に使用できる jar 内の META-INF/services/javax.xml.transform.TransformerFactory ファイルからクラス名を検索する
• プラットフォームのデフォルトの TransformerFactory インスタンス

アプリケーションが TransformerFactory への参照を取得すると、ファクトリを使用してパーサのインスタンスを設定および取得することができます。

戻り値:

新しい TransformerFactory インスタンス。null は不可

例外:

TransformerFactoryConfigurationError - 実装が使用できないかインスタンス化できない場合

newTransformer

public abstract Transformer newTransformer(Source source)
                                    throws TransformerConfigurationException

Source を Transformer オブジェクトに処理します。このオブジェクトを同時に動作する複数のスレッドで使用しないように注意を与える必要があります。異なるスレッドでは同時に使用される TransformerFactories も異なります。

パラメータ:

source - URI、入力ストリームなどを保持するオブジェクト

戻り値:

1 つのスレッドで変換を実行するために使用される Transformer オブジェクト。null は不可

例外:

TransformerConfigurationException - Templates オブジェクトの構築で失敗した場合に構文解析時にスローされる場合がある

newTransformer

public abstract Transformer newTransformer()
                                    throws TransformerConfigurationException

結果へのソースのコピーを実行する新しい Transformer オブジェクトを作成します。

戻り値:

1 つのスレッドで変換を実行するために使用される Transformer オブジェクト。null は不可

例外:

TransformerConfigurationException - Templates オブジェクトの構築で失敗した場合に構文解析時にスローされる場合がある

newTemplates

public abstract Templates newTemplates(Source source)
                                throws TransformerConfigurationException

Source を処理して、ソースのコンパイル表現である Templates オブジェクトにします。この Templates オブジェクトは、複数のスレッドで同時に使用することができます。Templates オブジェクトを作成することにより、TransformerFactory は変換命令のパフォーマンスの最適化を詳細に行うことができ、実行時変換が低下することはありません。

パラメータ:

source - URL、入力ストリームなどを保持するオブジェクト

戻り値:

変換のために使用できる Templates オブジェクト。null は不可

例外:

TransformerConfigurationException - Templates オブジェクトの構築で失敗した場合に構文解析時にスローされる場合がある

getAssociatedStylesheet

public abstract Source getAssociatedStylesheet(Source source,
                                               String media,
                                               String title,
                                               String charset)
                                        throws TransformerConfigurationException

xml-stylesheet の処理命令 (http://www.w3.org/TR/xml-stylesheet/ を参照) によりソースパラメータで指定されたドキュメントに関連付けられた、指定された基準に一致するスタイルシート仕様を取得します。いくつかのスタイルシートを返すことができます。その場合、それらのスタイルシートは、1 つのスタイルシート内のインポートまたはカスケードのリストであるかのように適用されます。

パラメータ:

source - XML ソースドキュメント

media - 一致するメディア属性。null の場合があり、その場合は、設定されているテンプレートが使用される (つまり alternate = no)

title - 一致するタイトル属性の値。null の場合あり

charset - 一致する文字セット属性の値。null の場合あり

戻り値:

TransformerFactory に渡すのに適した Source オブジェクト

例外:

TransformerConfigurationException.

TransformerConfigurationException

setURIResolver

public abstract void setURIResolver(URIResolver resolver)

xsl:import または xsl:includeSet で使用される URI を解決するために変換時にデフォルトで使用されるオブジェクトを設定します。

パラメータ:

resolver - URIResolver インタフェースを実装するオブジェクト、または null

getURIResolver

public abstract URIResolver getURIResolver()

document()、xsl:import、または xsl:includeSet で使用される URI を解決するために変換時にデフォルトで使用されるオブジェクトを取得します。

戻り値:

setURIResolver を使用して設定された URIResolver

getFeature

public abstract boolean getFeature(String name)

機能の値を検索します。

機能名は任意の絶対 URI です。

パラメータ:

name - 絶対 URI である機能名

戻り値:

機能の現在の状態 (true または false)

setAttribute

public abstract void setAttribute(String name,
                                  Object value)
                           throws IllegalArgumentException

ユーザが基本となる実装に特定の属性を設定できるようにします。このコンテキストの属性は、実装が提供するオプションとして定義されます。

パラメータ:

name - 属性の名前

value - 属性の値

例外:

IllegalArgumentException - 基本となる実装が属性を認識しない場合にスローされる

getAttribute

public abstract Object getAttribute(String name)
                             throws IllegalArgumentException

ユーザが基本となる実装の特定の属性を取り出すことができるようにします。

パラメータ:

name - 属性の名前

戻り値:

属性の値

例外:

IllegalArgumentException - 基本となる実装が属性を認識しない場合にスローされる

setErrorListener

public abstract void setErrorListener(ErrorListener listener)
                               throws IllegalArgumentException

TransformerFactory のエラーイベントリスナーを設定します。TransformerFactory は、変換自体のためではなく、変換命令を処理するために使用されます。

パラメータ:

listener - 新しいエラーリスナー

例外:

IllegalArgumentException - リスナーが null の場合

getErrorListener

public abstract ErrorListener getErrorListener()

TransformerFactory のエラーイベントハンドラを取得します。

戻り値:

現在のエラーハンドラ。null は不可