パッケージ org.springframework.webflow.engine.model.builder.xml

クラス XmlFlowModelBuilder

java.lang.ObjectSE
org.springframework.webflow.engine.model.builder.xml.XmlFlowModelBuilder
実装されたすべてのインターフェース:
FlowModelBuilder
public class XmlFlowModelBuilder extends ObjectSE implements FlowModelBuilder
XML ベースのフロー定義リソースからフローモデルを構築します。
作成者:
Keith Donald, Scott Andrews, Rossen Stoyanchev

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    XmlFlowModelBuilder(org.springframework.core.io.Resource resource)
    指定されたリソースの場所にある XML ドキュメントを解析し、提供されたロケーターを使用して親フローモデルにアクセスする新しい XML フローモデルビルダーを作成します。
    XmlFlowModelBuilder(org.springframework.core.io.Resource resource, FlowModelLocator modelLocator)
    指定されたリソースの場所にある XML ドキュメントを解析し、提供されたロケーターを使用して親フローモデルにアクセスする新しい XML フローモデルビルダーを作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    build()
    フローの開始時にフローによって初期化される変数を構築します。
    void
    dispose()
    ビルダーをシャットダウンし、保持しているリソースを解放します。
    protected DocumentSE
    getDocument()
    XML ファイルから解析された DOM ドキュメントを返します。
    protected ElementSE
    getDocumentElement()
    ルートドキュメント要素を返します。
    FlowModel
    getFlowModel()
    完全に構築されたフローモデルを取得します。
    org.springframework.core.io.Resource
    getFlowModelResource()
    このフローモデルを構築するためにアクセスされる、基礎となるフローモデルリソースを取得します。
    boolean
    hasFlowModelResourceChanged()
    FlowModelBuilder.init() への最後の呼び出し以降に基礎となるフローモデルリソースが変更された場合は true を返します。
    void
    init()
    このビルダーを初期化します。
    void
    setDocumentLoader(DocumentLoader documentLoader)
    XML ベースのフロー定義ドキュメントをロードするローダーを設定します。
    StringSE
    toString()

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE

  • コンストラクターの詳細

    • XmlFlowModelBuilder

      public XmlFlowModelBuilder(org.springframework.core.io.Resource resource)
      指定されたリソースの場所にある XML ドキュメントを解析し、提供されたロケーターを使用して親フローモデルにアクセスする新しい XML フローモデルビルダーを作成します。
      パラメーター:
      resource - XML フロー定義へのパス (必須)

    • XmlFlowModelBuilder

      public XmlFlowModelBuilder(org.springframework.core.io.Resource resource, FlowModelLocator modelLocator)
      指定されたリソースの場所にある XML ドキュメントを解析し、提供されたロケーターを使用して親フローモデルにアクセスする新しい XML フローモデルビルダーを作成します。
      パラメーター:
      resource - XML フロー定義へのパス (必須)
      modelLocator - フロー継承をサポートするための親フローモデルのロケータ

  • メソッドの詳細

    • setDocumentLoader

      public void setDocumentLoader(DocumentLoader documentLoader)
      XML ベースのフロー定義ドキュメントをロードするローダーを設定します。オプション、デフォルトは DefaultDocumentLoader です。
      パラメーター:
      documentLoader - ドキュメントローダー

    • init

      public void init() throws FlowModelBuilderException
      インターフェースからコピーされた説明: FlowModelBuilder
      このビルダーを初期化します。これにより、ビルダーは、たとえばフロー定義を表す外部化されたリソースへのストリームを開くことができます。
      次で指定:
      インターフェース FlowModelBuilder の init 
      例外:
      FlowModelBuilderException - フローの構築中に例外が発生しました

    • build

      public void build() throws FlowModelBuilderException
      インターフェースからコピーされた説明: FlowModelBuilder
      フローの開始時にフローによって初期化される変数を構築します。
      次で指定:
      インターフェース FlowModelBuilder の build 
      例外:
      FlowModelBuilderException - フローの構築中に例外が発生しました

    • getFlowModel

      public FlowModel getFlowModel() throws FlowModelBuilderException
      インターフェースからコピーされた説明: FlowModelBuilder
      完全に構築されたフローモデルを取得します。アセンブリ後にビルダーのアセンブラー (ディレクター) によって呼び出されます。このメソッドがアセンブラーによって呼び出される場合、フロー構築が完了し、返されたフローモデルが使用できる状態になっていることが予想されます。
      次で指定:
      インターフェース FlowModelBuilder の getFlowModel 
      例外:
      FlowModelBuilderException - このフローの構築中に例外が発生しました

    • dispose

      public void dispose() throws FlowModelBuilderException
      インターフェースからコピーされた説明: FlowModelBuilder
      ビルダーをシャットダウンし、保持しているリソースを解放します。新しいフロー構築プロセスは、FlowModelBuilder.init() メソッドの別の呼び出しから開始する必要があります。
      次で指定:
      インターフェース FlowModelBuilder の dispose 
      例外:
      FlowModelBuilderException - このフローを破棄中に例外が発生しました

    • getFlowModelResource

      public org.springframework.core.io.Resource getFlowModelResource()
      インターフェースからコピーされた説明: FlowModelBuilder
      このフローモデルを構築するためにアクセスされた、基礎となるフローモデルリソースを取得します。このビルダーがリソースからフローモデルを構築しない場合は null を返します。
      次で指定:
      インターフェース FlowModelBuilder の getFlowModelResource 
      戻り値:
      フローモデルリソース

    • hasFlowModelResourceChanged

      public boolean hasFlowModelResourceChanged()
      インターフェースからコピーされた説明: FlowModelBuilder
      FlowModelBuilder.init() への最後の呼び出し以降に基礎となるフローモデルリソースが変更された場合は true を返します。フローモデルがリソースから構築されていない場合は常に false を返します。
      次で指定:
      インターフェース FlowModelBuilder の hasFlowModelResourceChanged 
      戻り値:
      フローモデルを支えるリソースが変更された場合は true

    • getDocument

      protected DocumentSE getDocument()
      XML ファイルから解析された DOM ドキュメントを返します。

    • getDocumentElement

      protected ElementSE getDocumentElement()
      ルートドキュメント要素を返します。

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString