3. カスタマイズ方法

POICellFormatterとJXLCellFormattertとも、カスタマイズ方法が同じであるため、POIを例に説明します。

3.1. キャッシュの制御

Excelの書式をパースする処理はコストがかかるため、一度パースした結果のフォーマッタオブジェクト CellFormatter は、メモリ上にキャッシュします。

3.1.1. キャッシュへの自動登録制御

メソッド POICellFormatter.setCache(true|false) でキャッシュへの自動登録を制御することができます。

  • 初期値は true で、キャッシュへの自動登録が有効になっています。

  • この機能を無効にするには、値を false に設定します。

POICellFormatter cellFormatter = new POICellFormatter();

// キャッシュへの自動登録をOFFにする。
cellFormatter.setCache(false);

3.1.2. キャッシュの初期化

キャッシュの内容を初期化などするには、 POICellFormatter.getFormatterResolver() で取得できる FormatterResolver クラスのインスタンスを利用します。

  • キャッシュの内容を全てクリアするには、 FormatterResolver.clearFormat() メソッドを呼びます。

  • 本来ライブラリで予め準備されているフォーマット FormatterResolver.registerDefaultFormat() メソッドで登録します。

    • clearFormat() メソッドを呼ぶと予め登録されているキャッシュも削除されるため、 registerDefaultFormat() メソッドを呼ぶことを推奨します。

    • 特に、ビルトインフォーマット（組み込みフォーマット）の場合は、書式を持たずにインデックス番号しか保持していない場合があるため、キャッシュクリ後はフォーマットに失敗する場合があります。

POICellFormatter cellFormatter = new POICellFormatter();

// FormatterResolverの取得
FormatterResolver formatterResolver = cellFormatter.getFormatterResolver();

// キャッシュへの内容を全てクリアする。
formatterResolver.clearFormat();

// ライブラリで準備されているデフォルトのフォーマッタをキャッシュに登録する。
formatterResolver.registerDefaultFormat();

3.2. フォーマッタの事前登録

本来ライブラリで予め準備されているフォーマッタでは不足している場合など、POICellFormatter.getFormatterResolver() で取得できる FormatterResolver クラスのインスタンスを利用し、予め登録しておくことで制御できます。

  • 特に、ビルトインフォーマットで、書式を持たずにインデックス番号しか保持していないときに有効です。

  • さらに、Excelのバージョンによっても違いがある場合に、既存のフォーマッタを修正する際にも利用します。

  • LocaleSwitchFormatter を利用することで、実行時のロケールによって切り替えることも可能です。

    • LocaleSwitchFormatter のコンストラクタにデフォルトのフォーマッタを渡します。

    • LocaleSwitchFormatter.register(...) でロケールと切り替えるフォーマッターを渡します。

POICellFormatter cellFormatter = new POICellFormatter();

// FormatterResolverの取得
FormatterResolver formatterResolver = cellFormatter.getFormatterResolver();

// フォーマッターの作成
CellFOrmatter fomratter1 = formatterResolver.createFormatter("yyyy-mm-dd HH:mm:ss");

// インデックス番号を指定して登録する。
formatterResolver.registerFormatter((short)2, fomratter1);

// パターンを指定して登録する。
formatterResolver.registerFormatter("yyyy/mm/dd", fomratter1);

// 実行時のロケールによって切り替えることができるフォーマッタの登録
formatterResolver.registerFormatter("[$-F800]dddd\\,\\ mmmm\\ dd\\,\\ yyyy",
        new LocaleSwitchFormatter(formatterResolver.createFormatter("[$-F800]dddd\\,\\ mmmm\\ dd\\,\\ yyyy"))
            .register(formatterResolver.createFormatter("yyyy\"年\"m\"月\"d\"日\""), Locale.JAPAN, Locale.JAPANESE, LOCALE_JAPANESE));

cellFormatter.format(cell, Locale.JAPAN);

3.3. 元号の定義の変更

元号が変わったときに即時対応する必要がある場合、元号の定義用プロパティファイル era_ja.properties をクラスパスのルートに配置しておくことで、 定義を変更することができます。 [ver.0.9+]

プロパティファイルは、既存の定義に対して差分のみ定義すれば問題ありません。 ただし、プロパティファイルは、 UTF-8 で定義してください。 native2ascii コマンドでUnicodeへ変換する必要はありません。

元のファイルは、jarファイル中の com/github/mygreen/cellformatter/era_ja.properties に格納してあります。

######################################################################
#
# 元号を定義するプロパティファイル
# - 日本語
#
######################################################################
#
# ・era.<コード>.<プロパティ> で追加可能。
# ・プロパティの説明
#   name : 正式名称
#   abbrevName : 略称
#   abbrevRomanName : ローマ字の略称
#   start : 開始日時。yyyy-MM-dd HH:mm:ss.SSSの形式
#   end : 終了日時。yyyy-MM-dd HH:mm:ss.SSSの形式。省略可能
#
#
######################################################################

# 定義を変更する際のサンプル

# 平成
era.heisei.name=平成
era.heisei.abbrevName=平
era.heisei.abbrevRomanName=H
era.heisei.start=1989-01-08 00:00:00.000
era.heisei.end=2018-12-31 23:59:59.999

# 平成の次
era.karigou.name=仮号
era.karigou.abbrevName=仮
era.karigou.abbrevRomanName=K
era.karigou.start=2019-01-01 00:00:00.000
era.karigou.end=