Welcome to XlsMapper

ExcelとPOJOをマッピングするJavaライブラリです。

目次

• 1. 基本的な使い方
  • 1.1. ダウンロード
  • 1.2. 前提条件
  • 1.3. マッピングの基本
    • 1.3.1. 読み込み方の基本
    • 1.3.2. 書き込み方の基本
  • 1.4. 読み込み方
    • 1.4.1. 単一のシートを読み込む場合
    • 1.4.2. 複数のシートを読み込む場合
  • 1.5. 書き込み方
    • 1.5.1. 単一のシートの書き込む場合
    • 1.5.2. 複数のシートを書き込む場合
• 2. 注意事項
  • 2.1. ExcelとJava間で数値をマッピングする際の注意事項
  • 2.2. アノテーションの定義位置
• 3. 表・セルのマッピング方法
  • 3.1. @XlsSheet
    • 3.1.1. シート名を正規表現で指定する場合
  • 3.2. @XlsSheetName
    • 3.2.1. メソッドにアノテーションを付与する場合
  • 3.3. @XlsCell
  • 3.4. @XlsLabelledCell
    • 3.4.1. ラベルセルから離れたセルを指定する方法（属性range）
    • 3.4.2. ラベルセルから離れたセルを指定する方法（属性skip）
    • 3.4.3. ラベルセルが結合している場合（属性labelMerged）
    • 3.4.4. ラベルセルが重複するセルを指定する方法
    • 3.4.5. ラベルセルを正規表現、正規化して指定する場合
  • 3.5. @XlsArrayCells
    • 3.5.1. 縦方向に隣接したセルをマッピングする場合
    • 3.5.2. 結合したセルをマッピングする場合
    • 3.5.3. 書き込み時に配列・リストのサイズが不足、または余分である場合
    • 3.5.4. 位置情報／見出し情報を取得する際の注意事項
  • 3.6. @XlsLabelledArrayCells
    • 3.6.1. 縦方向に隣接したセルをマッピングする場合
    • 3.6.2. ラベルセルから離れたセルを指定する方法（属性range）
    • 3.6.3. ラベルセルから離れたセルを指定する方法（属性skip）
    • 3.6.4. 重複するラベルを指定する場合
    • 3.6.5. ラベルセルが結合している場合（属性labelMerged）
    • 3.6.6. 結合したセルをマッピングする場合（属性elementMerged）
    • 3.6.7. 書き込み時に配列・リストのサイズが不足、または余分である場合
    • 3.6.8. 位置情報／見出し情報を取得する際の注意事項
    • 3.6.9. ラベルセルを正規表現、正規化して指定する場合
  • 3.7. @XlsHorizontalRecords
    • 3.7.1. 表の開始位置の指定（表の名称がない場合）
    • 3.7.2. 表の名称から開始位置が離れた場所にある場合
    • 3.7.3. 表の見出しが縦に結合されデータレコードの開始位置が離れた場所にある場合
    • 3.7.4. 表の終端の指定（属性terminal）
    • 3.7.5. 空のレコードを読み飛ばす条件の指定
    • 3.7.6. 表の終端の指定（属性terminateLabel）
    • 3.7.7. 表の見出しの走査の終了条件の指定(headerLimit)
    • 3.7.8. 表の見出しに空白がある場合(range)
    • 3.7.9. 書き込み時にレコードが不足、余分である場合の操作の指定
    • 3.7.10. 任意の位置からレコードが開始するかを指定する場合
    • 3.7.11. 表の名称を正規表現、正規化して指定する場合
  • 3.8. @XlsVerticalRecords
    • 3.8.1. 表の名称位置の指定
    • 3.8.2. 表の名称から開始位置が離れた場所にある場合(right)
    • 3.8.3. 表の名称から開始位置が離れた場所にある場合(bottom)
    • 3.8.4. 表の見出しが横に結合されデータレコードの開始位置が離れた場所にある場合
    • 3.8.5. 書き込み時にレコードが不足、余分である場合の操作の指定
    • 3.8.6. 任意の位置からレコードが開始するかを指定する場合
  • 3.9. @XlsColumn
    • 3.9.1. データの列が結合されている場合
    • 3.9.2. 見出し行が結合されている場合
    • 3.9.3. 見出しを正規表現、正規化して指定する場合
  • 3.10. @XlsMapColumns
    • 3.10.1. 終了条件のセルを指定する場合
    • 3.10.2. 型変換する場合
    • 3.10.3. 位置情報／見出し情報を取得する際の注意事項
    • 3.10.4. 見出しを正規表現、正規化して指定する場合
    • 3.10.5. 書き込み前に動的にテンプレートファイルを書き換える
  • 3.11. @XlsArrayColumns
    • 3.11.1. 結合したセルをマッピングする場合
    • 3.11.2. 書き込み時に配列・リストのサイズが不足、または余分である場合
    • 3.11.3. 位置情報／見出し情報を取得する際の注意事項
    • 3.11.4. 見出しを正規表現、正規化して指定する場合
  • 3.12. @XlsNestedRecords
    • 3.12.1. 一対多の関係
    • 3.12.2. 一対一の関係
  • 3.13. @XlsIterateTables
    • 3.13.1. 基本的な使い方
    • 3.13.2. 縦方向の表を組み合わせてマッピングする場合
    • 3.13.3. 表の名称を正規表現、正規化して指定する場合
  • 3.14. @XlsComment
  • 3.15. @XlsLabelledComment
    • 3.15.1. ラベルセルが重複するセルを指定する方法
    • 3.15.2. ラベルセルを正規表現、正規化して指定する場合
  • 3.16. @XlsOrder
  • 3.17. @XlsIgnorable
    • 3.17.1. IsEmptyBuilderを使った記述の簡単化
  • 3.18. @XlsArrayOption
    • 3.18.1. 書き込み時に配列・リストのサイズが不足している場合(overOperation)
    • 3.18.2. 書き込み時に配列・リストのサイズが余っている場合(remainedOperation)
  • 3.19. @XlsRecordOption
    • 3.19.1. 書き込み時に配列・リストのサイズが不足している場合(overOperation)
    • 3.19.2. 書き込み時に配列・リストのサイズが余っている場合(remainedOperation)
  • 3.20. @XlsRecordFinder
  • 3.21. @XlsCommentOption
    • 3.21.1. 書き込み時にコメントの表示／非表示設定をする。
    • 3.21.2. 書き込み時にコメントの枠サイズを指定する
    • 3.21.3. 書き込み時に既存のコメントを自動削除する
    • 3.21.4. コメントの読み込み、書き込みの処理の実装を切り替える
    • 3.21.5. 書き込み時にコメントの枠サイズを自動設定する
