jp.co.fujitsu.reffi.client.nexaweb.action
クラス AbstractAction

java.lang.Object
  上位を拡張 jp.co.fujitsu.reffi.client.nexaweb.action.AbstractAction
すべての実装されたインタフェース:
Action
直系の既知のサブクラス:
BaseAction, FlexibleAction

public abstract class AbstractAction
extends Object
implements Action

[概 要]

全アクションクラスの抽象基底アクションクラスです。

[詳 細]

アクションクラスとして動作する為の必要最低限機能と、 ウィンドウ操作やエレメント取得の為のAPIを提供します。

[備 考]

[環 境] JDK 6.0 Update 11

Copyright (c) 2008-2009 FUJITSU Japan All rights reserved.

作成者:
Project Reffi

コンストラクタの概要
AbstractAction()
           
 
メソッドの概要
 void addPermanent(Object key, Object value)
          [概 要] アプリ起動~終了まで存在するデータ保存領域にkey=valueの形式で値を追加します。
protected  void alertDialog(String title, String message)
          [概 要] 警告ダイアログ表示をします。
protected  void cascadeWindows(int x_gap, int y_gap)
          [概 要] 全window(dialog)を階段状に整列します。
protected  void cascadeWindows(Vector<Element> windows, int x_gap, int y_gap)
          [概 要] 全window(dialog)を階段状に整列します。
protected  void closeChildWindows()
          [概 要] 子ウィンドウエレメント群を削除します。
protected  void closeOwnWindow()
          [概 要] ソースエレメントが属するウィンドウエレメントを削除します。
protected  void closeSiblingWindows()
          [概 要] 兄弟エレメント群を削除します。
protected  Element createElement(String localName)
          [概 要] エレメントを生成します。
protected  com.nexaweb.plugin.data.datasource.ObjectDataSource createElementObjectDataSource(Element element)
          [概 要] Element固有のデータソースをデータコンテナに生成します.
protected  Vector<Element> getAllWindows()
          [概 要] 画面上(ui DOM上)の全ウィンドウレベルエレメントを返却します。
protected  Vector<Element> getChildWindows()
          [概 要] ソースエレメントが属するウィンドウの子ウィンドウエレメント群を返却します。
 Log getClientLogger()
          [概 要] クライアント側のログ発行オブジェクトを取得します。
 BaseController getController()
          [概 要] コントローラオブジェクトを取得します。
protected  Element getElementById(String id)
          [概 要] ui Documentから、引数idをid属性値として持つエレメントを返却します。
protected  Element getElementByNameFromOwnWindow(String name)
          [概 要] このActionを発生させたコンポーネントが属するウィンドウレベルコンポーネントから、 引数nameをname属性値として持つエレメントを取得します。
protected  Element getElementByNameFromWindow(Element window, String name)
          [概 要] 引数windowで指定されたウィンドウレベルコンポーネントから、 引数nameをname属性値として持つエレメントを取得します。
protected  com.nexaweb.plugin.data.datasource.ObjectDataSource getElementObjectDataSource(Element element)
          [概 要] Element固有のデータソースを取得します.
protected  ElementValues getElementValueByNameFromOwnWindow(String name)
          [概 要] 引数nameをname属性値として持つエレメントの値を取得します。
protected  ElementValues getElementValueByNameFromWindow(Element window, String name)
          [概 要] 引数nameをname属性値として持つエレメントの値を取得します。
protected  com.nexaweb.plugin.data.datasource.ObjectDataSource getObjectDataSourceById(String id)
          [概 要] xal内で定義されたObjectDataSourceを取得するメソッドです。
protected  com.nexaweb.plugin.data.datasource.ObjectDataSource getObjectDataSourceByName(String name)
          [概 要] xal内で定義されたObjectDataSourceを取得するメソッドです。
protected  Element getOwnWindow()
          [概 要] Actionを発生させたソースエレメントが属する、ウィンドウレベルエレメントを返却します。
