Configuration.java

  1. package com.gh.mygreen.xlsmapper;

  3. import java.util.Optional;

  5. import com.gh.mygreen.xlsmapper.annotation.XlsSheet;
  6. import com.gh.mygreen.xlsmapper.cellconverter.CellConverterRegistry;
  7. import com.gh.mygreen.xlsmapper.expression.ExpressionLanguageJEXLImpl;
  8. import com.gh.mygreen.xlsmapper.fieldprocessor.FieldProcessorRegistry;
  9. import com.gh.mygreen.xlsmapper.localization.MessageInterpolator;
  10. import com.gh.mygreen.xlsmapper.validation.SheetBindingErrors;
  11. import com.gh.mygreen.xlsmapper.xml.bind.AnnotationMappingInfo;


  14. /**
  15.  * マッピングする際の設定などを保持するクラス。
  16.  *
  17.  * @version 2.1
  18.  * @author T.TSUCHIE
  19.  *
  20.  */
  21. public class Configuration {

  23.     /** シートが見つからなくても無視するかどうか */
  24.     private boolean ignoreSheetNotFound = false;

  26.     /** ラベルを正規化するかどうか */
  27.     private boolean normalizeLabelText = false;

  29.     /** ラベルを正規表現でマッピングするかどうか */
  30.     private boolean regexLabelText = false;

  32.     /** 型変換エラーが発生しても処理を続けるかどうか */
  33.     private boolean continueTypeBindFailure = false;

  35.     /** 書き込み時にセルの結合を行うかどうか */
  36.     private boolean mergeCellOnSave = false;

  38.     /** 書き込み時に名前の定義範囲を修正するかどうか */
  39.     private boolean correctNameRangeOnSave = false;

  41.     /** 書き込み時にセルの入力規則を修正するかどうか */
  42.     private boolean correctCellDataValidationOnSave = false;

  44.     /** 書き込み時に式の再計算をするかどうか */
  45.     private boolean formulaRecalcurationOnSave = true;

  47.     /** 読み込み時にセルの値のキャッシュを行うかどうか */
  48.     private boolean cacheCellValueOnLoad = true;

  50.     /** POIのセルの値のフォーマッター */
  51.     private CellFormatter cellFormatter = new DefaultCellFormatter();

  53.     /** アノテーションを処理するプロセッサの管理クラス */
  54.     private FieldProcessorRegistry fieldProcessorRegistry = new FieldProcessorRegistry();

  56.     /** セルの値の型変換の管理クラス */
  57.     private CellConverterRegistry converterRegistry = new CellConverterRegistry();

  59.     /** 読み込み時のBeanのインスタンスの作成クラス */
  60.     private BeanFactory<Class<?>, Object> beanFactory = new DefaultBeanFactory();

  62.     /** {@link SheetBindingErrors}のインスタンス作成クラス */
  63.     private SheetBindingErrorsFactory bindingErrorsFactory = new SheetBindingErrorsFactory();

  65.     /** 処理対象のシートを取得するクラス */
  66.     private SheetFinder sheetFinder = new SheetFinder();

  68.     /** 数式をフォーマットするクラス */
  69.     private MessageInterpolator formulaFormatter = new MessageInterpolator(new ExpressionLanguageJEXLImpl());
  70.     
  71.     /** セルコメントを操作するクラス */
  72.     private CellCommentOperator commentOperator = new CellCommentOperator();

  74.     /** Beanに対するアノテーションのマッピング情報 */
  75.     private AnnotationMappingInfo annotationMapping = null;
  76.     
  77.     /**
  78.      * 指定したクラスタイプのインスタンスを作成する
  79.      * @param clazz
  80.      * @return
  81.      */
  82.     @SuppressWarnings("unchecked")
  83.     public <P> P createBean(final Class<P> clazz) {
  84.         return (P) beanFactory.create(clazz);
  85.     }

  87.     /**
  88.      * シートが見つからなくても無視するかどうか。
  89.      * @return 初期値は、'false'です。
  90.      */
  91.     public boolean isIgnoreSheetNotFound() {
  92.         return ignoreSheetNotFound;
  93.     }

  95.     /**
  96.      * シートが見つからなくても無視するかどうか設定します。
  97.      * @param ignoreSheetNotFound 初期値は、'false'です。
  98.      * @return 自身のインスタンス
  99.      */
  100.     public Configuration setIgnoreSheetNotFound(boolean ignoreSheetNotFound) {
  101.         this.ignoreSheetNotFound = ignoreSheetNotFound;
  102.         return this;
  103.     }

  105.     /**
  106.      * ラベルの文字列を空白などを正規化してマッピングするかどうか。
  107.      * <p>正規化は、改行コード（{@literal \n},{@literal \r}）の除去、タブ（{@literal \t})、空白（全角、半角）の除去を行います。</p>
  108.      * @since 1.1
  109.      * @return 初期値は、'false'です。
  110.      */
  111.     public boolean isNormalizeLabelText() {
  112.         return normalizeLabelText;
  113.     }

  115.     /**
  116.      * ラベルの文字列を空白などを正規化してマッピングするかどうか設定します。
  117.      * <p>正規化は、改行コード（{@literal \n},{@literal \r}）の除去、タブ（{@literal \t})、空白（全角、半角）の除去を行います。</p>
  118.      * @since 1.1
  119.      * @param normalizeLabelText 初期値は、'false'です。
  120.      * @return 自身のインスタンス
  121.      */
  122.     public Configuration setNormalizeLabelText(boolean normalizeLabelText) {
  123.         this.normalizeLabelText = normalizeLabelText;
  124.         return this;
  125.     }

  127.     /**
  128.      * ラベルを正規表現でマッピングするかどうか。
  129.      * <p>ラベルに{@literal /正規表現/}と記述しておくと正規表現でマッピングできる。</p>
  130.      * @since 1.1
  131.      * @return 初期値は、'false'です。
  132.      */
  133.     public boolean isRegexLabelText() {
  134.         return regexLabelText;
  135.     }

  137.     /**
  138.      * ラベルを正規表現でマッピングするかどうか設置します。
  139.      * <p>ラベルに{@literal /正規表現/}と記述しておくと正規表現でマッピングできる。</p>
  140.      * @since 1.1
  141.      * @param regexLabelText 正規表現でマッピングするかどうか。
  142.      * @return 自身のインスタンス
  143.      */
  144.     public Configuration setRegexLabelText(boolean regexLabelText) {
  145.         this.regexLabelText = regexLabelText;
  146.         return this;
  147.     }

  149.     /**
  150.      * 型変換エラーが発生しても処理を続けるかどうか。
  151.      * @return 初期値は、'false'です。
  152.      */
  153.     public boolean isContinueTypeBindFailure() {
  154.         return continueTypeBindFailure;
  155.     }

  157.     /**
  158.      * 型変換エラーが発生しても処理を続けるかどうか。
  159.      * @param continueTypeBindFailure 初期値は、'false'です。
  160.      * @return
  161.      */
  162.     public Configuration setContinueTypeBindFailure(boolean continueTypeBindFailure) {
  163.         this.continueTypeBindFailure = continueTypeBindFailure;
  164.         return this;
  165.     }

  167.     /**
  168.      * 書き込み時にセルの結合を行うかどうか
  169.      * @return 初期値は、'false'です。
  170.      */
  171.     public boolean isMergeCellOnSave() {
  172.         return mergeCellOnSave;
  173.     }

  175.     /**
  176.      * 書き込み時にセルの結合を行うかどうか設定します。
  177.      * @param mergeCellOnSave 初期値は、'false'です。
  178.      * @return 自身のインスタンス
  179.      */
  180.     public Configuration setMergeCellOnSave(boolean mergeCellOnSave) {
  181.         this.mergeCellOnSave = mergeCellOnSave;
  182.         return this;
  183.     }

  185.     /**
  186.      * 書き込み時に名前の定義範囲を修正するかどうか
  187.      * @since 0.3
  188.      * @return 初期値は、'false'です。
  189.      */
  190.     public boolean isCorrectNameRangeOnSave() {
  191.         return correctNameRangeOnSave;
  192.     }

  194.     /**
  195.      * 書き込み時に名前の定義範囲を修正するかどうか設定します。
  196.      * @since 0.3
  197.      * @param correctNameRangeOnSave 初期値は、'false'です。
  198.      * @return 自身のインスタンス
  199.      */
  200.     public Configuration setCorrectNameRangeOnSave(boolean correctNameRangeOnSave) {
  201.         this.correctNameRangeOnSave = correctNameRangeOnSave;
  202.         return this;
  203.     }

  205.     /**
  206.      * 書き込み時にセルの入力規則を修正するかどうか。
  207.      * @since 0.3
  208.      * @return 初期値は、'false'です。
  209.      */
  210.     public boolean isCorrectCellDataValidationOnSave() {
  211.         return correctCellDataValidationOnSave;
  212.     }

  214.     /**
  215.      * 書き込み時にセルの入力規則を修正するかどうか。
  216.      * <p>trueの場合（修正する場合）、POI-3.11以上が必要になります。
  217.      * <p>POI-3.10以前の場合、データの修正は行われません。
  218.      * @param correctCellDataValidationOnSave 初期値は、'false'です。
  219.      */
  220.     public Configuration setCorrectCellDataValidationOnSave(boolean correctCellDataValidationOnSave) {
  221.         this.correctCellDataValidationOnSave = correctCellDataValidationOnSave;
  222.         return this;
  223.     }

  225.      /**
  226.      * 書き込み時に式の再計算をするか設定します。
  227.      * <p>数式を含むシートを出力したファイルを開いた場合、一般的には数式が開いたときに再計算されます。
  228.      * <p>ただし、大量で複雑な数式が記述されていると、パフォーマンスが落ちるため無効にすることもできます。
  229.      * @since 1.5
  230.      * @return 初期値は、'true'です。
  231.      */
  232.     public boolean isFormulaRecalcurationOnSave() {
  233.         return formulaRecalcurationOnSave;
  234.     }

  236.     /**
  237.      * 書き込み時に式の再計算をするか設定します。
  238.      * <p>数式を含むシートを出力したファイルを開いた場合、一般的には数式が開いたときに再計算されます。
  239.      * <p>ただし、大量で複雑な数式が記述されていると、パフォーマンスが落ちるため無効にすることもできます。
  240.      * @since 1.5
  241.      * @param formulaRecalcurationOnSave
  242.      * @return 自身のインスタンス
  243.      */
  244.     public Configuration setFormulaRecalcurationOnSave(boolean formulaRecalcurationOnSave) {
  245.         this.formulaRecalcurationOnSave = formulaRecalcurationOnSave;
  246.         return this;
  247.     }

  249.     /**
  250.      * 読み込み時にセルの値のキャッシュを行うかどうか設定します。
  251.      * @since 2.0
  252.      * @return true 初期値は、'true'です。
  253.      */
  254.     public boolean isCacheCellValueOnLoad() {
  255.         return cacheCellValueOnLoad;
  256.     }

  258.     /**
  259.      * 読み込み時にセルの値のキャッシュを行うかどうか設定します。
  260.      * @since 2.0
  261.      * @param cacheCellValueOnLoad trueのときキャッシュを行います。
  262.      */
  263.     public Configuration setCacheCellValueOnLoad(boolean cacheCellValueOnLoad) {
  264.         this.cacheCellValueOnLoad = cacheCellValueOnLoad;
  265.         return this;
  266.     }

  268.     /**
  269.      * POIのセルのフォーマッターを取得します。
  270.      * @return セルのフォーマッタ。
  271.      */
  272.     public CellFormatter getCellFormatter() {
  273.         return cellFormatter;
  274.     }

  276.     /**
  277.      * POIのセルのフォーマッターを指定します。
  278.      * @param cellFormatter セルのフォーマッタ
  279.      * @return 自身のインスタンス
  280.      */
  281.     public Configuration setCellFormatter(CellFormatter cellFormatter) {
  282.         this.cellFormatter = cellFormatter;
  283.         return this;
  284.     }

  286.     /**
  287.      * セルの値の型変換の管理クラスを取得します。
  288.      * @return
  289.      */
  290.     public CellConverterRegistry getConverterRegistry() {
  291.         return converterRegistry;
  292.     }

  294.     /**
  295.      * セルの値の型変換の管理クラスを設定します。
  296.      * @param converterRegistry
  297.      * @return 自身のインスタンス
  298.      */
  299.     public Configuration setConverterRegistry(CellConverterRegistry converterRegistry) {
  300.         this.converterRegistry = converterRegistry;
  301.         return this;
  302.     }

  304.     /**
  305.      * アノテーションを処理するプロセッサの管理クラスを取得します。
  306.      * @return
  307.      */
  308.     public FieldProcessorRegistry getFieldProcessorRegistry() {
  309.         return fieldProcessorRegistry;
  310.     }

  312.     /**
  313.      * アノテーションを処理するプロセッサの管理クラスを設定します。
  314.      * @return 自身のインスタンス
  315.      */
  316.     public Configuration setFieldProcessorRegistry(FieldProcessorRegistry fieldProcessorRegistry) {
  317.         this.fieldProcessorRegistry = fieldProcessorRegistry;
  318.         return this;
  319.     }

  321.     /**
  322.      * Beanを生成するためのFactoryクラスを設定します。
  323.      * @return
  324.      */
  325.     public Configuration setBeanFactory(BeanFactory<Class<?>, Object> beanFactory) {
  326.         this.beanFactory = beanFactory;
  327.         return this;
  328.     }

  330.     /**
  331.      * Beanを生成するためのFactoryクラスを取得します。
  332.      * @since 1.0
  333.      * @return
  334.      */
  335.     public BeanFactory<Class<?>, Object> getBeanFactory() {
  336.         return beanFactory;
  337.     }

  339.     /**
  340.      * {@link SheetBindingErrors}を生成するためのFactoryクラスを取得します。
  341.      * @since 2.0
  342.      * @return
  343.      */
  344.     public SheetBindingErrorsFactory getBindingErrorsFactory() {
  345.         return bindingErrorsFactory;
  346.     }

  348.     /**
  349.      * {@link SheetBindingErrors}を生成するためのFactoryクラスを設定します。
  350.      * @since 2.0
  351.      * @param bindingErrorsFactory
  352.      */
  353.     public void setBindingErrorsFactory(SheetBindingErrorsFactory bindingErrorsFactory) {
  354.         this.bindingErrorsFactory = bindingErrorsFactory;
  355.     }

  357.     /**
  358.      * 処理対象のシートを取得するためのクラスを取得します。
  359.      * <p>アノテーション{@link XlsSheet} を処理します。
  360.      * @since 1.1
  361.      * @return 現在設定されいるシートを処理するクラスのインタンス。
  362.      */
  363.     public SheetFinder getSheetFinder() {
  364.         return sheetFinder;
  365.     }

  367.     /**
  368.      * 処理対象のシートを取得するためのクラスを設定します。
  369.      * <p>アノテーション{@link XlsSheet} を処理します。
  370.      * @since 1.1
  371.      * @param sheetFinder シートを処理するクラスのインタンス。
  372.      * @return 自身のインスタンス
  373.      */
  374.     public Configuration setSheetFinder(SheetFinder sheetFinder) {
  375.         this.sheetFinder = sheetFinder;
  376.         return this;
  377.     }

  379.     /**
  380.      * 数式をフォーマットするためのクラスを取得します。
  381.      * <p>出力するセルの数式を設定する際に、独自の変数やEL式を指定したときにフォーマットする際に利用します。
  382.      *
  383.      * @since 1.5
  384.      * @return 数式をフォーマットするクラス。
  385.      */
  386.     public MessageInterpolator getFormulaFormatter() {
  387.         return formulaFormatter;
  388.     }

  390.     /**
  391.      * 数式をフォーマットするためのクラスを取得します。
  392.      * <p>出力するセルの数式を設定する際に、独自の変数やEL式を指定したときにフォーマットする際に利用します。
  393.      *
  394.      * @since 1.5
  395.      * @param formulaFormatter 数式をフォーマットするクラス。
  396.      * @return 自身のインスタンス
  397.      */
  398.     public Configuration setFormulaFormatter(MessageInterpolator formulaFormatter) {
  399.         this.formulaFormatter = formulaFormatter;
  400.         return this;
  401.     }

  403.     /**
  404.      * アノテーションのマッピング情報を取得する。
  405.      * @since 2.0
  406.      * @return 設定されていない場合は、空を返す。
  407.      */
  408.     public Optional<AnnotationMappingInfo> getAnnotationMapping() {
  409.         return Optional.ofNullable(annotationMapping);
  410.     }

  412.     /**
  413.      * アノテーションのマッピング情報を設定します。
  414.      * @since 2.0
  415.      * @param annotationMapping アノテーションの設定情報
  416.      */
  417.     public void setAnnotationMapping(AnnotationMappingInfo annotationMapping) {
  418.         this.annotationMapping = annotationMapping;
  419.     }

  421.     /**
  422.      * セルコメントを操作するクラスを取得します。
  423.      * @since 2.1
  424.      * @return セルコメントを操作するクラス
  425.      */
  426.     public CellCommentOperator getCommentOperator() {
  427.         return commentOperator;
  428.     }

  430.     /**
  431.      * セルコメントを操作するクラスを設定します。
  432.      * @since 2.1
  433.      * @param commentOperator セルコメントを操作するクラス
  434.      * @return 自身のインスタンス
  435.      */
  436.     public Configuration setCommentOperator(CellCommentOperator commentOperator) {
  437.         this.commentOperator = commentOperator;
  438.         return this;
  439.     }

  441. }
Created with JaCoCo 0.8.5.201910111838