Jaxcel/README

   1 ========================================================
   2  Jaxcel
   3     http://sourceforge.jp/projects/jaxcel/
   4 ========================================================
   5
   6                 Copyright 2014 Hanei Management Co.,Ltd.
   7                                  http://www.hanei.co.jp/
   8 ========================================================
   9
  10 -------------------------------------------
  11 1. Jaxcel とは
  12 -------------------------------------------
  13 Jaxcelとは、Excelにテンプレート式を書くことによって、動的にデータを埋め込み、Excel帳票を出力するライブラリです。
  14
  15 Excelファイル自体をテンプレートとして用いることが可能な為、レイアウトの変更等も簡単に行えます。
  16
  17
  18 -------------------------------------------
  19 2. 主な特徴
  20 -------------------------------------------
  21 ・Excelファイル自体にデータ埋め込み式を記述する為、専用ツールの知識や習得が不要。
  22
  23 ・フォントサイズや罫線等の装飾は、テンプレートとなるExcelファイルで設定可能。
  24
  25 ・チャートやピボットテーブルをテンプレートとして設定可能。
  26
  27 ・複数シートが存在するブックに対応。
  28
  29 ・マクロ埋め込みブックに対応。
  30
  31 ・Excel97-2003ブック形式(.xls)、2007以降のブック形式(.xlsx .xlsm)に対応。
  32
  33 ・リストや配列等の繰り返し出力(foreach)、データによる出力・非出力(if)の制御構文が使用可能。
  34
  35 ・制御構文は行/列全体のみでなく、矩形範囲での制御が可能。
  36
  37 ・制御構文毎に、制御方向(行/列)の指定が可能。
  38
  39 ・制御構文内では埋め込みデータ以外に、下記の繰返し生成(foreach句使用時)、非出力(if句使用時)が可能。
  40   ・オートシェイプや画像等のオブジェクト ※1
  41   ・テーブル ※1
  42   ・結合セル
  43   ・オートフィルタ ※2
  44
  45 ・数式の参照範囲も制御構文に連動。
  46
  47 ・埋め込みデータの解析にはApache Commons JEXLを使用し、柔軟な埋め込み式の記述が可能。
  48
  49
  50 ※1：Excel2007以降のブック形式(.xlsx .xlsm)のみ対応。
  51 ※2：if句による出力・非出力のみ対応。
  52
  53
  54 -------------------------------------------
  55 3. サンプルの実行
  56 -------------------------------------------
  57 配布ファイルのsample/binディレクトリ配下のバッチファイル、シェルスクリプトファイルの実行で、
  58 sample/resourcesディレクトリ配下の同名のExcelテンプレートファイルと、json形式のデータ
  59 ファイルを使用し、sample/outputディレクトリに出力結果のExcelファイルが生成されます。
  60
  61 ※：実行環境にjava1.7以上がインストールされていること。
  62
  63
  64 -------------------------------------------
  65 4. Java ソースサンプル
  66 -------------------------------------------
  67 // Jaxcelレポートメーカーオブジェクトの生成
  68 ReportMaker jaxcel = new ReportMaker();
  69
  70 // パラメータとなるMapブジェクトの生成・データの投入
  71 HashMap<String, Object> parameter = new HashMap<>();
  72
  73 parameter.put("data1", "Hello");
  74 parameter.put("data2", "Jaxcel");
  75
  76 // テンプレートExcelファイル、パラメータ、出力結果Excelファイルを指定。
  77 // result.xlsxファイルが生成される。
  78 jaxcel.makeReport(new File("template.xlsx"), parameter, new File("result.xlsx"));
  79
  80 ※：詳細は配布ファイルのJavadocを参照願います。
  81
  82
  83 -------------------------------------------
  84 4. セットアップ
  85 -------------------------------------------
  86 配布ファイルの jaxcel-xx.xx.xx.jar をクラスパスを含めます。
  87
  88 また、Jexcelの使用には下記のライブラリが必要となります。
  89
  90 ・Apache POI 3.10
  91   ・poi-3.10-FINAL-20140208.jar
  92   ・poi-ooxml-3.10-FINAL-20140208.jar
  93   ・ooxml-schemas-1.1.jar ※
  94   ・Apache POIは下記のライブラリが必要となります。(Apache POI 3.10-FINALの場合)
  95     ・commons-codec-1.5.jar
  96     ・dom4j-1.6.1.jar
  97     ・xmlbeans-2.3.0.jar
  98
  99       ※：Apache POIのダウンロードに含まれるpoi-ooxml-schemas-3.10-FINAL-20140208.jarではありません。
 100           poi-ooxml-schemasのフルセットとなるooxml-schemasが必要です。
 101
 102       http://jakarta.apache.org/poi/
 103       http://repo1.maven.org/maven2/org/apache/poi/ooxml-schemas/1.1/
 104
 105
 106 ・Apache Commons JEXL 2.1.1
 107   ・commons-jexl-2.1.1.jar
 108
 109       http://commons.apache.org/proper/commons-jexl/
 110
 111
 112 ・Apache Commons Lang 3.3
 113   ・commons-lang3-3.3.2.jar
 114
 115       http://commons.apache.org/proper/commons-lang/
 116
 117
 118 ・SLF4J 1.7
 119   ・slf4j-api-1.7.7.jar
 120
 121       http://www.slf4j.org/
 122
 123
 124 ・JSONIC 1.3
 125   ・jsonic-1.3.5.jar ※
 126
 127     ※サンプル等で使用するコンソールツール「MakeReportTool」使用時のみ必要です。
 128
 129       http://jsonic.sourceforge.jp/
 130
 131
 132 -------------------------------------------
 133 5. 免責事項
 134 -------------------------------------------
 135 本ソフトウエアを利用する、もしくは利用できないことにより発生した一切の損害（一次的、二次的に関わらず）
 136 および第三者からなされる請求について、株式会社阪栄マネージメントは一切責任を負いません。
 137 各自の責任においてご使用下さい。
 138
 139
 140 -------------------------------------------
 141 6. ライセンス
 142 -------------------------------------------
 143 本ソフトウェアはLGPL v3にて公開しています。
 144
 145
 146 --