protected  String getOwnWindowCommunicateId()
          [概 要] 自ウィンドウのcommunicateIdを返却します。
 ParameterMapping getParameterMapping()
          [概 要] MVC各レイヤを伝播するパラメータオブジェクトを取得します。
protected  Element getParentWindow()
          [概 要] ソースエレメントが属するウィンドウの親ウィンドウエレメントを返却します。
 Map<Object,Object> getPermanent()
          [概 要] アプリ起動~終了まで存在するデータ保存領域を取得します。
 Object getPermanent(Object key)
          [概 要] アプリ起動~終了まで存在するデータ保存領域から引数keyに対応する値を取得します。
protected  Object getSerializedHttpResponseContent(HttpResponse response)
          [概 要] HttpResponseオブジェクトからシリアライズオブジェクトを取り出すメソッドです。
protected  Vector<Element> getSiblingWindows()
          [概 要] ソースエレメントが属するウィンドウの兄弟ウィンドウエレメント群を返却します。
protected  List<String> getSubscribingTopicNames()
          [概 要] 現在購読中のトピック名リストを返却します。
protected  Rectangle getWindowRect(Element window)
          [概 要] 引数指定されたwindow(dialog)の矩形サイズを返却します。
protected  Vector<Element> getWindowsByCommunicateId(String communicateId)
          [概 要] ui DOMの中から引数communicateIdをcommunicateId属性として持つ、 ウィンドウレベルエレメントを返却します。
protected  boolean isSubscribing(String topicName)
          [概 要] 引数で指定されたトピックを現在購読中かどうか調べます。
protected  void moveToWindowBottomPosition(Element base, Element window)
          [概 要] ウィンドウ位置を対象ウィンドウの位置(下)まで移動させます。
protected  void moveToWindowPosition(Element base, Element window)
          [概 要] ウィンドウ位置を対象ウィンドウの位置まで移動させます。
protected  void moveToWindowPosition(Element base, Element window, int x_gap, int y_gap)
          [概 要] ウィンドウ位置を対象ウィンドウの位置まで移動させます。
protected  void moveToWindowRightPosition(Element base, Element window)
          [概 要] ウィンドウ位置を対象ウィンドウの位置(右)まで移動させます。
protected  void removeElementObjectDataSource(Element element)
          [概 要] Element固有のデータソースをデータコンテナーからRemoveします.
 void removePermanent(Object key)
          [概 要] アプリ起動~終了まで存在するデータ保存領域から引数keyに対応する値を削除します。
 void renderResponseToUI(HttpResponse response)
          [概 要] HttpResponseを画面にレンダリングするメソッドです。
protected  boolean returnElementStatusBeforeError(Element element)
          [概 要] エレメントの背景色とチップをバリデーションエラー発生前の状態に戻します。
 ParameterMapping run(ParameterMapping parameterMapping)
          [概 要] コントローラにコールされるアクションの主幹メソッドです。
 void setController(BaseController controller)
          [概 要] コントローラオブジェクトを設定します。
 void setParameterMapping(ParameterMapping parameterMapping)
          [概 要] MVC各レイヤを伝播するパラメータオブジェクトを設定します。
protected  void tileWindows()
          [概 要] 全window(dialog)をタイル状に整列します。
protected  void tileWindows(Vector<Element> windows)
          [概 要] 引数で指定されたwindow(dialog)群をタイル状に整列します。
protected  ValidateErrors validate(List<CustomValidator> validators)
          [概 要] バリデーションを行うメソッドです。
 void validationFault(ValidateErrors errors)
          [概 要] バリデーションエラーが発生した時にコールされるメソッドです。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

AbstractAction

public AbstractAction()
メソッドの詳細

getParameterMapping

public ParameterMapping getParameterMapping()

[概 要]

MVC各レイヤを伝播するパラメータオブジェクトを取得します。

[詳 細]

parameterMappingフィールドを返却します。

[備 考]

