org.xml.sax.helpers
クラス DefaultHandler

java.lang.Object
  |
  +--org.xml.sax.helpers.DefaultHandler

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

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class DefaultHandler

extends Object

implements EntityResolver, DTDHandler, ContentHandler, ErrorHandler

SAX 2 イベントハンドラのデフォルト基底クラスです。

このモジュールは、ソースコード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。

このクラスは、SAX2 アプリケーション用の簡易基底クラスです。SAX2 の 4 つのコアハンドラクラスに含まれるすべてのコールバックのデフォルト実装を提供します。

• EntityResolver
• DTDHandler
• ContentHandler
• ErrorHandler

アプリケーションの作成者は、インタフェースの一部だけを実装する必要があるとき、このクラスを拡張します。パーサの作成者は、アプリケーション固有のデフォルトハンドラが提供されないとき、このクラスをインスタンス化してデフォルトハンドラを提供します。

このクラスは、非推奨に指定されている HandlerBase クラスに代わるクラスです。

導入されたバージョン:

SAX 2.0

関連項目:

EntityResolver, DTDHandler, ContentHandler, ErrorHandler

コンストラクタの概要

DefaultHandler()

メソッドの概要

void	characters(char[] ch, int start, int length) 要素内の文字データの通知を受け取ります。
void	endDocument() 文書の終了通知を受け取ります。
void	endElement(String uri, String localName, String qName) 要素の終了通知を受け取ります。
void	endPrefixMapping(String prefix) 名前空間マッピングの終了通知を受け取ります。
void	error(SAXParseException e) 回復可能なパーサエラーの通知を受け取ります。
void	fatalError(SAXParseException e) 致命的な XML 構文解析エラーを報告します。
void	ignorableWhitespace(char[] ch, int start, int length) 要素コンテンツに含まれる無視できる空白文字の通知を受け取ります。
void	notationDecl(String name, String publicId, String systemId) 表記法宣言の通知を受け取ります。
void	processingInstruction(String target, String data) 処理命令の通知を受け取ります。
InputSource	resolveEntity(String publicId, String systemId) 外部エンティティを解決します。
void	setDocumentLocator(Locator locator) 文書イベントの Locator オブジェクトを受け取ります。
void	skippedEntity(String name) スキップされたエンティティの通知を受け取ります。
void	startDocument() 文書の開始通知を受け取ります。
void	startElement(String uri, String localName, String qName, Attributes attributes) 要素の開始通知を受け取ります。
void	startPrefixMapping(String prefix, String uri) 名前空間マッピングの開始通知を受け取ります。
void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName) 未構文解析エンティティ宣言の通知を受け取ります。
void	warning(SAXParseException e) パーサ警告の通知を受け取ります。

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

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

コンストラクタの詳細

DefaultHandler

public DefaultHandler()

メソッドの詳細

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException

外部エンティティを解決します。

常に null を返します。これは、パーサに XML 文書内のシステム識別子を使用させるためです。このメソッドは SAX のデフォルトの動作を実装します。アプリケーションの作成者は、サブクラス内でこれをオーバーライドし、カタログ検索や URI リダイレクションのような特殊な変換を行います。

定義:

インタフェース EntityResolver 内の resolveEntity

パラメータ:

publicId - 公開識別子。使用できない場合は null

systemId - XML 文書に含まれているシステム識別子

戻り値:

新しい入力ソース。デフォルトの動作が必要な場合は null

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

EntityResolver.resolveEntity(java.lang.String, java.lang.String)

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
                  throws SAXException

表記法宣言の通知を受け取ります。

デフォルトでは何も行いません。文書内に宣言された表記法を追跡する必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。

定義:

インタフェース DTDHandler 内の notationDecl

パラメータ:

name - 表記法名

publicId - 表記法の公開識別子。使用できない場合は null

systemId - 表記法のシステム識別子

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
                        throws SAXException

未構文解析エンティティ宣言の通知を受け取ります。

デフォルトでは何も行いません。文書内に宣言された未構文解析エンティティを追跡する必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。

定義:

インタフェース DTDHandler 内の unparsedEntityDecl

パラメータ:

name - エンティティ名

publicId - エンティティの公開識別子。使用できない場合は null

systemId - エンティティのシステム識別子

notationName - 関連表記法名

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

setDocumentLocator

public void setDocumentLocator(Locator locator)

文書イベントの Locator オブジェクトを受け取ります。

デフォルトでは何も行いません。その他の文書イベントで使用するためロケータを格納しておく必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。

定義:

インタフェース ContentHandler 内の setDocumentLocator

パラメータ:

locator - すべての SAX 文書イベントのロケータ

関連項目:

ContentHandler.setDocumentLocator(org.xml.sax.Locator), Locator

startDocument

public void startDocument()
                   throws SAXException

文書の開始通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、文書の先頭で特殊なアクション (ツリーのルートノードの割り当て、出力ファイルの作成など) を実行することができます。

定義:

インタフェース ContentHandler 内の startDocument

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

