org.xml.sax.helpers
クラス XMLFilterImpl

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

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

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, XMLFilter, XMLReader

public class XMLFilterImpl

extends Object

implements XMLFilter, EntityResolver, DTDHandler, ContentHandler, ErrorHandler

XML フィルタを派生する基底クラスです。

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

このクラスは、XMLReader とクライアントアプリケーションのイベントハンドラの中間に置かれます。デフォルトでは、リーダに要求を渡し、イベントにハンドラを通過させる (通過後もイベントは変更されない) だけです。しかし、このクラスのサブクラスが特定のメソッドをオーバーライドして、イベントを変更したり、転送中に構成要求を変更したりする可能性もあります。

導入されたバージョン:

SAX 2.0

関連項目:

XMLFilter, XMLReader, EntityResolver, DTDHandler, ContentHandler, ErrorHandler

コンストラクタの概要

XMLFilterImpl()
親を持たない空の XML フィルタを構築します。

XMLFilterImpl(XMLReader parent)
指定された親を持つ XML フィルタを構築します。

メソッドの概要

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) 致命的なエラーイベントをファイルタリングします。
ContentHandler	getContentHandler() コンテンツイベントハンドラを取得します。
DTDHandler	getDTDHandler() 現在の DTD イベントハンドラを取得します。
EntityResolver	getEntityResolver() 現在のエンティティリゾルバを取得します。
ErrorHandler	getErrorHandler() 現在のエラーイベントハンドラを取得します。
boolean	getFeature(String name) 機能の状態を検索します。
XMLReader	getParent() 親リーダを取得します。
Object	getProperty(String name) プロパティ値を検索します。
void	ignorableWhitespace(char[] ch, int start, int length) 無視できる空白文字イベントをファイルタリングします。
void	notationDecl(String name, String publicId, String systemId) 表記法宣言イベントをファイルタリングします。
void	parse(InputSource input) 文書を構文解析します。
void	parse(String systemId) 文書を構文解析します。
void	processingInstruction(String target, String data) 処理命令イベントをファイルタリングします。
InputSource	resolveEntity(String publicId, String systemId) 外部エンティティ解決をファイルタリングします。
void	setContentHandler(ContentHandler handler) コンテンツイベントハンドラを設定します。
void	setDocumentLocator(Locator locator) 新しい文書ロケータイベントをファイルタリングします。
void	setDTDHandler(DTDHandler handler) DTD イベントハンドラを設定します。
void	setEntityResolver(EntityResolver resolver) エンティティリゾルバを設定します。
void	setErrorHandler(ErrorHandler handler) エラーイベントハンドラを設定します。
void	setFeature(String name, boolean state) 機能の状態を設定します。
void	setParent(XMLReader parent) 親リーダを設定します。
void	setProperty(String name, Object value) プロパティ値を設定します。
void	skippedEntity(String name) スキップされたエンティティイベントをファイルタリングします。
void	startDocument() 文書開始イベントをファイルタリングします。
void	startElement(String uri, String localName, String qName, Attributes atts) 要素開始イベントをファイルタリングします。
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

コンストラクタの詳細

XMLFilterImpl

public XMLFilterImpl()

親を持たない空の XML フィルタを構築します。

このフィルタは親を持ちません。構文解析や、setFeature または setProperty を使って構成を行う前に、親を割り当てる必要があります。

関連項目:

XMLReader.setFeature(java.lang.String, boolean), XMLReader.setProperty(java.lang.String, java.lang.Object)

XMLFilterImpl

public XMLFilterImpl(XMLReader parent)

指定された親を持つ XML フィルタを構築します。

関連項目:

setParent(org.xml.sax.XMLReader), getParent()

メソッドの詳細

setParent

public void setParent(XMLReader parent)

親リーダを設定します。

このフィルタは、この XMLReader からイベントを取得し、この XMLReader に構成要求を渡します。別のフィルタを親に指定することもできます。

親リーダが設定されていないと、構文解析、機能またはプロパティの設定、機能またはプロパティの取得に失敗します。

定義:

インタフェース XMLFilter 内の setParent

パラメータ:

parent - 親 XML リーダ

例外:

NullPointerException - 親が null の場合

関連項目:

getParent()

getParent

