com.asakusafw.vocabulary.operator

Annotation Type Fold

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

畳み込み演算子を表すメソッドに付与する注釈。

この演算子は、単一の入力を特定の項目でグループ化し、グループ内で畳みこんだ結果を出力する。

同じモデル型の二つの引数を取り、メソッドの本体で第一引数の内容を変更するプログラムを記述する。 また、第一引数にはKey注釈を指定し、 グループ化のためのプロパティ名を指定する必要がある (整列のためのプロパティ名および整列方向は無視される)。

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

この注釈を付与するメソッドは、一般的な演算子メソッドの要件の他に、 下記の要件をすべて満たす必要がある。

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

例:

/**
 * レコードHogeを畳み込む。
 * @param left ここまでの畳み込みの結果
 * @param right 畳み込む対象
 */
@Fold
public void fold(@Key(group = "name") Hoge left, Hoge right) {
    // @Summarizeを手動で行うイメージで、leftに次々とrightを加える
    left.setValue(left.getValue() + right.getValue());
}

Field Summary

Fields

Modifier and Type	Fields and Description
static int	ID_INPUT The input port number.
static int	ID_OUTPUT The output port number.
static String	INPUT The default input port name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	outputPort The default output port name.
PartialAggregation	partialAggregation 部分集約の設定。

Field Detail

ID_INPUT

public static final int ID_INPUT

The input port number.

ID_OUTPUT

public static final int ID_OUTPUT

The output port number.

INPUT

public static final String INPUT

The default input port name.

Element Detail

partialAggregation

public abstract PartialAggregation partialAggregation

部分集約の設定。

この演算子で部分集約を可能にした場合、現在はメソッド内でフレームワークAPIを利用できなくなる。

Since:

0.2.0

Default:

com.asakusafw.vocabulary.flow.processor.PartialAggregation.DEFAULT

outputPort

public abstract String outputPort

The default output port name.

Default:

"out"