パッケージ com.osboffice.osbxl

クラス WorkBookWrapper

java.lang.Object
com.osboffice.osbxl.WorkBookWrapper
すべての実装されたインタフェース:
AutoCloseable
public class WorkBookWrapper extends Object implements AutoCloseable
Excelのワークブックを取り扱うクラスです。ワークシートの生成や削除や位置移動、読み込みや保存を行います。 また、カスタムスタイルやカスタムテーブルスタイルの作成、削除も可能です。

openWorkBook等で取得されたインスタンスは、不要となった時点でcloseメソッドを呼び、ワークブックを閉じる必要があります。

AutoCloseableにも対応しているので、Javaのtry-with-resources構文にてインスタンス生成も可能です。 この場合、closeメソッドはあえて呼び出す必要がありません。

  • メソッドの詳細

    • getBookPath

      public String getBookPath()
      ワークブックのファイルパスを取得します。
      戻り値:
      ファイルの絶対パス

    • openWorkSheet

      public WorkSheetWrapper openWorkSheet(String sheetName)
      ワークシートを開きます。
      パラメータ:
      sheetName - シート名
      戻り値:
      読み込んだワークシートクラス

    • addWorkSheet

      public WorkSheetWrapper addWorkSheet(String sheetName, int position)
      ワークシートを追加します。
      1. `position`の先頭は1です。
      2. `position`の前にシートを挿入します(-1の場合は最後尾になります)。
      パラメータ:
      sheetName - シート名
      position - 挿入位置
      戻り値:
      追加したワークシートクラス

    • addWorkSheet

      public WorkSheetWrapper addWorkSheet(String sheetName)
      ワークシートを追加します(追加位置:最後尾)。
      パラメータ:
      sheetName - シート名
      戻り値:
      追加したワークシートクラス

    • deleteWorkSheet

      public void deleteWorkSheet(String sheetName)
      ワークシートを削除します。
      パラメータ:
      sheetName - シート名

    • save

      public void save()
      ワークブックを同一ファイルに保存します。
      1. パスワード付きワークブックを読み込んだ場合、パスワード付きで保存されます。

    • save

      public void save(String passWord)
      ワークブックをパスワード付きで同一ファイルに保存します。
      1. 保存可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。
      パラメータ:
      passWord - パスワード

    • saveAs

      public void saveAs(String savePath) throws IOException
      ワークブックを別ファイルに保存します。
      1. 保存可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。
      パラメータ:
      savePath - 保存Excelの絶対パス
      例外:
      IOException

    • saveAs

      public void saveAs(String savePath, String passWord) throws IOException
      ワークブックを別ファイルにパスワード付きで保存します。
      1. 保存可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。
      パラメータ:
      savePath - 保存Excelの絶対パス
      passWord - パスワード。読み込んだパスワード付きワークブックを空文字で設定すると、パスワードなしとなります。
      例外:
      IOException

    • close

      public void close() throws Exception
      ワークブックを閉じます。
      1. このメソッドは、必ず呼ぶ必要があります（ワークブックが不必要になった時点で）。
      定義:
      close インタフェース内 AutoCloseable
      例外:
      Exception

    • getSheetNumber

      public int getSheetNumber(String sheetName)
      ワークシートのシート番号を取得します。
      パラメータ:
      sheetName - シート名
      戻り値:
      シート番号 (先頭シートを1とします)

    • getSheetCount

      public int getSheetCount()
      ワークシート数を取得します。
      戻り値:
      ワークシート数

    • moveSheet

      public void moveSheet(String sheetName, int position)
      ワークシートを移動します。
      パラメータ:
      sheetName - シート名
      position - 移動後のポジション (先頭シートを1とします)

    • getNames

      public NamesWrapper getNames()
      名前付き範囲クラスのインスタンスを取得します。
      戻り値:
      名前付き範囲クラスのインスタンス

    • addCustomStyle

      public void addCustomStyle(String styleName, CustomStyleObjectWrapper customStyleObject)
      カスタムセルスタイルを追加します。
      パラメータ:
      styleName - セルスタイル名
      customStyleObject - セルスタイルオブジェクト

    • addCustomStyle

      public void addCustomStyle(String styleName, CustomStyleObjectWrapper customStyleObject, XlBuiltInStyle builtinNumber)
      カスタムセルスタイルを既存のスタイルからコピー＆上書きして追加します。
      パラメータ:
      styleName - セルスタイル名
      customStyleObject - セルスタイルオブジェクト
      builtinNumber - 派生元スタイル

    • getCustomStyle

      public CustomStyleObjectWrapper getCustomStyle(String styleName)
      カスタムセルスタイルを取得します。
      パラメータ:
      styleName - セルスタイル名
      戻り値:
      セルスタイルオブジェクト

    • deleteCustomStyle

      public void deleteCustomStyle(String styleName)
      カスタムセルスタイルを削除します。
      パラメータ:
      styleName - セルスタイル名

    • addCustomTableStyle

      public void addCustomTableStyle(String tableStyleName, CustomTableStyleObjectWrapper customTableStyleObject)
      カスタムテーブルスタイルを追加します。
      1. CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。
      2. 設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。
      パラメータ:
      tableStyleName - テーブルスタイル名
      customTableStyleObject - テーブルスタイルオブジェクト

    • addCustomTableStyle

      public void addCustomTableStyle(String tableStyleName, CustomTableStyleObjectWrapper customTableStyleObject, XlDefaultTableStyle defaultStyle)
      カスタムテーブルスタイルを既存のスタイルからコピー＆上書きして追加します。
      1. CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。
      2. 設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。
      パラメータ:
      tableStyleName - テーブルスタイル名
      customTableStyleObject - テーブルスタイルオブジェクト
      defaultStyle - 派生元テーブルスタイル

    • addPivotCustomTableStyle

      public void addPivotCustomTableStyle(String tableStyleName, CustomTableStyleObjectWrapper customTableStyleObject)
      カスタムテーブルスタイルを追加します(ピボットテーブル)。
      1. CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。
      2. 設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。
      パラメータ:
      tableStyleName - ピボットテーブルスタイル名
      customTableStyleObject - テーブルスタイルオブジェクト

    • addPivotCustomTableStyle

      public void addPivotCustomTableStyle(String tableStyleName, CustomTableStyleObjectWrapper customTableStyleObject, XlPivotDefaultTableStyle defaultPivotStyle)
      カスタムテーブルスタイルを既存のスタイルからコピー＆上書きして追加します(ピボットテーブル)。
      1. CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。
      2. 設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。
      パラメータ:
      tableStyleName - ピボットテーブルスタイル名
      customTableStyleObject - テーブルスタイルオブジェクト
      defaultPivotStyle - 派生元ピボットテーブルスタイル

    • getCustomTableStyle

      public CustomTableStyleObjectWrapper getCustomTableStyle(String tableStyleName)
      カスタムテーブルスタイルを取得します。
      1. テーブルスタイルも、ピボットテーブルスタイルも取得可能です。
      パラメータ:
      tableStyleName - テーブルスタイル名または、ピボットテーブルスタイル名
      戻り値:
      テーブルスタイルオブジェクト

    • deleteCustomTableStyle

      public void deleteCustomTableStyle(String tableStyleName)
      カスタムテーブルスタイルを削除します。
      1. テーブルスタイル、ピボットテーブルスタイル両方とも削除可能です。
      パラメータ:
      tableStyleName - テーブルスタイル名または、ピボットテーブルスタイル名

    • isDate1904

      public boolean isDate1904()
      Excelの日付1904年形式であるかどうかを取得します。
      戻り値:
      true: 1904年形式 false: 既定形式

    • addExternalWorkBook

      public int addExternalWorkBook(String path) throws IOException
      ワークシートの参照先として用いる外部ワークブックを追加します。
      1. 外部ブックを参照する関数や値を新規に入力する前に、本メソッドで外部ワークブックを予め登録しておく必要があります。
      パラメータ:
      path - 外部ワークシートのパス
      戻り値:
      追加された外部ブックID 1から始まります。
      例外:
      IOException

    • updateExternalWorkBook

      public void updateExternalWorkBook(int externalId)
      ワークシートの参照先として用いる外部ワークブックを更新します(参照先のデータを再度取り込みます)。
      1. `externalId`は、getExternalWorkBookPathメソッドで確認できます。
      2. シートの外部ワークシートは、取り込まれた(キャッシュされた)データを元に計算されます。
      3. (更新された)外部ワークシートの最新データを取得するには、本メソッドを呼ぶ必要があります。
      パラメータ:
      externalId - 外部ワークシートID 1から始まります。

    • getExternalWorkBookPath

      public Map<Integer,String> getExternalWorkBookPath()
      外部ワークブック一覧を取得します。
      戻り値:
      map＜int,String＞ int:externalId(外部ワークブックID)、String:外部ワークブックのファイルパス。外部ワークシートID 1から始まります。

    • setCompanyName

      public void setCompanyName(String company)
      ワークブックのファイル属性として所属組織(Company)を設定します。
      パラメータ:
      company - 所属組織

    • setManagerName

      public void setManagerName(String manager)
      ワークブックのファイル属性として管理者(マネージャー)を設定します。
      パラメータ:
      manager - 管理者(マネージャー)

    • setCreateAuthor

      public void setCreateAuthor(String author)
      ワークブックのファイル属性としてドキュメント作成者を設定します。
      パラメータ:
      author - ドキュメント作成者

    • setLastAuthor

      public void setLastAuthor(String author)
      ワークブックのファイル属性としてドキュメントの最終更新者を設定します。
      パラメータ:
      author - ドキュメントの最終更新者