BookController (excella-core 2.1 API)

java.lang.Object
- org.bbreak.excella.core.BookController

```
public class BookController
extends Object
```
ワークブックの解析を行うクラス

導入されたバージョン:

1.0

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`COMMENT_PREFIX` コメントのプレフィックス
`static String`	`HSSF_SUFFIX` Excel2003以前のファイル末尾
`static String`	`XSSF_SUFFIX` Excel2007のファイル末尾

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

コンストラクタ
コンストラクタと説明
`BookController(String filepath)` コンストラクタファイルの形式を判定してWorkbookを生成する
`BookController(org.apache.poi.ss.usermodel.Workbook workbook)` コンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addBookExporter(BookExporter exporter)` ブック出力処理クラスの追加
`void`	`addPostSheetParseListener(PostSheetParseListener listener)` シート処理後イベントリスナの追加
`void`	`addPostSheetParseListener(String sheetName, PostSheetParseListener listener)` シート処理後イベントリスナの追加
`void`	`addPreSheetParseListener(PreSheetParseListener listener)` シート処理前イベントリスナの追加
`void`	`addPreSheetParseListener(String sheetName, PreSheetParseListener listener)` シート処理前イベントリスナの追加
`void`	`addSheetExporter(SheetExporter exporter)` シート解析結果出力クラスの追加
`void`	`addSheetExporter(String sheetName, SheetExporter exporter)` シート解析結果出力クラスの追加
`void`	`addSheetParseListener(SheetParseListener listener)` シート処理リスナの追加
`void`	`addSheetParseListener(String sheetName, SheetParseListener listener)` シート処理リスナの追加
`void`	`addTagParser(String sheetName, TagParser<?> parser)` 対象シート指定でのタグパーサの追加
`void`	`addTagParser(TagParser<?> parser)` タグパーサの追加
`void`	`clearBookExporters()` 全てのブック出力処理クラスを削除する
`void`	`clearPostSheetParseListeners()` 全てのシート処理後イベントリスナを削除する
`void`	`clearPreSheetParseListeners()` 全てのシート処理前イベントリスナを削除する
`void`	`clearSheetExporters()` すべての解析結果出力クラスを削除する
`void`	`clearSheetParseListeners()` 全てのシート処理リスナを削除する
`void`	`clearTagParsers()` すべてのタグパーサを削除する
`org.apache.poi.ss.usermodel.Workbook`	`getBook()` 現時点でのWorkbookの取得
`BookData`	`getBookData()` 現時点での解析データの取得
`ParseErrorHandler`	`getErrorHandler()` エラーハンドラの取得
`List<BookExporter>`	`getExporter()` 出力処理クラスの取得
`List<String>`	`getSheetNames()` ブックに含まれるシート名の一覧取得(コメントシート含む)
`void`	`parseBook()` ブックに含まれる全シート(コメントシートを除く)の解析の実行
`void`	`parseBook(Object data)` ブックに含まれる全シート(コメントシートを除く)の解析の実行
`SheetData`	`parseSheet(String sheetName)` シートデータの解析
`SheetData`	`parseSheet(String sheetName, Object data)` シートデータの解析
`void`	`removeTagParser(String tag)` 指定タグのタグパーサ情報を削除する
`void`	`setErrorHandler(ParseErrorHandler errorHandler)` エラーハンドラの設定

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

- フィールドの詳細
  - XSSF_SUFFIX
```
public static final String XSSF_SUFFIX
```
    Excel2007のファイル末尾
    
    関連項目:
    
    定数フィールド値
  - HSSF_SUFFIX
```
public static final String HSSF_SUFFIX
```
    Excel2003以前のファイル末尾
    
    関連項目:
    
    定数フィールド値
  - COMMENT_PREFIX
```
public static final String COMMENT_PREFIX
```
    コメントのプレフィックス
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - BookController
```
public BookController(String filepath)
               throws IOException
```
    コンストラクタ
    ファイルの形式を判定してWorkbookを生成する
    
    パラメータ:
    
    filepath - ファイルパス
    
    例外:
    
    IOException - ファイルの読み込みに失敗した場合
  - BookController
```
public BookController(org.apache.poi.ss.usermodel.Workbook workbook)
```
    コンストラクタ
    
    パラメータ:
    
    workbook - 処理対象のブック
- メソッドの詳細
  - parseBook
```
public void parseBook()
               throws ParseException,
                      ExportException
```
    ブックに含まれる全シート(コメントシートを除く)の解析の実行
    
    例外:
    
    ParseException - パースに失敗した場合
    
    IOException - エラーファイルの書き込みに失敗した場合
    
    ExportException
  - parseBook
```
public void parseBook(Object data)
               throws ParseException,
                      ExportException
```
    ブックに含まれる全シート(コメントシートを除く)の解析の実行
    
    パラメータ:
    
    data - BookControllerのparseBook(), parseSheet()メソッド、 SheetParserのparseSheetメソッドで引数を渡した場合に TagParserまで引き継がれる処理データ
    
    例外:
    
    ParseException - パースに失敗した場合
    
    ExportException - 出力処理に失敗した場合
  - getBookData
```
public BookData getBookData()
```
    現時点での解析データの取得
    
    戻り値:
    
    現時点での解析データ
  - getBook
```
public org.apache.poi.ss.usermodel.Workbook getBook()
```
    現時点でのWorkbookの取得
    
    戻り値:
    
    現時点でのWorkbook
  - parseSheet
```
public SheetData parseSheet(String sheetName)
                     throws ParseException,
                            ExportException
