jp.co.intra_mart.foundation.propagation.sender

クラス AbstractEncoder<D,G extends Serializable>

java.lang.Object

jp.co.intra_mart.foundation.propagation.sender.AbstractEncoder<D,G>

型パラメータ:

D - 自モジュール内で伝搬機能に渡すデータのクラスタイプ

G - 伝搬機能で他モジュールへ送信するデータのクラスタイプ

すべての実装されたインタフェース:

Encoder<D,G>

直系の既知のサブクラス:

PropagationDataViewEncoder, PropagationQueryEncoder, PropagationQueryRouteEncoder, SalesforceEventNotificationPropagationEncoder, SalesforceStreamingFatalErrorInfoEncoder

public abstract class AbstractEncoder<D,G extends Serializable>
extends Object
implements Encoder<D,G>

自モジュール内で IM-Propagation (伝搬機能) に渡されたデータを、他モジュールへ送信するデータに変換するクラスの基底クラス。

伝搬機能において、データの送信側が用意するデータ変換クラスの基底クラスを提供します。
データの送信側がデータ変換クラスを実装する場合は、必ずこのクラスを継承してください。

型パラメータ D には、伝搬機能マネージャに渡される送信対象のデータが格納されたクラスと同じクラスタイプを指定してください。
異なるクラスタイプを指定した場合は、伝搬機能の処理中に例外がスローされます。

型パラメータ G には、基本的に伝搬機能でデータの伝搬のために用意された共通モデルのクラスタイプを指定してください。
指定するモデルクラスは、データ送信側が送信するデータのクラスに依存します。
総称型を指定できない、フィールドで使用できるクラスが制限されている等、 制約 がありますのでご注意ください。

データの送信側と受信側が同じモジュール内で完結しており、他モジュールがデータを受け取らないことが保証されている場合は、型パラメータ D と G に同じクラスタイプを指定できます。

バージョン:

8.0.0

関連項目:

Encoder

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
AbstractEncoder()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
abstract G	encode(D data) 自モジュール内で使用するデータを、伝搬機能で他モジュールへ送信する送信するデータに変換して返却します。
abstract Class<G>	getGenericDataClass() 伝搬機能で他モジュールへ送信するデータのクラスを返却します。
protected Set<String>	getParamKeys() このクラスに設定された独自パラメータのキーを全て取得します。
protected String	getParamValue(String key) このクラスに設定された独自パラメータのキーに割り当てられた値を 1 つ取得します。
protected List<String>	getParamValues(String key) このクラスに設定された独自パラメータのキーに割り当てられた値を全て取得します。
void	setParamValuesMap(Map<String,List<String>> map) 伝搬機能からこのクラスに設定された独自パラメータのマップを受け取ります。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

AbstractEncoder

public AbstractEncoder()

メソッドの詳細

encode

public abstract G encode(D data)
                  throws ConvertException

自モジュール内で使用するデータを、伝搬機能で他モジュールへ送信する送信するデータに変換して返却します。

引数 data に格納されている内容を、伝搬機能で他モジュールへ送信するクラスに移し替えて返却してください。
型パラメータ D と G に同じクラスタイプが指定されている場合は、引数 data をそのまま返却することができます。

引数 data に不足情報があった場合はここで補完してください。 補完できない場合は ConvertException 例外をスローしてください。
独自の例外クラスをスローしたい場合は、 ConvertException クラスを継承した例外クラスをスローしてください。

定義:

encode インタフェース内 Encoder<D,G extends Serializable>

パラメータ:

data - 自モジュール内で伝搬機能に渡されたデータ

戻り値:

伝搬機能で他モジュールへ送信するデータ

例外:

ConvertException - データの変換に失敗した場合

関連項目:

Encoder.encode(Object)

getGenericDataClass

public abstract Class<G> getGenericDataClass()

伝搬機能で他モジュールへ送信するデータのクラスを返却します。

型パラメータ G のクラスを返却してください。 例えば G が GenericData クラスの場合は GenericData.class を返却してください。

定義:

getGenericDataClass インタフェース内 Encoder<D,G extends Serializable>

戻り値:

伝搬機能で他モジュールへ送信するデータのクラス

関連項目:

Encoder.getGenericDataClass()

setParamValuesMap

public void setParamValuesMap(Map<String,List<String>> map)

伝搬機能からこのクラスに設定された独自パラメータのマップを受け取ります。

伝搬機能によって自動的に呼び出されるため、このメソッドを明示的に呼び出すことは避けてください。

定義:

setParamValuesMap インタフェース内 Encoder<D,G extends Serializable>

パラメータ:

map - 独自パラメータのマップ

関連項目:

Encoder.setParamValuesMap(Map)

getParamKeys

protected Set<String> getParamKeys()

このクラスに設定された独自パラメータのキーを全て取得します。

戻り値:

独自パラメータのキーの一覧

getParamValue

protected String getParamValue(String key)

このクラスに設定された独自パラメータのキーに割り当てられた値を 1 つ取得します。

指定したキーに割り当てられた値が存在しない場合は、 null を返します。
値が複数存在する場合は、最初の 1 つのみを返します。 全ての値を取得する場合は getParamValues メソッドを呼び出してください。

パラメータ:

key - 独自パラメータのキー

戻り値:

独自パラメータの値

getParamValues

protected List<String> getParamValues(String key)

このクラスに設定された独自パラメータのキーに割り当てられた値を全て取得します。

指定したキーに割り当てられた値が存在しない場合は、 0 件の一覧を返します。

パラメータ:

key - 独自パラメータのキー

戻り値:

独自パラメータの値の一覧