戻り値:
MVC各レイヤを伝播するパラメータオブジェクト

setParameterMapping

public void setParameterMapping(ParameterMapping parameterMapping)

[概 要]

MVC各レイヤを伝播するパラメータオブジェクトを設定します。

[詳 細]

parameterMappingフィールドを引数parameterMappingで設定します。

[備 考]

パラメータ:
parameterMapping -

getController

public BaseController getController()

[概 要]

コントローラオブジェクトを取得します。

[詳 細]

controllerフィールドを返却します。

[備 考]

戻り値:
コントローラオブジェクト

setController

public void setController(BaseController controller)

[概 要]

コントローラオブジェクトを設定します。

[詳 細]

controllerフィールドを引数controllerで設定します。

[備 考]

パラメータ:
controller - コントローラオブジェクト

run

public ParameterMapping run(ParameterMapping parameterMapping)
                     throws Exception

[概 要]

コントローラにコールされるアクションの主幹メソッドです。

[詳 細]

引数parameterMappingをフィールドに保存し、このアクションを起こした エレメントが所属するウィンドウレベルエレメントをparameterMappingに設定します。

[備 考]

このメソッドをオーバーライドして新たなアクション基底クラスを作成する場合、 super.run(parameterMapping);を記述する必要が有ります。

定義:
インタフェース Action 内の run
パラメータ:
parameterMapping - MVC各レイヤを伝播するパラメータオブジェクト
戻り値:
パラメータマッピング
例外:
Exception - アクション実行例外

validate

protected ValidateErrors validate(List<CustomValidator> validators)
                           throws Exception

[概 要]

バリデーションを行うメソッドです。

[詳 細]

validatorsメソッドで登録されたValidatorの数分、バリデーションを行います。 バリデーションエラーが発生した場合、エラー情報がValidateErrorオブジェクトに設定され、 戻り値であるValidateErrorsオブジェクトに追加されます。

[備 考]

ValidateErrors返却後、BaseAction#execute(ClientEvent, ParameterMapping)validationFault(ValidateErrors)メソッドをテンプレートコールします。
ValidateErrorをハンドリングする場合は、validationFaultメソッドをオーバーライドして下さい。

パラメータ:
validators - validatorsメソッドで設定されたバリデータオブジェクト群
戻り値:
バリデーションエラー保持リストオブジェクト
例外:
Exception

validationFault

public void validationFault(ValidateErrors errors)

[概 要]

バリデーションエラーが発生した時にコールされるメソッドです。

[詳 細]

一つでもバリデーションエラーが発生した場合に呼び出されます。
ClientConfigオブジェクトの設定によってデフォルト処理が異なります。

【ClientConfig#isEnableValidationFaultProcessing()がtrue】
デフォルトエラーハンドリング処理を行います。

【ClientConfig#isComponentColorAndTipChangeOnValidationFault()がtrue】
・エラーコンポーネントの背景色をcomponent.color.on.validation.faultの値で変更します。
・エラーコンポーネントのツールチップをエラーメッセージに変更します。

【ClientConfig#isDisplayDialogOnValidationFault()がtrue】
全エラーメッセージをダイアログ表示します。

[備 考]

デフォルトエラーハンドリング処理を行わない場合、 ClientConfig#setEnableValidationFaultProcessing(false)を実行して下さい。

パラメータ:
errors - validate(List)で生成されたエラーリストオブジェクト
関連項目:
BaseController#initialize()

returnElementStatusBeforeError

protected boolean returnElementStatusBeforeError(Element element)

[概 要]

エレメントの背景色とチップをバリデーションエラー発生前の状態に戻します。

[詳 細]

BaseControllerに保存されているElementSnapshotオブジェクトから 引数で指定されたエレメントのエラー前状態エレメントを取得します。 エラー前状態エレメントからbackgroundColor、tooltip属性を取り出し、現在の エレメントに属性セットします。 ElementSnapshotオブジェクトに引数指定されたエレメントが存在しなかった場合は、 処理を行わずにfalseを返却します。

