モジュール java.xml
パッケージ org.xml.sax

クラスHandlerBase

  • すべての実装されたインタフェース:
    DocumentHandler, DTDHandler, EntityResolver, ErrorHandler
    非推奨。 
    このクラスは非推奨のDocumentHandlerインタフェースで動作します。 SAX2では、このクラスはDefaultHandlerクラスで置き換えられています。 

    public class HandlerBase
extends Object
implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
    ハンドラのデフォルトの基底クラスです。
    このモジュールは、ソース・コード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。 詳細については、http://www.saxproject.orgを参照してください。

    このクラスは、EntityResolver、DTDHandler、DocumentHandler、ErrorHandlerの4つのSAX1インタフェースのデフォルトの動作を実装します。 このクラスは現在使用されていませんが、古いSAX1アプリケーションをサポートするため、SAX2に含められています。 SAX2アプリケーションでは、代わりにDefaultHandlerクラスを使用する必要があります。

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

    このクラスの使用はオプションです。

    導入されたバージョン:
    1.4, SAX 1.0
    関連項目:
    EntityResolver, DTDHandler, DocumentHandler, ErrorHandler

    • コンストラクタの詳細

      • HandlerBase

        public HandlerBase​()
        非推奨。 

    • メソッドの詳細

      • resolveEntity

        public InputSource resolveEntity​(String publicId,
                                 String systemId)
                          throws SAXException
        非推奨。 
        外部エンティティを解決します。

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

        定義:
        resolveEntity、インタフェース: EntityResolver
        パラメータ:
        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)
        非推奨。 
        表記法宣言の通知を受け取ります。

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

        定義:
        notationDecl、インタフェース: DTDHandler
        パラメータ:
        name - 表記法名。
        publicId - 表記法の公開識別子。使用できない場合はnull。
        systemId - 表記法のシステム識別子。
        関連項目:
        DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)

      • unparsedEntityDecl

        public void unparsedEntityDecl​(String name,
                               String publicId,
                               String systemId,
                               String notationName)
        非推奨。 
        解析対象外エンティティ宣言の通知を受け取ります。

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

        定義:
        unparsedEntityDecl、インタフェース: DTDHandler
        パラメータ:
        name - エンティティ名。
        publicId - エンティティの公開識別子。使用できない場合はnull。
        systemId - エンティティのシステム識別子。
        notationName - 関連表記法名。
        関連項目:
        DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

      • setDocumentLocator

        public void setDocumentLocator​(Locator locator)
        非推奨。 
        文書イベントのLocatorオブジェクトを受け取ります。

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

        定義:
        setDocumentLocator、インタフェース: DocumentHandler
        パラメータ:
        locator - すべてのSAX文書イベントのロケータ。
        関連項目:
        DocumentHandler.setDocumentLocator(org.xml.sax.Locator), Locator

      • startDocument

        public void startDocument​()
                   throws SAXException
        非推奨。 
        文書の開始通知を受け取ります。

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

        定義:
        startDocument、インタフェース: DocumentHandler
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        DocumentHandler.startDocument()

      • endDocument

        public void endDocument​()
                 throws SAXException
        非推奨。 
        文書の終了通知を受け取ります。

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

        定義:
        endDocument、インタフェース: DocumentHandler
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        DocumentHandler.endDocument()

      • startElement

        public void startElement​(String name,
                         AttributeList attributes)
                  throws SAXException
        非推奨。 
        要素の開始通知を受け取ります。

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

        定義:
        startElement、インタフェース: DocumentHandler
        パラメータ:
        name - 要素型名。
        attributes - 指定された属性またはデフォルトの属性。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        DocumentHandler.startElement(java.lang.String, org.xml.sax.AttributeList)

      • endElement

        public void endElement​(String name)
                throws SAXException
        非推奨。 
        要素の終了通知を受け取ります。

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

        定義:
        endElement、インタフェース: DocumentHandler
        パラメータ:
        name - 要素名
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        DocumentHandler.endElement(java.lang.String)

      • characters

        public void characters​(char[] ch,
                       int start,
                       int length)
                throws SAXException
        非推奨。 
        要素内の文字データの通知を受け取ります。

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

        定義:
        characters、インタフェース: DocumentHandler
        パラメータ:
        ch - 文字。
        start - 文字配列内の開始位置。
        length - 文字配列から使用される文字数。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        DocumentHandler.characters(char[], int, int)

      • ignorableWhitespace

        public void ignorableWhitespace​(char[] ch,
                                int start,
                                int length)
                         throws SAXException
        非推奨。 
        要素コンテンツに含まれる無視できる空白文字の通知を受け取ります。

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

        定義:
        ignorableWhitespace、インタフェース: DocumentHandler
        パラメータ:
        ch - 空白文字。
        start - 文字配列内の開始位置。
        length - 文字配列から使用される文字数。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        DocumentHandler.ignorableWhitespace(char[], int, int)

      • processingInstruction

        public void processingInstruction​(String target,
                                  String data)
                           throws SAXException
        非推奨。 
        処理命令の通知を受け取ります。

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

        定義:
        processingInstruction、インタフェース: DocumentHandler
        パラメータ:
        target - 処理命令のターゲット。
        data - 処理命令データ。データが提供されない場合はnull。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        DocumentHandler.processingInstruction(java.lang.String, java.lang.String)

      • warning

        public void warning​(SAXParseException e)
             throws SAXException
        非推奨。 
        パーサー警告の通知を受け取ります。

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

        定義:
        warning、インタフェース: ErrorHandler
        パラメータ:
        e - 例外としてエンコードされた警告情報。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        ErrorHandler.warning(org.xml.sax.SAXParseException), SAXParseException

      • error

        public void error​(SAXParseException e)
           throws SAXException
        非推奨。 
        回復可能なパーサー・エラーの通知を受け取ります。

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

        定義:
        error、インタフェース: ErrorHandler
        パラメータ:
        e - 例外としてエンコードされた警告情報。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        ErrorHandler.warning(org.xml.sax.SAXParseException), SAXParseException

      • fatalError

        public void fatalError​(SAXParseException e)
                throws SAXException
        非推奨。 
        致命的なXML構文解析エラーを報告します。

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

        定義:
        fatalError、インタフェース: ErrorHandler
        パラメータ:
        e - 例外としてエンコードされたエラー情報。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性がある。
        関連項目:
        ErrorHandler.fatalError(org.xml.sax.SAXParseException), SAXParseException