• 4. セルの書式の指定方法
  • 4.1. @XlsBooleanConverter
    • 4.1.1. 読み込み時の値の指定
    • 4.1.2. 書き込み時の値の指定
    • 4.1.3. 変換に失敗した際の処理
  • 4.2. @XlsNumberConverter
    • 4.2.1. 読み込み時の書式の指定
    • 4.2.2. 書き込み時の書式の指定
    • 4.2.3. 有効桁数の指定
  • 4.3. @XlsDateTimeConverter
    • 4.3.1. 読み込み時の書式の指定
    • 4.3.2. 書き込み時の書式の指定
  • 4.4. @XlsEnumConverter
    • 4.4.1. 基本的な使い方
    • 4.4.2. 別名でマッピングする場合
  • 4.5. @XlsArrayConverter
    • 4.5.1. 基本的な使い方
    • 4.5.2. 空の要素を無視する場合
    • 4.5.3. 要素の値を変換するクラスを指定する
  • 4.6. @XlsCellOption
  • 4.7. 独自のクラスタイプの対応方法
    • 4.7.1. CellConverterの実装クラスの作成
    • 4.7.2. CellConverterFactoryの実装クラスの作成
    • 4.7.3. 作成したCellConverterの使用方法
• 5. セルの値の変換方法
  • 5.1. @XlsTrim
  • 5.2. @XlsDefaultValue