[備 考]

パラメータ:
element - 状態を元に戻すエレメント
戻り値:
true : 状態復帰

getElementByNameFromOwnWindow

protected Element getElementByNameFromOwnWindow(String name)

[概 要]

このActionを発生させたコンポーネントが属するウィンドウレベルコンポーネントから、 引数nameをname属性値として持つエレメントを取得します。

[詳 細]

自ウィンドウエレメントを求め、getElementByNameFromWindow(Element, String) メソッドを呼び出します。
引数nameをname属性値として持つエレメントが自ウィンドウ内に無かった場合はnullを返却します。

[備 考]

同じxal、同じname属性のエレメントが複数有る場合でも、 このメソッドを使用することでユニークに取得出来ます。

パラメータ:
name - 取得するエレメントのname属性値
戻り値:
自ウィンドウ内で引数nameをnameとして持つエレメント

getElementByNameFromWindow

protected Element getElementByNameFromWindow(Element window,
                                             String name)

[概 要]

引数windowで指定されたウィンドウレベルコンポーネントから、 引数nameをname属性値として持つエレメントを取得します。

[詳 細]

第一引数エレメントの子孫エレメントの中から、引数nameをname属性として持つエレメント を返却します。

[備 考]

Aウィンドウで発生したActionの中からBウィンドウのエレメント値を参照する場合等に使用します。

パラメータ:
window - 取得したいエレメントが存在するウィンドウレベルエレメント
name - 取得するエレメントのname属性値
戻り値:
他ウィンドウ内で引数nameをnameとして持つエレメント

getOwnWindow

protected Element getOwnWindow()

[概 要]

Actionを発生させたソースエレメントが属する、ウィンドウレベルエレメントを返却します。

[詳 細]

このアクションを発生させたエレメントを取得し、
  1. rootPane
  2. window
  3. dialog
  4. messageDialog
の何れかに該当するまで、DOM構造的な親を辿ります。

[備 考]

上記に該当したエレメントが、このアクションを発生させたエレメントが属する ウィンドウであると見做されます。

パラメータ:
element -
戻り値:
Actionを発生させたソースエレメントが所属するウィンドウレベルエレメント

closeOwnWindow

protected void closeOwnWindow()

[概 要]

ソースエレメントが属するウィンドウエレメントを削除します。

[詳 細]

getOwnWindowメソッドで返却されたウィンドウエレメントをui DOMから削除します。 但し、ウィンドウエレメントが「rootPane」であった場合は処理しません。

[備 考]


getParentWindow

protected Element getParentWindow()

[概 要]

ソースエレメントが属するウィンドウの親ウィンドウエレメントを返却します。

[詳 細]

getOwnWindowメソッドが返却するウィンドウレベルエレメントから「parentId」 属性値を取得、その属性値を「id」として持つエレメントを返却します。

[備 考]

「親」はDOM構造的な親では無く、「ウィンドウの発生元」を意味します。

戻り値:
ウィンドウ発生元ウィンドウエレメント

getChildWindows

protected Vector<Element> getChildWindows()

[概 要]

ソースエレメントが属するウィンドウの子ウィンドウエレメント群を返却します。

[詳 細]

getOwnWindowメソッドが返却するウィンドウレベルエレメントから「id」 属性値を取得、その属性値を「parentId」として持つエレメント群を返却します。

[備 考]

「子」はDOM構造的な子では無く、「自ウィンドウから発生したウィンドウ」を意味します。

戻り値:
ウィンドウ発生先ウィンドウ群

closeChildWindows

protected void closeChildWindows()

[概 要]

子ウィンドウエレメント群を削除します。

[詳 細]

getChildWindowsメソッドで返却されたウィンドウレベルエレメント群を、 ui DOMからremoveします。結果、子ウィンドウ群は画面から削除されます。

[備 考]


getSiblingWindows

