jp.co.fujitsu.reffi.client.swing.controller
クラス ParameterMapping

java.lang.Object
  jp.co.fujitsu.reffi.client.swing.controller.ParameterMapping

public class ParameterMapping
extends java.lang.Object

[概 要]

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

[詳 細]

JVMから提供されるイベント情報、フレームワークが動作する為の情報、ビジネスロジックから 参照が必要な情報が格納されます。
イベント発生時にコントローラによってインスタンス生成され、 アクション→コントローラ→モデル→コントローラ→アクション→コントローラ
と伝播して、イベントハンドリングが終了した後に破棄されます。

アクションの中で発生したイベント情報を取得したい場合には、

 EventObject evt = parameterMapping.getEventObject();
 

等で取得することが出来ます。

又、put(Object, Object)を使用することで、 ビジネスロジック固有のパラメータを格納することが出来ます。
MVCの各フックポイントでこのクラスの同一インスタンスを参照することで、 「アクションレイヤで設定したパラメータをモデルレイヤで参照する」 といった処理を、広いスコープの変数を用意することなく実装出来ます。

[備 考]

Reffiによって自動的にset系メソッドがコールされ、情報が設定されます。

[環 境] JDK 6.0 Update 11

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

作成者:

Project Reffi

フィールドの概要

static java.lang.String	ACTION_CLASS_NAME 具象イベントハンドラ名マッピングのキー定数です。
static java.lang.String	ACTION_INSTANCE 実行されるアクションのインスタンスを示すキー定数です。
static java.lang.String	ALLOW_INTERUPTED_EXCEPTION_ON_SYNC_MODEL モデル同期実行時に発生したInterruptedExceptionをエラーと見做すかどうかのフラグを表すキー定数です。
static java.lang.String	EVENT_LISTENER イベントリスナプロキシインスタンスのキー定数です。
static java.lang.String	EVENT_LISTENER_TYPE イベントリスナの型を示すキー定数です。
static java.lang.String	EVENT_OBJECT Swingクライアントイベントマッピングのキー定数です。
static java.lang.String	EVENT_SOURCE_OBJECT イベントを起こしたコンポーネントマッピングのキー定数です。
static java.lang.String	EVENT_SOURCE_OBJECT_PARENT イベントを起こしたコンポーネントの親コンポーネントを示すキー定数です。
static java.lang.String	EVENT_TYPE イベントリスナプロキシがハンドリングした、イベントリスナのハンドラメソッド名を示すキー定数です。
static java.lang.String	MODEL_CLASSES コントローラによって実行されるモデルクラス群のキー定数です。
static java.lang.String	MODEL_FINISHED_NUM モデルの終了数を示す定数です。
static java.lang.String	MODEL_RESERVED_NUM モデルの登録数を示す定数です。
static java.lang.String	RUN_MODELS_AND_NO_WAIT モデル連続実行時、一モデルの終了を待つかどうかのフラグを示すキー定数です。
static java.lang.String	VALIDATORS 実行されるバリデータ群のキー定数です。
static java.lang.String	WAIT_MODELS_DONE イベントを発生させたエレメントが所属するウィンドウレベルエレメントを示すキー定数です。

コンストラクタの概要

ParameterMapping()
[概 要] デフォルトコンストラクタです。

メソッドの概要

