com.asakusafw.vocabulary.operator

Annotation Type MasterJoinUpdate

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface MasterJoinUpdate

マスタつき更新演算子を表すメソッドに付与する注釈。

この演算子は、トランザクションデータに対応するマスタデータを引き当てたのち、 マスタデータの情報を利用してトランザクションデータの任意の項目を変更し、出力に流す。

対象のメソッドは結合対象の二つのモデルオブジェクト型の引数を取る。 このとき最初の引数は、マスタデータなど結合条件に対してユニークであるようなモデルオブジェクトである必要がある。 また、モデルオブジェクト型の引数にはそれぞれKey注釈を指定し、 グループ化のためのプロパティ名を指定する必要がある (整列のためのプロパティ名および整列方向に関する動作は規定されない)。 メソッドの本体では引数のトランザクションデータの内容を変更するプログラムを記述する (マスタデータの内容を変更した際の動作は規定されない)。

また、引数には同メソッドで宣言した型変数を利用できるが、 全ての結果オブジェクト型の出力に型変数を含める場合には、 いずれかの入力に同様の型変数を指定してある必要がある。

この注釈を付与するメソッドは、下記の要件を満たす必要がある。

• 返戻型にvoidを指定する
• 以下の引数を宣言する
  • 結合対象のモデルオブジェクト型の引数 (マスタデータ)、 さらにKey注釈でグループ化のための情報を指定する
  • 結合対象のモデルオブジェクト型の引数、 さらにKey注釈でグループ化のための情報を指定する
• 以下の修飾子を付与する
  • (特になし)
• 以下の修飾子は付与しない
  • abstract

例:

/**
 * マスタの価格をトランザクションデータに設定する。
 * @param master マスタデータ
 * @param tx 変更するトランザクションデータ
 */
@MasterJoinUpdate
public void updateWithMaster(
        @Key(group = "id") ItemMst master,
        @Key(group = "itemId") HogeTrn tx) {
    tx.setPrice(master.getPrice());
}

See Also:

MasterJoin, Update, MasterSelection

Field Summary

Fields

Modifier and Type	Fields and Description
static int	ID_INPUT_MASTER The input port number for the master data.
static int	ID_INPUT_TRANSACTION The input port number for the transaction data.
static int	ID_OUTPUT_MISSED The output port number for the master missing data.
static int	ID_OUTPUT_UPDATED The output port number for the successfully updated data.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	missedPort The default port name of ID_OUTPUT_MISSED.
String	selection The selector method name.
String	updatedPort The default port name of ID_OUTPUT_UPDATED.

Field Detail

ID_INPUT_MASTER

public static final int ID_INPUT_MASTER

The input port number for the master data.

ID_INPUT_TRANSACTION

public static final int ID_INPUT_TRANSACTION

The input port number for the transaction data.

ID_OUTPUT_UPDATED

public static final int ID_OUTPUT_UPDATED

The output port number for the successfully updated data.

ID_OUTPUT_MISSED

public static final int ID_OUTPUT_MISSED

The output port number for the master missing data.

Element Detail

updatedPort

public abstract String updatedPort

The default port name of ID_OUTPUT_UPDATED.

Default:

"updated"

missedPort

public abstract String missedPort

The default port name of ID_OUTPUT_MISSED.

Default:

"missed"

selection

public abstract String selection

The selector method name. The target method must be declared in the same class.

See Also:

MasterSelection

Default:

"-"