commons-wpoi
b2007062401

org.phosphoresce.commons.wpoi.dyna
クラス PoiDynaSheet

java.lang.Object
  拡張org.phosphoresce.commons.wpoi.dyna.PoiDynaSheet
すべての実装インタフェース:
java.io.Serializable

public final class PoiDynaSheet
extends java.lang.Object
implements java.io.Serializable

POI動的出力操作クラス。

作成者:
last modified by: Kitagawa
LastUpdate: 2005/12/07
関連項目:
直列化された形式

フィールドの概要
 int debugCount
          デバッグ用カウンタ
static boolean debugOut
          デバッグ用出力フラグ
 
コンストラクタの概要
PoiDynaSheet(java.lang.String path, int index)
          コンストラクタ
指定されたテンプレートExcelファイルとテンプレートベースとなる シートインデックスでクラスを初期化します。
PoiDynaSheet(java.lang.String path, int index, PoiProgressMonitor monitor)
          コンストラクタ
指定されたテンプレートExcelファイルとテンプレートベースとなる シートインデックスでクラスを初期化します。
 
メソッドの概要
 void addDynaSheet(java.lang.String sheetName, PoiDynaMap dynaMap)
          指定されたシート名とPoiDynaMapオブジェクトで生成するシートを追加します。
 void addDynaSheet(java.lang.String sheetName, PoiDynaMap dynaMap, PoiPrintConfig printConfig)
          指定されたシート名とPoiDynaMapオブジェクトで生成するシートを追加します。
 PoiWorkbook save()
          PoiWorkbookオブジェクトとして動的値をセットしたExcel情報を提供します。
 void save(java.io.OutputStream os)
          指定されたOutputStreamオブジェクト値をセットした内容を出力します。
 void save(java.lang.String path)
          指定されたExcelファイルパスに対して値をセットした内容を保存します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

debugCount

public int debugCount
デバッグ用カウンタ


debugOut

public static boolean debugOut
デバッグ用出力フラグ

コンストラクタの詳細

PoiDynaSheet

public PoiDynaSheet(java.lang.String path,
                    int index)
コンストラクタ
指定されたテンプレートExcelファイルとテンプレートベースとなる シートインデックスでクラスを初期化します。

パラメータ:
path - テンプレートExcelファイルパス
index - テンプレートExcelシートインデックス(0〜)

PoiDynaSheet

public PoiDynaSheet(java.lang.String path,
                    int index,
                    PoiProgressMonitor monitor)
コンストラクタ
指定されたテンプレートExcelファイルとテンプレートベースとなる シートインデックスでクラスを初期化します。

パラメータ:
path - テンプレートExcelファイルパス
index - テンプレートExcelシートインデックス(0〜)
monitor - 進捗状況モニタオブジェクト
メソッドの詳細

addDynaSheet

public void addDynaSheet(java.lang.String sheetName,
                         PoiDynaMap dynaMap)
                  throws PoiException
指定されたシート名とPoiDynaMapオブジェクトで生成するシートを追加します。

パラメータ:
sheetName - 生成対象シート名
dynaMap - 動的値マップオブジェクト
例外:
PoiException - 既存のシート名を追加、1文字以下のシート名を指定した場合に発生

addDynaSheet

public void addDynaSheet(java.lang.String sheetName,
                         PoiDynaMap dynaMap,
                         PoiPrintConfig printConfig)
                  throws PoiException
指定されたシート名とPoiDynaMapオブジェクトで生成するシートを追加します。
シート毎に指定された印刷環境設定オブジェクトが適用されます。

パラメータ:
sheetName - 生成対象シート名
dynaMap - 動的値マップオブジェクト
printConfig - 印刷環境設定オブジェクト
例外:
PoiException - 既存のシート名を追加、1文字以下のシート名を指定した場合に発生

save

public void save(java.lang.String path)
          throws PoiException,
                 PoiIOException
指定されたExcelファイルパスに対して値をセットした内容を保存します。

パラメータ:
path - 出力対象Excelファイルパス
例外:
PoiException - 正常に値のセット、ファイルの保存処理が出来なかった場合に発生
PoiIOException - 正常にIO操作が行えなかった場合に発生

save

public void save(java.io.OutputStream os)
          throws PoiException,
                 PoiIOException
指定されたOutputStreamオブジェクト値をセットした内容を出力します。
OutputStreamオブジェクトに対するクローズ処理は担当しません。

パラメータ:
os - OutputStreamオブジェクト
例外:
PoiException - 正常に値のセット、ファイルの出力処理が出来なかった場合に発生
PoiIOException - 正常にIO操作が行えなかった場合に発生

save

public PoiWorkbook save()
                 throws PoiException,
                        PoiIOException
PoiWorkbookオブジェクトとして動的値をセットしたExcel情報を提供します。
ファイルまたはOutputStreamオブジェクトへの保存は使用側のタイミングに依存します。

戻り値:
PoiWorkbookオブジェクト
例外:
PoiException - 正常に値のセット、ファイルの出力処理が出来なかった場合に発生
PoiIOException - 正常にIO操作が行えなかった場合に発生

commons-wpoi
b2007062401