概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.bbreak.excella.core
クラス BookController

    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(Workbook workbook)` コンストラクタ

メソッドの概要
`void` | `addBookExporter(BookExporter exporter)` ブック出力処理クラスの追加
`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` | `clearSheetExporters()` すべての解析結果出力クラスを削除する
`void` | `clearSheetParseListeners()` 全てのシート処理リスナを削除する
`void` | `clearTagParsers()` すべてのタグパーサを削除する
`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(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 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()

  全てのシート処理リスナを削除する

### 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()

  全てのブック出力処理クラスを削除する

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド