com.asakusafw.vocabulary.operator

Annotation Type MasterJoin

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

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

この演算子は、トランザクションデータに対して対応するマスタデータを結合し、出力に流す。

対象のメソッドは抽象メソッドとして宣言し、結合対象の二つのモデルオブジェクト型の引数を取る。 このとき最初の引数は、マスタデータなど結合条件に対してユニークであるようなモデルオブジェクトである必要がある。 また、戻り値型には結合結果のモデルオブジェクトの型を指定する。 結合結果のモデルオブジェクトの型は、必ず結合対象の二つのモデルオブジェクトを結合したものを 表現しなければならない。 結合条件や結合方法については戻り値型に定義されているため、 ここでは特に指定しない。

なお、この演算子メソッドには型引数を定義できない。

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

• 返戻型に集計結果となるモデル型を指定する
• 以下の引数を宣言する
  • 結合対象のモデルオブジェクト型の引数 (マスタデータ)
  • 結合対象のモデルオブジェクト型の引数
• 以下の修飾子を付与する
  • abstract
• 以下の修飾子は付与しない
  • (特になし)

例:

/**
 * レコードHogeMstとHogeTrnを結合し、結合結果のHogeを返す。
 * @param master マスタデータ
 * @param tx トランザクションデータ
 * @return 結合結果
 */
@MasterJoin
public abstract Hoge join(HogeMst master, HogeTrn tx);

See Also:

Joined, 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_JOINED The output port number for the successfully joined 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	joinedPort The default port name of ID_OUTPUT_JOINED.
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_JOINED

public static final int ID_OUTPUT_JOINED

The output port number for the successfully joined data.

ID_OUTPUT_MISSED

public static final int ID_OUTPUT_MISSED

The output port number for the master missing data.

Element Detail

joinedPort

public abstract String joinedPort

The default port name of ID_OUTPUT_JOINED.

Default:

"joined"

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:

"-"