com.github.mygreen.cellformatter

クラス JXLCellFormatter

java.lang.Object

com.github.mygreen.cellformatter.JXLCellFormatter

public class JXLCellFormatter
extends Object

JExcel APIのセルのフォーマッタ。

基本的な使い方

JXLCellFormatterのインスタンスを生成して利用します。

• 結果を単純に文字列で取得したい場合は、formatAsString(Cell, boolean)を利用します。
• Excelには、日時が1900年始まりか1904年始まりかの情報をもっており、その判定結果を渡す必要があります。
  1904年始まりかの判定は、JXLUtils.isDateStart1904(jxl.Sheet)やJXLUtils.isDateStart1904(jxl.Workbook)で判定します。
• フォーマット対象のセルの値や書式に適用された文字色などを取得したい場合は、 format(Cell, boolean)の結果であるCellFormatResultから取得します。
• 書式「m/d/yy」など、実行環境の言語設定によって切り替わるような場合は、 formatAsString(Cell, Locale, boolean)でロケールを直接指定します。

 // シートの読み込み
 final WorkbookSettings settings = new WorkbookSettings();
 settings.setSuppressWarnings(true);
 settings.setGCDisabled(true);
 
 // 文字コードを「ISO8859_1」にしないと、会計の記号が文字化けする
 settings.setEncoding("ISO8859_1");
 
 final Workbook workbook = Workbook.getWorkbook(in, settings);
 
 // 基本的な使い方。
 JXLCellFormatter cellFormatter = new JXLCellFormatter();
 
 // 1904年始まりかの判定
 boolean startDate1904 = JXLUtils.isDateStart1904(workbook);
 
 Cell cell = // セルの取得
 String text1 = cellForrmatter.formatAsString(cell, startDate1904);
 
 // ロケールに依存する書式の場合
 String text2 = cellForrmatter.formatAsString(cell, Locale.US, startDate1904);

 // 文字色の条件が設定されている場合
 CellFormatResult result = cellForrmatter.format(cell);
 String text3 = result.getText(); // フォーマット結果の文字列
 MSColor textColor = result.getTextColor(); // 書式の文字色
 

注意事項

• 日本語を含むExcelファイルの場合、文字コードを「ISO8859_1」 を指定します。
  指定しない場合は、会計の書式中の円記号 ￥ が文字化けします。
  「Windows-31j」と指定しても文字化けするため、注意してください。

導入されたバージョン:

0.4

バージョン:

0.6

作成者:

T.TSUCHIE

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
CellFormatResult	format(Cell cell, boolean isStartDate1904) セルの値をフォーマットする。
CellFormatResult	format(Cell cell, Locale locale, boolean isStartDate1904) ロケールを指定してセルの値をフォーマットする。
String	formatAsString(Cell cell, boolean isStartDate1904) セルの値をフォーマットし、文字列として取得する
String	formatAsString(Cell cell, Locale locale, boolean isStartDate1904) ロケールを指定してセルの値をフォーマットし、文字列として取得する
FormatterResolver	getFormatterResolver() FormatterResolverを取得する。
boolean	isCache() パースしたフォーマッタをキャッシュするかどうか。
boolean	isErrorCellAsEmpty() エラーセルの値を空文字として取得するかどうか。
void	setCache(boolean cache) パースしたフォーマッタをキャッシュするかどうか設定する。
void	setErrorCellAsEmpty(boolean errorCellAsEmpty) エラーセルの値を空文字として取得するかどうか設定する。
void	setFormatterResolver(FormatterResolver formatterResolver) FormatterResolverを設定する。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

JXLCellFormatter

public JXLCellFormatter()

メソッドの詳細

formatAsString

public String formatAsString(Cell cell,
                             boolean isStartDate1904)

セルの値をフォーマットし、文字列として取得する

パラメータ:

cell - フォーマット対象のセル

isStartDate1904 - ファイルの設定が1904年始まりかどうか。 JXLUtils.isDateStart1904(jxl.Sheet)で値を調べます。

戻り値:

フォーマットしたセルの値。

例外:

IllegalArgumentException - cell is null.

formatAsString

public String formatAsString(Cell cell,
                             Locale locale,
                             boolean isStartDate1904)

ロケールを指定してセルの値をフォーマットし、文字列として取得する

パラメータ:

cell - フォーマット対象のセル

locale - フォーマットしたロケール。nullでも可能。 ロケールに依存する場合、指定したロケールにより自動的に切り替わります。

isStartDate1904 - ファイルの設定が1904年始まりかどうか。 JXLUtils.isDateStart1904(jxl.Sheet)で値を調べます。

戻り値:

フォーマットしたセルの値。

例外:

IllegalArgumentException - cell is null.

format

public CellFormatResult format(Cell cell,
                               boolean isStartDate1904)

セルの値をフォーマットする。

パラメータ:

cell - フォーマット対象のセル

isStartDate1904 - ファイルの設定が1904年始まりかどうか。 JXLUtils.isDateStart1904(jxl.Sheet)で値を調べます。

戻り値:

フォーマットしたセルの値。

例外:

IllegalArgumentException - cell is null.

導入されたバージョン:

0.3

format

public CellFormatResult format(Cell cell,
                               Locale locale,
                               boolean isStartDate1904)

ロケールを指定してセルの値をフォーマットする。

パラメータ:

cell - フォーマット対象のセル

locale - フォーマットしたロケール。nullでも可能。 ロケールに依存する場合、指定したロケールにより自動的に切り替わります。

isStartDate1904 - ファイルの設定が1904年始まりかどうか。 JXLUtils.isDateStart1904(jxl.Sheet)で値を調べます。

戻り値:

フォーマットしたセルの値。

例外:

IllegalArgumentException - cell is 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