BaseCellConverter (XlsMapper 2.3 API)

java.lang.Object
- com.gh.mygreen.xlsmapper.cellconverter.BaseCellConverter<T>

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

CellConverter<T>, FieldFormatter<T>

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

AbstractDateCellConverter, AbstractNumberCellConverter, AbstractTemporalCellConverter, ArrayCellConverterFactory.ArrayCellConverter, BooleanCellConverterFactory.BooleanCellConverter, CalendarCellConverterFactory.CalendarCellConverter, CellLinkCellConverterFactory.CellLinkCellConverter, CharacterCellConverterFactory.CharacterCellConverter, EnumCellConverterFactory.EnumCellConverter, ListCellConverterFactory.ListCellConverter, SetCellConverterFactory.SetCellConverter, StringCellConverterFactory.StringCellConverter, URICellConverterFactory.URICellConverter
```
public abstract class BaseCellConverter<T>
extends Object
implements CellConverter<T>, FieldFormatter<T>
```
CellConverterを実装するときのベースとなる抽象クラス。通常は、このクラスを継承してCellConverterを実装します。

バージョン:

2.0

作成者:

T.TSUCHIE

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected Configuration`	`configuration` システム設定
`protected OptionalProcessCase<T>`	`defaultValue` 初期値 - 初期値を持たない場合は空
`protected FieldAccessor`	`field` フィールド情報
`protected Optional<CellFormulaHandler>`	`formulaHandler` 書き込み時の数式を設定する
`protected Optional<org.apache.poi.ss.usermodel.HorizontalAlignment>`	`horizontalAlignment` セルの設定 - 横位置
`protected short`	`indent` セルの設定 - インデント
`protected boolean`	`shrinktToFit` セルの設定 - セルを縮小して表示するかどうか
`protected TextFormatter<T>`	`textFormatter` 文字列とオブジェクトを相互変換するフォーマッタ
`protected boolean`	`trimmed` 値をトリムするかどうか
`protected Optional<org.apache.poi.ss.usermodel.VerticalAlignment>`	`verticalAlignment` セルの設定 - 縦位置
`protected boolean`	`wrapText` セルの設定 - 折り返して全体を表示するかどうか

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

コンストラクタ
コンストラクタと説明

BaseCellConverter(FieldAccessor field, Configuration config)

コンストラクタ
コンストラクタと説明
`BaseCellConverter(FieldAccessor field, Configuration config)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`String`	`format(T value)` 値をフォーマットする。
`Configuration`	`getConfiguration()` システム情報を取得します。
`OptionalProcessCase<T>`	`getDefaultValue()` 初期値を取得します。
`FieldAccessor`	`getField()` フィールド情報を取得します。
`Optional<org.apache.poi.ss.usermodel.HorizontalAlignment>`	`getHorizontalAlignment()` セルの設定 - 横位置
`short`	`getIndent()` セルの設定 - インデント
`TextFormatter<T>`	`getTextFormatter()` 文字列とオブジェクトを相互変換するフォーマッタを取得します。
`Optional<org.apache.poi.ss.usermodel.VerticalAlignment>`	`getVerticalAlignment()` セルの設定 - 縦位置
`protected boolean`	`isEmptyCell(String formattedValue, org.apache.poi.ss.usermodel.Cell cell)` セルの値が空かどうか判定します。
`protected boolean`	`isEmptyValue(T obj, Configuration config)` オブジェクトの値を空と判定する
`boolean`	`isShrinktToFit()` セルの設定 - セルを縮小して表示するかどうか。
`boolean`	`isTrimmed()` 値をトリミングするかどうか。
`boolean`	`isWrapText()` セルの設定 - 折り返して全体を表示するかどうか。
`TypeBindException`	`newTypeBindExceptionOnParse(org.apache.poi.ss.usermodel.Cell cell, Object cellValue)` セルの値をパースしセルの値をJavaオブジェクトに型変換するとに失敗したときの例外`TypeBindException`を作成します。
`TypeBindException`	`newTypeBindExceptionOnParse(Exception error, org.apache.poi.ss.usermodel.Cell cell, Object cellValue)` セルの値をパースしJavaオブジェクトに型変換するとこに失敗したときの例外`TypeBindException`を作成します。
`protected abstract T`	`parseCell(org.apache.poi.ss.usermodel.Cell evaluatedCell, String formattedValue)` セルをJavaのオブジェクト型に変換します。
`void`	`setDefaultValue(T defaultValue, ProcessCase[] cases)` 初期値を設定します。
`void`	`setFormulaHandler(CellFormulaHandler formulaHandler)` 数式を処理するハンドラを設定する
`void`	`setHorizontalAlignment(org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlignment)` セルの設定 - 横位置
`void`	`setIndent(short indent)` セルの設定 - インデント
`void`	`setShrinktToFit(boolean shrinktToFit)` セルの設定 - セルを縮小して表示するかどうか設定します。
`void`	`setTextFormatter(TextFormatter<T> textFormatter)` 文字列とオブジェクトを相互変換するフォーマッタを取得します。
`void`	`setTrimmed(boolean trimmed)` 値をトリミングするかどうか設定する
`protected abstract void`	`setupCell(org.apache.poi.ss.usermodel.Cell cell, Optional<T> cellValue)` 書き込み時のセルに値と書式を設定します。
`void`	`setVerticalAlignment(org.apache.poi.ss.usermodel.VerticalAlignment verticalAlignment)` セルの設定 - 縦位置
`void`	`setWrapText(boolean wrapText)` セルの設定 - 折り返して全体を表示するかどうか設定します。
`org.apache.poi.ss.usermodel.Cell`	`toCell(T targetValue, Object targetBean, org.apache.poi.ss.usermodel.Sheet sheet, CellPosition address)` シート書き込み時のJavaオブジェクト => Excel Cellに変換する。
`T`	`toObject(org.apache.poi.ss.usermodel.Cell cell)` シート読み込み時のExcel Cell => Javaオブジェクトに変換する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - field
```
protected final FieldAccessor field
```
    フィールド情報
  - configuration
