com.asakusafw.vocabulary.operator

Annotation Type Convert

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

変換演算子を表すメソッドに付与する注釈。

この演算子は、入力されたデータを他の種類のデータに変換し、出力に流す。

一つの引数を取り、変換して別のモデルオブジェクトを返すプログラムを記述する。

また、引数には同メソッドで宣言した型変数を利用できるが、 戻り値の型に型変数を含めることはできない。

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

• 返戻型に変換後のモデルオブジェクト型を指定する
• 以下の引数を宣言する
  • モデルオブジェクト型の引数
• 以下の修飾子を付与する
  • (特になし)
• 以下の修飾子は付与しない
  • abstract

このフレームワークを正しく利用する限り、この注釈を付与するメソッドはスレッド安全となる。 ただし、同メソッドが共有データを操作したり、または共有データを操作する別のメソッドを起動したりする 場合についてはスレッド安全でない。

例:

// スレッド安全なので変換後の結果オブジェクトを再利用可能
private final Foo foo = new Foo();

/**
 * レコードHogeを等価なFooに変換して返す。
 * @param hoge 変換するレコード
 * @return 変換後のレコード
 */
@Convert
public Foo toFoo(Hoge hoge) {
    foo.setValue(hoge.getValue());
    return foo;
}

Field Summary

Fields

Modifier and Type	Fields and Description
static int	ID_INPUT The input port number.
static int	ID_OUTPUT_CONVERTED The output port number which provides the converted data-set.
static int	ID_OUTPUT_ORIGINAL The output port number which provides the original data-set.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	convertedPort The default port name of ID_OUTPUT_CONVERTED.
String	originalPort The default port name of ID_OUTPUT_ORIGINAL.

Field Detail

ID_INPUT

public static final int ID_INPUT

The input port number.

ID_OUTPUT_ORIGINAL

public static final int ID_OUTPUT_ORIGINAL

The output port number which provides the original data-set.

ID_OUTPUT_CONVERTED

public static final int ID_OUTPUT_CONVERTED

The output port number which provides the converted data-set.

Element Detail

originalPort

public abstract String originalPort

The default port name of ID_OUTPUT_ORIGINAL.

Default:

"original"

convertedPort

public abstract String convertedPort

The default port name of ID_OUTPUT_CONVERTED.

Default:

"out"