protected Vector<Element> getSiblingWindows()

[概 要]

ソースエレメントが属するウィンドウの兄弟ウィンドウエレメント群を返却します。

[詳 細]

getOwnWindowメソッドが返却するウィンドウレベルエレメントから「parentId」 属性値を取得、その属性値を同じく「parentId」として持つエレメント群を返却します。

[備 考]

「兄弟」はDOM構造的な兄弟では無く、「同じウィンドウから発生したウィンドウ」を意味します。

戻り値:
発生元が同じウィンドウ群

closeSiblingWindows

protected void closeSiblingWindows()

[概 要]

兄弟エレメント群を削除します。

[詳 細]

getSiblingWindowsメソッドで返却されたウィンドウレベルエレメント群を、 ui DOMからremoveします。結果、兄弟ウィンドウ群は画面から削除されます。

[備 考]


getAllWindows

protected Vector<Element> getAllWindows()

[概 要]

画面上(ui DOM上)の全ウィンドウレベルエレメントを返却します。

[詳 細]

ui Dom上から全window、dialogエレメントを取得して返却します。

[備 考]

戻り値:

getWindowsByCommunicateId

protected Vector<Element> getWindowsByCommunicateId(String communicateId)

[概 要]

ui DOMの中から引数communicateIdをcommunicateId属性として持つ、 ウィンドウレベルエレメントを返却します。

[詳 細]

[備 考]

communicateIdに関しては XalReturnPossibilityModel.addIdentifierToWindows(com.nexaweb.xml.Document) を参照して下さい。

パラメータ:
communicateId - 通信識別ID
戻り値:

getOwnWindowCommunicateId

protected String getOwnWindowCommunicateId()

[概 要]

自ウィンドウのcommunicateIdを返却します。

[詳 細]

getOwnWindow()メソッドでこのアクションを起動したコンポーネントが属する ウィンドウレベルエレメントを求めた後、そのエレメントからcommunicateId属性値を 取得、返却します。

[備 考]

communicateIdに関しては XalReturnPossibilityModel.addIdentifierToWindows(com.nexaweb.xml.Document) を参照して下さい。

戻り値:

moveToWindowPosition

protected void moveToWindowPosition(Element base,
                                    Element window)

[概 要]

ウィンドウ位置を対象ウィンドウの位置まで移動させます。

[詳 細]

moveToWindowPositionオーバーロードメソッドを、x_gap=0、y_gap=0でコールします。

[備 考]

移動後のウィンドウのx、y属性値は、baseエレメントのx、y属性値と同値です。

パラメータ:
base - 移動先ウィンドウ
window - 移動するウィンドウ

moveToWindowPosition

protected void moveToWindowPosition(Element base,
                                    Element window,
                                    int x_gap,
                                    int y_gap)

[概 要]

ウィンドウ位置を対象ウィンドウの位置まで移動させます。

[詳 細]

baseとなるウィンドウのx座標、y座標にx_gap、y_gapをプラスした座標にwindowを移動します。

[備 考]

パラメータ:
base - 移動先ウィンドウ
window - 移動するウィンドウ
x_gap - 移動先ウィンドウとのx座標差異
y_gap - 移動先ウィンドウとのy座標差異

moveToWindowRightPosition

protected void moveToWindowRightPosition(Element base,
                                         Element window)

[概 要]

ウィンドウ位置を対象ウィンドウの位置(右)まで移動させます。

[詳 細]

baseとなるウィンドウの右隣座標にwindowを移動します。

[備 考]

パラメータ:
base - 移動先ウィンドウ
window - 移動するウィンドウ

moveToWindowBottomPosition

protected void moveToWindowBottomPosition(Element base,
                                          Element window)

[概 要]

ウィンドウ位置を対象ウィンドウの位置(下)まで移動させます。

[詳 細]

baseとなるウィンドウの下隣座標にwindowを移動します。

[備 考]