```
protected final Configuration configuration
```
    システム設定
  - trimmed
```
protected boolean trimmed
```
    値をトリムするかどうか
  - defaultValue
```
protected OptionalProcessCase<T> defaultValue
```
    初期値 - 初期値を持たない場合は空
  - shrinktToFit
```
protected boolean shrinktToFit
```
    セルの設定 - セルを縮小して表示するかどうか
  - wrapText
```
protected boolean wrapText
```
    セルの設定 - 折り返して全体を表示するかどうか
  - indent
```
protected short indent
```
    セルの設定 - インデント
  - horizontalAlignment
```
protected Optional<org.apache.poi.ss.usermodel.HorizontalAlignment> horizontalAlignment
```
    セルの設定 - 横位置
  - verticalAlignment
```
protected Optional<org.apache.poi.ss.usermodel.VerticalAlignment> verticalAlignment
```
    セルの設定 - 縦位置
  - formulaHandler
```
protected Optional<CellFormulaHandler> formulaHandler
```
    書き込み時の数式を設定する
  - textFormatter
```
protected TextFormatter<T> textFormatter
```
    文字列とオブジェクトを相互変換するフォーマッタ
- コンストラクタの詳細
  - BaseCellConverter
```
public BaseCellConverter(FieldAccessor field,
                         Configuration config)
```
- メソッドの詳細
  - toObject
```
public T toObject(org.apache.poi.ss.usermodel.Cell cell)
           throws XlsMapperException
```
    インタフェースからコピーされた説明: CellConverter
    
    シート読み込み時のExcel Cell => Javaオブジェクトに変換する。
    
    定義:
    
    toObject インタフェース内 CellConverter<T>
    
    パラメータ:
    
    cell - 読み込み対象のセル
    
    戻り値:
    
    変換したJavaオブジェクト
    
    例外:
    
    XlsMapperException - 変換に失敗した場合
  - parseCell
```
protected abstract T parseCell(org.apache.poi.ss.usermodel.Cell evaluatedCell,
                               String formattedValue)
                        throws TypeBindException
```
    セルをJavaのオブジェクト型に変換します。
    
    パラメータ:
    
    evaluatedCell - 数式を評価済みのセル
    
    formattedValue - フォーマット済みのセルの値。トリミングなど適用済み。
    
    戻り値:
    
    変換した値を返す。
    
    例外:
    
    TypeBindException - 変換に失敗した場合
  - newTypeBindExceptionOnParse
