CellField.java

  1. package com.gh.mygreen.xlsmapper.validation.fieldvalidation;

  3. import java.util.ArrayList;
  4. import java.util.Arrays;
  5. import java.util.Collections;
  6. import java.util.List;
  7. import java.util.Map;
  8. import java.util.Optional;

  10. import com.gh.mygreen.xlsmapper.fieldaccessor.LabelGetterFactory;
  11. import com.gh.mygreen.xlsmapper.fieldaccessor.PositionGetterFactory;
  12. import com.gh.mygreen.xlsmapper.util.ArgUtils;
  13. import com.gh.mygreen.xlsmapper.util.CellPosition;
  14. import com.gh.mygreen.xlsmapper.validation.FieldError;
  15. import com.gh.mygreen.xlsmapper.validation.FieldErrorBuilder;
  16. import com.gh.mygreen.xlsmapper.validation.SheetBindingErrors;


  19. /**
  20.  * 1つの項目（フィールド）に対する入力値チェックをするためのクラス。
  21.  * <p>型変換などにおけるバインドエラーなどはシートの読み込み時に行われます。
  22.  * <p>必須エラーのメッセージキーは、「fieldError.required」。
  23.  *
  24.  * @version 0.5
  25.  * @author T.TSUCHIE
  26.  * @param <T> チェック対象の値のタイプ
  27.  *
  28.  */
  29. public class CellField<T> {

  31.     private static final PositionGetterFactory positionGetterFactory = new PositionGetterFactory();
  32.     private static final LabelGetterFactory labelGetterFactory = new LabelGetterFactory();

  34.     private final SheetBindingErrors<?> errors;

  36.     /**
  37.      * フィールドの名称
  38.      */
  39.     private final String fieldName;

  41.     /**
  42.      * フィールドが定義されているBeanクラスのインスタンス
  43.      */
  44.     private Object beanObj;

  46.     /**
  47.      * フィールドの値
  48.      */
  49.     private T fieldValue;

  51.     /**
  52.      * フィールドのJavaBean上のパス
  53.      */
  54.     private String fieldPath;

  56.     /**
  57.      * セルの位置情報。
  58.      * Beanに定義されたプロパティ情報から取得する。
  59.      * 定義されていない場合は、nullが設定される。
  60.      */
  61.     private CellPosition position;

  63.     /**
  64.      * セルのラベル情報
  65.      * Beanに定義されたプロパティ情報から取得する。
  66.      * 定義されていない場合は、nullが設定される。
  67.      */
  68.     private String label;

  70.     /**
  71.      * 必須かどうか
  72.      */
  73.     private boolean required;

  75.     private List<FieldValidator<T>> validators;

  77.     private FieldFormatter<T> formatter;

  79.     private Class<T> fieldType;

  81.     /**
  82.      * 指定されたフィールドの名称に対応するオブジェクトを構築します。
  83.      * @param fieldName フィールドの名称。現在のBeanに対するフィールドの相対パスを指定します。
  84.      * @param errors エラー情報
  85.      */
  86.     public CellField(final String fieldName, final SheetBindingErrors<?> errors) {

  88.         ArgUtils.notEmpty(fieldName, "fieldName");
  89.         ArgUtils.notNull(errors, "errors");

  91.         this.fieldName = fieldName;
  92.         this.errors = errors;

  94.         init();
  95.     }

  97.     @SuppressWarnings("unchecked")
  98.     private void init() {

  100.         this.beanObj = errors.getValue();
  101.         this.fieldValue = (T)errors.getFieldValue(fieldName);
  102.         this.fieldType = (Class<T>)errors.getFieldType(fieldName);
  103.         this.fieldPath = errors.buildFieldPath(fieldName);

  105.         Optional<CellPosition> position = positionGetterFactory.create(beanObj.getClass(), fieldName)
  106.                 .map(getter -> getter.get(beanObj)).orElse(Optional.empty());
  107.         position.ifPresent(p -> setPosition(p));

  109.         Optional<String> label = labelGetterFactory.create(beanObj.getClass(), fieldName)
  110.                 .map(getter -> getter.get(beanObj)).orElse(Optional.empty());
  111.         label.ifPresent(l -> setLabel(l));

  113.         this.required = false;
  114.         this.validators = new ArrayList<>();

  116.         this.formatter = errors.findFieldFormatter(fieldName, fieldType);
  117.     }

  119.     /**
  120.      * 値が必須かの設定を行う。
  121.      * @param required 必須チェックを行いたい場合、「true」を設定する。
  122.      * @return 自身のインスタンス。メソッドチェーンで記述する。
  123.      */
  124.     public CellField<T> setRequired(final boolean required) {
  125.         this.required = required;
  126.         return this;
  127.     }

  129.     /**
  130.      * 値が必須かチェックを行うかどうか。
  131.      * @return true: 必須入力チェックを行う。
  132.      *               初期値は、非必須（オプション）です。
  133.      */
  134.     public boolean isRequired() {
  135.         return required;
  136.     }

  138.     /**
  139.      * {@link FieldValidator} を追加する。
  140.      * @param validator validatorのインスタンス。
  141.      * @return 自身のインスタンス。
  142.      * @throws NullPointerException validator is null.
  143.      */
  144.     public CellField<T> add(final FieldValidator<T> validator) {
  145.         ArgUtils.notNull(validator, "validator");
  146.         this.validators.add(validator);

  148.         return this;
  149.     }

  151.     /**
  152.      * 複数の{@link FieldValidator} を追加する。
  153.      * @param validators 複数のvalidatorのインスタンス。
  154.      * @return 自身のインスタンス。
  155.      * @throws NullPointerException validator is null.
  156.      */
  157.     public CellField<T> add(final List<FieldValidator<T>> validators) {

  159.         if(validators.isEmpty()) {
  160.             return this;
  161.         }

  163.         for(FieldValidator<T> validator : validators) {
  164.             add(validator);
  165.         }
  166.         return this;
  167.     }

  169.     /**
  170.      * 現在の{@link FieldValidator}を取得する。
  171.      * @return 現在設定されている{@link FieldValidator}。
  172.      */
  173.     public List<FieldValidator<T>> getValidators() {
  174.         return validators;
  175.     }

  177.     /**
  178.      * グループなどのヒントを指定して、入力値の検証を行う。
  179.      * <p>判定結果は、{@link #hasErrors()}で確認します。</p>
  180.      * <p>型変換エラーなどが既に存在するときには、処理は終了します。</p>
  181.      *
  182.      * @param groups 検証するときのヒントとなるグループ。
  183.      * @return 自身のインスタンス。
  184.      */
  185.     public CellField<T> validate(final Class<?>... groups) {

  187.         // 既に型変換エラーなどがある場合、値が設定されていないため処理を終了します。
  188.         if(hasErrors()) {
  189.             return this;
  190.         }

  192.         // 必須チェック
  193.         if(!validateForRequired()) {
  194.             return this;
  195.         }

  197.         final List<Class<?>> hints = Arrays.asList(groups);

  199.         if(getValidators() != null && !getValidators().isEmpty()) {
  200.             for(FieldValidator<T> validator : getValidators()) {
  201.                 if(!validator.validate(this, hints)) {
  202.                     return this;
  203.                 }
  204.             }
  205.         }

  207.         return this;

  209.     }

  211.     /**
  212.      * 必須エラーのメッセージキーを取得する。
  213.      * <p>キー名は、「fieldError.required」。
  214.      * @return
  215.      */
  216.     protected String getMessageKeyRequired() {
  217.         return "cellFieldError.required";
  218.     }

  220.     /**
  221.      * 必須チェックを行う。
  222.      * @return trueの場合、必須エラーでない。
  223.      */
  224.     protected boolean validateForRequired() {

  226.         if(isRequired() && isInputEmpty()) {
  227.             errors.createFieldError(fieldName, getMessageKeyRequired())
  228.                 .address(getPosition())
  229.                 .label(getLabel())
  230.                 .variables("validatedValue", getValue())
  231.                 .buildAndAddError();
  232.             return false;
  233.         }

  235.         return true;

  237.     }

  239.     /**
  240.      * エラーを追加する。
  241.      * @param errorCode エラーコード
  242.      */
  243.     public void rejectValue(final String errorCode) {
  244.         rejectValue(errorCode, Collections.emptyMap());
  245.     }

  247.     /**
  248.      * エラーを追加する
  249.      * @param errorCode エラコード
  250.      * @param variables エラーメッセージ中の変数
  251.      */
  252.     public void rejectValue(final String errorCode, final Map<String, Object> variables) {

  254.         final String codes[] = errors.generateMessageCodes(errorCode, fieldPath, fieldType);

  256.         final FieldError error = new FieldErrorBuilder(errors.getObjectName(), fieldPath, codes)
  257.             .sheetName(errors.getSheetName())
  258.             .rejectedValue(fieldValue)
  259.             .variables(variables)
  260.             .address(position)
  261.             .label(label)
  262.             .build();

  264.         errors.addError(error);
  265.     }

  267.     /**
  268.      * フィールドの値が空かどうか。
  269.      * <p>値がnullまたは、文字列の場合空文字のとき、空と判定する。
  270.      * @return trueの場合、値は空。
  271.      */
  272.     public boolean isInputEmpty() {
  273.         if(fieldValue == null || fieldValue.toString().isEmpty()) {
  274.             return true;
  275.         }

  277.         return false;
  278.     }

  280.     /**
  281.      * フィールドに対してエラーが存在するかどうか。
  282.      * @return trueの場合、エラーが存在する。
  283.      */
  284.     public boolean hasErrors() {
  285.         return errors.hasFieldErrors(fieldName);
  286.     }

  288.     /**
  289.      * フィールドに対してエラーが存在しなかどうか。
  290.      * @return trueの場合、エラーが存在しない。
  291.      */
  292.     public boolean hasNotErrors() {
  293.         return !hasErrors();
  294.     }

  296.     /**
  297.      * エラー情報を取得する。
  298.      * @return エラー情報
  299.      */
  300.     public SheetBindingErrors<?> getBindingErrors() {
  301.         return errors;
  302.     }

  304.     /**
  305.      * フィールドの名称を取得する
  306.      * @return フィールドの名称
  307.      */
  308.     public String getFieldName() {
  309.         return fieldName;
  310.     }

  312.     /**
  313.      * フィールドの値を取得する。
  314.      * @return フィールドの値。
  315.      */
  316.     public T getValue() {
  317.         return fieldValue;
  318.     }

  320.     /**
  321.      * フィールドのクラスタイプを取得する。
  322.      * @return クラスタイプ
  323.      */
  324.     public Class<T> getType() {
  325.         return fieldType;
  326.     }

  328.     /**
  329.      * フィールドのJavaBean上のパスを取得する。
  330.      * @return フィールドのJavaBean上のパス
  331.      */
  332.     public String getFieldPath() {
  333.         return fieldPath;
  334.     }

  336.     /**
  337.      * セルの位置情報を取得します。
  338.      * <p>位置情報の取得用のフィールドやメソッドがbeanに定義されている場合は、コンストラクタの呼び出し時に設定されています。</p>
  339.      * @return 自身のインスタンス。
  340.      */
  341.     public CellPosition getPosition() {
  342.         return position;
  343.     }

  345.     /**
  346.      * セルの位置情報を設定します。
  347.      * @param position セルの位置情報
  348.      */
  349.     public void setPosition(CellPosition position) {
  350.         this.position = position;
  351.     }

  353.     /**
  354.      * セルのラベル情報を取得します。
  355.      * <p>ラベル情報の取得用のフィールドやメソッドがbeanに定義されている場合は、コンストラクタの呼び出し時に設定されています。</p>
  356.      * @return 自身のインスタンス。
  357.      */
  358.     public String getLabel() {
  359.         return label;
  360.     }

  362.     /**
  363.      * セルのラベル情報を設定します。
  364.      * @param label セルのラベル情報
  365.      */
  366.     public void setLabel(String label) {
  367.         this.label = label;
  368.     }

  370.     /**
  371.      * フォーマッタを取得する。
  372.      * @return フォーマッタ。
  373.      *         デフォルトでは、フィールドのクラスタイプ、付与されたアノテーションを元にしたもの。
  374.      *
  375.      */
  376.     public FieldFormatter<T> getFormatter() {
  377.         return formatter;
  378.     }

  380.     /**
  381.      * フォーマッタを設定する。
  382.      * @param formatter
  383.      */
  384.     public void setFormatter(FieldFormatter<T> formatter) {
  385.         this.formatter = formatter;
  386.     }
  387. }
Created with JaCoCo 0.8.5.201910111838