shohaku.composer
インタフェース Node

既知の実装クラスの一覧:
AbstractNode, TextNode

public interface Node

ノードの情報を表現するインターフェースを定義します。


フィールドの概要
static int SCOPE_OWNER
          ID識別子のスコープ:インスタンスの所有者。
static int SCOPE_PRIVATE
          ID識別子のスコープ:ドキュメント内のみ。
static int SCOPE_PUBLIC
          ID識別子のスコープ:公開。
static int TYPE_COMMAND
          処理を実行する型。
static int TYPE_COMMENT
          コメント型。
static int TYPE_CONTAINER
          子の要素を持つコンテナ型。
static int TYPE_TEXT
          テキストノード。
static int TYPE_VALUE
          データ型。
 
メソッドの概要
 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 getNodeContext()
          ノードのコンテキスト情報を返却します。
 java.lang.Object getNodeValue()
          ノードの値表現を返却します。
 int getScope()
          ノードのスコープを返却します。
 java.lang.String getText()
          テキスト情報を評価して返却します。
 void initialize(NodeContext nodeContext)
          ドキュメント解析処理を開始する直前に初期化の通知を受ける。
 boolean isType(int type)
          指定されたノードの種別に属する場合Trueを返却します。
 

フィールドの詳細

TYPE_CONTAINER

public static final int TYPE_CONTAINER
子の要素を持つコンテナ型。

関連項目:
定数フィールド値

TYPE_TEXT

public static final int TYPE_TEXT
テキストノード。

関連項目:
定数フィールド値

TYPE_VALUE

public static final int TYPE_VALUE
データ型。

関連項目:
定数フィールド値

TYPE_COMMAND

public static final int TYPE_COMMAND
処理を実行する型。

関連項目:
定数フィールド値

TYPE_COMMENT

public static final int TYPE_COMMENT
コメント型。

関連項目:
定数フィールド値

SCOPE_PUBLIC

public static final int SCOPE_PUBLIC
ID識別子のスコープ:公開。

関連項目:
定数フィールド値

SCOPE_OWNER

public static final int SCOPE_OWNER
ID識別子のスコープ:インスタンスの所有者。

関連項目:
定数フィールド値

SCOPE_PRIVATE

public static final int SCOPE_PRIVATE
ID識別子のスコープ:ドキュメント内のみ。

関連項目:
定数フィールド値
メソッドの詳細

isType

public boolean isType(int type)
指定されたノードの種別に属する場合Trueを返却します。

パラメータ:
type - 検証する種別
戻り値:
指定されたノードの種別に属する場合True

getScope

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

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

getNodeValue

public java.lang.Object getNodeValue()
ノードの値表現を返却します。
isType(TYPE_VALUE) が True の場合必ず、有効な値を返却する必要がある。
isType(TYPE_VALUE) が False を返却する場合の実装は任意とします。

戻り値:
ノードの値表現

getNodeContext

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

戻り値:
ノードのコンテキスト情報

getAttribute

public java.lang.String getAttribute(java.lang.String name)
属性を検索し存在しない場合は拡張属性を検索し値を返却します。
属性名が存在しない場合 null を返す。

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

getAttribute

public java.lang.String getAttribute(java.lang.String name,
                                     java.lang.String defaultValue)
属性を検索し存在しない場合は拡張属性を検索し値を返却します。
属性名が存在しない場合 defaultValue を返す。

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

getText

public java.lang.String getText()
テキスト情報を評価して返却します。
テキスト情報を持たないノードは空文字を返却します。
テキスト情報を評価する基準はノードの実装により異なることが認められています。 前後のスペースの評価や子のエレメントの値を含めるか否か、またテキストを変換して返却する場合も考えられます。

戻り値:
テキスト情報

initialize

public void initialize(NodeContext nodeContext)
ドキュメント解析処理を開始する直前に初期化の通知を受ける。

パラメータ:
nodeContext - ノードのコンテキスト情報
例外:
CompositeException - 構成情報例外。

begin

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

例外:
CompositeException - 構成情報例外。

child

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

パラメータ:
node - 子のノード
例外:
CompositeException - 構成情報例外。

end

public void end()
解析処理プロセス完了通知を受ける。 終了タグの解析に対応します。
この通知が完了した段階で、値を持つノードは値の生成が可能である必要が有ります。

例外:
CompositeException - 構成情報例外。

finish

public void finish()
ドキュメント解析処理プロセスを完了の通知を受ける。

例外:
CompositeException - 構成情報例外。