ParameterMapping	clone() [概 要] このクラスオブジェクトの複製を返却します。
java.lang.Object	get(java.lang.Object key) [概 要] クライアントMVCレイヤ内で追加されたパラメータを取得します。
Action	getActionInstance() [概 要] アクションインスタンスを返却します。
java.util.EventListener	getEventListener() [概 要] イベントリスナプロキシインスタンスを返却します。
java.lang.Class<? extends java.util.EventListener>	getEventListenerType() [概 要] イベントリスナの型を返却します。
java.util.EventObject	getEventObject() [概 要] Swingコンポーネントが発行したイベントオブジェクトを返却します。
java.lang.Object	getEventSource() [概 要] イベントを起こしたオブジェクトを返却します。
java.lang.Object	getEventSourceParent() [概 要] イベントを起こしたオブジェクトの親を返却します。
java.lang.String	getEventType() [概 要] イベントハンドラメソッド名を返却します。
java.util.List<java.lang.Class<? extends Model>>	getModelClasses() [概 要] モデルクラス一覧を取得します。
int	getModelFinishedNum() [概 要] 終了モデル数を返却します。
int	getModelReservedNum() [概 要] 登録モデル数を返却します。
boolean	isAllowInteruptedExceptionOnSyncModel() [概 要] モデル同期実行時に発生したInterruptedExceptionをエラーと見做すかどうかのフラグを返却します。
boolean	isRunModelsAndNoWait() [概 要] 複数予約されたモデルの実行動作を取得します。
void	put(java.lang.Object key, java.lang.Object value) [概 要] クライアントMVCレイヤ内で自由に使用出来るパラメータを追加します。
void	setActionInstance(Action action) [概 要] アクションインスタンスを設定します。
void	setAllowInteruptedExceptionOnSyncModel(boolean allowInteruptedExceptionOnSyncModel) [概 要] モデル同期実行時に発生したInterruptedExceptionをエラーと見做すかどうかのフラグを設定します。
void	setEventListener(java.util.EventListener eventListener) [概 要] イベントリスナプロキシインスタンスを設定します。
void	setEventListenerType(java.lang.Class<? extends java.util.EventListener> listenerType) [概 要] イベントリスナの型を設定します。
void	setEventObject(java.util.EventObject eventObject) [概 要] Swingコンポーネントが発行したイベントオブジェクトを返却します。
void	setEventSource(java.lang.Object eventSourceObject) [概 要] イベントを起こしたオブジェクトを設定します。
void	setEventSourceParent(java.lang.Object eventSourceObjectParent) [概 要] イベントを起こしたオブジェクトの親を設定します。
void	setEventType(java.lang.String eventType) [概 要] イベントハンドラメソッド名を設定します。
void	setModelClasses(java.util.List<java.lang.Class<? extends Model>> modelClasses) [概 要] モデルクラス一覧を設定します。
void	setModelFinishedNum(int modelFinishedNum) [概 要] 終了モデル数を設定します。
void	setModelReservedNum(int modelReservedNum) [概 要] 登録モデル数を設定します。
void	setRunModelsAndNoWait(boolean runModelsAndNoWait) [概 要] 複数予約されたモデルの実行動作を設定します。

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

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

ACTION_CLASS_NAME

public static final java.lang.String ACTION_CLASS_NAME

具象イベントハンドラ名マッピングのキー定数です。

関連項目:

定数フィールド値

EVENT_OBJECT

public static final java.lang.String EVENT_OBJECT

Swingクライアントイベントマッピングのキー定数です。

関連項目:

定数フィールド値

EVENT_LISTENER

public static final java.lang.String EVENT_LISTENER

イベントリスナプロキシインスタンスのキー定数です。

関連項目:

定数フィールド値

EVENT_LISTENER_TYPE

public static final java.lang.String EVENT_LISTENER_TYPE

イベントリスナの型を示すキー定数です。

関連項目:

定数フィールド値

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

イベントリスナプロキシがハンドリングした、イベントリスナのハンドラメソッド名を示すキー定数です。

関連項目:

定数フィールド値

EVENT_SOURCE_OBJECT

public static final java.lang.String EVENT_SOURCE_OBJECT

イベントを起こしたコンポーネントマッピングのキー定数です。

関連項目:

定数フィールド値

EVENT_SOURCE_OBJECT_PARENT

public static final java.lang.String EVENT_SOURCE_OBJECT_PARENT

イベントを起こしたコンポーネントの親コンポーネントを示すキー定数です。

関連項目:

定数フィールド値

MODEL_CLASSES

public static final java.lang.String MODEL_CLASSES

コントローラによって実行されるモデルクラス群のキー定数です。

関連項目:

定数フィールド値

MODEL_RESERVED_NUM

public static final java.lang.String MODEL_RESERVED_NUM

モデルの登録数を示す定数です。

関連項目:

定数フィールド値

MODEL_FINISHED_NUM

public static final java.lang.String MODEL_FINISHED_NUM

モデルの終了数を示す定数です。

関連項目:

定数フィールド値

VALIDATORS

public static final java.lang.String VALIDATORS

実行されるバリデータ群のキー定数です。

関連項目:

定数フィールド値

ACTION_INSTANCE

public static final java.lang.String ACTION_INSTANCE

