ReportBook (excella-reports 2.2 API)

java.lang.Object
- org.bbreak.excella.reports.model.ReportBook

すべての実装されたインタフェース:

Serializable
```
public class ReportBook
extends Object
implements Serializable
```
ワークブックの置換情報を保持するクラス

導入されたバージョン:

1.0

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`ReportBook()` デフォルトコンストラクタ
`ReportBook(String templateFileName, String outputFileName, ConvertConfiguration... configurations)`
`ReportBook(String templateFileName, String outputFileName, String... formatTypes)`
`ReportBook(URL templateFileURL, String outputFileName, ConvertConfiguration... configurations)` jarに含まれるテンプレートを指定したい場合はこちらを使用する
`ReportBook(URL templateFileURL, String outputFileName, String... formatTypes)` jarに含まれるテンプレートを指定したい場合はこちらを使用する

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addReportSheet(ReportSheet reportSheet)` ワークシート置換情報を追加する。
`void`	`addReportSheets(List<ReportSheet> reportSheets)` ワークシート置換情報群を追加する。
`void`	`clearReportSheets()` ワークシート置換情報群を削除する。
`ConvertConfiguration[]`	`getConfigurations()` 出力変換情報を取得します。
`String`	`getOutputFileName()` 出力パス＋ファイル名（拡張子なし）を取得します。
`List<ReportSheet>`	`getReportSheets()` ワークシート置換情報群を取得します。
`String`	`getTemplateFileName()` テンプレートファイル名を取得します。
`URL`	`getTemplateFileURL()` テンプレートファイルのURLを取得します。
`void`	`removeReportSheet(ReportSheet reportSheet)` ワークシート置換情報を削除する。
`void`	`setConfigurations(ConvertConfiguration... configurations)` 出力変換情報を設定します。
`void`	`setOutputFileName(String outputFileName)` 出力パス＋ファイル名（拡張子なし）を設定します。
`void`	`setReportSheets(List<ReportSheet> reportSheets)` ワークシート置換情報群を設定します。
`void`	`setTemplateFileName(String templateFileName)` テンプレートファイル名を設定します。
`void`	`setTemplateFileURL(URL templateFileURL)` テンプレートファイルのURLを設定します。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ReportBook
```
public ReportBook()
```
    デフォルトコンストラクタ
  - ReportBook
```
public ReportBook(String templateFileName,
                  String outputFileName,
                  ConvertConfiguration... configurations)
```
    パラメータ:
    
    templateFileName - テンプレートファイル名(フルパス)
    
    outputFileName - 出力パス＋ファイル名（拡張子なし）
    
    configurations - 変換情報
  - ReportBook
```
public ReportBook(String templateFileName,
                  String outputFileName,
                  String... formatTypes)
```
    パラメータ:
    
    templateFileName - テンプレートファイル名(フルパス)
    
    outputFileName - 出力パス＋ファイル名（拡張子なし）
    
    formatTypes - 変換タイプ
  - ReportBook
```
public ReportBook(URL templateFileURL,
                  String outputFileName,
                  ConvertConfiguration... configurations)
```
    jarに含まれるテンプレートを指定したい場合はこちらを使用する
    
    パラメータ:
    
    templateFileURL - テンプレートファイル
    
    outputFileName - 出力パス＋ファイル名（拡張子なし）
    
    configurations - 変換情報
  - ReportBook
```
public ReportBook(URL templateFileURL,
                  String outputFileName,
                  String... formatTypes)
```
    jarに含まれるテンプレートを指定したい場合はこちらを使用する
    
    パラメータ:
    
    templateFileURL - テンプレートファイル名
    
    outputFileName - 出力パス＋ファイル名（拡張子なし）
    
    formatTypes - 変換タイプ
- メソッドの詳細
  - setReportSheets
```
public void setReportSheets(List<ReportSheet> reportSheets)
```
    ワークシート置換情報群を設定します。
    
    パラメータ:
    
    reportSheets - ワークシート置換情報群
  - getReportSheets
```
public List<ReportSheet> getReportSheets()
```
    ワークシート置換情報群を取得します。
    
    戻り値:
    
    ワークシート置換情報群
  - addReportSheet
```
public void addReportSheet(ReportSheet reportSheet)
```
    ワークシート置換情報を追加する。
    
    パラメータ:
    
    reportSheet - ワークシート置換情報
  - addReportSheets
```
public void addReportSheets(List<ReportSheet> reportSheets)
```
    ワークシート置換情報群を追加する。
    
    パラメータ:
    
    reportSheets - ワークシート置換情報群
  - removeReportSheet
```
public void removeReportSheet(ReportSheet reportSheet)
```
    ワークシート置換情報を削除する。
    
    パラメータ:
    
    reportSheet - ワークシート置換情報
  - clearReportSheets
```
public void clearReportSheets()
```
    ワークシート置換情報群を削除する。
  - getOutputFileName
```
public String getOutputFileName()
```
    出力パス＋ファイル名（拡張子なし）を取得します。
    
    戻り値:
    
    出力パス＋ファイル名（拡張子なし）
  - setOutputFileName
```
public void setOutputFileName(String outputFileName)
```
    出力パス＋ファイル名（拡張子なし）を設定します。
    
    パラメータ:
    
    outputFileName - 出力パス＋ファイル名（拡張子なし）
  - getConfigurations
```
public ConvertConfiguration[] getConfigurations()
```
    出力変換情報を取得します。
    
    戻り値:
    
    出力変換情報
  - setConfigurations
```
public void setConfigurations(ConvertConfiguration... configurations)
```
    出力変換情報を設定します。
    
    パラメータ:
    
    configurations - 出力変換情報
  - getTemplateFileName
```
public String getTemplateFileName()
```
    テンプレートファイル名を取得します。
    
    戻り値:
    
    テンプレートファイル名
  - setTemplateFileName
```
public void setTemplateFileName(String templateFileName)
```
    テンプレートファイル名を設定します。
    
    パラメータ:
    
    templateFileName - テンプレートファイル名
  - getTemplateFileURL
```
public URL getTemplateFileURL()
```
    テンプレートファイルのURLを取得します。
    
    戻り値:
    
    テンプレートファイルのURL
  - setTemplateFileURL
```
public void setTemplateFileURL(URL templateFileURL)
```
    テンプレートファイルのURLを設定します。
    
    パラメータ:
    
    templateFileName - テンプレートファイル

クラス ReportBook

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

ReportBook

ReportBook

ReportBook

ReportBook

ReportBook

メソッドの詳細

setReportSheets

getReportSheets

addReportSheet

addReportSheets

removeReportSheet

clearReportSheets

getOutputFileName

setOutputFileName

getConfigurations

setConfigurations

getTemplateFileName

setTemplateFileName

getTemplateFileURL

setTemplateFileURL