com.asakusafw.vocabulary.operator

Annotation Type MasterBranch

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

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

この演算子は、トランザクションデータに対応するマスタデータを引き当て、 それらの内容に応じてトランザクションデータをそれぞれの出力に振り分ける。

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

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

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

• 返戻型には分岐先を表現する列挙型を指定する
  • その列挙型は、public として宣言されている
  • その列挙型は、一つ以上の列挙定数を持つ
• 以下の引数を宣言する
  • 結合対象のモデルオブジェクト型の引数 (マスタデータ)、 さらにKey注釈でグループ化のための情報を指定する
  • 結合対象のモデルオブジェクト型の引数、 さらにKey注釈でグループ化のための情報を指定する
• 以下の修飾子を付与する
  • (特になし)
• 以下の修飾子は付与しない
  • abstract

例:

public abstract class <Operator-Class> {
    ...

    /**
     * Returns the record status.
     * @param master the master data, or {@code null} if there is no suitable data for the record
     * @param tx the target record
     * @return the branch target status
     */
    @MasterBranch
    public Status branchWithJoin(
            @Key(group = "id") ItemMst master,
            @Key(group = "itemId") HogeTrn tx) {
        if (master == null) {
            return Status.ERROR;
        }
        int price = master.getPrice();
        if (price < 0) {
            return Status.ERROR;
        } else if (price < 1000000) {
            return Status.CHEAP;
        } else {
            return Status.EXPENSIVE;
        }
    }

    /**
     * Represents price status.
     */
    public enum Status {

        /**
         * Expensive price.
         */
        EXPENSIVE,

        /**
         * Cheap price.
         */
        CHEAP,

        /**
         * Erroneous price.
         */
        ERROR,
    }
    ...
}

Since:

0.1.0

Version:

0.5.1

See Also:

MasterJoin, Branch, 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.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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.

Element Detail

selection

public abstract String selection

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

See Also:

MasterSelection

Default:

"-"