実行されるアクションのインスタンスを示すキー定数です。

関連項目:

定数フィールド値

WAIT_MODELS_DONE

public static final java.lang.String WAIT_MODELS_DONE

イベントを発生させたエレメントが所属するウィンドウレベルエレメントを示すキー定数です。

関連項目:

定数フィールド値

RUN_MODELS_AND_NO_WAIT

public static final java.lang.String RUN_MODELS_AND_NO_WAIT

モデル連続実行時、一モデルの終了を待つかどうかのフラグを示すキー定数です。

関連項目:

定数フィールド値

ALLOW_INTERUPTED_EXCEPTION_ON_SYNC_MODEL

public static final java.lang.String ALLOW_INTERUPTED_EXCEPTION_ON_SYNC_MODEL

モデル同期実行時に発生したInterruptedExceptionをエラーと見做すかどうかのフラグを表すキー定数です。

関連項目:

定数フィールド値

コンストラクタの詳細

ParameterMapping

public ParameterMapping()

[概 要]

デフォルトコンストラクタです。

[詳 細]

parametersフィールドMap領域を初期化します。

[備 考]

メソッドの詳細

get

public java.lang.Object get(java.lang.Object key)

[概 要]

クライアントMVCレイヤ内で追加されたパラメータを取得します。

[詳 細]

アクション、モデル内で伝播させる情報を取得します。

[備 考]

パラメータ:

key - マッピングキー

戻り値:

マッピング値

put

public void put(java.lang.Object key,
                java.lang.Object value)

[概 要]

クライアントMVCレイヤ内で自由に使用出来るパラメータを追加します。

[詳 細]

ParameterMappingオブジェクトに対して、key=valueの形式で値を登録します。

[備 考]

一イベントハンドリング間のビジネスロジックに必要な、任意のパラメータ を格納する為に使用します。

パラメータ:

key - マッピングキー

value - マッピング値

getEventObject

public java.util.EventObject getEventObject()

[概 要]

Swingコンポーネントが発行したイベントオブジェクトを返却します。

[詳 細]

parametersフィールドから"EVENT_OBJECT"キーで値を取り出します。

[備 考]

戻り値:

Swingコンポーネントが発行したイベントオブジェクト

setEventObject

public void setEventObject(java.util.EventObject eventObject)

[概 要]

Swingコンポーネントが発行したイベントオブジェクトを返却します。

[詳 細]

parametersフィールドに"EVENT_OBJECT"キーで引数eventObjectを設定します。

[備 考]

パラメータ:

eventObject - Swingコンポーネントが発行したイベントオブジェクト

getEventSource

public java.lang.Object getEventSource()

[概 要]

イベントを起こしたオブジェクトを返却します。

[詳 細]

paramtersフィールドから"EVENT_SOURCE_OBJECT"キーで値を取得します。

[備 考]

戻り値:

イベントを起こしたオブジェクト

setEventSource

public void setEventSource(java.lang.Object eventSourceObject)

[概 要]

イベントを起こしたオブジェクトを設定します。

[詳 細]

parametersフィールドに"EVENT_SOURCE_OBJECT"キーで引数eventSourceObjectを設定します。

[備 考]

パラメータ:

eventSourceComponent - イベントを起こしたオブジェクト

getEventSourceParent

public java.lang.Object getEventSourceParent()

[概 要]

イベントを起こしたオブジェクトの親を返却します。

[詳 細]

paramtersフィールドから"EVENT_SOURCE_OBJECT_PARENT"キーで値を取得します。

[備 考]

戻り値:

イベントを起こしたオブジェクトの親

setEventSourceParent

public void setEventSourceParent(java.lang.Object eventSourceObjectParent)

[概 要]

イベントを起こしたオブジェクトの親を設定します。

[詳 細]

parametersフィールドに"EVENT_SOURCE_OBJECT_PARENT"キーで引数eventSourceObjectParentを設定します。

[備 考]

パラメータ:

eventSourceComponentParent - イベントを起こしたオブジェクトの親

getEventListener

public java.util.EventListener getEventListener()

[概 要]

イベントリスナプロキシインスタンスを返却します。

[詳 細]

parametersフィールドから"EVENT_LISTENER"キーで値を取得します。

[備 考]

戻り値:

イベントリスナプロキシインスタンス

