SAXParser (Java 2 Platform SE 5.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Standard Ed. 5.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.xml.parsers
クラス SAXParser

java.lang.Object
  javax.xml.parsers.SAXParser

public abstract class SAXParser
extends Object
extends Object

XMLReader 実装クラスをラップする API を定義します。JAXP 1.0 では、このクラスは Parser インタフェースをラップしましたが、このインタフェースは XMLReader に置き換えられました。移行を簡単にするために、このクラスは新しいメソッドのサポートと同様、同じ名前とインタフェースのサポートも継続します。このクラスのインスタンスは SAXParserFactory.newSAXParser() メソッドにより取得できます。このクラスのインスタンスを取得すると、さまざまな入力ソースから XML ドキュメントを構文解析できます。これらの入力ソースには、InputStream、File、URL、および SAX InputSource があります。

この static メソッドは、システムプロパティ設定に基づいて新しいファクトリインスタンスを作成するか、またはプロパティが定義されていない場合にプラットフォームのデフォルトを使用します。

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

コンテンツは基本となるパーサで構文解析されるため、指定された HandlerBase または DefaultHandler のメソッドが呼び出されます。

基本となる実装をラップするこのクラスの実装側では、ParserAdapter クラスを使用して、その SAX1 実装をこの改訂されたクラスの下で動作するように、最初に適合させることを考慮できます。

コンストラクタの概要
`protected`	`SAXParser()` インストールを妨げる protected コンストラクタです。

メソッドの概要
`abstract Parser`	`getParser()` このクラスの実装によりカプセル化される SAX パーサを返します。
`abstract Object`	`getProperty(String name)` `XMLReader` の基本となる実装で要求された特定のプロパティを返します。
`Schema`	`getSchema()` XML プロセッサによって使用される `Schema` への参照を取得します。
`abstract XMLReader`	`getXMLReader()` このクラスの実装によりカプセル化される `XMLReader` を返します。
`abstract boolean`	`isNamespaceAware()` このパーサが名前空間を認識するように設定されているかどうかを示します。
`abstract boolean`	`isValidating()` このパーサが XML ドキュメントを検証するように設定されているかどうかを示します。
`boolean`	`isXIncludeAware()` このパーサの XInclude 処理モードを取得します。
`void`	`parse(File f, DefaultHandler dh)` 指定されたファイルのコンテンツを、指定された `DefaultHandler` を使用して XML として構文解析します。
`void`	`parse(File f, HandlerBase hb)` 指定されたファイルのコンテンツを、指定された `HandlerBase` を使用して XML として構文解析します。
`void`	`parse(InputSource is, DefaultHandler dh)` 指定された `InputSource` のコンテンツを、指定された `DefaultHandler` を使用して XML として構文解析します。
`void`	`parse(InputSource is, HandlerBase hb)` 指定された `InputSource` のコンテンツを、指定された `HandlerBase` を使用して XML として構文解析します。
`void`	`parse(InputStream is, DefaultHandler dh)` 指定された `InputStream` インスタンスのコンテンツを、指定された `DefaultHandler` を使用して XML として構文解析します。
`void`	`parse(InputStream is, DefaultHandler dh, String systemId)` 指定された `InputStream` インスタンスのコンテンツを、指定された `DefaultHandler` を使用して XML として構文解析します。
`void`	`parse(InputStream is, HandlerBase hb)` 指定された `InputStream` インスタンスのコンテンツを、指定された `HandlerBase` を使用して XML として構文解析します。
`void`	`parse(InputStream is, HandlerBase hb, String systemId)` 指定された `InputStream` インスタンスのコンテンツを、指定された `HandlerBase` を使用して XML として構文解析します。
`void`	`parse(String uri, DefaultHandler dh)` 指定された URI (Uniform Resource Identifier) で表わされたコンテンツを、指定された `DefaultHandler` を使用して XML として構文解析します。
`void`	`parse(String uri, HandlerBase hb)` 指定された URI (Uniform Resource Identifier) で表わされたコンテンツを、指定された `HandlerBase` を使用して XML として構文解析します。
`void`	`reset()` この `SAXParser` を元の設定にリセットします。
`abstract void`	`setProperty(String name, Object value)` `XMLReader` の基本となる実装に特定のプロパティを設定します。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

SAXParser

protected SAXParser()

インストールを妨げる protected コンストラクタです。SAXParserFactory.newSAXParser() を使用します。

メソッドの詳細

reset

public void reset()

この SAXParser を元の設定にリセットします。

SAXParser は、SAXParserFactory.newSAXParser() で作成された時点の状態にリセットされます。reset() は、既存の SAXParser の再使用を許可するように設定されているため、新しい SAXParser の作成に関連するリソースを節約できます。

SAXParser をリセットした場合、Object.equals(Object obj) などの同じ Schema Object を持つことは保証されません。機能的に同じ Schema を持つことは保証されます。

導入されたバージョン:: 1.5

parse

public void parse(InputStream is,
                  HandlerBase hb)
           throws SAXException,
                  IOException

指定された InputStream インスタンスのコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:: is - 構文解析されるコンテンツを含む InputStream; hb - 使用する SAX HandlerBase
例外:: IllegalArgumentException - 指定された InputStream が null の場合; SAXException - 構文解析で SAX エラーが生成された場合; IOException - InputStream とのやりとりで入出力エラーが発生した場合
関連項目:: DocumentHandler

parse

public void parse(InputStream is,
                  HandlerBase hb,
                  String systemId)
           throws SAXException,
                  IOException

パラメータ:: is - 構文解析されるコンテンツを含む InputStream; hb - 使用する SAX HandlerBase; systemId - 相対 URI を解決するのに必要なシステム識別子
例外:: IllegalArgumentException - 指定された InputStream が null の場合; IOException - InputStream とのやりとりで入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: version of this method instead.

parse

public void parse(InputStream is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException

指定された InputStream インスタンスのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:: is - 構文解析されるコンテンツを含む InputStream; dh - 使用する SAX DefaultHandler
例外:: IllegalArgumentException - 指定された InputStream が null の場合; IOException - 入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: DocumentHandler

parse

public void parse(InputStream is,
                  DefaultHandler dh,
                  String systemId)
           throws SAXException,
                  IOException

指定された InputStream インスタンスのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:: is - 構文解析されるコンテンツを含む InputStream; dh - 使用する SAX DefaultHandler; systemId - 相対 URI を解決するのに必要なシステム識別子
例外:: IllegalArgumentException - 指定された InputStream が null の場合; IOException - 入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: version of this method instead.

parse

public void parse(String uri,
                  HandlerBase hb)
           throws SAXException,
                  IOException

指定された URI (Uniform Resource Identifier) で表わされたコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:: uri - 構文解析されるコンテンツの場所; hb - 使用する SAX HandlerBase
例外:: IllegalArgumentException - uri が null の場合; IOException - 入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: DocumentHandler

parse

public void parse(String uri,
                  DefaultHandler dh)
           throws SAXException,
                  IOException

指定された URI (Uniform Resource Identifier) で表わされたコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:: uri - 構文解析されるコンテンツの場所; dh - 使用する SAX DefaultHandler
例外:: IllegalArgumentException - uri が null の場合; IOException - 入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: DocumentHandler

parse

public void parse(File f,
                  HandlerBase hb)
           throws SAXException,
                  IOException

指定されたファイルのコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:: f - 構文解析対象の XML を含むファイル; hb - 使用する SAX HandlerBase
例外:: IllegalArgumentException - File オブジェクトが null の場合; IOException - 入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: DocumentHandler

parse

public void parse(File f,
                  DefaultHandler dh)
           throws SAXException,
                  IOException

指定されたファイルのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:: f - 構文解析対象の XML を含むファイル; dh - 使用する SAX DefaultHandler
例外:: IllegalArgumentException - File オブジェクトが null の場合; IOException - 入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: DocumentHandler

parse

public void parse(InputSource is,
                  HandlerBase hb)
           throws SAXException,
                  IOException

指定された InputSource のコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:: is - 構文解析されるコンテンツを含む InputSource; hb - 使用する SAX HandlerBase
例外:: IllegalArgumentException - InputSource オブジェクトが null の場合; IOException - 入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: DocumentHandler

parse

public void parse(InputSource is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException

指定された InputSource のコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:: is - 構文解析されるコンテンツを含む InputSource; dh - 使用する SAX DefaultHandler
例外:: IllegalArgumentException - InputSource オブジェクトが null の場合; IOException - 入出力エラーが発生した場合; SAXException - 処理中に SAX エラーが発生した場合
関連項目:: DocumentHandler

getParser

public abstract Parser getParser()
                          throws SAXException

このクラスの実装によりカプセル化される SAX パーサを返します。

戻り値:: このクラスの実装によりカプセル化される SAX パーサ
例外:: SAXException - 処理中に SAX エラーが発生した場合

getXMLReader

public abstract XMLReader getXMLReader()
                                throws SAXException

このクラスの実装によりカプセル化される XMLReader を返します。

戻り値:: このクラスの実装によりカプセル化される XMLReader
例外:: SAXException - 処理中に SAX エラーが発生した場合

isNamespaceAware

public abstract boolean isNamespaceAware()

このパーサが名前空間を認識するように設定されているかどうかを示します。

戻り値:: このパーサが名前空間を認識するように設定されている場合は true、そうでない場合は false

isValidating

public abstract boolean isValidating()

このパーサが XML ドキュメントを検証するように設定されているかどうかを示します。

戻り値:: このパーサが XML ドキュメントを検証するように設定されている場合は true、そうでない場合は false

setProperty

public abstract void setProperty(String name,
                                 Object value)
                          throws SAXNotRecognizedException,
                                 SAXNotSupportedException

XMLReader の基本となる実装に特定のプロパティを設定します。コア機能とコアプロパティのリストについては、 http://sax.sourceforge.net/?selected=get-set のサイトを参照してください。

パラメータ:: name - 設定されるプロパティの名前; value - 設定されるプロパティの値
例外:: SAXNotRecognizedException - 基本となる XMLReader がプロパティ名を認識しない場合; SAXNotSupportedException - 基本となる XMLReader はプロパティ名を認識するが、そのプロパティをサポートしない場合
関連項目:: XMLReader.setProperty(java.lang.String, java.lang.Object)

getProperty

public abstract Object getProperty(String name)
                            throws SAXNotRecognizedException,
                                   SAXNotSupportedException

XMLReader の基本となる実装で要求された特定のプロパティを返します。

パラメータ:: name - 取り出されるプロパティの名前
戻り値:: 要求されたプロパティの値
例外:: SAXNotRecognizedException - 基本となる XMLReader がプロパティ名を認識しない場合; SAXNotSupportedException - 基本となる XMLReader はプロパティ名を認識するが、そのプロパティをサポートしない場合
関連項目:: XMLReader.getProperty(java.lang.String)

getSchema

public Schema getSchema()

XML プロセッサによって使用される Schema への参照を取得します。

スキーマを使用していない場合は null が返されます。

戻り値:: 使用されている Schema または何も使用していない場合は null
例外:: UnsupportedOperationException - 下位互換性のため、JAXP の以前のバージョンを使用している場合に、この例外がスローされる
導入されたバージョン:: 1.5

isXIncludeAware

public boolean isXIncludeAware()

このパーサの XInclude 処理モードを取得します。

戻り値:: このパーサがファクトリから作成された場合に SAXParserFactory.isXIncludeAware() の戻り値
例外:: UnsupportedOperationException - 下位互換性のため、JAXP の以前のバージョンを使用している場合に、この例外がスローされる
導入されたバージョン:: 1.5
関連項目:: SAXParserFactory.setXIncludeAware(boolean)