com.github.mygreen.cellformatter

クラス ObjectCellFormatter

java.lang.Object

com.github.mygreen.cellformatter.ObjectCellFormatter

public class ObjectCellFormatter
extends Object

Javaのオブジェクト型を直接フォーマットするクラス。

Excelの基本型である「文字列型」「ブール型」「数値型」「日付型」の4つをサポートします。

数値型については、JavaのNumberを継承している標準クラスに対応しています。

• プリミティブ型：byte/shrot/int/long/float/double
• ラッパークラス：Byte/Short/Integer/Long/Float/Double
• その他：AtomicInteger/AtomicLong/BigDecimal/BigInteger

 // 基本的な使い方。
 ObjectCellFormatter cellFormatter = new ObjectCellFormatter();
 Date date = Timestamp.valueOf("2012-02-01 12:10:00.000");
 
 // 各型に対応したインタフェースを利用します。
 String text = cellFormatter.formatAsString("yyyy\"年\"m\"月\"d\"日\";@", date);
 
 // 細かく指定したい場合。
 // 仮想的なセルのクラス「ObejctCell」の、型に合った具象クラスを利用します。
 ObejctCell cell = new DateCell(date, "yyyy\"年\"m\"月\"d\"日\";@", false)
 CellFormatResult result = cellFormatter.format(cell);
 String text = result.getText(); // フォーマットした文字列の取得
 MSColor color = result.getTextColor(); // 文字色が設定されている場合、その色の取得。
 

導入されたバージョン:

0.6

作成者:

T.TSUCHIE

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
CellFormatResult	format(ObjectCell<?> cell) 値をフォーマットする。
CellFormatResult	format(ObjectCell<?> cell, Locale locale) 値をフォーマットする。
CellFormatResult	format(String formatPattern, boolean value) ロケールを指定して、ブール型をフォーマットする。
CellFormatResult	format(String formatPattern, boolean value, Locale locale) ブール型をフォーマットする。
CellFormatResult	format(String formatPattern, Date value) ロケールを指定して、日付型をフォーマットする。
CellFormatResult	format(String formatPattern, Date value, Locale locale) 日付型をフォーマットする。
<N extends Number> CellFormatResult	format(String formatPattern, N value) ロケールを指定して、数値型をフォーマットする。
<N extends Number> CellFormatResult	format(String formatPattern, N value, Locale locale) 数値列型をフォーマットする。
CellFormatResult	format(String formatPattern, String value) 文字列型をフォーマットする。
CellFormatResult	format(String formatPattern, String value, Locale locale) ロケールを指定して、文字列型をフォーマットする。
String	formatAsString(ObjectCell<?> cell) セルの値を文字列として取得する。
String	formatAsString(ObjectCell<?> cell, Locale locale) ロケールを指定してセルの値を文字列として取得する
String	formatAsString(String formatPattern, boolean value) ロケールを指定して、ブール型をフォーマットし、結果を直接文字列として取得する。
String	formatAsString(String formatPattern, boolean value, Locale locale) ブール型をフォーマットし、結果を直接文字列として取得する。
String	formatAsString(String formatPattern, Date value) ロケールを指定して、日付型をフォーマットし、結果を直接文字列として取得する。
String	formatAsString(String formatPattern, Date value, Locale locale) 日付型をフォーマットし、結果を直接文字列として取得する。
<N extends Number> String	formatAsString(String formatPattern, N value) ロケールを指定して、数値型をフォーマットし、結果を直接文字列として取得する。
<N extends Number> String	formatAsString(String formatPattern, N value, Locale locale) 数値型をフォーマットし、結果を直接文字列として取得する。
String	formatAsString(String formatPattern, String value) 文字列型をフォーマットし、結果を直接文字列として取得する。
String	formatAsString(String formatPattern, String value, Locale locale) ロケールを指定して、文字列型をフォーマットし、結果を直接文字列として取得する。
FormatterResolver	getFormatterResolver() FormatterResolverを取得する。
boolean	isCache() パースしたフォーマッタをキャッシュするかどうか。
void	setCache(boolean cache) パースしたフォーマッタをキャッシュするかどうか設定する。
void	setFormatterResolver(FormatterResolver formatterResolver) FormatterResolverを設定する。

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

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

コンストラクタの詳細

ObjectCellFormatter

public ObjectCellFormatter()

メソッドの詳細

formatAsString

public String formatAsString(String formatPattern,
                             String value)

文字列型をフォーマットし、結果を直接文字列として取得する。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果の文字列。

format

public CellFormatResult format(String formatPattern,
                               String value)

文字列型をフォーマットする。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果。

formatAsString

public String formatAsString(String formatPattern,
                             String value,
                             Locale locale)

