<!-- NewPage -->\r
<html lang="ja">\r
<head>\r
-<!-- Generated by javadoc (version 1.7.0_25) on Mon Sep 01 02:16:30 JST 2014 -->\r
+<!-- Generated by javadoc (version 1.7.0_25) on Thu Dec 18 02:26:11 JST 2014 -->\r
<meta http-equiv="Content-Type" content="text/html" charset="utf-8">\r
<title>ReportMaker</title>\r
-<meta name="date" content="2014-09-01">\r
+<meta name="date" content="2014-12-18">\r
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">\r
</head>\r
<body>\r
<div class="block">Excel帳票生成クラス<br>
テンプレートのExcelファイルにデータを挿入することでExcel帳票を生成する。
- <h4>テンプレートの書式について</h4>
- <h5>${expression}</h5>
- <p>値出力。expressionを解析し値を出力する。</p>
-
- <h5>#if(${expression} delete:"left|up|clear" block:"true|false" rows:"number" cols:"number")</h5>
- <p>if句。expressionを解析した結果、false判定の場合、指定範囲を設定の方法で削除する。</p>
- <table border="1" cellspacing="1">
- <tr><th>属性</th><th>説明</th></tr>
- <tr>
- <td>${expression}</td>
- <td>必須項目。<br>
- Bool値を返す式を指定する。Bool値を返さない式の場合は、値がnullでなければtrueと判断する。</td>
- </tr>
- <tr>
- <td>delete</td>
- <td>オプション。デフォルト "left"<br>
- ${expression}がfalse判定の場合のセルに対する操作を指定する。<br>
- <table>
- <tr><td>left</td><td>左に詰める。</td></tr>
- <tr><td>up</td><td>上に詰める。</td></tr>
- <tr><td>clear</td><td>値をクリアするのみで詰めない。</td></tr>
- </table>
- </tr>
- <tr>
- <td>block</td>
- <td>オプション。デフォルト "true"<br>
- ブロック範囲での削除操作について指定する。"false"指定で行列全体での削除となる。<br>
- deleteオプションが"up"且つ、blockオプション"false"で行全体が削除対象となる。<br>
- deleteオプションが"left"且つ、blockオプション"false"で列全体が削除対象となる。
- </tr>
- <tr>
- <td>rows</td>
- <td>オプション。デフォルト "1"<br>
- 影響範囲の行数を指定。"1"指定で#if指示子が存在する行のみとなる。
- </tr>
- <tr>
- <td>cols</td>
- <td>オプション。デフォルト "1"<br>
- 影響範囲の列数を指定。"1"指定で#if指示子が存在する列のみとなる。
- </tr>
- </table>
-
- <h5>#foreach(${object in listObject} direction:"row|col" style:"copy|^copy" shift:"true|false" block:"true|false" start:"number" end:"number" rows:"number" cols:"number")</h5>
- <p>foreach句。listObjectで繰返し処理を行う。</p>
- <table border="1" cellspacing="1">
- <tr><th>属性</th><th>説明</th></tr>
- <tr>
- <td>${object in listObject}</td>
- <td>必須項目。<br>
- オブジェクト in リストオブジェクトのフォーマットでを指定する。リストオブジェクトには配列、List、Mapが使用可能。</td>
- </tr>
- <tr>
- <td>direction</td>
- <td>オプション。デフォルト "row"<br>
- 繰返し処理の方向を指定する。
- <table>
- <tr><td>row</td><td>行(縦)方向に繰返す。</td></tr>
- <tr><td>col</td><td>列(横)方向に繰返す。</td></tr>
- </table>
- </tr>
- <tr>
- <td>style</td>
- <td>オプション。デフォルト "copy"<br>
- 繰返し範囲のセルスタイルのコピーについて指定する。
- <table>
- <tr><td>copy</td><td>スタイルを繰返しコピーする。</td></tr>
- <tr><td>copy以外</td><td>スタイルをコピーしない。</td></tr>
- </table>
- </tr>
- <tr>
- <td>shift</td>
- <td>オプション。デフォルト "true"<br>
- 繰返し範囲より後方の範囲をずらすか（シフトするか）について指定する。
- <table>
- <tr><td>true</td><td>direction方向にシフトする。</td></tr>
- <tr><td>false</td><td>シフトしない。</td></tr>
- </table>
- </tr>
- <tr>
- <td>block</td>
- <td>オプション。デフォルト "true"<br>
- ブロック範囲での繰返し操作について指定する。"false"指定で行列全体での繰返しとなる。<br>
- directionオプションが"row"且つ、blockオプションが"false"で行全体が繰返し範囲となる。<br>
- directionオプションが"col"且つ、blockオプションが"false"で列全体が繰返し範囲となる。
- </tr>
- <tr>
- <td>rows</td>
- <td>オプション。デフォルト "1"<br>
- 影響範囲の行数を指定。"1"指定で#foreach指示子が存在する行のみとなる。
- </tr>
- <tr>
- <td>cols</td>
- <td>オプション。デフォルト "1"<br>
- 影響範囲の列数を指定。"1"指定で#foreach指示子が存在する列のみとなる。
- </tr>
- <tr>
- <td>start</td>
- <td>オプション。デフォルト "1"<br>
- リストオブジェクトの開始インデックス(1起点)。
- </tr>
- <tr>
- <td>end</td>
- <td>オプション。デフォルト リストオブジェクトの要素数<br>
- リストオブジェクトの終了インデックス(1起点)。<br>
- ※start(開始インデックス)・end(終了インデックス)の指定により、降順ループ(start > end)も可能。<br>
- ※リストオブジェクトの要素数はsize(list)で取得可能。
- </tr>
- </table></div>\r
-<dl><dt><span class="strong">バージョン:</span></dt>\r
+ <p>テンプレートの書式については、AbstractTLParserのサブクラスのJavadocを参照</p></div>\r
+<dl><dt><span class="strong">導入されたバージョン:</span></dt>\r
<dd>1.00.00</dd>\r
<dt><span class="strong">作成者:</span></dt>\r
<dd>Noboru Saito</dd></dl>\r
</tr>\r
<tr class="altColor">\r
<td class="colOne"><code><strong><a href="../../../../org/hanei/jaxcel/report/ReportMaker.html#ReportMaker()">ReportMaker</a></strong>()</code>\r
-<div class="block">コンストラクタ</div>\r
+<div class="block">デフォルトコンストラクタ</div>\r
+</td>\r
+</tr>\r
+<tr class="rowColor">\r
+<td class="colOne"><code><strong><a href="../../../../org/hanei/jaxcel/report/ReportMaker.html#ReportMaker(java.io.File)">ReportMaker</a></strong>(java.io.File properties)</code>\r
+<div class="block">カスタムパーサ用のプロパティファイルを指定</div>\r
+</td>\r
+</tr>\r
+<tr class="altColor">\r
+<td class="colOne"><code><strong><a href="../../../../org/hanei/jaxcel/report/ReportMaker.html#ReportMaker(java.io.InputStream)">ReportMaker</a></strong>(java.io.InputStream properties)</code>\r
+<div class="block">カスタムパーサ用のプロパティファイルを指定</div>\r
</td>\r
</tr>\r
</table>\r
<div class="block">ExcelテンプレートのWorkbookオブジェクトにデータを挿入することでExcel帳票を生成する。</div>\r
</td>\r
</tr>\r
+<tr class="altColor">\r
+<td class="colFirst"><code>void</code></td>\r
+<td class="colLast"><code><strong><a href="../../../../org/hanei/jaxcel/report/ReportMaker.html#setCustomProperties(java.io.File)">setCustomProperties</a></strong>(java.io.File properties)</code>\r
+<div class="block">カスタムパーサ用のプロパティファイルセッター</div>\r
+</td>\r
+</tr>\r
+<tr class="rowColor">\r
+<td class="colFirst"><code>void</code></td>\r
+<td class="colLast"><code><strong><a href="../../../../org/hanei/jaxcel/report/ReportMaker.html#setCustomProperties(java.io.InputStream)">setCustomProperties</a></strong>(java.io.InputStream properties)</code>\r
+<div class="block">カスタムパーサ用のプロパティファイルセッター</div>\r
+</td>\r
+</tr>\r
</table>\r
<ul class="blockList">\r
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">\r
<a name="ReportMaker()">\r
<!-- -->\r
</a>\r
-<ul class="blockListLast">\r
+<ul class="blockList">\r
<li class="blockList">\r
<h4>ReportMaker</h4>\r
<pre>public ReportMaker()</pre>\r
-<div class="block">コンストラクタ</div>\r
+<div class="block">デフォルトコンストラクタ</div>\r
+</li>\r
+</ul>\r
+<a name="ReportMaker(java.io.File)">\r
+<!-- -->\r
+</a>\r
+<ul class="blockList">\r
+<li class="blockList">\r
+<h4>ReportMaker</h4>\r
+<pre>public ReportMaker(java.io.File properties)</pre>\r
+<div class="block">カスタムパーサ用のプロパティファイルを指定</div>\r
+<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>properties</code> - カスタムパーサ用プロパティファイル</dd></dl>\r
+</li>\r
+</ul>\r
+<a name="ReportMaker(java.io.InputStream)">\r
+<!-- -->\r
+</a>\r
+<ul class="blockListLast">\r
+<li class="blockList">\r
+<h4>ReportMaker</h4>\r
+<pre>public ReportMaker(java.io.InputStream properties)</pre>\r
+<div class="block">カスタムパーサ用のプロパティファイルを指定</div>\r
+<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>properties</code> - カスタムパーサ用プロパティファイル</dd></dl>\r
</li>\r
</ul>\r
</li>\r
<!-- -->\r
</a>\r
<h3>メソッドの詳細</h3>\r
+<a name="setCustomProperties(java.io.File)">\r
+<!-- -->\r
+</a>\r
+<ul class="blockList">\r
+<li class="blockList">\r
+<h4>setCustomProperties</h4>\r
+<pre>public void setCustomProperties(java.io.File properties)</pre>\r
+<div class="block">カスタムパーサ用のプロパティファイルセッター</div>\r
+<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>properties</code> - カスタムパーサ用プロパティファイル</dd></dl>\r
+</li>\r
+</ul>\r
+<a name="setCustomProperties(java.io.InputStream)">\r
+<!-- -->\r
+</a>\r
+<ul class="blockList">\r
+<li class="blockList">\r
+<h4>setCustomProperties</h4>\r
+<pre>public void setCustomProperties(java.io.InputStream properties)</pre>\r
+<div class="block">カスタムパーサ用のプロパティファイルセッター</div>\r
+<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>properties</code> - カスタムパーサ用プロパティファイル</dd></dl>\r
+</li>\r
+</ul>\r
<a name="makeReport(java.io.InputStream, java.util.Map)">\r
<!-- -->\r
</a>\r
java.util.Map<java.lang.String,java.lang.Object> parameter)</pre>\r
<div class="block">入力ストリームのExcelテンプレートファイルにデータを挿入することでExcel帳票を生成、Workbookオブジェクトを返却する。<br>
返却されたWorkbookオブジェクトはPOIを使用し、加工・出力が可能。<br>
- 入力ストリームは別途クローズが必要。</div>\r
+ 入力ストリームは別途クローズが必要。<br>
+ Workbookオブジェクトの使用終了後はclose()メソッドでExcelテンプレートファイルのクローズが必要。</div>\r
<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>template</code> - Excelテンプレートファイル入力ストリーム</dd><dd><code>parameter</code> - テンプレートに挿入するデータ</dd>\r
<dt><span class="strong">戻り値:</span></dt><dd>Workbookオブジェクト</dd>\r
<dt><span class="strong">例外:</span></dt>\r
java.util.Map<java.lang.String,java.lang.Object> parameter)</pre>\r
<div class="block">Excelテンプレートファイルにデータを挿入することでExcel帳票を生成、Workbookオブジェクトを返却する。<br>
返却されたWorkbookオブジェクトはPOIを使用し、加工・出力が可能。<br>
- Excelテンプレートファイルは別途クローズが必要。</div>\r
+ Workbookオブジェクトの使用終了後はclose()メソッドでExcelテンプレートファイルのクローズが必要。</div>\r
<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>template</code> - Excelテンプレートファイル</dd><dd><code>parameter</code> - テンプレートに挿入するデータ</dd>\r
<dt><span class="strong">戻り値:</span></dt><dd>Workbookオブジェクト</dd>\r
<dt><span class="strong">例外:</span></dt>\r
<pre>public void makeReport(org.apache.poi.ss.usermodel.Workbook book,\r
java.util.Map<java.lang.String,java.lang.Object> parameter)</pre>\r
<div class="block">ExcelテンプレートのWorkbookオブジェクトにデータを挿入することでExcel帳票を生成する。<br>
- Excelテンプレートファイルは別途クローズが必要。</div>\r
+ Workbookオブジェクトの使用終了後はclose()メソッドでExcelテンプレートファイルのクローズが必要。</div>\r
<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>book</code> - Workbookオブジェクト</dd><dd><code>parameter</code> - テンプレートに挿入するデータ</dd>\r
<dt><span class="strong">例外:</span></dt>\r
<dd><code><a href="../../../../org/hanei/jaxcel/exception/JaxcelInputException.html" title="org.hanei.jaxcel.exception内のクラス">JaxcelInputException</a></code> - 入力例外発生時</dd></dl>\r
OSDN Git Service
