JavaTM Platform
Standard Ed. 6

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 フィルタを派生する基底クラスです。

このモジュールは、ソースコード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。詳細については、http://www.saxproject.org を参照してください。
 

このクラスは、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 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)
          警告イベントをフィルタリングします。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

XMLFilterImpl

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

このフィルタは親を持ちません。このフィルタを XMLReader としてではなく純粋なイベントコンシューマとして使用しないかぎり、構文解析を始める前、あるいは setFeature または setProperty を使用して構成を始める前に親を割り当てる必要があります。

関連項目:
XMLReader.setFeature(java.lang.String, boolean), XMLReader.setProperty(java.lang.String, java.lang.Object), setParent(org.xml.sax.XMLReader)

XMLFilterImpl

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

関連項目:
setParent(org.xml.sax.XMLReader), getParent()
メソッドの詳細

setParent

public void setParent(XMLReader parent)
親リーダーを設定します。  

親リーダーは、このフィルタがイベントを取得し、構成要求を渡す XMLReader そのものです。親リーダーとして別のフィルタを指定することもできます。

 

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

定義:
インタフェース XMLFilter 内の setParent
パラメータ:
parent - 親 XML リーダー
関連項目:
getParent()

getParent

public XMLReader getParent()
親リーダーを取得します。

定義:
インタフェース XMLFilter 内の getParent
戻り値:
親 XML リーダー。設定されていない場合は null
関連項目:
setParent(org.xml.sax.XMLReader)

setFeature

public void setFeature(String name,
                       boolean value)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException
機能の値を設定します。  

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

定義:
インタフェース XMLReader 内の setFeature
パラメータ:
name - 機能名
value - 要求された機能の値
例外:
SAXNotRecognizedException - 機能値を割り当てられない、あるいは親から取得できない場合
SAXNotSupportedException - 親が機能名を認識するだけで、要求された値を設定できない場合
関連項目:
XMLReader.getFeature(java.lang.String)

getFeature