```
    シートデータの解析
    
    パラメータ:
    
    sheetName - 解析対象のシート名
    
    戻り値:
    
    シートの解析結果
    
    例外:
    
    ParseException - パースに失敗した場合
    
    ExportException - エクスポート処理エラー
  - parseSheet
```
public SheetData parseSheet(String sheetName,
                            Object data)
                     throws ParseException,
                            ExportException
```
    シートデータの解析
    
    パラメータ:
    
    sheetName - 解析対象のシート名
    
    data - BookControllerのparseBook(), parseSheet()メソッド、 SheetParserのparseSheetメソッドで引数を渡した場合に TagParserまで引き継がれる処理データ
    
    戻り値:
    
    シートの解析結果
    
    例外:
    
    ParseException - パース処理エラー
    
    ExportException - エクスポート処理エラー
  - getSheetNames
```
public List<String> getSheetNames()
```
    ブックに含まれるシート名の一覧取得(コメントシート含む)
    
    戻り値:
    
    シート名の一覧
  - addTagParser
```
public void addTagParser(TagParser<?> parser)
```
    タグパーサの追加
    
    パラメータ:
    
    parser - 追加するタグパーサ
  - addTagParser
```
public void addTagParser(String sheetName,
                         TagParser<?> parser)
```
    対象シート指定でのタグパーサの追加
    
    パラメータ:
    
    sheetName - 対象シート名
    
    parser - 追加するタグパーサ
  - removeTagParser
```
public void removeTagParser(String tag)
```
    指定タグのタグパーサ情報を削除する
    
    パラメータ:
    
    tag - タグ
  - clearTagParsers
```
public void clearTagParsers()
```
    すべてのタグパーサを削除する
  - addSheetParseListener
```
public void addSheetParseListener(SheetParseListener listener)
```
    シート処理リスナの追加
    
    パラメータ:
    
    listener - 追加するリスナ
  - addSheetParseListener
```
public void addSheetParseListener(String sheetName,
                                  SheetParseListener listener)
```
    シート処理リスナの追加
    
    パラメータ:
    
    sheetName - 対象シート名
    
    listener - 追加するリスナ
  - clearSheetParseListeners
```
public void clearSheetParseListeners()
```
    全てのシート処理リスナを削除する
  - addPreSheetParseListener
```
public void addPreSheetParseListener(PreSheetParseListener listener)
```
    シート処理前イベントリスナの追加
    
    パラメータ:
    
    listener - 追加するリスナ
    
    導入されたバージョン:
    
    2.1
  - addPreSheetParseListener
```
public void addPreSheetParseListener(String sheetName,
                                     PreSheetParseListener listener)
```
    シート処理前イベントリスナの追加
    
    パラメータ:
    
    sheetName - 対象シート名
    
    listener - 追加するリスナ
    
    導入されたバージョン:
    
    2.1
  - clearPreSheetParseListeners
```
public void clearPreSheetParseListeners()
```
    全てのシート処理前イベントリスナを削除する
    
    導入されたバージョン:
    
    2.1
  - addPostSheetParseListener
```
public void addPostSheetParseListener(PostSheetParseListener listener)
```
    シート処理後イベントリスナの追加
    
    パラメータ:
    
    listener - 追加するリスナ
    
    導入されたバージョン:
    
    2.1
  - addPostSheetParseListener
```
public void addPostSheetParseListener(String sheetName,
                                      PostSheetParseListener listener)
```
    シート処理後イベントリスナの追加
    
    パラメータ:
    
    sheetName - 対象シート名
    
    listener - 追加するリスナ
    
    導入されたバージョン:
    
    2.1
  - clearPostSheetParseListeners
```
public void clearPostSheetParseListeners()
```
    全てのシート処理後イベントリスナを削除する
    
    導入されたバージョン:
    
    2.1
  - getExporter
```
public List<BookExporter> getExporter()
```
    出力処理クラスの取得
    
    戻り値:
    
    出力処理クラス
  - addSheetExporter
```
public void addSheetExporter(SheetExporter exporter)
```
    シート解析結果出力クラスの追加
    
    パラメータ:
    
    exporter - 追加する出力クラス
  - addSheetExporter
```
public void addSheetExporter(String sheetName,
                             SheetExporter exporter)
```
    シート解析結果出力クラスの追加
    
    パラメータ:
    
    sheetName - 対象シート名
    
    exporter - 追加する出力クラス
  - clearSheetExporters
```
public void clearSheetExporters()
```
    すべての解析結果出力クラスを削除する
  - getErrorHandler
```
public ParseErrorHandler getErrorHandler()
```
    エラーハンドラの取得
    
    戻り値:
    
    エラーハンドラ
  - setErrorHandler
```
public void setErrorHandler(ParseErrorHandler errorHandler)
```
    エラーハンドラの設定
    
    パラメータ:
    
    errorHandler - エラーハンドラ
  - addBookExporter
```
public void addBookExporter(BookExporter exporter)
```
    ブック出力処理クラスの追加
    
    パラメータ:
    
    exporter - ブック出力処理クラス
  - clearBookExporters
```
public void clearBookExporters()
```
    全てのブック出力処理クラスを削除する

クラス BookController

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

XSSF_SUFFIX

HSSF_SUFFIX

COMMENT_PREFIX

コンストラクタの詳細

BookController

BookController

メソッドの詳細

parseBook

parseBook

getBookData

getBook

parseSheet

parseSheet

getSheetNames

addTagParser

addTagParser

removeTagParser

clearTagParsers

addSheetParseListener

addSheetParseListener

clearSheetParseListeners

addPreSheetParseListener

addPreSheetParseListener

clearPreSheetParseListeners

addPostSheetParseListener

addPostSheetParseListener

clearPostSheetParseListeners

getExporter

addSheetExporter

addSheetExporter

clearSheetExporters

getErrorHandler

setErrorHandler

addBookExporter

clearBookExporters