POICellFormatter (Excel-CellFormatter 0.12 API)

java.lang.Object
- com.github.mygreen.cellformatter.POICellFormatter

```
public class POICellFormatter
extends Object
```
Apache POIのセルの値を文字列として取得するためのクラス。
基本的な使い方

POICellFormatterのインスタンスを生成して利用します。
- 結果を単純に文字列で取得したい場合は、formatAsString(Cell)を利用します。
- フォーマット対象のセルの値や書式に適用された文字色などを取得したい場合は、 format(Cell)の結果であるCellFormatResultから取得します。
- 書式「m/d/yy」など、実行環境の言語設定によって切り替わるような場合は、 formatAsString(Cell, Locale)でロケールを直接指定します。
```
 POICellFormatter  cellFormatter = new POICellFormatter ();

 Cell cell = // セルの取得
 String text1 = cellForrmatter.formatAsString(cell);

 // ロケールに依存する書式の場合
 String text2 = cellForrmatter.formatAsString(cell, Locale.US);

 // 文字色の条件が設定されている場合
 CellFormatResult result = cellForrmatter.format(cell);
 String text3 = result.getText(); // フォーマット結果の文字列
 MSColor textColor = result.getTextColor(); // 書式の文字色
 
```
注意事項
- Cellのインスタンスがnullの場合、空（Blank）セルとして扱います。
  POIの場合、データの入力がない領域のセルは、nullとなるためです。
- 結合されたセルの場合、結合領域を走査し、非空セルがそのセルの値を評価します。
  POIの場合、結合されたセルの領域は、基本的に左上のセルに値が設定され、それ以外のセルは空セルとなるためです。
- 数式や関数が設定されたセルの場合、それらを評価した結果を返します。
  POIが対応していない数式や関数の場合、Excel上では正しく表示されていても、エラーセルの扱いとなります。
  使用するPOIのバージョンによって対応する関数も異なります。
バージョン:

0.8.3

作成者:

T.TSUCHIE

関連項目:

ひしだま's 技術メモページ - Apache POI Cell : Cellの値の取得, POIでセルの値をとるのは大変　日付編

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

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

POICellFormatter()

コンストラクタ
コンストラクタと説明
`POICellFormatter()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`CellFormatResult`	`format(Cell cell)` セルの値を取得する
`CellFormatResult`	`format(Cell cell, Locale locale)` ロケールを指定してセルの値を取得する
`String`	`formatAsString(Cell cell)` セルの値を文字列として取得する
`String`	`formatAsString(Cell cell, Locale locale)` ロケールを指定してセルの値を文字列として取得する
`FormatterResolver`	`getFormatterResolver()` `FormatterResolver`を取得する。
`boolean`	`isCache()` パースしたフォーマッタをキャッシュするかどうか。
`boolean`	`isConsiderMergedCell()` 結合されたセルを考慮するかどうか。
`boolean`	`isErrorCellAsEmpty()` エラーセルの値を空文字として取得するかどうか。
`boolean`	`isThrowFailEvaluateFormula()` 式を評価する際に失敗したときに、例外`FormulaEvaluateException`をスローするかどうか。
`void`	`setCache(boolean cache)` パースしたフォーマッタをキャッシュするかどうか設定する。
`void`	`setConsiderMergedCell(boolean considerMergedCell)` 結合されたセルを考慮するかどうか。
`void`	`setErrorCellAsEmpty(boolean errorCellAsEmpty)` エラーセルの値を空文字として取得するかどうか設定する。
`void`	`setFormatterResolver(FormatterResolver formatterResolver)` `FormatterResolver`を設定する。
`void`	`setThrowFailEvaluateFormula(boolean throwFailEvaluateFormula)` 式を評価する際に失敗したときに、例外`FormulaEvaluateException`をスローするかどうか設定する。

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

- コンストラクタの詳細
  - POICellFormatter
```
public POICellFormatter()
```
- メソッドの詳細
  - formatAsString
```
public String formatAsString(Cell cell)
```
    セルの値を文字列として取得する
    
    パラメータ:
    
    cell - 取得対象のセル
    
    戻り値:
    
    フォーマットしたセルの値。 cellがnullの場合、空文字を返す。
  - formatAsString
```
public String formatAsString(Cell cell,
                             Locale locale)
