@XlsIterateTables

同一の構造の表がシート内で繰り返し出現する場合に使用し、Collection(List、Set)または配列にマッピングします。 次のアノテーションを組み合わせて構成します。

  • 横方向の表をマッピングするアノテーション @XlsHorizontalRecords 。

  • 縦方向の表をマッピングするアノテーション @XlsVerticalRecords [ver.2.0+] 。

    • ただし、アノテーション @XlsHorizontalRecords と同時に使用はできません。

  • 見出し付きの1つのセルをマッピングするアノテーション @XlsLabelledCell 。

  • 見出し付きの連続し隣接する複数のセルをマッピングするアノテーション @XlsLabelledArrayCells [ver.2.0+]。

基本的な使い方

属性 tableLabel で繰り返し部分の表の名称を指定します。

また、属性bottomは、@XlsIterateTables 内で @XlsHorizontalRecords を使用する場合に、テーブルの開始位置が @XlsIterateTables の表の名称セルからどれだけ離れているかを指定します。

_images/IterateTables.png

IterateTables

シート用クラスの定義
1@XlsSheet(name="シート名")
2public class SampleSheet {
3
4    @XlsIterateTables(tableLabel="部門情報", bottom=2)
5    private List<SampleTable> tables;
6}

繰り返し部分に対応するJavaBeanでは以下のように、アノテーション @XlsLabelledCell @XlsHorizontalRecords を使用できます。

アノテーション @XlsHorizontalRecords を使用する場合、属性tableLabel は設定する必要はありません。 @XlsIterateTables の属性 tableLabelとbottomの値を引き継ぐため、指定しなくても問題ないためです。

テーブル用クラスの定義
1public class SampleTable {
2
3    @XlsLabelledCell(label="部門名", type=LabelledCellType.Right)
4    private String deptName;
5
6    @XlsHorizontalRecords(terminal=RecordTerminal.Border)
7    private List<SampleRecord> records;
8}

繰り返し部分に対応するJavaBeanで @XlsHorizontalRecords を使用した場合、通常の場合と同じく @XlsColumn や @XlsMapColumns で列とのマッピングを行います。

レコード用クラスの定義
1public class SampleRecord {
2
3    @XlsColumn(columnName="ID")
4    private String id;
5
6    @XlsColumn(columnName="名前")
7    private String name;
8}

注釈

  • ver.2.0から、Collection型(List型、Set型)にも対応しています。

  • インタフェースの型を指定する場合、次の実装クラスのインスタンスが設定されます。

    • List型の場合、 java.util.ArrayList クラス。

    • Set型の場合、 java.util.LinkedHashSet クラス。

    • Collection型の場合、 java.util.ArrayList クラス。

  • 実装クラスを指定した場合、そのインスタンスが設定されます。

縦方向の表を組み合わせてマッピングする場合

縦方向の表をマッピングするアノテーション @XlsVerticalRecords も使用できます。

  • ただし、横方向の表をマッピングするアノテーション @XlsHorizontalRecords と同時に使用することはできません。

  • 属性 tableLabelAbove=true が自動的に有効になり、表の見出しが上部にあることを前提に処理されます。

_images/IterateTables_VerticalRecords.png

IterateTables(縦方向)

 1// シート用クラス
 2@XlsSheet(name="観測データ")
 3public class SampleSheet {
 4
 5    @XlsIterateTables(tableLabel="/観測情報.+/", bottom=2)
 6    private List<DataTable> tables;
 7}
 8
 9// テーブル用クラス
10public class DataTable {
11
12    @XlsLabelledCell(label="日付", type=LabelledCellType.Right)
13    private LocalDate date;
14
15    @XlsVerticalRecords(terminal=RecordTerminal.Border)
16    private List<WeatherRecord> records;
17}
18
19// レコード用クラス
20public class WeatherRecord {
21
22    @XlsColumn(columnName="時間")
23    private String time;
24
25    @XlsColumn(columnName="降水")
26    private double precipitation;
27}

表の名称を正規表現、正規化して指定する場合

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

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

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

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

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

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

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

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

 1// システム設定
 2XlsMapper xlsMapper = new XlsMapper();
 3xlsMapper.getConfiguration()
 4        .setRegexLabelText(true)        // ラベルを正規表現で指定可能にする機能を有効にする。
 5        .setNormalizeLabelText(true);   // ラベルを正規化して比較する機能を有効にする。
 6
 7// シート用クラス
 8@XlsSheet(name="シート名")
 9public class SampleSheet {
10
11    // 正規表現による指定
12    @XlsIterateTables(tableLabel="/部門情報.+/", bottom=2)
13    private List<SampleTable> tables;
14
15}