XML Library 1.0

org.koiroha.xml.parser
クラス AbstractXMLReader

java.lang.Object
  上位を拡張 org.koiroha.xml.parser.AbstractXMLReader
すべての実装されたインタフェース:
XMLReader
直系の既知のサブクラス:
LooseXMLReader

public abstract class AbstractXMLReader
extends Object
implements XMLReader

XML リーダーの抽象実装クラスです。

導入されたバージョン:
2009/04/03 Java2 SE 5.0
バージョン:
$Revision: 1.2 $ $Date: 2010/02/24 13:59:38 $
作成者:
torao

フィールドの概要
protected  LocatorReader in
          入力ストリームです。
 
コンストラクタの概要
protected AbstractXMLReader()
          機能フラグとプロパティが未設定状態のインスタンスを構築します。
protected AbstractXMLReader(Map<String,Boolean> feature, Map<String,Object> property)
          指定された機能フラグとプロパティを引き継いだ構成で構築を行います。
 
メソッドの概要
 ContentHandler getContentHandler()
          内容ハンドラを参照します。
 DTDHandler getDTDHandler()
          DTD ハンドラを参照します。
 String getEntityReference(String name)
          指定された実体参照名に対する文字列を参照します。
 EntityResolver getEntityResolver()
          エンティティリゾルバーを参照します。
 ErrorHandler getErrorHandler()
          エラーハンドラを参照します。
 boolean getFeature(String name)
          指定された機能が有効になっているかを判定します。
protected  boolean getFeature(String name, boolean def)
          指定された機能が有効になっているかを判定します。
 LexicalHandler getLexicalHandler()
          プロパティから構文ハンドラを参照するためのアクセサメソッドです。
 int getMaxEntityReferenceName()
          実体参照として定義されている名前の最大文字数を参照します。
 Object getProperty(String name)
          プロパティを参照します。
protected abstract  void handleDocument()
          ドキュメントの解析を開始するためにスーパークラスによって呼び出されます。
 boolean isNamespaceAware()
          このインスタンスが要素名または属性名の接頭辞とその名前空間 URI を認識するかどうかを判定 します。
 boolean isValidating()
          このパーサが DTD 検証を行うかどうかを参照します。
 void parse(InputSource is)
          指定された入力ソースから読み出される XML の解析を開始します。
 void parse(String systemId)
          指定された SYSTEM ID の HTML を解析します。
 void removeEntityReference(String name)
          このパーサが認識する実体文字参照定義を削除します。
 void setContentHandler(ContentHandler handler)
          内容ハンドラを設定します。
 void setDTDHandler(DTDHandler handler)
          DTD ハンドラを設定します。
 void setEntityReference(String name, String value)
          このパーサが認識する実体文字参照を定義します。
 void setEntityResolver(EntityResolver resolver)
          エンティティリゾルバーを設定します。
 void setErrorHandler(ErrorHandler handler)
          エラーハンドラを設定します。
 void setFeature(String name, boolean value)
          指定された機能を設定します。
 void setProperty(String name, Object value)
          プロパティを設定します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

in

protected LocatorReader in
入力ストリームです。

コンストラクタの詳細

AbstractXMLReader

protected AbstractXMLReader()
機能フラグとプロパティが未設定状態のインスタンスを構築します。


AbstractXMLReader

protected AbstractXMLReader(Map<String,Boolean> feature,
                            Map<String,Object> property)
指定された機能フラグとプロパティを引き継いだ構成で構築を行います。このインスタンスの機能 またはプロパティが変更されても指定されたマップに影響は与えません。

パラメータ:
feature - 機能フラグ
property - プロパティ
メソッドの詳細

getFeature

public boolean getFeature(String name)
指定された機能が有効になっているかを判定します。機能が設定されていない場合は false を 返します。

定義:
インタフェース XMLReader 内の getFeature
パラメータ:
name - 機能名
戻り値:
機能が有効な場合 true

getFeature

protected boolean getFeature(String name,
                             boolean def)
指定された機能が有効になっているかを判定します。機能が設定されていない場合はデフォルト値を 返します。

パラメータ:
name - 機能名
def - デフォルト値
戻り値:
機能が有効な場合 true

isNamespaceAware

public boolean isNamespaceAware()
このインスタンスが要素名または属性名の接頭辞とその名前空間 URI を認識するかどうかを判定 します。

戻り値:
名前空間が有効な場合 true

isValidating

public boolean isValidating()
このパーサが DTD 検証を行うかどうかを参照します。

戻り値:
DTD 検証を行う場合 true

setFeature

public void setFeature(String name,
                       boolean value)
指定された機能を設定します。

定義:
インタフェース XMLReader 内の setFeature
パラメータ:
name - 機能名
value - 機能を有効にする場合 true

getProperty

public Object getProperty(String name)
プロパティを参照します。指定されたプロパティが設定されていない場合は null を返します。

