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フィルタを派生する基底クラスです。
このモジュールは、ソース・コード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。 詳細については、http://www.saxproject.orgを参照してください。
このクラスは、XMLReader
とクライアント・アプリケーションのイベント・ハンドラの中間に置かれます。 デフォルトでは、ハンドラに対するイベントを変更せずに要求をリーダーに渡すのみです。しかし、サブクラスでは特定のメソッドをオーバーライドして、転送中にイベント・ストリームや構成要求を変更できます。
- 導入されたバージョン:
- 1.4, 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(String systemId)
文書を構文解析します。void
parse(InputSource input)
文書を構文解析します。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 value)
機能の値を設定します。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)
警告イベントをフィルタ・リングします。
-
コンストラクタの詳細
-
XMLFilterImpl
public XMLFilterImpl()親を持たない空のXMLフィルタを構築します。このフィルタは親を持ちません。このフィルタを
XMLReader
としてではなく純粋なイベント・コンシューマとして使用しないかぎり、構文解析を始める前、あるいはsetFeatureまたはsetPropertyを使用して構成を始める前に親を割り当てる必要があります。 -
XMLFilterImpl
public XMLFilterImpl(XMLReader parent)指定された親を持つXMLフィルタを構築します。
-
-
メソッドの詳細
-
setParent
public void setParent(XMLReader parent)親リーダーを設定します。親リーダーは、このフィルタがイベントを取得し、構成要求を渡す
XMLReader
そのものです。 親リーダーとして別のフィルタを指定することもできます。親リーダーが設定されていないと、構文解析、機能またはプロパティの設定や取得に失敗します。
- 定義:
setParent
、インタフェース:XMLFilter
- パラメータ:
parent
- 親XMLリーダー。- 関連項目:
getParent()
-
getParent
public XMLReader getParent()親リーダーを取得します。- 定義:
getParent
、インタフェース:XMLFilter
- 戻り値:
- 親XMLリーダー。設定されていない場合はnull。
- 関連項目:
setParent(org.xml.sax.XMLReader)
-
setFeature
public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException機能の値を設定します。親がnullの場合は常に失敗します。
- 定義:
setFeature
、インタフェース:XMLReader
- パラメータ:
name
- 機能名。value
- 要求された機能の値。- 例外:
SAXNotRecognizedException
- 機能値を割り当てられない、あるいは親から取得できない場合。SAXNotSupportedException
- 親が機能名を認識するだけで、要求された値を設定できない場合。- 関連項目:
XMLReader.getFeature(java.lang.String)
-
getFeature
public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException機能の値を検索します。親がnullの場合は常に失敗します。
- 定義:
getFeature
、インタフェース:XMLReader
- パラメータ:
name
- 機能名。- 戻り値:
- 機能の現在の値。
- 例外:
SAXNotRecognizedException
- 機能値を割り当てられない、あるいは親から取得できない場合。SAXNotSupportedException
- 親が機能名を認識するだけで、現時点ではその値を判断できない場合。- 関連項目:
XMLReader.setFeature(java.lang.String, boolean)
-
setProperty
public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedExceptionプロパティ値を設定します。親がnullの場合は常に失敗します。
- 定義:
setProperty
、インタフェース:XMLReader
- パラメータ:
name
- プロパティ名。value
- 要求されたプロパティ値。- 例外:
SAXNotRecognizedException
- プロパティ値を割り当てられない、あるいは親から取得できない場合。SAXNotSupportedException
- 親がプロパティ名を認識するだけで、要求された値を設定できない場合。
-
getProperty
public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedExceptionプロパティ値を検索します。- 定義:
getProperty
、インタフェース:XMLReader
- パラメータ:
name
- プロパティ名。- 戻り値:
- 現在のプロパティ値。
- 例外:
SAXNotRecognizedException
- プロパティ値を割り当てられない、あるいは親から取得できない場合。SAXNotSupportedException
- 親がプロパティ名を認識するだけで、現時点ではその値を判断できない場合。- 関連項目:
XMLReader.setProperty(java.lang.String, java.lang.Object)
-
setEntityResolver
public void setEntityResolver(EntityResolver resolver)エンティティ・リゾルバを設定します。- 定義:
setEntityResolver
、インタフェース:XMLReader
- パラメータ:
resolver
- 新しいエンティティ・リゾルバ。- 関連項目:
XMLReader.getEntityResolver()
-
getEntityResolver
public EntityResolver getEntityResolver()現在のエンティティ・リゾルバを取得します。- 定義:
getEntityResolver
、インタフェース:XMLReader
- 戻り値:
- 現在のエンティティ・リゾルバ。設定されていない場合はnull。
- 関連項目:
XMLReader.setEntityResolver(org.xml.sax.EntityResolver)
-
setDTDHandler
public void setDTDHandler(DTDHandler handler)DTDイベント・ハンドラを設定します。- 定義:
setDTDHandler
、インタフェース:XMLReader
- パラメータ:
handler
- 新しいDTDハンドラ- 関連項目:
XMLReader.getDTDHandler()
-
getDTDHandler
public DTDHandler getDTDHandler()現在のDTDイベント・ハンドラを取得します。- 定義:
getDTDHandler
、インタフェース:XMLReader
- 戻り値:
- 現在のDTDハンドラ。設定されていない場合はnull。
- 関連項目:
XMLReader.setDTDHandler(org.xml.sax.DTDHandler)
-
setContentHandler
public void setContentHandler(ContentHandler handler)コンテンツ・イベント・ハンドラを設定します。- 定義:
setContentHandler
、インタフェース:XMLReader
- パラメータ:
handler
- 新しいコンテンツ・ハンドラ- 関連項目:
XMLReader.getContentHandler()
-
getContentHandler
public ContentHandler getContentHandler()コンテンツ・イベント・ハンドラを取得します。- 定義:
getContentHandler
、インタフェース:XMLReader
- 戻り値:
- 現在のコンテンツ・ハンドラ。設定されていない場合はnull。
- 関連項目:
XMLReader.setContentHandler(org.xml.sax.ContentHandler)
-
setErrorHandler
public void setErrorHandler(ErrorHandler handler)エラー・イベント・ハンドラを設定します。- 定義:
setErrorHandler
、インタフェース:XMLReader
- パラメータ:
handler
- 新しいエラー・ハンドラ- 関連項目:
XMLReader.getErrorHandler()
-
getErrorHandler
public ErrorHandler getErrorHandler()現在のエラー・イベント・ハンドラを取得します。- 定義:
getErrorHandler
、インタフェース:XMLReader
- 戻り値:
- 現在のエラー・ハンドラ。設定されていない場合はnull。
- 関連項目:
XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)
-
parse
public void parse(InputSource input) throws SAXException, IOException文書を構文解析します。- 定義:
parse
、インタフェース:XMLReader
- パラメータ:
input
- 文書エンティティの入力ソース。- 例外:
SAXException
- 任意のSAX例外。ほかの例外をラップしている可能性があります。IOException
- パーサーからのIO例外。アプリケーションが提供するバイト・ストリームまたは文字ストリームから発生する可能性があります。- 関連項目:
InputSource
,XMLReader.parse(java.lang.String)
,XMLReader.setEntityResolver(org.xml.sax.EntityResolver)
,XMLReader.setDTDHandler(org.xml.sax.DTDHandler)
,XMLReader.setContentHandler(org.xml.sax.ContentHandler)
,XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)
-
parse
public void parse(String systemId) throws SAXException, IOException文書を構文解析します。- 定義:
parse
、インタフェース:XMLReader
- パラメータ:
systemId
- システム識別子を示す完全指定URI。- 例外:
SAXException
- 任意のSAX例外。ほかの例外をラップしている可能性があります。IOException
- パーサーからのIO例外。アプリケーションが提供するバイト・ストリームまたは文字ストリームから発生する可能性があります。- 関連項目:
XMLReader.parse(org.xml.sax.InputSource)
-
resolveEntity
public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException外部エンティティ解決をフィルタ・リングします。- 定義:
resolveEntity
、インタフェース:EntityResolver
- パラメータ:
publicId
- エンティティの公開識別子またはnull。systemId
- エンティティのシステム識別子。- 戻り値:
- 新しいInputSource。デフォルトの場合はnull。
- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。IOException
- 新しいInputSourceの取得中にクライアントが入出力関連の例外をスローすることがあります。- 関連項目:
InputSource
-
notationDecl
public void notationDecl(String name, String publicId, String systemId) throws SAXException表記法宣言イベントをフィルタ・リングします。- 定義:
notationDecl
、インタフェース:DTDHandler
- パラメータ:
name
- 表記法名。publicId
- 表記法の公開識別子またはnull。systemId
- 表記法のシステム識別子またはnull。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
,Attributes
-
unparsedEntityDecl
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException解析対象外エンティティ宣言イベントをフィルタ・リングします。- 定義:
unparsedEntityDecl
、インタフェース:DTDHandler
- パラメータ:
name
- エンティティ名。publicId
- エンティティの公開識別子またはnull。systemId
- エンティティのシステム識別子またはnull。notationName
- 関連表記法名。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
,Attributes
-
setDocumentLocator
public void setDocumentLocator(Locator locator)新しい文書ロケータ・イベントをフィルタ・リングします。- 定義:
setDocumentLocator
、インタフェース:ContentHandler
- パラメータ:
locator
- 文書ロケータ。- 関連項目:
Locator
-
startDocument
public void startDocument() throws SAXException文書開始イベントをフィルタ・リングします。- 定義:
startDocument
、インタフェース:ContentHandler
- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
ContentHandler.endDocument()
-
endDocument
public void endDocument() throws SAXException文書終了イベントをフィルタ・リングします。- 定義:
endDocument
、インタフェース:ContentHandler
- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
ContentHandler.startDocument()
-
startPrefixMapping
public void startPrefixMapping(String prefix, String uri) throws SAXException名前空間前置修飾子マッピングの開始イベントをフィルタ・リングします。- 定義:
startPrefixMapping
、インタフェース:ContentHandler
- パラメータ:
prefix
- 名前空間接頭辞。uri
- 名前空間URI。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
ContentHandler.endPrefixMapping(java.lang.String)
,ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
-
endPrefixMapping
public void endPrefixMapping(String prefix) throws SAXException名前空間前置修飾子マッピングの終了イベントをフィルタ・リングします。- 定義:
endPrefixMapping
、インタフェース:ContentHandler
- パラメータ:
prefix
- 名前空間接頭辞。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
,ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
-
startElement
public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException要素開始イベントをフィルタ・リングします。- 定義:
startElement
、インタフェース:ContentHandler
- パラメータ:
uri
- 要素の名前空間URI、または空文字列。localName
- 要素のローカル名、または空文字列。qName
- 要素の接頭辞付きの修飾名、または空文字列。atts
- 要素の属性。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,Attributes
,AttributesImpl
-
endElement
public void endElement(String uri, String localName, String qName) throws SAXException要素終了イベントをフィルタ・リングします。- 定義:
endElement
、インタフェース:ContentHandler
- パラメータ:
uri
- 要素の名前空間URI、または空文字列。localName
- 要素のローカル名、または空文字列。qName
- 要素の接頭辞付きの修飾名、または空文字列。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。
-
characters
public void characters(char[] ch, int start, int length) throws SAXException文字データ・イベントをフィルタ・リングします。- 定義:
characters
、インタフェース:ContentHandler
- パラメータ:
ch
- 文字配列。start
- 配列内の開始位置。length
- 配列から使用される文字数。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
ContentHandler.ignorableWhitespace(char[], int, int)
,Locator
-
ignorableWhitespace
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException無視できる空白類文字イベントをフィルタ・リングします。- 定義:
ignorableWhitespace
、インタフェース:ContentHandler
- パラメータ:
ch
- 文字配列。start
- 配列内の開始位置。length
- 配列から使用される文字数。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
ContentHandler.characters(char[], int, int)
-
processingInstruction
public void processingInstruction(String target, String data) throws SAXException処理命令イベントをフィルタ・リングします。- 定義:
processingInstruction
、インタフェース:ContentHandler
- パラメータ:
target
- 処理命令のターゲット。data
- ターゲットのあとに続くテキスト。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。
-
skippedEntity
public void skippedEntity(String name) throws SAXExceptionスキップされたエンティティ・イベントをフィルタ・リングします。- 定義:
skippedEntity
、インタフェース:ContentHandler
- パラメータ:
name
- スキップされたエンティティの名前。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。
-
warning
public void warning(SAXParseException e) throws SAXException警告イベントをフィルタ・リングします。- 定義:
warning
、インタフェース:ErrorHandler
- パラメータ:
e
- 警告を示す例外。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
SAXParseException
-
error
public void error(SAXParseException e) throws SAXExceptionエラー・イベントをフィルタ・リングします。- 定義:
error
、インタフェース:ErrorHandler
- パラメータ:
e
- エラーを示す例外。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
SAXParseException
-
fatalError
public void fatalError(SAXParseException e) throws SAXException致命的なエラー・イベントをフィルタ・リングします。- 定義:
fatalError
、インタフェース:ErrorHandler
- パラメータ:
e
- エラーを示す例外。- 例外:
SAXException
- 処理中にクライアントが例外をスローする場合があります。- 関連項目:
SAXParseException
-