パラメータ:
base - 移動先ウィンドウ
window - 移動するウィンドウ

getWindowRect

protected Rectangle getWindowRect(Element window)

[概 要]

引数指定されたwindow(dialog)の矩形サイズを返却します。

[詳 細]

引数指定されたウィンドウエレメントの、
  1. x
  2. y
  3. width
  4. height
属性値を取り出し、「px」をトリムしてRectangleに格納、返却します。

[備 考]

パラメータ:
window - 矩形サイズを調べるウィンドウエレメント
戻り値:
引数windowの矩形サイズ

cascadeWindows

protected void cascadeWindows(int x_gap,
                              int y_gap)

[概 要]

全window(dialog)を階段状に整列します。

[詳 細]

ui Document上の全てのウィンドウ、引数x_gap、y_gapを元に、 cascadeWindowsオーバーロードメソッドをコールします。

[備 考]

x_gap、y_gapには負数も指定出来ます。

パラメータ:
x_gap - 1ウィンドウ毎のx座標増加分量
y_gap - 1ウィンドウ毎のy座標増加分量

cascadeWindows

protected void cascadeWindows(Vector<Element> windows,
                              int x_gap,
                              int y_gap)

[概 要]

全window(dialog)を階段状に整列します。

[詳 細]

引数windowsに対して、x、y座標(0始まり)を設定します。
Vector内の設定対象ウィンドウが変わる度、x_gap、y_gapの値を設定値にプラスします。

[備 考]

x_gap、y_gapには負数も指定出来ます。

パラメータ:
windows - 階段状に整列させる、対象のウィンドウ群
x_gap - 1ウィンドウ毎のx座標増加分量
y_gap - 1ウィンドウ毎のy座標増加分量

tileWindows

protected void tileWindows()

[概 要]

全window(dialog)をタイル状に整列します。

[詳 細]

ui Document上の全てのウィンドウを元にtileWindowsオーバーロードメソッドを コールします。

[備 考]


tileWindows

protected void tileWindows(Vector<Element> windows)

[概 要]

引数で指定されたwindow(dialog)群をタイル状に整列します。

[詳 細]

引数指定されたウィンドウ数の平方根を元に、縦、横のウィンドウ数の粗値を求めた後、 平方根の少数値を判断して粗値を補正します。
画面サイズを求め、縦、横ウィンドウで除算した結果を一ウィンドウのサイズにします。
算出された縦横ウィンドウ表示数、ウィンドウサイズを元に引数windowsのx、y、width、height 属性値を設定します。

[備 考]

パラメータ:
windows - タイル状に整列させる対象のウィンドウ

createElement

protected Element createElement(String localName)

[概 要]

エレメントを生成します。

[詳 細]

名前空間が「"http://openxal.org/ui/java"」であるNexawebエレメントを生成します。
生成するエレメント種がウィンドウレベル定義されているものである場合 (ClientConfig.getWindowLevelElementDefinition()に含まれるものである場合)、 「parentId」属性、「communicateId」属性が自動的に付与されます。

[備 考]

parentId、communicateIdに関しては XalReturnPossibilityModel.addIdentifierToWindows(com.nexaweb.xml.Document) を参照して下さい。

パラメータ:
localName - 生成するエレメント名
戻り値:
生成されたエレメントオブジェクト

getElementById

protected Element getElementById(String id)

[概 要]

ui Documentから、引数idをid属性値として持つエレメントを返却します。

[詳 細]

Nexawebクライアントセッションからui Documentを取得し、 UiDocument.getElementById(String)をコールします。

[備 考]

XML idが重複するとParserはXMLをパースすることが出来ません。
idをエレメント取得ソースとすると、プログラム内から任意に識別可能なidを振る 必要が有りますが、同じxalを複数読み込むようなアプリケーションの場合、 id conflictを回避する手法が必要になります。

(Reffiフレームワークではidを任意に振らず(Nexawebに付与を委譲)、name属性値で 取得する方法を推奨しています。)