• 6. 数式の指定方法
  • 6.1. @XlsFormula
    • 6.1.1. 数式を直接指定する場合（属性value）
    • 6.1.2. 数式を組み立てるメソッドを指定する場合（属性methodName）
    • 6.1.3. 数式を優先する場合（属性primary）
    • 6.1.4. 式言語処理のカスタマイズ
    • 6.1.5. 数式を設定する際のポイント
    • 6.1.6. 複雑な表を作成する
• 7. ライフサイクルイベントの管理
  • 7.1. JavaBeanクラスに実装する場合
  • 7.2. リスナークラスに実装する場合
• 8. シート情報の取得
  • 8.1. シート上の位置情報の取得
    • 8.1.1. 書き込み時の位置情報取得の注意点
  • 8.2. シート上の見出しの取得
  • 8.3. シート上のコメントの取得
    • 8.3.1. 書き込み時のコメント情報の設定方法
• 9. XMLによるマッピング方法
  • 9.1. アノテーションをXMLで上書きする場合
  • 9.2. XMLを動的に組み立てる場合
• 10. 値の検証方法
  • 10.1. 検証の基本
  • 10.2. 独自の入力値検証
  • 10.3. フィールド（プロパティ）の入力値検証
  • 10.4. メッセージファイルの定義
  • 10.5. メッセージファイルの読み込み方法の変更
  • 10.6. Bean Validationを使用した入力値検証
    • 10.6.1. Bean Validationのカスタマイズ
• 11. 独自の表・セルのマッピング方法
• 12. SpringFrameworkとの連携
  • 12.1. ライブラリの追加
  • 12.2. XMLによるコンテナの設定
  • 12.3. JavaConfigによるコンテナの設定
  • 12.4. SpringBeanとしての定義
• 13. システム設定
• 14. XLSBeansとの違い
  • 14.1. 改善機能
  • 14.2. 追加機能
  • 14.3. 削除機能
• 15. マイグレーション
  • 15.1. To ver.2.0
    • 15.1.1. 前提環境の変更
    • 15.1.2. クラス名などの変更
    • 15.1.3. アノテーションの定義の変更
    • 15.1.4. その他の変更
  • 15.2. To ver.1.1
  • 15.3. To ver.1.2
• 16. リリースノート
  • 16.1. ver.2.2 - 2022-01-01
  • 16.2. ver.2.1.1 - 2021-02-13
  • 16.3. ver.2.1 - 2019-06-23
  • 16.4. ver.2.0 - 2018-06-30
  • 16.5. ver.1.6 - 2017-01-02
  • 16.6. ver.1.5.2 - 2016-10-30
  • 16.7. ver.1.5.1 - 2016-10-30
  • 16.8. ver.1.5.0 - 2016-08-30
  • 16.9. ver.1.4.4 - 2016-07-02
  • 16.10. ver.1.4.3 - 2016-05-28
  • 16.11. ver.1.4.2 - 2016-05-07
  • 16.12. ver.1.4.1 - 2016-04-29
  • 16.13. ver.1.4 - 2016-03-21
  • 16.14. ver.1.3 - 2016-03-13
  • 16.15. ver.1.2.1 - 2016-03-12
  • 16.16. ver.1.2 - 2016-03-12
  • 16.17. ver.1.1 - 2016-03-08
  • 16.18. ver.1.0a - 2015-09-23
  • 16.19. ver.1.0 - 2015-07-19
  • 16.20. ver.0.5 - 2015-06-29
  • 16.21. ver.0.4 - 2015-04-05
  • 16.22. ver.0.3 - 2015-01-11
  • 16.23. ver.0.2.3 - 2015-01-01
  • 16.24. ver.0.2.2 - 2014-12-01
  • 16.25. ver.0.2.1 - 2014-11-25
  • 16.26. ver.0.2 - 2014-11-24
  • 16.27. ver.0.1 - 2014-10-30