定義:
インタフェース XMLReader 内の getProperty
パラメータ:
name - プロパティ名
戻り値:
プロパティの値

setProperty

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

定義:
インタフェース XMLReader 内の setProperty
パラメータ:
name - プロパティ名
value - プロパティ値

getContentHandler

public ContentHandler getContentHandler()
内容ハンドラを参照します。内容ハンドラが設定されていない場合は null を返します。

定義:
インタフェース XMLReader 内の getContentHandler
戻り値:
内容ハンドラ

setContentHandler

public void setContentHandler(ContentHandler handler)
内容ハンドラを設定します。

定義:
インタフェース XMLReader 内の setContentHandler
パラメータ:
handler - 内容ハンドラ

getDTDHandler

public DTDHandler getDTDHandler()
DTD ハンドラを参照します。DTD ハンドラが設定されていない場合は null を返します。

定義:
インタフェース XMLReader 内の getDTDHandler
戻り値:
DTD ハンドラ

setDTDHandler

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

定義:
インタフェース XMLReader 内の setDTDHandler
パラメータ:
handler - DTD ハンドラ

getEntityResolver

public EntityResolver getEntityResolver()
エンティティリゾルバーを参照します。エンティティリゾルバーが設定されていない場合は null を返します。

定義:
インタフェース XMLReader 内の getEntityResolver
戻り値:
エンティティリゾルバー

setEntityResolver

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

定義:
インタフェース XMLReader 内の setEntityResolver
パラメータ:
resolver - エンティティリゾルバー

getErrorHandler

public ErrorHandler getErrorHandler()
エラーハンドラを参照します。エラーハンドラが設定されていない場合は null を返します。

定義:
インタフェース XMLReader 内の getErrorHandler
戻り値:
エラーハンドラ

setErrorHandler

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

定義:
インタフェース XMLReader 内の setErrorHandler
パラメータ:
handler - エラーハンドラ

getLexicalHandler

public LexicalHandler getLexicalHandler()
プロパティから構文ハンドラを参照するためのアクセサメソッドです。構文ハンドラが設定されて いない場合は null を返します。

戻り値:
構文ハンドラ

getMaxEntityReferenceName

public int getMaxEntityReferenceName()
実体参照として定義されている名前の最大文字数を参照します。サブクラスはこの値を参照して、 ストリーム中に出現した '&' から何文字目で実体参照としての認識を放棄して良いかを 決定できます。

このメソッドは少なくとも数値実体参照の最大文字数 ("#65535") を返します。

戻り値:
実体参照名として可能な最大文字数

setEntityReference

public void setEntityReference(String name,
                               String value)
このパーサが認識する実体文字参照を定義します。&foo; という実体参照を定義する場合、 "foo" を指定します。

スーパークラスはデフォルト状態で XML で定義されている "lt", "gt", "amp", "quot", "apos" が定義されています。

パラメータ:
name - 実体文字参照の名前
value - 実体参照に対する値

removeEntityReference

public void removeEntityReference(String name)
このパーサが認識する実体文字参照定義を削除します。

パラメータ:
name - 削除する実体文字参照の名前

getEntityReference

public String getEntityReference(String name)
指定された実体参照名に対する文字列を参照します。名前には "#x0a" のような数値参照を指定 することも出来ます。該当する文字が定義されていなければ null を返します。

パラメータ:
name - 実体参照の名前 ("quot", "lt" など)
戻り値:
該当する文字

parse

public void parse(String systemId)
           throws IOException,
                  SAXException
指定された SYSTEM ID の HTML を解析します。

定義:
インタフェース XMLReader 内の parse
パラメータ:
systemId - システム ID
例外:
IOException - 読み込みに失敗した場合
SAXException - ハンドラが例外を発生した場合

parse

public void parse(InputSource is)
           throws IOException,
                  SAXException
指定された入力ソースから読み出される XML の解析を開始します。

is にバイナリストリームが指定されエンコーディングが省略された場合、ストリームから 先読みした内容からエンコーディングを推測します。この動作を抑止するには is に テキストストリームを指定するか適切なエンコーディングを設定してください。

定義:
インタフェース XMLReader 内の parse
パラメータ:
is - 入力ソース
例外:
IOException - 読み込みに失敗した場合
SAXException - ハンドラが例外を発生した場合

handleDocument

protected abstract void handleDocument()
                                throws SAXException,
                                       IOException
ドキュメントの解析を開始するためにスーパークラスによって呼び出されます。このメソッドが呼び 出された時点で入力用のストリーム in が準備され、ContentHandler に対する ドキュメント開始の通知が行われています。

サブクラスはこのメソッド内で ContentHandler へのドキュメント終了通知を行う必要はあり ません。

例外:
IOException - 読み込みに失敗した場合
SAXException - ハンドラによって中断された場合

koiroha.org by takami torao