パラメータ:
id - 取得するエレメントID
戻り値:
引数idをid属性値として持つエレメント

getElementValueByNameFromOwnWindow

protected ElementValues getElementValueByNameFromOwnWindow(String name)
                                                    throws Exception

[概 要]

引数nameをname属性値として持つエレメントの値を取得します。

[詳 細]

自ウィンドウレベルエレメント(getOwnWindow())から、 引数nameをname属性値として持つエレメントを取得、エレメントの保持する値を 汎用的な値格納オブジェクトに格納して返却します。

[備 考]

パラメータ:
name - 値を取得するエレメントのname属性値
戻り値:
エレメント値の汎用格納オブジェクト
例外:
Exception

getElementValueByNameFromWindow

protected ElementValues getElementValueByNameFromWindow(Element window,
                                                        String name)
                                                 throws Exception

[概 要]

引数nameをname属性値として持つエレメントの値を取得します。

[詳 細]

引数windowで指定されたウィンドウレベルエレメントから、 引数nameをname属性値として持つエレメントを取得、エレメントの保持する値を 汎用的な値格納オブジェクトに格納して返却します。

[備 考]

パラメータ:
window - 引数nameをname属性値として持つエレメントが存在するウィンドウレベルエレメント
name - 値を取得するエレメントのname属性値
戻り値:
エレメント値の汎用格納オブジェクト
例外:
Exception

getSerializedHttpResponseContent

protected Object getSerializedHttpResponseContent(HttpResponse response)
                                           throws IOException,
                                                  ClassNotFoundException

[概 要]

HttpResponseオブジェクトからシリアライズオブジェクトを取り出すメソッドです。

[詳 細]

HttpResponse#getContent()の返却値を入力ストリームを使用してオブジェクト化します。

[備 考]

パラメータ:
response - HTTP応答オブジェクト
戻り値:
HTTP応答オブジェクトから取り出されたシリアライズオブジェクト
例外:
IOException
ClassNotFoundException

createElementObjectDataSource

protected com.nexaweb.plugin.data.datasource.ObjectDataSource createElementObjectDataSource(Element element)
                                                                                     throws Exception

[概 要] Element固有のデータソースをデータコンテナに生成します.

[詳 細]

[備 考]

パラメータ:
element - 対象エレメント
戻り値:
オブジェクトデータソース
例外:
Exception

getElementObjectDataSource

protected com.nexaweb.plugin.data.datasource.ObjectDataSource getElementObjectDataSource(Element element)

[概 要] Element固有のデータソースを取得します.

[詳 細]

[備 考]

パラメータ:
element - 対象エレメント
戻り値:
オブジェクトデータソース

removeElementObjectDataSource

protected void removeElementObjectDataSource(Element element)

[概 要] Element固有のデータソースをデータコンテナーからRemoveします.

[詳 細]

[備 考]

パラメータ:
element - 対象エレメント

getObjectDataSourceById

protected com.nexaweb.plugin.data.datasource.ObjectDataSource getObjectDataSourceById(String id)

[概 要]

xal内で定義されたObjectDataSourceを取得するメソッドです。

[詳 細]

[備 考]

パラメータ:
id -
戻り値:

getObjectDataSourceByName

protected com.nexaweb.plugin.data.datasource.ObjectDataSource getObjectDataSourceByName(String name)

[概 要]

xal内で定義されたObjectDataSourceを取得するメソッドです。

[詳 細]

[備 考]

パラメータ:
name -
戻り値:

renderResponseToUI

public void renderResponseToUI(HttpResponse response)
                        throws ParserException

[概 要]

HttpResponseを画面にレンダリングするメソッドです。

[詳 細]

[備 考]

HttpResponseのコンテントはxalである必要が有ります。

パラメータ:
response - リモートサーバから取得したHttpResponseオブジェクト
例外:
ParserException

getPermanent

public Map<Object,Object> getPermanent()

[概 要]

