shohaku.ginkgo
インタフェース TagNode

すべてのスーパーインタフェース:
Node
既知の実装クラスの一覧:
AbstractTag, CacheTag

public interface TagNode
extends Node

XMLタグを表現するインターフェースを提供します。

銀杏APIでは、タグの属性とテキストおよび要素の値はシステムの自動変換機能からプロパティに格納されます。

属性に対しては、属性名と同じプロパティ名の Setter メソッドとバインドされます。
Setter メソッドが定義されない場合は、自動転送は実行されません。

テキストは固定名 textTransferValue プロパティの Setter メソッドとバインドされます。
Setter メソッドが定義されない場合は、自動転送は実行されません。

要素の値は単一の引数を取る、要素のタグ名に接尾辞 "add" を不可したメソッドとバインドされます。
またデフォルトメソッドとして、固定名で単一の引数を取る、addElementTransferValue メソッドとバインドされます。
一般的な方針としては、要素のタグ名ではなく、型のみでバインドする場合は、デフォルトメソッドのみを定義します。
接尾辞を持つメソッドやデフォルトメソッドはオーバーロード可能で要素の値から推測的に格納可能なメソッドを検出して設定します。
接尾辞を持つメソッドか addElementTransferValue メソッドが定義されない場合は、自動転送は実行されません。

型の変換処理と変換ルールは TagPropertyTransfer の実装に依存します。
デフォルト実装では、各メソッドの引数型に対応付けられた変換処理を実行します。


メソッドの概要
 void begin()
          タグ解析開始の通知を受ける。
 void child(TagNode tagNode)
          子のタグの追加の通知を受ける。
 void end()
          タグ解析終了通知を受ける。
 void finish()
          ドキュメント解析処理プロセスを完了の通知を受ける。
 java.lang.String getId()
          タグの識別子を返却します。
 java.lang.String getName()
          タグの識別名を返却します。
 TagContext getTagContext()
          タグのコンテキスト情報を返却します。
 void initialize(TagContext tagContext)
          ドキュメント解析処理を開始する直前に初期化の通知を受ける。
 void text(TextNode textNode)
          テキストノードの格納の通知を受ける。
 

メソッドの詳細

getId

public java.lang.String getId()
タグの識別子を返却します。

戻り値:
タグの識別子

getName

public java.lang.String getName()
タグの識別名を返却します。
識別名はドキュメント内、同一階層内、階層下内で重複があり得ます。
識別名は定義上で、0個以上のデータを持つ名前コレクションとして認識されます。

戻り値:
タグの識別名

getTagContext

public TagContext getTagContext()
タグのコンテキスト情報を返却します。

戻り値:
タグのコンテキスト情報

initialize

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

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

begin

public void begin()
タグ解析開始の通知を受ける。 開始タグの解析終了直後に対応します。

例外:
GinkgoException - 構成情報例外

child

public void child(TagNode tagNode)
子のタグの追加の通知を受ける。 子タグの解析終了直後に対応します。

パラメータ:
tagNode - 子のタグ
例外:
GinkgoException - 構成情報例外

text

public void text(TextNode textNode)
テキストノードの格納の通知を受ける。 終了タグの解析終了直後に対応します。

パラメータ:
textNode - テキストノード
例外:
GinkgoException - 構成情報例外

end

public void end()
タグ解析終了通知を受ける。 終了タグの解析終了直後に対応します。

例外:
GinkgoException - 構成情報例外

finish

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

例外:
GinkgoException - 構成情報例外