shohaku.composer
クラス DocumentContext

java.lang.Object
  拡張shohaku.composer.DocumentContext

public class DocumentContext
extends java.lang.Object

ドキュメントのコンテキスト情報を提供します。


メソッドの概要
 java.lang.Object getAttribute(java.lang.String name)
          引数の名前を持つ属性値を返却します。
 java.lang.Object getAttribute(java.lang.String name, java.lang.Object defaultValue)
          引数の名前を持つ属性が存在する場合その属性値を存在しない場合は第二引数を返却します。
 java.util.Iterator getAttributeNameIterator()
          属性の名前のセットを全て返却します。
 java.util.Map getAttributePrefix(java.lang.String prefix)
          接頭辞の一致する属性をMapに格納して返却します。
 CompositeContext getCompositeContext()
          解析処理のコンテキスト情報を返却します。
 CompositeRule getCompositeRule()
          ドキュメント解析の構成ルールを返却します。
 Node getNodeById(java.lang.String id)
          IDが示すノードを返す。
 java.util.Iterator getNodeIdIterator()
          全てのノードのIDを返す。
 java.lang.String getPublicId()
          ドキュメントの公開識別子を返却します。
 Node getRoot()
          ドキュメントのルートノードを返します。
 java.lang.Object removeAttribute(java.lang.String name)
          属性を削除し削除された属性値を返却します。
 void removeAttributeAll()
          属性を全て削除します。
 java.util.Map removeAttributePrefix(java.lang.String prefix)
          接頭辞の一致する属性を削除し削除された属性をMapに格納して返却します。
 java.lang.Object setAttribute(java.lang.String name, java.lang.Object value)
          属性を登録する、既存の属性が存在する場合は既存の属性値を返却し上書きします。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

getAttributeNameIterator

public java.util.Iterator getAttributeNameIterator()
属性の名前のセットを全て返却します。

戻り値:
属性の名前のセット

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
引数の名前を持つ属性値を返却します。 指定された属性が存在しない場合は、 null が返されます。

パラメータ:
name - 属性名
戻り値:
属性値

getAttribute

public java.lang.Object getAttribute(java.lang.String name,
                                     java.lang.Object defaultValue)
引数の名前を持つ属性が存在する場合その属性値を存在しない場合は第二引数を返却します。

パラメータ:
name - 属性名
defaultValue - 属性が存在しない場合に返却される値
戻り値:
属性値

getAttributePrefix

public java.util.Map getAttributePrefix(java.lang.String prefix)
接頭辞の一致する属性をMapに格納して返却します。

パラメータ:
prefix - 属性名の接頭辞
戻り値:
接頭辞の一致する属性のMap

setAttribute

public java.lang.Object setAttribute(java.lang.String name,
                                     java.lang.Object value)
属性を登録する、既存の属性が存在する場合は既存の属性値を返却し上書きします。 既存の属性が存在しない場合は、 null が返されます。

パラメータ:
name - 属性名
value - 属性値
戻り値:
既存の属性値、存在しない場合は null

removeAttribute

public java.lang.Object removeAttribute(java.lang.String name)
属性を削除し削除された属性値を返却します。 属性が存在しない場合は、 null が返されます。

パラメータ:
name - 属性名
戻り値:
属性値

removeAttributePrefix

public java.util.Map removeAttributePrefix(java.lang.String prefix)
接頭辞の一致する属性を削除し削除された属性をMapに格納して返却します。

パラメータ:
prefix - 属性名の接頭辞
戻り値:
接頭辞の一致する属性のMap

removeAttributeAll

public void removeAttributeAll()
属性を全て削除します。


getNodeIdIterator

public java.util.Iterator getNodeIdIterator()
全てのノードのIDを返す。

戻り値:
全てのノードのID

getNodeById

public Node getNodeById(java.lang.String id)
IDが示すノードを返す。

パラメータ:
id - ID
戻り値:
IDが示すノード
例外:
java.lang.NullPointerException - id が null の場合発生する

getCompositeContext

public CompositeContext getCompositeContext()
解析処理のコンテキスト情報を返却します。

戻り値:
解析処理のコンテキスト情報

getCompositeRule

public CompositeRule getCompositeRule()
ドキュメント解析の構成ルールを返却します。

戻り値:
ドキュメント解析の構成ルール

getPublicId

public java.lang.String getPublicId()
ドキュメントの公開識別子を返却します。

戻り値:
ドキュメントの公開識別子

getRoot

public Node getRoot()
ドキュメントのルートノードを返します。

戻り値:
ドキュメントのルートノード