アプリ起動~終了まで存在するデータ保存領域を取得します。

[詳 細]

コントローラに保持されているデータ保持領域Mapインスタンスを取得します。

[備 考]

このデータ保持領域は、コントローラの初期化時に生成され、 アプリケーション終了時まで保持されます。

戻り値:
アプリ起動~終了まで存在するデータ保存領域

getPermanent

public Object getPermanent(Object key)

[概 要]

アプリ起動~終了まで存在するデータ保存領域から引数keyに対応する値を取得します。

[詳 細]

コントローラに保持されているデータ保持領域Mapから、 引数keyをキーにして値を取得、返却します。

[備 考]

このデータ保持領域は、コントローラの初期化時に生成され、 アプリケーション終了時まで保持されます。

パラメータ:
key - データ保存領域Map内のキー
戻り値:
引数keyに対する値

addPermanent

public void addPermanent(Object key,
                         Object value)

[概 要]

アプリ起動~終了まで存在するデータ保存領域にkey=valueの形式で値を追加します。

[詳 細]

コントローラに保持されているデータ保持領域Mapを取得、 引数keyをキーにして引数valueを値として追加します。

[備 考]

このデータ保持領域は、コントローラの初期化時に生成され、 アプリケーション終了時まで保持されます。

パラメータ:
key - データ保存領域Map内のキー
value - 引数keyに対する値

removePermanent

public void removePermanent(Object key)

[概 要]

アプリ起動~終了まで存在するデータ保存領域から引数keyに対応する値を削除します。

[詳 細]

コントローラに保持されているデータ保持領域Mapから、 引数keyをキーにして値を削除します。

[備 考]

このデータ保持領域は、コントローラの初期化時に生成され、 アプリケーション終了時まで保持されます。

パラメータ:
key - データ保存領域Map内のキー

getSubscribingTopicNames

protected List<String> getSubscribingTopicNames()

[概 要]

現在購読中のトピック名リストを返却します。

[詳 細]

トピック購読を管理しているSubscriberManagerシングルトンインスタンスから、 getSubscribingTopicNames()メソッドの戻り値を受け取り、返却します。

[備 考]

SubscribeManager.getSubscribingTopicNames()

戻り値:
購読中のトピック名リスト

isSubscribing

protected boolean isSubscribing(String topicName)

[概 要]

引数で指定されたトピックを現在購読中かどうか調べます。

[詳 細]

トピック購読を管理しているSubscriberManagerシングルトンインスタンスから、 isSubscribing(topicName)メソッドの戻り値を受け取り、返却します。

[備 考]

SubscribeManager.isSubscribing(String)

パラメータ:
topicName - トピック名
戻り値:
true : 購読中、 false : 非購読中

getClientLogger

public Log getClientLogger()

[概 要]

クライアント側のログ発行オブジェクトを取得します。

[詳 細]

コントローラが保持するクライアントログ発行オブジェクトを取得して返却します。

[備 考]

以下のように使用します。
        getClientLogger().log(Log.DEBUG, "データ登録処理終了");
 
ログ発行イベントをハンドルするLogConsumerインスタンスの種類は、 ClientConfigオブジェクト内の以下の設定によって変更可能です。

【ClientConfig#isEnableLogConsumer()がtrue】
ClientConfig#getLogConsumerClass()で設定されているLogConsumer実装クラスがログイベントをハンドリングします。

【ClientConfig#isEnableLogConsumer()がfalse】
ClientConfig#getLogConsumerClass()は判断されず、標準出力に出力されます。

デフォルトではClientConfig#isEnableLogConsumer()はfalseです。

戻り値:
クライアントログ発行オブジェクト

alertDialog

protected void alertDialog(String title,
                           String message)

[概 要]

警告ダイアログ表示をします。

[詳 細]

[備 考]

パラメータ:
title - ダイアログタイトル
message - メッセージ


Copyright(C) Fujitsu All Rights Reserved.