package com.gh.mygreen.xlsmapper;
import java.util.HashMap;
import java.util.Map;
import org.apache.poi.ss.usermodel.Sheet;
import com.gh.mygreen.xlsmapper.annotation.XlsArrayConverter;
import com.gh.mygreen.xlsmapper.annotation.XlsSheet;
import com.gh.mygreen.xlsmapper.cellconvert.CellConverterRegistry;
import com.gh.mygreen.xlsmapper.cellconvert.DefaultItemConverter;
import com.gh.mygreen.xlsmapper.cellconvert.ItemConverter;
import com.gh.mygreen.xlsmapper.expression.CustomFunctions;
import com.gh.mygreen.xlsmapper.expression.ExpressionLanguageJEXLImpl;
import com.gh.mygreen.xlsmapper.fieldprocessor.FieldProcessorRegstry;
import com.gh.mygreen.xlsmapper.validation.MessageInterpolator;
/**
* マッピングする際の設定などを保持するクラス。
*
* @version 1.6
* @author T.TSUCHIE
*
*/
public class XlsMapperConfig {
/** シートが見つからなくても無視するかどうか */
private boolean ignoreSheetNotFound = false;
/** ラベルを正規化するかどうか */
private boolean normalizeLabelText = false;
/** ラベルを正規表現でマッピングするかどうか */
private boolean regexLabelText = false;
/** 型変換エラーが発生しても処理を続けるかどうか */
private boolean continueTypeBindFailure = false;
/** 保存時にセルの結合を行うかどうか */
private boolean mergeCellOnSave = false;
/** 書き込み時に名前の定義範囲を修正するかどうか */
private boolean correctNameRangeOnSave = false;
/** 書き込み時にセルの入力規則を修正するかどうか */
private boolean correctCellDataValidationOnSave = false;
/** 書き込み時にセルのコメントを修正するかどうか */
private boolean correctCellCommentOnSave = false;
/** 書き込み時にセルの結合を修正するかどうか */
private boolean correctMergedCellOnSave = POIUtils.AVAILABLE_METHOD_SHEET_REMOVE_MERGE_REGIONS;
/** 書き込み時に式の再計算をするかどうか */
private boolean formulaRecalcurationOnSave = true;
/** POIのセルの値のフォーマッター */
private CellFormatter cellFormatter = new DefaultCellFormatter();
private FieldProcessorRegstry fieldProcessorRegistry = new FieldProcessorRegstry();
private CellConverterRegistry converterRegistry = new CellConverterRegistry();
/** 読み込み時のBeanのインスタンスの作成クラス */
private FactoryCallback<Class<?>, Object> beanFactory = new DefaultBeanFactory();
/** 処理対象のシートを取得するクラス */
private SheetFinder sheetFinder = new SheetFinder();
/** 単純なクラスオブジェクトの変換するクラス */
private ItemConverter<?> itemConverter = new DefaultItemConverter();
/** 数式をフォーマットするクラス */
private MessageInterpolator formulaFormatter = new MessageInterpolator();
public XlsMapperConfig() {
// 数式をフォーマットする際のEL関数を登録する。
ExpressionLanguageJEXLImpl formulaEL = new ExpressionLanguageJEXLImpl();
Map<String, Object> funcs = new HashMap<>();
funcs.put("x", CustomFunctions.class);
formulaEL.getJexlEngine().setFunctions(funcs);
formulaFormatter.setExpressionLanguage(formulaEL);
}
/**
* 指定したクラスタイプのインスタンスを作成する
* @param clazz
* @return
*/
@SuppressWarnings("unchecked")
public <P> P createBean(final Class<P> clazz) {
return (P) beanFactory.create(clazz);
}
/**
* シートが見つからなくても無視するかどうか。
* @return 初期値は、'false'です。
*/
public boolean isIgnoreSheetNotFound() {
return ignoreSheetNotFound;
}
/**
* シートが見つからなくても無視するかどうか設定します。
* @param ignoreSheetNotFound 初期値は、'false'です。
* @return 自身のインスタンス
*/
public XlsMapperConfig setIgnoreSheetNotFound(boolean ignoreSheetNotFound) {
this.ignoreSheetNotFound = ignoreSheetNotFound;
return this;
}
/**
* ラベルの文字列を空白などを正規化してマッピングするかどうか。
* <p>正規化は、改行コード（{@literal \n},{@literal \r}）の除去、タブ（{@literal \t})、空白（全角、半角）の除去を行います。</p>
* @since 1.1
* @return 初期値は、'false'です。
*/
public boolean isNormalizeLabelText() {
return normalizeLabelText;
}
/**
* ラベルの文字列を空白などを正規化してマッピングするかどうか設定します。
* <p>正規化は、改行コード（{@literal \n},{@literal \r}）の除去、タブ（{@literal \t})、空白（全角、半角）の除去を行います。</p>
* @since 1.1
* @param normalizeLabelText 初期値は、'false'です。
* @return 自身のインスタンス
*/
public XlsMapperConfig setNormalizeLabelText(boolean normalizeLabelText) {
this.normalizeLabelText = normalizeLabelText;
return this;
}
/**
* ラベルを正規表現でマッピングするかどうか。
* <p>ラベルに{@literal /正規表現/}と記述しておくと正規表現でマッピングできる。</p>
* @since 1.1
* @return 初期値は、'false'です。
*/
public boolean isRegexLabelText() {
return regexLabelText;
}
/**
* ラベルを正規表現でマッピングするかどうか設置します。
* <p>ラベルに{@literal /正規表現/}と記述しておくと正規表現でマッピングできる。</p>
* @since 1.1
* @param regexLabelText 正規表現でマッピングするかどうか。
* @return 自身のインスタンス
*/
public XlsMapperConfig setRegexLabelText(boolean regexLabelText) {
this.regexLabelText = regexLabelText;
return this;
}
/**
* 型変換エラーが発生しても処理を続けるかどうか。
* @return 初期値は、'false'です。
*/
public boolean isContinueTypeBindFailure() {
return continueTypeBindFailure;
}
/**
* 型変換エラーが発生しても処理を続けるかどうか。
* @param continueTypeBindFailure 初期値は、'false'です。
* @return
*/
public XlsMapperConfig setContinueTypeBindFailure(boolean continueTypeBindFailure) {
this.continueTypeBindFailure = continueTypeBindFailure;
return this;
}
/**
* 保存時にセルの結合を行うかどうか
* @return 初期値は、'false'です。
*/
public boolean isMergeCellOnSave() {
return mergeCellOnSave;
}
/**
* 保存時にセルの結合を行うかどうか設定します。
* @param mergeCellOnSave 初期値は、'false'です。
* @return 自身のインスタンス
*/
public XlsMapperConfig setMergeCellOnSave(boolean mergeCellOnSave) {
this.mergeCellOnSave = mergeCellOnSave;
return this;
}
/**
* 書き込み時に名前の定義範囲を修正するかどうか
* @since 0.3
* @return 初期値は、'false'です。
*/
public boolean isCorrectNameRangeOnSave() {
return correctNameRangeOnSave;
}
/**
* 書き込み時に名前の定義範囲を修正するかどうか設定します。
* @since 0.3
* @param correctNameRangeOnSave 初期値は、'false'です。
* @return 自身のインスタンス
*/
public XlsMapperConfig setCorrectNameRangeOnSave(boolean correctNameRangeOnSave) {
this.correctNameRangeOnSave = correctNameRangeOnSave;
return this;
}
/**
* 書き込み時にセルの入力規則を修正するかどうか。
* @since 0.3
* @return 初期値は、'false'です。
*/
public boolean isCorrectCellDataValidationOnSave() {
return correctCellDataValidationOnSave;
}
/**
* 書き込み時にセルの入力規則を修正するかどうか。
* <p>trueの場合（修正する場合）、POI-3.11以上が必要になります。
* <p>POI-3.10以前の場合、データの修正は行われません。
* @param correctCellDataValidationOnSave 初期値は、'false'です。
*/
public XlsMapperConfig setCorrectCellDataValidationOnSave(boolean correctCellDataValidationOnSave) {
this.correctCellDataValidationOnSave = correctCellDataValidationOnSave;
return this;
}
/**
* 書き込み時にセルノコメントを修正するかどうか。
* <p>POI-3.10～3.11の場合、コメント付きのシートに対して行を追加すると、ファイルが壊れるため、それらを補正します。
* <p>アノテーション{@literal @XlsHorizontalRecords}で行の追加などを行うときに補正します。
* <p>ただし、この機能を有効にするとシートのセルを全て走査するため処理時間がかかります。
* @return 初期値は、'false'です。
*/
public boolean isCorrectCellCommentOnSave() {
return correctCellCommentOnSave;
}
/**
* 書き込み時にセルのコメントを修正するかどうか設定します。
* <p>'true'の場合、修正します。
* <p>POI-3.10～3.11の場合、コメント付きのシートに対して行を追加すると、ファイルが壊れるため、それらを補正します。
* <p>アノテーション{@literal @XlsHorizontalRecords}で行の追加などを行うときに補正します。
* <p>ただし、この機能を有効にするとシートのセルを全て走査するため処理時間がかかります。
* @param correctCellCommentOnSave 初期値は、'false'です。
* @return 自身のインスタンス
*/
public XlsMapperConfig setCorrectCellCommentOnSave(boolean correctCellCommentOnSave) {
this.correctCellCommentOnSave = correctCellCommentOnSave;
return this;
}
/**
* 書き込み時にセルの結合を修正するか。
* <p>アノテーション{@literal @XlsHorizontalRecords}で行の追加などを行うときに補試します。</p>
* <p>POI-3.15以上の場合の<a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=59740" target="_blank">BUg 59740</a>において、
* 行を挿入する際に、{@link Sheet#shiftRows(int, int, int)}メソッドをでレコードをずらすときにその範囲に結合したセルがあると、
* 自動的に解除されるのを補正します。
* </p>
* @since 1.6
* @return trueのとき、セルノ結合を修正します。
* 初期値は、POI-3.15以上のときtrueとな、POI 3.14以前はfalseになります。
*/
public boolean isCorrectMergedCellOnSave() {
return correctMergedCellOnSave;
}
/**
* 書き込み時にセルの結合を修正するかどうか設定します。
* <p>アノテーション{@literal @XlsHorizontalRecords}で行の追加などを行うときに補試します。</p>
* <p>POI-3.15以上の場合の<a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=59740" target="_blank">BUg 59740</a>において、
* 行を挿入する際に、{@link Sheet#shiftRows(int, int, int)}メソッドをでレコードをずらすときにその範囲に結合したセルがあると、
* 自動的に解除されるのを補正します。
* </p>
* @since 1.6
* @param correctMergedCellOnSave trueの場合、セルの結合を修正します。
* @return 自身のインスタンス
*/
public XlsMapperConfig setCorrectMergedCellOnSave(boolean correctMergedCellOnSave) {
this.correctMergedCellOnSave = correctMergedCellOnSave;
return this;
}
/**
* 書き込み時に式の再計算をするか設定します。
* <p>数式を含むシートを出力したファイルを開いた場合、一般的には数式が開いたときに再計算されます。
* <p>ただし、大量で複雑な数式が記述されていると、パフォーマンスが落ちるため無効にすることもできます。
* @since 1.5
* @return 初期値は、'true'です。
*/
public boolean isFormulaRecalcurationOnSave() {
return formulaRecalcurationOnSave;
}
/**
* 書き込み時に式の再計算をするか設定します。
* <p>数式を含むシートを出力したファイルを開いた場合、一般的には数式が開いたときに再計算されます。
* <p>ただし、大量で複雑な数式が記述されていると、パフォーマンスが落ちるため無効にすることもできます。
* @since 1.5
* @param formulaRecalcurationOnSave
* @return 自身のインスタンス
*/
public XlsMapperConfig setFormulaRecalcurationOnSave(boolean formulaRecalcurationOnSave) {
this.formulaRecalcurationOnSave = formulaRecalcurationOnSave;
return this;
}
/**
* POIのセルのフォーマッターを取得します。
* @return
*/
public CellFormatter getCellFormatter() {
return cellFormatter;
}
/**
* POIのセルのフォーマッターを指定します。
* @param cellFormatter
* @return 自身のインスタンス
*/
public XlsMapperConfig setCellFormatter(CellFormatter cellFormatter) {
this.cellFormatter = cellFormatter;
return this;
}
/**
* セルの値の型変換の管理クラスを取得します。
* @return
*/
public CellConverterRegistry getConverterRegistry() {
return converterRegistry;
}
/**
* セルの値の型変換の管理クラスを設定します。
* @param converterRegistry
* @return 自身のインスタンス
*/
public XlsMapperConfig setConverterRegistry(CellConverterRegistry converterRegistry) {
this.converterRegistry = converterRegistry;
return this;
}
/**
* アノテーションを処理するプロセッサの管理クラスを取得します。
* @return
*/
public FieldProcessorRegstry getFieldProcessorRegistry() {
return fieldProcessorRegistry;
}
/**
* アノテーションを処理するプロセッサの管理クラスを設定します。
* @return 自身のインスタンス
*/
public XlsMapperConfig setFieldProcessorRegistry(FieldProcessorRegstry fieldProcessorRegistry) {
this.fieldProcessorRegistry = fieldProcessorRegistry;
return this;
}
/**
* Beanを生成するためのFactoryクラスを設定します。
* @return
*/
public XlsMapperConfig setBeanFactory(FactoryCallback<Class<?>, Object> beanFactory) {
this.beanFactory = beanFactory;
return this;
}
/**
* Beanを生成するためのFactoryクラスを取得します。
* @since 1.0
* @return
*/
public FactoryCallback<Class<?>, Object> getBeanFactory() {
return beanFactory;
}
/**
* 処理対象のシートを取得するためのクラスを取得します。
* <p>アノテーション{@link XlsSheet} を処理します。
* @since 1.1
* @return 現在設定されいるシートを処理するクラスのインタンス。
*/
public SheetFinder getSheetFinder() {
return sheetFinder;
}
/**
* 処理対象のシートを取得するためのクラスを設定します。
* <p>アノテーション{@link XlsSheet} を処理します。
* @since 1.1
* @param sheetFinder シートを処理するクラスのインタンス。
* @param 自身のインスタンス
*/
public XlsMapperConfig setSheetFinder(SheetFinder sheetFinder) {
this.sheetFinder = sheetFinder;
return this;
}
/**
* 任意のクラス型に変換するクラスを設定します。
* <p>{@link XlsArrayConverter#itemConverterClass()}の処理クラスです。
*
* @since 1.1
* @return
*/
public ItemConverter<?> getItemConverter() {
return itemConverter;
}
/**
* 任意のクラス型に変換するクラスを取得します。
* <p>{@link XlsArrayConverter#itemConverterClass()}の処理クラスです。
* @since 1.1
* @param itemConverter 任意のクラス型に変換するクラス
* @return 自身のインスタンス
*/
public XlsMapperConfig setItemConverter(ItemConverter<?> itemConverter) {
this.itemConverter = itemConverter;
return this;
}
/**
* 数式をフォーマットするためのクラスを取得します。
* <p>出力するセルの数式を設定する際に、独自の変数やEL式を指定したときにフォーマットする際に利用します。
*
* @since 1.5
* @return 数式をフォーマットするクラス。
*/
public MessageInterpolator getFormulaFormatter() {
return formulaFormatter;
}
/**
* 数式をフォーマットするためのクラスを取得します。
* <p>出力するセルの数式を設定する際に、独自の変数やEL式を指定したときにフォーマットする際に利用します。
*
* @since 1.5
* @param formulaFormatter 数式をフォーマットするクラス。
* @return 自身のインスタンス
*/
public XlsMapperConfig setFormulaFormatter(MessageInterpolator formulaFormatter) {
this.formulaFormatter = formulaFormatter;
return this;
}
}