文書の終了通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、文書の終わりで特殊なアクション (ツリーのファイナライズ、出力ファイルの終了など) を実行することができます。

定義:

インタフェース ContentHandler 内の endDocument

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.endDocument()

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

名前空間マッピングの開始通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、名前空間前置修飾子のスコープの開始位置で特殊なアクション (前置修飾子のマッピングの格納など) を実行することができます。

定義:

インタフェース ContentHandler 内の startPrefixMapping

パラメータ:

prefix - 宣言される名前空間前置修飾子

uri - 前置修飾子にマッピングされた名前空間 URI

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

名前空間マッピングの終了通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、個々の前置修飾子の終了位置で特殊なアクションを実行することができます。

定義:

インタフェース ContentHandler 内の endPrefixMapping

パラメータ:

prefix - 宣言される名前空間前置修飾子

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.endPrefixMapping(java.lang.String)

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attributes)
                  throws SAXException

要素の開始通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、各要素の先頭で特殊なアクション (新しいツリーノードの割り当て、出力内容のファイルへの書き込みなど) を実行することができます。

定義:

インタフェース ContentHandler 内の startElement

パラメータ:

attributes - 指定された属性またはデフォルトの属性

localName - 前置修飾子を含まないローカル名。名前空間処理が行われない場合は空文字列

qName - 前置修飾子を持つ修飾名。修飾名を使用できない場合は空文字列

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

要素の終了通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、各要素の終わりで特殊なアクション (ツリーノードのファイナライズ、出力内容のファイルへの書き込みなど) を実行することができます。

定義:

インタフェース ContentHandler 内の endElement

パラメータ:

localName - 前置修飾子を含まないローカル名。名前空間処理が行われない場合は空文字列

qName - 前置修飾子を持つ XML 1.0 修飾名。修飾名を使用できない場合は空文字列

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

要素内の文字データの通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、このメソッドをオーバーライドして、各文字データチャンクに対して特殊なアクション (ノードまたはバッファへのデータの追加、データのファイルへの出力など) を実行することができます。

定義:

インタフェース ContentHandler 内の characters

パラメータ:

ch - 文字

start - 文字配列内の開始位置

length - 文字配列から使用される文字数

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.characters(char[], int, int)

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws SAXException

要素コンテンツに含まれる無視できる空白文字の通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、このメソッドをオーバーライドして、無視できる空白文字の各チャンクに対して特殊なアクション (ノードまたはバッファへのデータの追加、データのファイルへの出力など) を実行することができます。

定義:

インタフェース ContentHandler 内の ignorableWhitespace

パラメータ:

ch - 空白文字

start - 文字配列内の開始位置

length - 文字配列から使用される文字数

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.ignorableWhitespace(char[], int, int)

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

処理命令の通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、各処理命令に対して特殊なアクション (状態変数の設定、その他のメソッドの呼び出しなど) を実行することができます。

定義:

インタフェース ContentHandler 内の processingInstruction

パラメータ:

target - 処理命令のターゲット

data - 処理命令データ。データが提供されない場合は null

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

スキップされたエンティティの通知を受け取ります。

デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、各処理命令に対して特殊なアクション (状態変数の設定、その他のメソッドの呼び出しなど) を実行することができます。

定義:

インタフェース ContentHandler 内の skippedEntity

パラメータ:

name - スキップされたエンティティの名前

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

warning

public void warning(SAXParseException e)
             throws SAXException

パーサ警告の通知を受け取ります。

デフォルト実装は何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、各警告に対して特殊なアクション (ログファイルへのメッセージの挿入、メッセージのコンソールへの出力など) を実行することができます。

定義:

インタフェース ErrorHandler 内の warning

パラメータ:

e - 例外としてエンコードされたエラー情報

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ErrorHandler.warning(org.xml.sax.SAXParseException), SAXParseException

error

public void error(SAXParseException e)
           throws SAXException

回復可能なパーサエラーの通知を受け取ります。

デフォルト実装は何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、各エラーに対して特殊なアクション (ログファイルへのメッセージの挿入、メッセージのコンソールへの出力など) を実行することができます。

定義:

インタフェース ErrorHandler 内の error

パラメータ:

e - 例外としてエンコードされた警告情報

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ErrorHandler.warning(org.xml.sax.SAXParseException), SAXParseException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

致命的な XML 構文解析エラーを報告します。

デフォルト実装は SAXParseException をスローします。アプリケーションの作成者は、個々の致命的なエラーに対して特殊なアクションをとる (すべてのエラーを単一の報告にまとめるなど) 必要がある場合、サブクラス内でこのメソッドをオーバーライドすることができます。このメソッドが呼び出されると、文書の信頼性が低くなり、パーサも構文解析イベントを報告しなくなるので、アプリケーションの通常処理はすべて終了されなければなりません。

定義:

インタフェース ErrorHandler 内の fatalError

パラメータ:

e - 例外としてエンコードされたエラー情報

例外:

SAXException - SAX 例外。ほかの例外をラップしている可能性がある

関連項目:

ErrorHandler.fatalError(org.xml.sax.SAXParseException), SAXParseException