```
    ロケールを指定してセルの値を文字列として取得する
    
    パラメータ:
    
    cell - フォーマット対象のセル
    
    locale - locale フォーマットしたロケール。nullでも可能。ロケールに依存する場合、指定したロケールにより自動的に切り替わります。
    
    戻り値:
    
    フォーマットした文字列。cellがnullの場合、空文字を返す。
  - format
```
public CellFormatResult format(Cell cell)
```
    セルの値を取得する
    
    パラメータ:
    
    cell - フォーマット対象のセル
    
    戻り値:
    
    フォーマット結果。cellがnullの場合、空セルとして値を返す。
    
    導入されたバージョン:
    
    0.3
  - format
```
public CellFormatResult format(Cell cell,
                               Locale locale)
```
    ロケールを指定してセルの値を取得する
    
    パラメータ:
    
    cell - フォーマット対象のセル
    
    locale - locale フォーマットしたロケール。nullでも可能。ロケールに依存する場合、指定したロケールにより自動的に切り替わります。
    
    戻り値:
    
    フォーマット結果。cellがnullの場合、空セルとして値を返す。
    
    導入されたバージョン:
    
    0.3
  - getFormatterResolver
```
public FormatterResolver getFormatterResolver()
```
    FormatterResolverを取得する。
    
    戻り値:
  - setFormatterResolver
```
public void setFormatterResolver(FormatterResolver formatterResolver)
```
    FormatterResolverを設定する。独自のものに入れ替える際に利用します。
    
    パラメータ:
    
    formatterResolver -
  - isCache
```
public boolean isCache()
```
    パースしたフォーマッタをキャッシュするかどうか。初期値はtrueです。
    
    戻り値:
  - setCache
```
public void setCache(boolean cache)
```
    パースしたフォーマッタをキャッシュするかどうか設定する。
    
    パラメータ:
    
    cache - true:キャッシュする。
  - isErrorCellAsEmpty
```
public boolean isErrorCellAsEmpty()
```
    エラーセルの値を空文字として取得するかどうか。初期値はfalseです。
    
    戻り値:
    
    導入されたバージョン:
    
    0.4
  - setErrorCellAsEmpty
```
public void setErrorCellAsEmpty(boolean errorCellAsEmpty)
```
    エラーセルの値を空文字として取得するかどうか設定する。
    
    パラメータ:
    
    errorCellAsEmpty - true:空文字として取得する。
    
    導入されたバージョン:
    
    0.4
  - isThrowFailEvaluateFormula
```
public boolean isThrowFailEvaluateFormula()
```
    式を評価する際に失敗したときに、例外FormulaEvaluateExceptionをスローするかどうか。
    初期値はfalseで、式の評価に失敗したときは、エラーセルとして扱われます。
    
    戻り値:
    
    true: 例外をスローする。
    
    導入されたバージョン:
    
    0.7
  - setThrowFailEvaluateFormula
```
public void setThrowFailEvaluateFormula(boolean throwFailEvaluateFormula)
```
    式を評価する際に失敗したときに、例外FormulaEvaluateExceptionをスローするかどうか設定する。
    
    パラメータ:
    
    throwFailEvaluateFormula - true: 例外をスローする。
    
    導入されたバージョン:
    
    0.7
  - isConsiderMergedCell
```
public boolean isConsiderMergedCell()
```
    結合されたセルを考慮するかどうか。
    POIの場合、結合されている領域は、左上のセル以外はブランクセルとなるため、値が設定してあるセルを操作する必要がある。
    初期値はtrueで、ブランクセルを結合セルと見なして処理を行います。
    
    戻り値:
    
    true: 結合セルを考慮する。
    
    導入されたバージョン:
    
    0.7
  - setConsiderMergedCell
```
public void setConsiderMergedCell(boolean considerMergedCell)
```
    結合されたセルを考慮するかどうか。
    POIの場合、結合されている領域は、左上のセル以外はブランクセルとなるため、値が設定してあるセルを走査する必要がある。
    
    パラメータ:
    
    considerMergedCell - true:結合セルを考慮して処理を行う。
    
    導入されたバージョン:
    
    0.7

クラス POICellFormatter

基本的な使い方

注意事項

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

メソッドのサマリー

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

コンストラクタの詳細

POICellFormatter

メソッドの詳細

formatAsString

formatAsString

format

format

getFormatterResolver

setFormatterResolver

isCache

setCache

isErrorCellAsEmpty

setErrorCellAsEmpty

isThrowFailEvaluateFormula

setThrowFailEvaluateFormula

isConsiderMergedCell

setConsiderMergedCell