setEventListener

public void setEventListener(java.util.EventListener eventListener)

[概 要]

イベントリスナプロキシインスタンスを設定します。

[詳 細]

parametersフィールドに"EVENT_LISTENRE"キーで引数eventListenerを設定します。

[備 考]

パラメータ:

eventListener - イベントリスナプロキシインスタンス

getEventListenerType

public java.lang.Class<? extends java.util.EventListener> getEventListenerType()

[概 要]

イベントリスナの型を返却します。

[詳 細]

parametersフィールドから"EVENT_LISTENER_TYPE"キーで値を取得します。

[備 考]

戻り値:

イベントリスナの型

setEventListenerType

public void setEventListenerType(java.lang.Class<? extends java.util.EventListener> listenerType)

[概 要]

イベントリスナの型を設定します。

[詳 細]

parametersフィールドに"EVENT_LISTENER_TYPE"キーで引数listenerTypeを設定します。

[備 考]

パラメータ:

listenerType - イベントリスナの型

getEventType

public java.lang.String getEventType()

[概 要]

イベントハンドラメソッド名を返却します。

[詳 細]

parametersフィールドから"EVENT_TYPE"キーで値を取得します。

[備 考]

戻り値:

イベントハンドラメソッド名

setEventType

public void setEventType(java.lang.String eventType)

[概 要]

イベントハンドラメソッド名を設定します。

[詳 細]

parametersフィールドに"EVENT_TYPE"キーで引数eventTypeを設定します。

[備 考]

パラメータ:

eventType - イベントハンドラメソッド名

getModelClasses

public java.util.List<java.lang.Class<? extends Model>> getModelClasses()

[概 要]

モデルクラス一覧を取得します。

[詳 細]

parametersフィールドから"MODES_CLASSES"キーで値を取得します。 登録されているモデルクラス一覧を取得します。

[備 考]

戻り値:

登録されているモデルクラス一覧

setModelClasses

public void setModelClasses(java.util.List<java.lang.Class<? extends Model>> modelClasses)

[概 要]

モデルクラス一覧を設定します。

[詳 細]

parametersフィールドに"MODEL_CLASSES"キーで引数modelClassesを設定します。 実行するモデルクラスを登録します。

[備 考]

パラメータ:

modelClasses - 実行するモデルクラス

getModelReservedNum

public int getModelReservedNum()

[概 要]

登録モデル数を返却します。

[詳 細]

parametersフィールドから"MODEL_RESERVED_NUM"キーで値を取得します。 登録したモデル数を取得します。

[備 考]

戻り値:

登録したモデル数

setModelReservedNum

public void setModelReservedNum(int modelReservedNum)

[概 要]

登録モデル数を設定します。

[詳 細]

parametersフィールドに"MODEL_RESERVED_NUM"キーで引数modelReservedNumを設定します。 登録したモデル数を設定します。

[備 考]

パラメータ:

modelReservedNum - 登録するモデル数

getModelFinishedNum

public int getModelFinishedNum()

[概 要]

終了モデル数を返却します。

[詳 細]

parametersフィールドから"MODEL_FINISHED_NUM"キーで値を取得します。 終了したモデル数を取得します。

[備 考]

戻り値:

終了したモデル数

setModelFinishedNum

public void setModelFinishedNum(int modelFinishedNum)

[概 要]

終了モデル数を設定します。

[詳 細]

parametersフィールドに"MODEL_FINISHED_NUM"キーで引数modelFinishedNumを設定します。 終了したモデル数を設定します。

[備 考]

パラメータ:

modelFinishedNum - 終了したモデル数

getActionInstance

public Action getActionInstance()

[概 要]

アクションインスタンスを返却します。

[詳 細]

parametersフィールドから"ACTION_INSTANCE"キーで値を取得します。 登録されているアクションを取得します。

[備 考]

パラメータ:

登録されているアクション -

setActionInstance

public void setActionInstance(Action action)

[概 要]

アクションインスタンスを設定します。

[詳 細]

parametersフィールドに"ACTION_INSTANCE"キーで引数actionを設定します。 実行するアクションを登録します。

[備 考]

パラメータ:

action - 実行するアクション

isRunModelsAndNoWait

public boolean isRunModelsAndNoWait()

[概 要]

