シート上の位置情報の取得¶

読み込み時、書き込み時にマッピングしたセルのアドレス取得することができます。

取得方法は複数ありますが、Map<String, CellPosition> positions フィールドを用いるのが記述量が少なく簡単だと思います。

Map<String, CellPosition> positions というフィールドを定義しておくとプロパティ名をキーにセルの位置がセットされるようになっています。

アノテーション @XlsMapColumns のセルの位置情報のキーは、 <プロパティ名>[<セルの見出し>] としてセットされます。

アノテーション @XlsArrayColumns のセルの位置情報のキーは、 <プロパティ名>[<セルのインデックス>] としてセットされます。

アノテーションを付与した <setterメソッド名>Position というメソッドを用意しておくと、引数にセルの位置が渡されます。

位置情報を取得用のsetterメソッドは以下のいずれかの引数を取る必要があります。

int x, int y

com.gh.mygreen.xlsmapper.util.CellPosition

ただし、@XlsMapColumns に対するsetterメソッドは、第一引数にセルの見出しが必要になります。

String key, int x, int y

String key, com.gh.mygreen.xlsmapper.util.CellPosition

アノテーションを付与した <フィールド名>Position という com.gh.mygreen.xlsmapper.util.CellPosition 型のフィールドを用意しておくと、セルの位置が渡されます。

ただし、@XlsMapColumns に対するフィールドは、Map<String, CellPosition> 型にする必要があります。キーには見出しが入ります。

com.gh.mygreen.xlsmapper.util.CellPosition クラスの代わりに、以下のクラスでも代替できます。

java.awt.Point

org.apache.poi.ss.util.CellAddress

public class SampleRecord {

    // 汎用的な位置情報
    public Map<String, CellPosition> positions;


    @XlsColumns(label="名前")
    private String name;

    // プロパティごとに個別に位置情報を定義するフィールド
    private Point namePosition;

    // プロパティごとに個別に位置情報を定義するメソッド（Pointクラス）
    // フィールド positionsが定義あれば必要ありません。
    public void setNamePosition(CellPosition position) {
        //...
    }

    // プロパティごとに個別に位置情報を定義するメソッド（Pointクラス）
    // フィールド positionsが定義あれば必要ありません。
    public void setNamePosition(int x, int y) {
        //...
    }

    // @XlsMapColumnsの場合
    @XlsMapColumns(previousColumnName="名前")
    private Map<String, String> attendedMap;

    // プロパティごとに個別に位置情報を定義するフィールド
    private Map<String, CellPosition> attendedMapPosition;

    // プロパティごとに個別に位置情報を定義するメソッド1
    // @XlsMapColumnsの場合keyは、セルの見出しの値
    // フィールド positionsが定義あれば必要ありません。
    public void setAttendedMapPosition(String key, CellPosition position) {
        //...
    }

    // プロパティごとに個別に位置情報を定義するメソッド2
    // @XlsMapColumnsの場合keyは、セルの見出しの値
    // フィールド positionsが定義あれば必要ありません。
    public void setAttendedMapPosition(String key, int x, int y) {
        //...
    }

}

注釈

フィールド Map<String, CellPosition> positions と対応するsetterメソッドやフィールドをそれぞれ定義していた場合、優先度 positions > setterメソッド > フィールド に従い設定されます。

書き込み時の位置情報取得の注意点¶

書き込み時は、行を追加/削除する処理がある場合、アノテーションを付与したプロパティの処理順序によって、セルの位置が正しく取得できない場合があります。

例えば、既に処理して取得したセルの位置情報よりも、上方の表で後から行を削除、追加したとき、取得済みのセルの位置情報が不正になります。

このような場合、アノテーション @XlsOrder をプロパティに付与して、処理順序を一定に保ちます。

@XlsSheet(name="情報")
public Employee {
    // セルの位置情報
    public Map<String, Point> positions;

    @XlsOrder(1) // プロパティの処理順序を指定します。
    @XlsHorizontalRecords(tableLabel="履歴", terminal=RecordTerminal.Border)
    @XlsRecordOption(overOperation=OverOperation.Insert, remainedOperation=RemainedOperation.Delete) // データによって行の追加、削除する設定
    private List<EmployeeHistory> histories;

    @XlsOrder(2) // プロパティの処理順序を指定します。
    @XlsLabelledCell(label="名前")
    private String name;

}