@XlsMapColumns

アノテーション @XlsHorizontalRecords もしくは @XlsVerticalRecords において、 指定されたレコード用クラスのカラム数が可変の場合に、それらのカラムを java.util.Map として設定します。

  • BeanにはMapを引数に取るフィールドまたはメソッドを用意し、このアノテーションを記述します。

  • 属性 previousColumnName で、指定された次のカラム以降、カラム名をキーとしたMapが生成され、Beanにセットされます。

  • 属性 optional で、見出しとなるセルが見つからない場合に無視するかどうかを指定しできます。 [ver2.0+]

_images/MapColumns.png

MapColumns

 1public class SampleRecord {
 2
 3    @XlsColumn(columnName="ID")
 4    private int id;
 5
 6    @XlsColumn(columnName="名前")
 7    private String name;
 8
 9    @XlsMapColumns(previousColumnName="名前")
10    private Map<String, String> attendedMap;
11}

終了条件のセルを指定する場合

属性 nextColumnName で、指定した前のカラムまでが処理対象となり、マッピングの終了条件を指定できます。 [ver1.2+]

  • 属性 optional で、見出しとなるセルが見つからない場合に無視するかどうかを指定しできます。 [ver2.0+]

_images/MapColumns_nextColumnName.png

MapColumns(nextColumnName)

 1public class SampleRecord {
 2
 3    @XlsColumn(columnName="ID")
 4    private int id;
 5
 6    @XlsColumn(columnName="名前")
 7    private String name;
 8
 9    @XlsMapColumns(previousColumnName="名前", nextColumnName="備考")
10    private Map<String, String> attendedMap;
11
12    @XlsColumn(columnName="備考")
13    private String comment;
14
15}

型変換する場合

アノテーション @XlsConverter などで型変換を適用するときは、Mapの値が変換対象となります。 マップのキーは必ずString型を指定してください。

 1public class SampleRecord {
 2
 3    @XlsColumn(columnName="ID")
 4    private int id;
 5
 6    @XlsColumn(columnName="名前")
 7    private String name;
 8
 9    // 型変換用のアノテーションを指定した場合、Mapの値に適用されます。
10    @XlsMapColumns(previousColumnName="名前")
11    @XlsBooleanConverter(loadForTrue={"出席"}, loadForFalse={"欠席"},
12            saveAsTrue="出席", saveAsFalse"欠席"
13            failToFalse=true)
14    private Map<String, Boolean> attendedMap;
15}

位置情報／見出し情報を取得する際の注意事項

マッピング対象のセルのアドレスを取得する際に、フィールド Map<String, Point> positions を定義しておけば、自動的にアドレスがマッピングされます。

通常は、キーにはプロパティ名が記述（フィールドの場合はフィールド名）が入ります。

アノテーション @XlsMapColumns でマッピングしたセルのキーは、 <プロパティ名>[<セルの見出し>] の形式になります。

同様に、マッピング対象の見出しを取得する、フィールド Map<String, String> labels へのアクセスも、 キーは、 <プロパティ名>[<セルの見出し>] の形式になります。

_images/MapColumns_positions.png

MapColumns(positions/labels)

 1public class SampleRecord {
 2
 3    // 位置情報
 4    private Map<String, Point> positions;
 5
 6    // 見出し情報
 7    private Map<String, String> labels;
 8
 9    @XlsColumn(columnName="ID")
10    private int id;
11
12    @XlsColumn(columnName="名前")
13    private String name;
14
15    @XlsMapColumns(previousColumnName="名前")
16    private Map<String, String> attendedMap;
17}
18
19// 位置情報・見出し情報へのアクセス
20SampleRecord record = /* レコードのインスタンスの取得 */;
21
22Point position = record.positions.get("attendedMap[4月2日]");
23
24String label = recrod.labeles.get("attendedMap[4月2日]");

見出しを正規表現、正規化して指定する場合

シートの構造は同じだが、ラベルのセルが微妙に異なる場合、ラベルセルを正規表現による指定が可能です。 また、空白や改行を除去してラベルセルを比較するように設定することも可能です。 [ver1.1+]

  • 正規表現で指定する場合、アノテーションの属性の値を /正規表現/ のように、スラッシュで囲み指定します。

    • スラッシュで囲まない場合、通常の文字列として処理されます。

    • 正規表現の指定機能を有効にするには、システム設定のプロパティ regexLabelText の値を trueに設定します。

  • ラベセルの値に改行が空白が入っている場合、それらを除去し、正規化してアノテーションの属性値と比較することが可能です。

    • 正規化とは、空白、改行、タブを除去することを指します。

    • ラベルを正規化する機能を有効にするには、システム設定のプロパティ normalizeLabelText の値を trueに設定します。

