12. 演算子の作成¶

12.3.1. 店舗マスタ結合¶

ここではマスタ確認演算子を使って、バッチ処理仕様 1.店舗マスタ結合 に対応する処理を実装します。

マスタ確認演算子は、トランザクションデータに対してマスタデータを結合して、マスタデータを発見できたものと発見できなかったものに振り分ける演算子です。

この処理は演算子メソッド checkStore として定義します。 売上明細 ( sales_detail ) と 店舗マスタ ( store_info ) を 店舗コードをキーとして結合し、 店舗コードを発見できた売上明細レコードと発見できなかった売上明細レコードに振り分けます。

@MasterCheck
public abstract boolean checkStore(
        @Key(group = "store_code") StoreInfo info,
        @Key(group = "store_code") SalesDetail sales);

マスタ確認演算子は MasterJoin 注釈を付与したメソッドとして宣言します。 マスタ確認演算子は抽象メソッド ( abstract )として宣言し、メソッド本体は実装しません。

このメソッドには結合対象の二つのデータモデルクラス型の引数を取ります。 第1引数にはマスタデータ（結合条件に対してユニークであるデータ）、 第2引数にトランザクションデータとなるデータモデルクラスを指定します。

メソッドの各引数には Key 注釈 [2] を使って各データモデルの結合条件を指定する必要があります。 Key 注釈の要素 group には、結合キーとなるデータモデルのプロパティ名を指定します。

戻り値型には boolean を指定します。 マスタデータを発見できた場合は ture 、発見できなかった場合は false が返されます。

12.3.2. 商品マスタ結合¶

ここではマスタ結合演算子を使って、バッチ処理仕様 2.商品マスタ結合 に対応する処理を実装します。

マスタ結合演算子は、トランザクションデータに対してマスタデータを結合して、結合したデータモデル（結合モデル）を出力します。

この処理は演算子メソッド joinItemInfo として定義します。 売上明細 ( sales_detail ) と 商品マスタ ( item_info ) を 商品コードをキーとして結合し、 結合モデル ( joined_sales_info ) を出力します。

@MasterJoin
public abstract JoinedSalesInfo joinItemInfo(ItemInfo info, SalesDetail sales);

マスタ結合演算子は MasterJoin 注釈を付与したメソッドとして宣言します。 マスタ確認演算子は抽象メソッド ( abstract )として宣言し、メソッド本体は実装しません。

このメソッドにはマスタ確認演算子と同様に結合対象の二つのデータモデルクラス型の引数を取ります。 第1引数にはマスタデータ（結合条件に対してユニークであるデータ）、 第2引数にトランザクションデータとなるデータモデルクラスを指定します。

戻り値型には結合モデルのデータモデルクラスを指定します。 ここでは 結合モデルと集計モデルの定義 で作成した結合モデル 結合モデル ( joined_sales_info ) に対応するデータモデルクラス JoinedSalesInfo を指定します。

マスタ結合演算子は、DMDLスクリプトに指定した結合モデルの結合条件やプロパティのマッピングルールに従って、結合モデルを生成します。 演算子側には結合に関するルールを定義する必要はありません。

なお、現時点の演算子メソッド joinItemInfo の定義では結合条件は等価結合（指定した結合キーの値が一致している）条件となります。 このチュートリアルの後半 商品マスタ結合 - 非等価結合条件の指定 ではこの結合条件を非等価結合条件に変更する手順を説明していきます。

12.3.3. カテゴリ別集計¶

ここでは単純集計演算子を使って、バッチ処理仕様 3.カテゴリ別集計 に対応する処理を実装します。

単純集計演算子はレコードをキーでグループ化し、グループ内で集計した結果を出力する演算子です。

この処理は演算子メソッド summarizeByCategory として定義します。 結合モデル ( joined_sales_info ) に対してカテゴリコードでグループ化して、それぞれの販売数量と売上金額の合計を求めます。

@Summarize
public abstract CategorySummary summarizeByCategory(JoinedSalesInfo info);

単純集計演算子は Summarize 注釈を付与したメソッドとして宣言します。 単純集計演算子は抽象メソッド ( abstract )として宣言し、メソッド本体は実装しません。

単純集計演算子のメソッドには、集計対象のデータモデルクラス型の引数を取ります。 戻り値型には集計モデルのデータモデルクラスを指定します。 ここでは 結合モデルと集計モデルの定義 で作成した集計モデル カテゴリ別売上集計 ( category_summary ) に対応するデータモデルクラス CategorySummary を指定します。