public XMLReader getParent()

親リーダを取得します。

定義:

インタフェース XMLFilter 内の getParent

戻り値:

親 XML リーダ。設定されていない場合は null

関連項目:

setParent(org.xml.sax.XMLReader)

setFeature

public void setFeature(String name,
                       boolean state)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException

機能の状態を設定します。

親が null の場合は常に失敗します。

定義:

インタフェース XMLReader 内の setFeature

パラメータ:

name - 機能名

state - 要求された機能の状態

例外:

SAXNotRecognizedException - XMLReader が機能名を認識しない場合

SAXNotSupportedException - XMLReader が機能名を認識するだけで要求された値を設定できない場合

関連項目:

XMLReader.setFeature(java.lang.String, boolean)

getFeature

public boolean getFeature(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

機能の状態を検索します。

親が null の場合は常に失敗します。

定義:

インタフェース XMLReader 内の getFeature

パラメータ:

name - 機能名

戻り値:

機能の現在の状態

例外:

SAXNotRecognizedException - XMLReader が機能名を認識しない場合

SAXNotSupportedException - XMLReader が機能名を認識するだけで、現時点ではその状態を判断できない場合

関連項目:

XMLReader.getFeature(java.lang.String)

setProperty

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

プロパティ値を設定します。

親が null の場合は常に失敗します。

定義:

インタフェース XMLReader 内の setProperty

パラメータ:

name - プロパティ名

例外:

SAXNotRecognizedException - XMLReader がプロパティ名を認識しない場合

SAXNotSupportedException - XMLReader がプロパティ名を認識するだけで要求された値を設定できない場合

関連項目:

XMLReader.setProperty(java.lang.String, java.lang.Object)

getProperty

public Object getProperty(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

プロパティ値を検索します。

定義:

インタフェース XMLReader 内の getProperty

パラメータ:

name - プロパティ名

戻り値:

現在のプロパティ値

例外:

SAXNotRecognizedException - XMLReader が機能名を認識しない場合

SAXNotSupportedException - XMLReader がプロパティ名を認識するだけで、現時点ではその値を判断できない場合

関連項目:

XMLReader.setFeature(java.lang.String, boolean)

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

エンティティリゾルバを設定します。

定義:

インタフェース XMLReader 内の setEntityResolver

パラメータ:

resolver - 新しいエンティティリゾルバ

例外:

NullPointerException - リゾルバが null の場合

関連項目:

XMLReader.setEntityResolver(org.xml.sax.EntityResolver)

getEntityResolver

public EntityResolver getEntityResolver()

現在のエンティティリゾルバを取得します。

定義:

インタフェース XMLReader 内の getEntityResolver

戻り値:

現在のエンティティリゾルバ。設定されていない場合は null

関連項目:

XMLReader.getEntityResolver()

setDTDHandler

public void setDTDHandler(DTDHandler handler)

DTD イベントハンドラを設定します。

定義:

インタフェース XMLReader 内の setDTDHandler

パラメータ:

handler - DTD ハンドラ

例外:

NullPointerException - ハンドラが null の場合

関連項目:

XMLReader.setDTDHandler(org.xml.sax.DTDHandler)

getDTDHandler

public DTDHandler getDTDHandler()

現在の DTD イベントハンドラを取得します。

定義:

インタフェース XMLReader 内の getDTDHandler

戻り値:

現在の DTD ハンドラ。設定されていない場合は null

関連項目:

XMLReader.getDTDHandler()

setContentHandler

public void setContentHandler(ContentHandler handler)

コンテンツイベントハンドラを設定します。

定義:

インタフェース XMLReader 内の setContentHandler

パラメータ:

handler - コンテンツハンドラ

例外:

NullPointerException - ハンドラが null の場合

関連項目:

XMLReader.setContentHandler(org.xml.sax.ContentHandler)

getContentHandler

public ContentHandler getContentHandler()

コンテンツイベントハンドラを取得します。

定義:

インタフェース XMLReader 内の getContentHandler

戻り値:

現在のコンテンツハンドラ。設定されていない場合は null

関連項目:

XMLReader.getContentHandler()

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

エラーイベントハンドラを設定します。

定義:

インタフェース XMLReader 内の setErrorHandler

パラメータ:

handler - エラーハンドラ

例外:

NullPointerException - ハンドラが null の場合

関連項目:

XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

getErrorHandler

public ErrorHandler getErrorHandler()

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

定義:

インタフェース XMLReader 内の getErrorHandler

戻り値:

現在のエラーハンドラ。設定されていない場合は null

関連項目:

XMLReader.getErrorHandler()

parse

public void parse(InputSource input)
           throws SAXException,
                  IOException

文書を構文解析します。

定義:

インタフェース XMLReader 内の parse

パラメータ:

input - 文書エンティティの入力ソース

例外:

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

IOException - パーサからの IO 例外。通常、アプリケーションが提供するバイトストリームまたは文字ストリームからの例外

関連項目:

XMLReader.parse(org.xml.sax.InputSource)

parse

public void parse(String systemId)
           throws SAXException,
                  IOException

文書を構文解析します。

定義:

インタフェース XMLReader 内の parse

パラメータ:

systemId - システム識別子を示す完全修飾 URI

例外:

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

IOException - パーサからの IO 例外。通常、アプリケーションが提供するバイトストリームまたは文字ストリームからの例外

関連項目:

XMLReader.parse(java.lang.String)

resolveEntity

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

外部エンティティ解決をファイルタリングします。

定義:

インタフェース EntityResolver 内の resolveEntity

パラメータ:

publicId - エンティティの公開識別子または null

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

戻り値:

新しい InputSource。デフォルトの場合は null

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

IOException - 新しい InputSource の取得中にクライアントが入出力関連の例外をスローすることがある

関連項目:

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 - 表記法のシステム識別子または null

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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 - エンティティのシステム識別子または null

notationName - 関連表記法名

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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

setDocumentLocator

public void setDocumentLocator(Locator locator)

新しい文書ロケータイベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の setDocumentLocator

パラメータ:

locator - 文書ロケータ

関連項目:

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

startDocument

public void startDocument()
                   throws SAXException

文書開始イベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の startDocument

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

文書終了イベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の endDocument

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

ContentHandler.endDocument()

startPrefixMapping

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

名前空間前置修飾子マッピングの開始イベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の startPrefixMapping

パラメータ:

prefix - 名前空間前置修飾子

uri - 名前空間 URI

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

名前空間前置修飾子マッピングの終了イベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の endPrefixMapping

パラメータ:

prefix - 名前空間前置修飾子

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

ContentHandler.endPrefixMapping(java.lang.String)

startElement

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

要素開始イベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の startElement

パラメータ:

uri - 要素の名前空間 URI または空文字列

localName - 要素のローカル名または空文字列

qName - 要素の前置修飾子付きの修飾名または空文字列

atts - 要素の属性

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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

パラメータ:

uri - 要素の名前空間 URI または空文字列

localName - 要素のローカル名または空文字列

qName - 要素の前置修飾子付きの修飾名または空文字列

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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 - 処理中にクライアントが例外をスローすることがある

関連項目:

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

ignorableWhitespace

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

無視できる空白文字イベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の ignorableWhitespace

パラメータ:

ch - 文字配列

start - 配列内の開始位置

length - 配列から読み取られる文字数

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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

processingInstruction

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

処理命令イベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の processingInstruction

パラメータ:

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

data - ターゲットのテキスト

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

スキップされたエンティティイベントをファイルタリングします。

定義:

インタフェース ContentHandler 内の skippedEntity

パラメータ:

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

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

ContentHandler.skippedEntity(java.lang.String)

warning

public void warning(SAXParseException e)
             throws SAXException

警告イベントをファイルタリングします。

定義:

インタフェース ErrorHandler 内の warning

パラメータ:

e - 警告を示す例外

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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

error

public void error(SAXParseException e)
           throws SAXException

エラーイベントをファイルタリングします。

定義:

インタフェース ErrorHandler 内の error

パラメータ:

e - エラーを示す例外

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

ErrorHandler.error(org.xml.sax.SAXParseException)

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

致命的なエラーイベントをファイルタリングします。

定義:

インタフェース ErrorHandler 内の fatalError

パラメータ:

e - エラーを示す例外

例外:

SAXException - 処理中にクライアントが例外をスローすることがある

関連項目:

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