com.asakusafw.vocabulary.operator

Annotation Type MasterCheck

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

マスタ確認演算子を表すメソッドに付与する注釈。

この演算子は、トランザクションデータに対応するマスタデータを引き当てて確認し、 マスタデータを発見できたものと発見できなかったものに分けて出力に流す。

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

引数には同メソッドで宣言した型変数を利用できる。

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

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

例:

/**
 * レコードHogeTrnに対するHogeMstが存在する場合に{@code true}を返す。
 * @param master マスタデータ
 * @param tx トランザクションデータ
 * @return HogeMstが存在する場合のみ{@code true}
 */
@MasterCheck
public abstract boolean exists(
        @Key(group = "id") HogeMst master,
        @Key(group = "masterId") HogeTrn tx);

See Also:

MasterJoin, 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_FOUND The output port number for the successfully checked data.
static int	ID_OUTPUT_MISSED The output port number for the master missing data.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	foundPort The default port name of {#ID_OUTPUT_FOUND}.
String	missedPort The default port name of ID_OUTPUT_MISSED.
String	selection The selector method name.

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_FOUND

public static final int ID_OUTPUT_FOUND

The output port number for the successfully checked data.

ID_OUTPUT_MISSED

public static final int ID_OUTPUT_MISSED

The output port number for the master missing data.

Element Detail

foundPort

public abstract String foundPort

The default port name of {#ID_OUTPUT_FOUND}.

Default:

"found"

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:

"-"