```
public TypeBindException newTypeBindExceptionOnParse(Exception error,
                                                     org.apache.poi.ss.usermodel.Cell cell,
                                                     Object cellValue)
```
    セルの値をパースしJavaオブジェクトに型変換するとこに失敗したときの例外TypeBindExceptionを作成します。
    
    パラメータ:
    
    error - 例外情報
    
    cell - パースに失敗したセル
    
    cellValue - パースに失敗した値
    
    戻り値:
    
    マッピングに失敗したときの例外のインスタンス
    
    導入されたバージョン:
    
    2.0
  - newTypeBindExceptionOnParse
```
public TypeBindException newTypeBindExceptionOnParse(org.apache.poi.ss.usermodel.Cell cell,
                                                     Object cellValue)
```
    セルの値をパースしセルの値をJavaオブジェクトに型変換するとに失敗したときの例外TypeBindExceptionを作成します。
    
    パラメータ:
    
    cell - パースに失敗したセル
    
    cellValue - パースに失敗した値
    
    戻り値:
    
    マッピングに失敗したときの例外のインスタンス
    
    導入されたバージョン:
    
    2.0
  - isEmptyCell
```
protected boolean isEmptyCell(String formattedValue,
                              org.apache.poi.ss.usermodel.Cell cell)
```
    セルの値が空かどうか判定します。
    読み込み時のセルの値をJavaオブジェクトにマッピングする際に呼ばれます。
    
    通常は、formattedValue.isEmpty() で判定しますが、ハイパーリンクのようにマッピング対象の値がセルの値だけではない場合は、オーバライドして判定方法を変更します。
    
    パラメータ:
    
    formattedValue - フォーマットしたセルの値
    
    cell - 評価対象のセル
    
    戻り値:
    
    trueの場合、空と判定する。
  - toCell
```
public org.apache.poi.ss.usermodel.Cell toCell(T targetValue,
                                               Object targetBean,
                                               org.apache.poi.ss.usermodel.Sheet sheet,
                                               CellPosition address)
                                        throws XlsMapperException
```
    インタフェースからコピーされた説明: CellConverter
    
    シート書き込み時のJavaオブジェクト => Excel Cellに変換する。
    
    定義:
    
    toCell インタフェース内 CellConverter<T>
    
    パラメータ:
    
    targetValue - 書き込み対象のオブジェクト。
    
    targetBean - 書き込み対象のフィールドが設定されているJavaBeanオブジェクト。
    
    sheet - 書き込み先のシート
    
    address - 書き込み先のセルのアドレス
    
    戻り値:
    
    書き込んだセル
    
    例外:
    
    XlsMapperException - 変換に失敗した場合
  - isEmptyValue
```
protected boolean isEmptyValue(T obj,
                               Configuration config)
```
    オブジェクトの値を空と判定する
    
    パラメータ:
    
    obj - 判定対象の値
    
    config - システム情報
    
    戻り値:
    
    trueの場合、空と判定する。
  - setupCell
```
protected abstract void setupCell(org.apache.poi.ss.usermodel.Cell cell,
                                  Optional<T> cellValue)
                           throws TypeBindException
```
    書き込み時のセルに値と書式を設定します。
    
    パラメータ:
    
    cell - 設定対象のセル
    
    cellValue - 設定対象の値。
    
    例外:
    
    TypeBindException - 変換に失敗した場合
  - getField
```
public FieldAccessor getField()
```
    フィールド情報を取得します。
    
    戻り値:
    
    フィールド情報
  - getConfiguration
```
public Configuration getConfiguration()
```
    システム情報を取得します。
    
    戻り値:
    
    システム情報
  - format
```
public String format(T value)
```
    インタフェースからコピーされた説明: FieldFormatter
    
    値をフォーマットする。
    
    定義:
    
    format インタフェース内 FieldFormatter<T>
    
    パラメータ:
    
    value - フォーマット対象の値。nullが渡ってくることもある。
    
    戻り値:
    
    フォーマットした文字列。
  - setTrimmed
```
public void setTrimmed(boolean trimmed)
```
    値をトリミングするかどうか設定する
    
    パラメータ:
    
    trimmed - trueの場合、トリムする。
  - isTrimmed