public boolean getFeature(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException
機能の値を検索します。  

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

定義:
インタフェース XMLReader 内の getFeature
パラメータ:
name - 機能名
戻り値:
機能の現在の値
例外:
SAXNotRecognizedException - 機能値を割り当てられない、あるいは親から取得できない場合
SAXNotSupportedException - 親が機能名を認識するだけで、現時点ではその値を判断できない場合
関連項目:
XMLReader.setFeature(java.lang.String, boolean)

setProperty

public void setProperty(String name,
                        Object value)
                 throws SAXNotRecognizedException,
                        SAXNotSupportedException
プロパティー値を設定します。  

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

定義:
インタフェース XMLReader 内の setProperty
パラメータ:
name - プロパティー名
value - 要求されたプロパティー値
例外:
SAXNotRecognizedException - プロパティー値を割り当てられない、あるいは親から取得できない場合
SAXNotSupportedException - 親がプロパティー名を認識するだけで、要求された値を設定できない場合

getProperty

public Object getProperty(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException
プロパティー値を検索します。

定義:
インタフェース XMLReader 内の getProperty
パラメータ:
name - プロパティー名
戻り値:
現在のプロパティー値
例外:
SAXNotRecognizedException - プロパティー値を割り当てられない、あるいは親から取得できない場合
SAXNotSupportedException - 親がプロパティー名を認識するだけで、現時点ではその値を判断できない場合
関連項目:
XMLReader.setProperty(java.lang.String, java.lang.Object)

setEntityResolver

public void setEntityResolver(EntityResolver resolver)
エンティティーリゾルバを設定します。

定義:
インタフェース XMLReader 内の setEntityResolver
パラメータ:
resolver - 新しいエンティティーリゾルバ
関連項目:
XMLReader.getEntityResolver()

getEntityResolver

public EntityResolver getEntityResolver()
現在のエンティティーリゾルバを取得します。

定義:
インタフェース XMLReader 内の getEntityResolver
戻り値:
現在のエンティティーリゾルバ。設定されていない場合は null
関連項目:
XMLReader.setEntityResolver(org.xml.sax.EntityResolver)

setDTDHandler

public void setDTDHandler(DTDHandler handler)
DTD イベントハンドラを設定します。

定義:
インタフェース XMLReader 内の setDTDHandler
パラメータ:
handler - 新しい DTD ハンドラ
関連項目:
XMLReader.getDTDHandler()

getDTDHandler

public DTDHandler getDTDHandler()
現在の DTD イベントハンドラを取得します。

定義:
インタフェース XMLReader 内の getDTDHandler
戻り値:
現在の DTD ハンドラ。設定されていない場合は null
関連項目:
XMLReader.setDTDHandler(org.xml.sax.DTDHandler)

setContentHandler

public void setContentHandler(ContentHandler handler)
コンテンツイベントハンドラを設定します。

定義:
インタフェース XMLReader 内の setContentHandler
パラメータ:
handler - 新しいコンテンツハンドラ
関連項目:
XMLReader.getContentHandler()

getContentHandler

public ContentHandler getContentHandler()
コンテンツイベントハンドラを取得します。

定義:
インタフェース XMLReader 内の getContentHandler
戻り値:
現在のコンテンツハンドラ。設定されていない場合は null
関連項目:
XMLReader.setContentHandler(org.xml.sax.ContentHandler)

setErrorHandler

public void setErrorHandler(ErrorHandler handler)
エラーイベントハンドラを設定します。

定義:
インタフェース XMLReader 内の setErrorHandler
パラメータ:
handler - 新しいエラーハンドラ
関連項目:
XMLReader.getErrorHandler()

getErrorHandler

public ErrorHandler getErrorHandler()
現在のエラーイベントハンドラを取得します。

定義:
インタフェース XMLReader 内の getErrorHandler
戻り値:
現在のエラーハンドラ。設定されていない場合は null
関連項目:
XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

parse

public void parse(InputSource input)
           throws SAXException,
                  IOException
文書を構文解析します。

定義:
インタフェース XMLReader 内の parse
パラメータ:
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
文書を構文解析します。

定義:
インタフェース XMLReader 内の parse
パラメータ:
systemId - システム識別子を示す完全指定 URI
例外:
SAXException - SAX 例外。ほかの例外をラップしている可能性がある
IOException - パーサーからの IO 例外。通常、アプリケーションが提供するバイトストリームまたは文字ストリームから発生する
関連項目:
XMLReader.parse(org.xml.sax.InputSource)

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 IOException
外部エンティティー解決をフィルタリングします。

定義:
インタフェース EntityResolver 内の resolveEntity
パラメータ:
publicId - エンティティーの公開識別子または null
systemId - エンティティーのシステム識別子
戻り値:
新しい InputSource。デフォルトの場合は null
例外:
SAXException - 処理中にクライアントが例外をスローすることがある
IOException - 新しい InputSource の取得中にクライアントが入出力関連の例外をスローすることがある
関連項目:
InputSource

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
                  throws SAXException
表記法宣言イベントをフィルタリングします。

定義:
インタフェース DTDHandler 内の notationDecl
パラメータ:
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
解析対象外エンティティー宣言イベントをフィルタリングします。

定義:
インタフェース DTDHandler 内の unparsedEntityDecl
パラメータ:
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)
新しい文書ロケータイベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の setDocumentLocator
パラメータ:
locator - 文書ロケータ
関連項目:
Locator

startDocument

public void startDocument()
                   throws SAXException
文書開始イベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の startDocument
例外:
SAXException - 処理中にクライアントが例外をスローすることがある
関連項目:
ContentHandler.endDocument()

endDocument

public void endDocument()
                 throws SAXException
文書終了イベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の endDocument
例外:
SAXException - 処理中にクライアントが例外をスローすることがある
関連項目:
ContentHandler.startDocument()

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException
名前空間前置修飾子マッピングの開始イベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の startPrefixMapping
パラメータ:
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
名前空間前置修飾子マッピングの終了イベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の endPrefixMapping
パラメータ:
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
要素開始イベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の startElement
パラメータ:
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
要素終了イベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の endElement
パラメータ:
uri - 要素の名前空間 URI または空文字列
localName - 要素のローカル名または空文字列
qName - 要素の接頭辞付きの修飾名または 空文字列
例外:
SAXException - 処理中にクライアントが例外をスローすることがある

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException
文字データイベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の characters
パラメータ:
ch - 文字配列
start - 配列内の開始位置
length - 配列から読み取られる文字数
例外:
SAXException - 処理中にクライアントが例外をスローすることがある
関連項目:
ContentHandler.ignorableWhitespace(char[], int, int), Locator

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws SAXException
無視できる空白類文字イベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の ignorableWhitespace
パラメータ:
ch - 文字配列
start - 配列内の開始位置
length - 配列から読み取られる文字数
例外:
SAXException - 処理中にクライアントが例外をスローすることがある
関連項目:
ContentHandler.characters(char[], int, int)

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException
処理命令イベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の processingInstruction
パラメータ:
target - 処理命令のターゲット
data - ターゲットのテキスト
例外:
SAXException - 処理中にクライアントが例外をスローすることがある

skippedEntity

public void skippedEntity(String name)
                   throws SAXException
スキップされたエンティティーイベントをフィルタリングします。

定義:
インタフェース ContentHandler 内の skippedEntity
パラメータ:
name - スキップされたエンティティーの名前
例外:
SAXException - 処理中にクライアントが例外をスローすることがある

warning

public void warning(SAXParseException e)
             throws SAXException
警告イベントをフィルタリングします。

定義:
インタフェース ErrorHandler 内の warning
パラメータ:
e - 警告を示す例外
例外:
SAXException - 処理中にクライアントが例外をスローすることがある
関連項目:
SAXParseException

error

public void error(SAXParseException e)
           throws SAXException
エラーイベントをフィルタリングします。

定義:
インタフェース ErrorHandler 内の error
パラメータ:
e - エラーを示す例外
例外:
SAXException - 処理中にクライアントが例外をスローすることがある
関連項目:
SAXParseException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException
致命的なエラーイベントをフィルタリングします。

定義:
インタフェース ErrorHandler 内の fatalError
パラメータ:
e - エラーを示す例外
例外:
SAXException - 処理中にクライアントが例外をスローすることがある
関連項目:
SAXParseException

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。