3.5. 用途を追加する¶

3.5.1.1.1. 親コンポーネントから渡される情報¶

親コンポーネントから props へ渡されるものは次のものです。 上記例では readonly しか使用していません。

親コンポーネントから provide される関数は次のものです。

また、この他に親コンポーネントから provide されるオブジェクトも存在します。内部で使用しています。

3.5.1.1.2. 親コンポーネントで定義されているコンポーネント¶

3.5.1.2.1. 用途の項目を表現するクラスの実装¶

このクラスの実装で大事なことは、用途の項目をどのようなデータ構造として扱うのか？を決めることです。 jp.co.intra_mart.foundation.repository.metadata.dictionary.usage.Usage を実装したクラスとして実装します。

クライアント側とは JSON 形式でデータのやり取りをします。 上記のクライアン側の例では

return {
  x: '',
  y: '',
  align: ''
}

となっているので、サーバ側では Map<String, Object> としてデータを扱います。

また、align は参照先の辞書項目とは別の値を持てるとしたので、AliasEditable アノテーションを付けます。 もしこのアノテーションをつけ忘れると、画面で入力した値が、参照先の辞書項目の値で書き換えられた上で保存されます。

src/main/java/sample/usage/SampleUsage.java

public class SampleUsage implements Usage {
    /**
     * この用途のIDです。
     */
    public static final String USAGE_ID = "sample_usage";

    private static final long serialVersionUID = 8444395879883374534L;

    // 用途の項目を格納する Map です。
    private final Map<String, Object> usageData = new HashMap<>();

    // x座標
    private String x;

    // y座標
    private String y;

    // 水平方向への配置位置
    @AliasEditable
    private String align;

    /**
     * 用途の表示名です。
     * 辞書項目の右側、用途の一覧にチェックボックスとともに表示されます。
     */
    @Override
    public String getName() {
        return "表示位置";
    }

    /**
     * 用途のIDを返します。
     */
    @Override
    public UsageId getUsageId() {
        return UsageId.of(USAGE_ID);
    }

    /**
     *  用途の項目データを返します。
     */
    @Override
    public Object getUsageData() {
        usageData.put("x", this.x);
        usageData.put("y", this.y);
        usageData.put("align", this.align);
        return usageData;
    }

    /**
     * 用途の項目データを設置します。
     * このメソッドは画面からと、永続化層の双方からセットされます。
     */
    @Override
    public void setUsageData(final Object data) {
        if (data != null && data instanceof Map<?, ?>) {
            @SuppressWarnings("unchecked")
            final Map<String, Object> map = (Map<String, Object>) data;

            this.x = Optional.ofNullable(map.get("x")).map(String.class::cast).orElse(StringUtil.EMPTY_STRING);
            this.y = Optional.ofNullable(map.get("y")).map(String.class::cast).orElse(StringUtil.EMPTY_STRING);
            this.align = Optional.ofNullable(map.get("align")).map(String.class::cast).orElse(StringUtil.EMPTY_STRING);
        }
    }

    /**
     * クライアント側の JavaScript 実装のパスを返します。
     */
    @Override
    public String[] getScriptPathList() {
        return new String[] { "im_repository/sample.js" };
    }

    /**
     * x座標を返します。
     * @return x座標
     */
    public String getX() {
        return x;
    }

    /**
     * y座標を返します。
     * @return y座標
     */
    public String getY() {
        return y;
    }

    /**
     * 水平位置を返します。
     * @return 水平位置
     */
    public String getAlign() {
        return align;
    }
}

3.5.1.2.2. インポート・エクスポート時の設定、処理を行うクラスの実装¶

インポート・エクスポートで利用されるクラスです。用途の各フィールドに対してインポート・エクスポートで使用するキーを定義します。 jp.co.intra_mart.system.repository.metadata.dictionary.import_export.StandardUsageSerializer を継承したクラスとして実装します。

/** x座標のインポート・エクスポートに使用するキーです。 */
private static final String SAMPLE_USAGE_X = "sample_usage_x";

/** ｙ座標のインポート・エクスポートに使用するキーです。 */
private static final String SAMPLE_USAGE_Y = "sample_usage_y";

/** 水平方向への配置位置のインポート・エクスポートに使用するキーです。 */
private static final String SAMPLE_USAGE_ALIGN = "sample_usage_align";

このキーは後述する インポート・エクスポートで使用する設定ファイルの追加 でも利用し、システムで一意とならなければなりません。 未知の用途、制約が追加されることを考慮し、FQDN やモジュールIDなど競合しない文字列を検討してください。 またシステムで利用している設定ファイルのキーにも競合しないように注意してください。

システムで利用している設定ファイルの配置場所は「WEB-INF/conf/im-repository-dictionary-config-type/im-repository-dictionary-config-type.xml」です。

getKeySettingsメソッドでインポート・エクスポートで使用するキーと用途の各フィールドの対応を設定することにより、エクスポート時の出力、インポート時の取込に対応させることができます。

public KeySetting[] getKeySettings() {
    return new KeySetting[] {
        KeySetting.of(SAMPLE_USAGE_X, "x"),
        KeySetting.of(SAMPLE_USAGE_Y, "y"),
        KeySetting.of(SAMPLE_USAGE_ALIGN, "align")};
}

validateメソッドはインポート時のインポート確認画面に出力されるエラーメッセージ、ワーニングメッセージを設定できます。 エラーメッセージが含まれる場合はインポートを継続できないので、内容に応じて設定してください。

src/main/java/sample/usage/SampleUsageSerializer.java

public class SampleUsageSerializer extends StandardUsageSerializer {

    /** x座標のインポート・エクスポートに使用するキーです。 */
    private static final String SAMPLE_USAGE_X = "sample_usage_x";

    /** ｙ座標のインポート・エクスポートに使用するキーです。 */
    private static final String SAMPLE_USAGE_Y = "sample_usage_y";

    /** 水平方向への配置位置のインポート・エクスポートに使用するキーです。 */
    private static final String SAMPLE_USAGE_ALIGN = "sample_usage_align";

    /**
     * XMLの設定値とフィールド名の組み合わせを返します。
     */
    @Override
    public List<KeySetting> getKeySettings() {
        final List<KeySetting> list = new ArrayList<>();
        list.add(KeySetting.of(SAMPLE_USAGE_X, "x"));
        list.add(KeySetting.of(SAMPLE_USAGE_Y, "y"));
        list.add(KeySetting.of(SAMPLE_USAGE_ALIGN, "align"));
        return list;
    }

    /**
     * 用途タイプを返却します。
     * 用途のclassを指定してください。
     */
    @SuppressWarnings("unchecked")
    @Override
    public Class<Usage> getSupportType() {
        return (Class<Usage>) (Object) SampleUsage.class;
    }

    /**
     * インポート時のバリデーションを行います。
     */
    @Override
    public void validate(final Class<?> element, final ImportDataModel importData) {
        // 入力チェックを行う対象
        final String key = SAMPLE_USAGE_X;

        if (!isEditable(element, key)) {
            // 編集不可の場合は値が設定されていないためバリデーションを行いません。
            return;
        }

        // インポートデータから値を取得
        final String x = getImportDataValue(importData.get(key));

        // バリデーション内容
        if (x != null && x.isEmpty()) {
            // エラーメッセージの追加例
            setErrorMessage("必須入力項目です。");
        } else {
            try {
                // 数値化
                Integer.valueOf(x);
            } catch (final NumberFormatException e) {
                // ワーニングメッセージの追加例
                setWarningMessage("数値ではありません。");
            }
        }
    }
}

3.5.1.2.3. 設定ファイルの追加¶