単純集計演算子はDMDLスクリプトに指定した集計モデルのグループ化条件や集計方法、プロパティのマッピングルールに従って集計モデルを生成します。 演算子側には集計に関するルールを定義する必要はありません。

12.3.4. エラー情報編集¶

ここでは更新演算子を使って、バッチ処理仕様 4.エラー情報編集 に対応する処理を実装します。

更新演算子は、レコード単位でデータモデルの内容を更新する演算子です。

この処理は演算子メソッド setErrorMessage として定義します。 エラー情報 ( error_record ) に対してエラーメッセージを設定します。

@Update
public void setErrorMessage(ErrorRecord record, String message) {
    record.setMessageAsString(message);
}

更新演算子は Update 注釈を付与したメソッドとして宣言します。

更新演算子のメソッドには、更新対象のデータモデルクラス型の引数を取ります。 ここでは エラー情報 ( error_record ) に対応するデータモデルクラス ErrorRecord を指定します。

第2引数の文字列型の引数は 値引数 と呼ばれるものです。値引数ついては後述します。

戻り値型は void を指定します。

メソッド内では引数のデータモデルモデルオブジェクトの値をセッターなどを使って変更します。 メソッド終了時にこのデータモデルオブジェクトの内容が、演算子の出力になります。

12.3.5. 商品マスタ結合 - 非等価結合条件の指定¶

ここではマスタ選択演算子を使って、 商品マスタ結合 で説明した演算子メソッド joinItemInfo に対して、 サンプルアプリケーションの説明 のバッチ処理仕様 2.商品マスタ結合 に対応する非等価結合条件を指定します。

マスタ結合演算子やいくつかの結合演算子では、マスタ選択用の 補助演算子 であるマスタ選択演算子を利用することで任意の結合条件を指定する非等価結合条件を利用することができます。 補助演算子は単体で演算子としては機能せず、他の演算子と組み合わせて利用する演算子の機能です。

この処理は演算子メソッド selectAvailableItem として定義します。 売上明細の「売上日時」が、商品マスタの「マスタ適用開始日」と「マスタ適用終了日」の範囲内にあるレコードを選択する結合条件を指定します。

import com.asakusafw.runtime.value.Date;
import com.asakusafw.runtime.value.DateTime;
import com.asakusafw.runtime.value.DateUtil;

...

private final Date dateBuffer = new Date();

@MasterSelection
public ItemInfo selectAvailableItem(List<ItemInfo> candidates, SalesDetail sales) {
    DateTime dateTime = sales.getSalesDateTime();
    dateBuffer.setElapsedDays(DateUtil.getDayFromDate(
            dateTime.getYear(), dateTime.getMonth(), dateTime.getDay()));
    for (ItemInfo item : candidates) {
        if (item.getBeginDate().compareTo(dateBuffer) <= 0
                && dateBuffer.compareTo(item.getEndDate()) <= 0) {
            return item;
        }
    }
    return null;
}

マスタ選択演算子は、 MasterSelection 注釈を付与したメソッドとして宣言します。

マスタ選択演算子のメソッドには、結合対象の二つのデータモデルクラス型の引数を取りますが、 第1引数にはマスタデータを表すデータモデルオブジェクトを要素に取る リスト型の引数 となる点がマスタ確認演算子やマスタ結合演算子とは異なります。 第2引数にトランザクションデータとなるデータモデルクラスを指定します。

メソッド内では引数のトランザクションデータに対して結合するマスタデータを選択し、一つだけ選んで戻り値として返します。 戻り値に null を返した場合には、マスタの引当に失敗した扱いになります。

戻り値型は第1引数のマスタデータを表すデータモデルクラス型と同じ型である必要があります。

マスタ選択演算子を作成したら、マスタ選択演算子を使用する演算子メソッドの定義を変更します。 ここでは 商品マスタ結合 で説明した演算子メソッド joinItemInfo に対して、以下のように定義します。

@MasterJoin(selection = "selectAvailableItem")
public abstract JoinedSalesInfo joinItemInfo(ItemInfo info, SalesDetail sales);

MasterJoin 注釈に対して注釈要素 selection を追加し、この値にマスタ選択用の演算子メソッド名を指定します。

マスタ選択演算子を指定した結合演算子は、その演算子の処理が実行される前にマスタ選択演算子のメソッドが起動されます。 その際結合演算子で指定したグループ化条件に従ってマスタデータがリストに詰められて、マスタ選択演算子メソッドの引数として与えられます。 そしてマスタ選択演算子メソッドの戻り値が結合演算子のマスタデータ側の引数として与えられ、結合演算子の処理が実行されます。