jp.co.ffc.gkit.excelgenerator
クラス EGBook

java.lang.Object
  拡張jp.co.ffc.gkit.excelgenerator.EGBook

public class EGBook
extends java.lang.Object

EGBookクラスはエクセルファイルを表現します。
EGBookクラスはエクセルファイル表現の最上位のクラスになります。
ここではエクセルファイルを生成するために必要な項目の設定および書出しを行います。

コンストラクタでヘッダ、レコード、フッタとなる雛型のエクセルファイルのInputStreamを
設定します。
コンストラクタの第一引数のstreamHeaderはnullを許可しません。
他の項目はnullを許可しますので、レコードおよびフッタが不要な場合はnullを指定してください。

・ヘッダ、レコード、フッタが必要な場合

    EGBook book = new EGBook(streamHeader, streamRecord, streamFooter);

・ヘッダ、レコードが必要な場合

    EGBook book = new EGBook(streamHeader, streamRecord, null);


コンストラクタの概要
EGBook(java.io.InputStream streamHeader)
          雛型ヘッダファイルからEGBookインスタンスを生成。
EGBook(java.io.InputStream streamHeader, java.io.InputStream streamRecord)
          雛型ヘッダファイル、雛型レコードファイルからEGBookインスタンスを生成。
EGBook(java.io.InputStream streamHeader, java.io.InputStream streamRecord, java.io.InputStream streamFooter)
          雛型ヘッダファイル、雛型レコードファイル、雛形フッタファイルからEGBookのインスタンスを生成。
 
メソッドの概要
 EGSheet copySheet(int sheetindex)
          引数で渡された番号のシートを末尾へコピー。
 EGSheet getSheetAt(int index)
          引数で渡された番号のシートのインスタンスを取得。
 int getSheetLength()
          EGBookが保持しているシート数を取得。
 java.lang.String getSheetName(int sheetIdx)
          シートのインデックスからシート名を取得する

null - シート名が取得できない場合
 void setAutoFormula(boolean auto)
          式の自動補正機能を設定。
 void setTrimEnd(boolean trimEnd)
          文字列型セルでテキストの末尾にある空白を削除するかどうかを設定。
 void write(java.io.OutputStream stream)
          エクセルファイルを出力。
 
クラス java.lang.Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

EGBook

public EGBook(java.io.InputStream streamHeader)
雛型ヘッダファイルからEGBookインスタンスを生成。

streamHeaderにnullを渡すことはできません。

パラメータ:
streamHeader - 雛型ヘッダファイルのInputStream

EGBook

public EGBook(java.io.InputStream streamHeader,
              java.io.InputStream streamRecord)
雛型ヘッダファイル、雛型レコードファイルからEGBookインスタンスを生成。

streamHeaderにnullを渡すことはできません。

パラメータ:
streamHeader - 雛型ヘッダファイルのInputStream
streamRecord - 雛形レコードファイルのInputStream

EGBook

public EGBook(java.io.InputStream streamHeader,
              java.io.InputStream streamRecord,
              java.io.InputStream streamFooter)
雛型ヘッダファイル、雛型レコードファイル、雛形フッタファイルからEGBookのインスタンスを生成。

streamHeaderにnullを渡すことはできません。

パラメータ:
streamHeader - 雛型ヘッダファイルのInputStream
streamRecord - 雛型レコードファイルのInputStream
streamFooter - 雛型フッタファイルのInputStream
例外:
java.lang.NullPointerException
メソッドの詳細

copySheet

public EGSheet copySheet(int sheetindex)
引数で渡された番号のシートを末尾へコピー。

プログラムから設定したデータはコピーされません。

パラメータ:
sheetindex - シート番号
戻り値:
コピーしたシート

getSheetAt

public EGSheet getSheetAt(int index)
引数で渡された番号のシートのインスタンスを取得。

パラメータ:
index - シート番号
戻り値:
indexのシート

getSheetLength

public int getSheetLength()
EGBookが保持しているシート数を取得。

戻り値:
シート数

getSheetName

public java.lang.String getSheetName(int sheetIdx)
シートのインデックスからシート名を取得する

null - シート名が取得できない場合

パラメータ:
sheetIdx - シート番号
戻り値:
シート名

setAutoFormula

public void setAutoFormula(boolean auto)
式の自動補正機能を設定。

true - 有効
false - 無効

パラメータ:
auto - 自動補正

setTrimEnd

public void setTrimEnd(boolean trimEnd)
文字列型セルでテキストの末尾にある空白を削除するかどうかを設定。

true - 有効
false - 無効

パラメータ:
trimEnd - 削除の有無

write

public void write(java.io.OutputStream stream)
           throws java.io.IOException
エクセルファイルを出力。

パラメータ:
stream - OutputStream
例外:
java.io.IOException