複数予約されたモデルの実行動作を取得します。

[詳 細]

parametersフィールドから"RUN_MODELS_AND_NO_WAIT"キーで値を取得します。
モデル群がコントローラに連続実行される際、モデルの処理結果を待たずに 次のモデルを実行するかどうかのフラグを取得します。

[備 考]

モデルをシーケンシャルに実行しない場合、モデルは登録された順序で実行されますが レスポンスを待たずに次のモデルが実行されます。

戻り値:

シーケンシャルに実行しない場合はtrue、それ以外はfalse

setRunModelsAndNoWait

public void setRunModelsAndNoWait(boolean runModelsAndNoWait)

[概 要]

複数予約されたモデルの実行動作を設定します。

[詳 細]

parametersフィールドに"RUN_MODELS_AND_NO_WAIT"キーで引数runModelsAndNoWaitを設定します。
モデル群がコントローラに実行される際、モデルの処理結果を待たずに 次モデルを実行するかどうかのフラグを設定します。

[備 考]

モデルをシーケンシャルに実行しない場合、モデルは登録された順序で実行されますが レスポンスを待たずに次のモデルが実行されます。

パラメータ:

runModelsAndNoWait - シーケンシャルに実行しない場合はtrue、それ以外はfalse

isAllowInteruptedExceptionOnSyncModel

public boolean isAllowInteruptedExceptionOnSyncModel()

[概 要]

モデル同期実行時に発生したInterruptedExceptionをエラーと見做すかどうかのフラグを返却します。

[詳 細]

parametersフィールドから"ALLOW_INTERUPTED_EXCEPTION_ON_SYNC_MODEL"キーで値を取得します。
実行モデルの処理終了をコントローラが待っている際にInterruptedExceptionが発生した場合に エラーと見做すか見做さないかを返却します。

[備 考]

戻り値:

モデル同期実行時に発生したInterruptedExceptionをエラーと見做すかどうかのフラグ

setAllowInteruptedExceptionOnSyncModel

public void setAllowInteruptedExceptionOnSyncModel(boolean allowInteruptedExceptionOnSyncModel)

[概 要]

モデル同期実行時に発生したInterruptedExceptionをエラーと見做すかどうかのフラグを設定します。

[詳 細]

parametersフィールドに"ALLOW_INTERUPTED_EXCEPTION_ON_SYNC_MODEL"キーで値を取得します。
実行モデルの処理終了をコントローラが待っている際にInterruptedExceptionが発生した場合に エラーと見做すか見做さないかを設定します。

[備 考]

TimerProcessCoreがActionを実行中で、Actionに同期実行モデルがreserveされている場合、 TimerProcessCoreをstopするとInterruptedExceptionがスローされます。
これをエラーではなく、中止と見做す為にTimerProcessCoreManagerが内部的にtrueに設定します。

パラメータ:

allowInteruptedExceptionOnSyncModel - モデル同期実行時に発生したInterruptedExceptionをエラーと見做すかどうかのフラグ

clone

public ParameterMapping clone()

[概 要]

このクラスオブジェクトの複製を返却します。

[詳 細]

ParameterMappingのシャローコピーを行います。
ParameterMappingオブジェクト、及び保持するプロパティは完全なコピーを作りますが、 parametersプロパティ内で保持する定数キー要素値のアドレス参照はコピーしません。
parameterMapping#parametersと、
clonedParameterMapping#parameters
は異なるアドレスで保持されますが、
parameterMapping#getEventSourceと、
clonedParameterMapping#getEventSource
は同じアドレスを返却します。

[備 考]

このメソッドはアクションからコントローラに別アクション実行を委譲する場合等に使用します。

    protected boolean prepare(ParameterMapping parameterMapping) throws Exception {
        this.getController().invoke(OtherAction.class, parameterMapping.clone());
        return true;
    }
 

コントローラはコールバック（successForwardやfailureForward）先アクションアドレスを ParameterMapping#getActionInstanceで判別しますが、invokeが呼ばれると左記のアドレスを指定 された新規アクションのアドレスで上書きします。
上記のようにinvokeを呼び出すことで、コントローラが認識するアクションアドレスの上書き を抑止することが出来ます。

オーバーライド:

クラス java.lang.Object 内の clone

戻り値:

複製されたParameterMappingオブジェクト