ロケールを指定して、文字列型をフォーマットし、結果を直接文字列として取得する。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

locale - ロケール。書式にロケール条件の記述（例. [$-403]）が含まれている場合は、書式のロケールが優先されます。

戻り値:

フォーマットした結果の文字列。

format

public CellFormatResult format(String formatPattern,
                               String value,
                               Locale locale)

ロケールを指定して、文字列型をフォーマットする。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

locale - ロケール。書式にロケール条件の記述（例. [$-403]）が含まれている場合は、書式のロケールが優先されます。

戻り値:

フォーマットした結果。

formatAsString

public String formatAsString(String formatPattern,
                             boolean value,
                             Locale locale)

ブール型をフォーマットし、結果を直接文字列として取得する。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果の文字列。

format

public CellFormatResult format(String formatPattern,
                               boolean value,
                               Locale locale)

ブール型をフォーマットする。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果。

formatAsString

public String formatAsString(String formatPattern,
                             boolean value)

ロケールを指定して、ブール型をフォーマットし、結果を直接文字列として取得する。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果の文字列。

format

public CellFormatResult format(String formatPattern,
                               boolean value)

ロケールを指定して、ブール型をフォーマットする。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果。

formatAsString

public <N extends Number> String formatAsString(String formatPattern,
                                                N value,
                                                Locale locale)

数値型をフォーマットし、結果を直接文字列として取得する。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果の文字列。

format

public <N extends Number> CellFormatResult format(String formatPattern,
                                                  N value,
                                                  Locale locale)

数値列型をフォーマットする。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果。

formatAsString

public <N extends Number> String formatAsString(String formatPattern,
                                                N value)

ロケールを指定して、数値型をフォーマットし、結果を直接文字列として取得する。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果の文字列。

format

public <N extends Number> CellFormatResult format(String formatPattern,
                                                  N value)

ロケールを指定して、数値型をフォーマットする。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。

戻り値:

フォーマットした結果。

formatAsString

public String formatAsString(String formatPattern,
                             Date value,
                             Locale locale)

日付型をフォーマットし、結果を直接文字列として取得する。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。タイムゾーンを含んだ値を指定します。

戻り値:

フォーマットした結果の文字列。

format

public CellFormatResult format(String formatPattern,
                               Date value,
                               Locale locale)

日付型をフォーマットする。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。タイムゾーンを含んだ値を指定します。

戻り値:

フォーマットした結果。

formatAsString

public String formatAsString(String formatPattern,
                             Date value)

ロケールを指定して、日付型をフォーマットし、結果を直接文字列として取得する。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。タイムゾーンを含んだ値を指定します。

戻り値:

フォーマットした結果の文字列。

format

public CellFormatResult format(String formatPattern,
                               Date value)

ロケールを指定して、日付型をフォーマットする。

パラメータ:

formatPattern - フォーマットの書式。

value - フォーマット対象の値。タイムゾーンを含んだ値を指定します。

戻り値:

フォーマットした結果。

formatAsString

public String formatAsString(ObjectCell<?> cell)

セルの値を文字列として取得する。

パラメータ:

cell - Javaの仮想的なオブジェクトを表現するセル。

戻り値:

フォーマットしたセルの値。 cellがnullの場合、空文字を返す。

formatAsString

public String formatAsString(ObjectCell<?> cell,
                             Locale locale)

ロケールを指定してセルの値を文字列として取得する

パラメータ:

cell - Javaの仮想的なオブジェクトを表現するセル。

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

戻り値:

フォーマットした文字列。cellがnullの場合、空文字を返す。

format

public CellFormatResult format(ObjectCell<?> cell)

値をフォーマットする。

パラメータ:

cell - Javaの仮想的なオブジェクトを表現するセル。

戻り値:

フォーマット結果。cellがnullの場合、空セルとして値を返す。

format

public CellFormatResult format(ObjectCell<?> cell,
                               Locale locale)

値をフォーマットする。

パラメータ:

cell - Javaの仮想的なオブジェクトを表現するセル。

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

戻り値:

フォーマット結果。cellがnullの場合、空セルとして値を返す。

getFormatterResolver

public FormatterResolver getFormatterResolver()

FormatterResolverを取得する。

戻り値:

導入されたバージョン:

0.9

setFormatterResolver

public void setFormatterResolver(FormatterResolver formatterResolver)

FormatterResolverを設定する。 独自のものに入れ替える際に利用します。

パラメータ:

formatterResolver -

導入されたバージョン:

0.9

isCache

public boolean isCache()

パースしたフォーマッタをキャッシュするかどうか。 初期値はtrueです。

戻り値:

setCache

public void setCache(boolean cache)

パースしたフォーマッタをキャッシュするかどうか設定する。

パラメータ:

cache - true:キャッシュする。