```
public boolean isTrimmed()
```
    値をトリミングするかどうか。
    
    戻り値:
    
    trueの場合、トリムする。
  - setDefaultValue
```
public void setDefaultValue(T defaultValue,
                            ProcessCase[] cases)
```
    初期値を設定します。
    
    パラメータ:
    
    defaultValue - 初期値となるオブジェクト。
    
    cases - 該当する処理ケース
  - getDefaultValue
```
public OptionalProcessCase<T> getDefaultValue()
```
    初期値を取得します。
    
    戻り値:
    
    設定されていない場合、空を返します。
  - setShrinktToFit
```
public void setShrinktToFit(boolean shrinktToFit)
```
    セルの設定 - セルを縮小して表示するかどうか設定します。
    
    パラメータ:
    
    shrinktToFit - trueの場合、セルを縮小して表示します。
  - isShrinktToFit
```
public boolean isShrinktToFit()
```
    セルの設定 - セルを縮小して表示するかどうか。
    
    戻り値:
    
    trueの場合、セルを縮小して表示します。
  - setWrapText
```
public void setWrapText(boolean wrapText)
```
    セルの設定 - 折り返して全体を表示するかどうか設定します。
    
    パラメータ:
    
    wrapText - trueの場合、折り返して全体を表示します。
  - isWrapText
```
public boolean isWrapText()
```
    セルの設定 - 折り返して全体を表示するかどうか。
    
    戻り値:
    
    trueの場合、折り返して全体を表示します。
  - getIndent
```
public short getIndent()
```
    セルの設定 - インデント
    
    戻り値:
    
    0以上の場合、有効。
  - setIndent
```
public void setIndent(short indent)
```
    セルの設定 - インデント
    
    パラメータ:
    
    indent - 0以上の場合、有効。
  - getHorizontalAlignment
```
public Optional<org.apache.poi.ss.usermodel.HorizontalAlignment> getHorizontalAlignment()
```
    セルの設定 - 横位置
    
    戻り値:
    
    横位置。設定がない場合は空を返す。
  - setHorizontalAlignment
```
public void setHorizontalAlignment(org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlignment)
```
    セルの設定 - 横位置
    
    パラメータ:
    
    horizontalAlignment - 横位置
  - getVerticalAlignment
```
public Optional<org.apache.poi.ss.usermodel.VerticalAlignment> getVerticalAlignment()
```
    セルの設定 - 縦位置
    
    戻り値:
    
    縦位置。設定がない場合は空を返す。
  - setVerticalAlignment
```
public void setVerticalAlignment(org.apache.poi.ss.usermodel.VerticalAlignment verticalAlignment)
```
    セルの設定 - 縦位置
    
    パラメータ:
    
    verticalAlignment - 縦位置
  - setFormulaHandler
```
public void setFormulaHandler(CellFormulaHandler formulaHandler)
```
    数式を処理するハンドラを設定する
    
    パラメータ:
    
    formulaHandler - 数式を処理するハンドラを
  - setTextFormatter
```
public void setTextFormatter(TextFormatter<T> textFormatter)
```
    文字列とオブジェクトを相互変換するフォーマッタを取得します。
    
    パラメータ:
    
    textFormatter - フォーマッタ
  - getTextFormatter
```
public TextFormatter<T> getTextFormatter()
```
    文字列とオブジェクトを相互変換するフォーマッタを取得します。
    
    戻り値:
    
    フォーマッタ

クラス BaseCellConverter<T>

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

field

configuration

trimmed

defaultValue

shrinktToFit

wrapText

indent

horizontalAlignment

verticalAlignment

formulaHandler

textFormatter

コンストラクタの詳細

BaseCellConverter

メソッドの詳細

toObject

parseCell

newTypeBindExceptionOnParse

newTypeBindExceptionOnParse

isEmptyCell

toCell

isEmptyValue

setupCell

getField

getConfiguration

format

setTrimmed

isTrimmed

setDefaultValue

getDefaultValue

setShrinktToFit

isShrinktToFit

setWrapText

isWrapText

getIndent

setIndent

getHorizontalAlignment

setHorizontalAlignment

getVerticalAlignment

setVerticalAlignment

setFormulaHandler

setTextFormatter

getTextFormatter