これらの指定が可能な属性は、previousColumnName 、nextColumnName です。

 1// システム設定
 2XlsMapper xlsMapper = new XlsMapper();
 3xlsMapper.getConfiguration()
 4        .setRegexLabelText(true)        // ラベルを正規表現で指定可能にする機能を有効にする。
 5        .setNormalizeLabelText(true);   // ラベルを正規化して比較する機能を有効にする。
 6
 7// レコード用クラス
 8public class SampleRecord {
 9
10    @XlsColumn(columnName="ID")
11    private int id;
12
13    // 正規表現による指定
14    @XlsColumn(columnName="/名前.+/")
15    private String name;
16
17    // 正規表現による指定
18    @XlsMapColumns(previousColumnName="/名前.+/", nextColumnName="/備考.+/")
19    private Map<String, String> attendedMap;
20
21    @XlsColumn(columnName="/備考.+/")
22    private String comment;
23
24}

書き込み前に動的にテンプレートファイルを書き換える

書き込み処理の場合、マップのキーがデータごとに異なり、テンプレートのフォーマットと合わない場合があります。

そのような場合、テンプレートファイルを書き込むデータに合わせて書き換えます。 その際には、 ライフサイクル・コールバック用のアノテーション @XlsPreSave で、実装できます。

実装処理は、Apache POIのAPIを使って行います。

_images/MapColumns_preSave.png

MapColumns(preSave)

 1// シート用クラス
 2@XlsSheet(name="List")
 3public class SampleSheet {
 4
 5    @XlsHorizontalRecords(tableLabel="ユーザ一覧")
 6    @XlsRecordOption(overOperation=OverOperation.Insert)
 7    List<SampleRecord> records;
 8
 9    // XlsMapColumnsのマッピング用のセルを作成する
10    @XlsPreSave
11    public void onPreSave(final Sheet sheet, final Configuration config) {
12
13        try {
14            final Workbook workbook = sheet.getWorkbook();
15
16            // 基準となる日付のセル[日付]を取得する
17            Cell baseHeaderCell = Utils.getCell(sheet, "[日付]", 0, 0, config);
18
19            // 書き換えるための見出しの値の取得
20            List<String> dateHeaders = new ArrayList<>(records.get(0).attendedMap.keySet());
21
22            // 1つ目の見出しの書き換え
23            baseHeaderCell.setCellValue(dateHeaders.get(0));
24
25            // ２つ目以降の見出し列の追加
26            Row headerRow = baseHeaderCell.getRow();
27            for(int i=1; i < dateHeaders.size(); i++) {
28                Cell headerCell = headerRow.createCell(baseHeaderCell.getColumnIndex() + i);
29
30                CellStyle style = workbook.createCellStyle();
31                style.cloneStyleFrom(baseHeaderCell.getCellStyle());
32                headerCell.setCellStyle(style);
33                headerCell.setCellValue(dateHeaders.get(i));
34
35            }
36
37            // 2つめ以降のデータ行の列の追加
38            Row valueRow = sheet.getRow(baseHeaderCell.getRowIndex() + 1);
39            Cell baseValueCell = valueRow.getCell(baseHeaderCell.getColumnIndex());
40            for(int i=1; + i < dateHeaders.size(); i++) {
41                Cell valueCell = valueRow.createCell(baseValueCell.getColumnIndex() + i);
42
43                CellStyle style = workbook.createCellStyle();
44                style.cloneStyleFrom(baseValueCell.getCellStyle());
45                valueCell.setCellStyle(style);
46
47            }
48
49        } catch (Exception e) {
50            throw new RuntimeException(e);
51        }
52
53    }
54
55}
56
57// レコード用クラス
58public class SampleRecord {
59
60    @XlsColumn(columnName="ID")
61    private int id;
62
63    @XlsColumn(columnName="名前")
64    private String name;
65
66    // 可変長のセルのマッピング
67    @XlsMapColumns(previousColumnName="名前")
68    private Map<String, String> attendedMap;
69
70}