shohaku.ginkgo
クラス AbstractNode

java.lang.Object
  拡張shohaku.ginkgo.AbstractNode
すべての実装インタフェース:
Node
直系の既知のサブクラス:
AbstractDefaultNode, CacheNode, SimpleNode

public abstract class AbstractNode
extends java.lang.Object
implements Node

ノードの抽象実装を提供し実装の負担を最小化します。


フィールドの概要
 
インタフェース shohaku.ginkgo.Node から継承したフィールド
SCOPE_DOCUMENT, SCOPE_OWNER, SCOPE_PUBLIC, TYPE_COMMAND, TYPE_COMMENT, TYPE_CONTAINER, TYPE_TEXT, TYPE_VALUE
 
コンストラクタの概要
AbstractNode()
           
 
メソッドの概要
 void begin()
          解析処理プロセス開始の通知を受ける(空実装)。
 void child(Node node)
          子のノードの追加の通知を受ける(空実装)。
 void end()
          解析処理プロセス完了通知を受ける(空実装)。
 void finish()
          解析処理プロセスを完了の通知を受ける(空実装)。
 java.lang.String getAttribute(java.lang.String name)
          引数の名前を持つノードの属性を検索し値を返却します。
 java.lang.String getAttribute(java.lang.String name, java.lang.String defaultValue)
          引数の名前を持つノードの属性を検索し値を返却します。
 NodeContext getContext()
          ノードのコンテキスト情報を返却します。
 java.lang.String getId()
          ノードの識別子を返却します。
protected  int getNodeScope()
          ノードの固有のスコープを返却します。
 java.lang.Object getNodeValue()
          ノードの値表現を返却します。
 int getScope()
          ノードのスコープを返却します。
 java.lang.String getText()
          テキスト情報を評価して返却します。
 void initialize(NodeContext nodeContext)
          解析処理を開始する直前に初期化の通知を受ける。
 boolean isType(int type)
          指定されたノードの種別に属する場合trueを返却します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

AbstractNode

public AbstractNode()
メソッドの詳細

isType

public boolean isType(int type)
指定されたノードの種別に属する場合trueを返却します。
デフォルト実装としてfalseを返却します。

定義:
インタフェース Node 内の isType
パラメータ:
type - 検証する種別
戻り値:
指定されたノードの種別に属する場合True

getScope

public int getScope()
ノードのスコープを返却します。

定義:
インタフェース Node 内の getScope
戻り値:
ノードのスコープ

getNodeScope

protected int getNodeScope()
ノードの固有のスコープを返却します。

戻り値:
ノードの固有のスコープ

getId

public java.lang.String getId()
ノードの識別子を返却します。

定義:
インタフェース Node 内の getId
戻り値:
ノードの識別子

getNodeValue

public java.lang.Object getNodeValue()
ノードの値表現を返却します。
デフォルト実装としてnullを返却します。

定義:
インタフェース Node 内の getNodeValue
戻り値:
null

getContext

public NodeContext getContext()
ノードのコンテキスト情報を返却します。

定義:
インタフェース Node 内の getContext
戻り値:
ノードのコンテキスト情報

getAttribute

public java.lang.String getAttribute(java.lang.String name)
引数の名前を持つノードの属性を検索し値を返却します。
属性が存在しない場合nullを返します。

定義:
インタフェース Node 内の getAttribute
パラメータ:
name - 属性名
戻り値:
属性値

getAttribute

public java.lang.String getAttribute(java.lang.String name,
                                     java.lang.String defaultValue)
引数の名前を持つノードの属性を検索し値を返却します。
属性が存在しない場合defaultValueを返します。

定義:
インタフェース Node 内の getAttribute
パラメータ:
name - 属性名
defaultValue - 属性が存在しない場合に返却される値
戻り値:
属性値

getText

public java.lang.String getText()
テキスト情報を評価して返却します。
全ての子のテキストノードを一つの文字列に連結して返却します。

定義:
インタフェース Node 内の getText
戻り値:
テキスト情報

initialize

public void initialize(NodeContext nodeContext)
解析処理を開始する直前に初期化の通知を受ける。
オーバライドした場合必ず親クラスの同メソッドを呼び出してください。

定義:
インタフェース Node 内の initialize
パラメータ:
nodeContext - ノードのコンテキスト情報
例外:
GinkgoException - 構成情報例外。

begin

public void begin()
解析処理プロセス開始の通知を受ける(空実装)。開始タグの解析に対応します。

定義:
インタフェース Node 内の begin
例外:
GinkgoException - 構成情報例外。

child

public void child(Node node)
子のノードの追加の通知を受ける(空実装)。 子ノードの解析終了直後に対応します。

定義:
インタフェース Node 内の child
パラメータ:
node - 子のノード
例外:
GinkgoException - 構成情報例外。

end

public void end()
解析処理プロセス完了通知を受ける(空実装)。終了タグの解析に対応します。
この通知が完了した段階で値を持つ情報は値の生成を完了している必要がある。

定義:
インタフェース Node 内の end
例外:
GinkgoException - 構成情報例外。

finish

public void finish()
解析処理プロセスを完了の通知を受ける(空実装)。ドキュメント解析処理全体の終了に対応します。

定義:
インタフェース Node 内の finish
例外:
GinkgoException - 構成情報例外。