org.opengion.plugin.io

## クラス HeaderData

- java.lang.Object
- - org.opengion.plugin.io.HeaderData

-      class HeaderData
      extends Object

  EXCEL ネイティブのデータを処理する ローカルクラスです。 このクラスでは、コメント行のスキップ判定、ヘッダー部のカラム名取得、 行情報(Row)から、カラムの配列の取得などを行います。
  変更履歴:

    3.5.4.8 (2004/02/23) 新規追加

  機能分類
    ファイル入力
  バージョン
    4.0
  作成者
    儲
  導入されたバージョン:
    JDK5.0,

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `HeaderData()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `(package private) int` | `getColumnSize()` カラムサイズを返します。
    `(package private) String` | `getLastCellMsg()` 最後に実行しているセル情報を返します。
    `(package private) String[]` | `getNames()` カラム名情報を返します。
    `(package private) boolean` | `isSkip(org.apache.poi.ss.usermodel.Row oRow)` EXCEL ネイティブのデータを処理する ローカルクラスです。
    `(package private) String[]` | `row2Array(org.apache.poi.ss.usermodel.Row oRow)` カラム名情報を返します。
    `(package private) boolean` | `setColumns(String columns)` カラム名を外部から指定します。
    `(package private) void` | `setDebug(boolean isDebug)` デバッグ情報を、出力するかどうか[true/false]を指定します(初期値:false)。
    `(package private) void` | `setSheetConstData(String constKeys, String constAdrs)` 固定値となるカラム名(CSV形式)と、constAdrs 固定値となるアドレス(行-列,行-列,・・・)を設定します。
    `(package private) void` | `setSheetConstValues(org.apache.poi.ss.usermodel.Sheet sheet)` Sheet単位の固定値のキャッシュ(シートの最初に値を取得して保持しておく)を設定します。
    `(package private) void` | `setUseNumber(boolean useNumber)` 行番号情報を、使用しているかどうか[true/false]を指定します(初期値:true)。

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### HeaderData

          HeaderData()

  - ### メソッドの詳細

    - #### setDebug

          void setDebug(boolean isDebug)

      デバッグ情報を、出力するかどうか[true/false]を指定します(初期値:false)。 初期値は、false(出力しない) です。
      パラメータ:
        `isDebug` - デバッグ情報 [true:出力する/false:出力しない]
      変更履歴:

        5.5.8.2 (2012/11/09) 新規作成

    - #### setUseNumber

          void setUseNumber(boolean useNumber)

      行番号情報を、使用しているかどうか[true/false]を指定します(初期値:true)。 初期値は、true(使用する) です。
      パラメータ:
        `useNumber` - 行番号情報 [true:使用している/false:していない]
      変更履歴:

        5.1.6.0 (2010/05/01) 新規作成

    - #### setSheetConstData

          void setSheetConstData(String constKeys,
                               String constAdrs)

      固定値となるカラム名(CSV形式)と、constAdrs 固定値となるアドレス(行-列,行-列,・・・)を設定します。 アドレスは、EXCEL上の行-列をカンマ区切りで指定します。 行列は、EXCELオブジェクトに準拠するため、０から始まる整数です。 0-0 ⇒ A1 , 1-0 ⇒ A2 , 0-1 ⇒ B1 になります。 これにより、シートの一か所に書かれている情報を、DBTableModel のカラムに固定値として 設定することができます。 例として、DB定義書で、テーブル名をシートの全レコードに設定したい場合などに使います。 このメソッドは、isExcel() == true の場合のみ利用されます。 5.7.6.3 (2014/05/23) より、 ①EXCEL表記に準拠した、A1,A2,B1 の記述も処理できるように対応します。 なお、A1,A2,B1 の記述は、必ず、英字1文字＋数字 にしてください。(A～Zまで) ②処理中のEXCELシート名をカラムに割り当てるために、"SHEET" という記号に対応します。 例えば、sheetConstKeys="CLM,LANG,NAME" とし、sheetConstAdrs="0-0,A2,SHEET" とすると、 NAMEカラムには、シート名を読み込むことができます。 これは、内部処理の簡素化のためです。 ちなみに、EXCELのセルに、シート名を表示させる場合の関数は、下記の様になります。 =RIGHT(CELL("filename",$A$1),LEN(CELL("filename",$A$1))-FIND("]",CELL("filename",$A$1)))
      パラメータ:
        `constKeys` - 固定値となるカラム名(CSV形式)
        `constAdrs` - 固定値となるアドレス(行-列,行-列,・・・)
      変更履歴:

        5.5.8.2 (2012/11/09) 新規追加
        5.7.6.3 (2014/05/23) EXCEL表記(A2,B1等)の対応と、特殊記号(SHEET)の対応

    - #### setColumns

          boolean setColumns(String columns)

      カラム名を外部から指定します。 カラム名が、NULL でなければ、＃NAME より、こちらが優先されます。 カラム名は、順番に、指定する必要があります。
      パラメータ:
        `columns` - EXCELのカラム列(CSV形式)
      戻り値:
        true:処理実施/false:無処理
      変更履歴:

        5.1.6.0 (2010/05/01) 新規作成
        5.5.8.2 (2012/11/09) 固定値取得用の cnstIndx の設定を行う。

    - #### isSkip

          boolean isSkip(org.apache.poi.ss.usermodel.Row oRow)

      EXCEL ネイティブのデータを処理する ローカルクラスです。 このクラスでは、コメント行のスキップ判定、ヘッダー部のカラム名取得、 行情報(Row)から、カラムの配列の取得などを行います。
      パラメータ:
        `oRow` - Row EXCELの行オブジェクト
      戻り値:
        true:コメント行/false:通常行
      変更履歴:

        4.3.4.0 (2008/12/01) POI3.2対応

    - #### getNames

          String[] getNames()

      カラム名情報を返します。 ここでは、内部配列をそのまま返します。
      戻り値:
        String[] カラム列配列情報

    - #### getColumnSize

          int getColumnSize()

      カラムサイズを返します。
      戻り値:
        カラムサイズ

    - #### setSheetConstValues

          void setSheetConstValues(org.apache.poi.ss.usermodel.Sheet sheet)

      Sheet単位の固定値のキャッシュ(シートの最初に値を取得して保持しておく)を設定します。 これは、シートチェンジの最初に一度呼び出しておくことで、それ以降の列取得時に 固定値を利用することで処理速度向上を目指します。 "SHEET" が指定された場合は、cnstRowNo[j]=-1 が設定されている。
      パラメータ:
        `sheet` - Sheet EXCELのSheetオブジェクト
      変更履歴:

        5.5.8.2 (2012/11/09) 新規作成
        5.7.6.3 (2014/05/23) 特殊記号(SHEET)の対応

    - #### row2Array

          String[] row2Array(org.apache.poi.ss.usermodel.Row oRow)

      カラム名情報を返します。
      パラメータ:
        `oRow` - Row EXCELの行オブジェクト
      戻り値:
        String[] カラム列配列情報
      変更履歴:

        5.5.8.2 (2012/11/09) 固定値の設定を行う。

    - #### getLastCellMsg

          String getLastCellMsg()

      最後に実行しているセル情報を返します。 エラー発生時に、どのセルでエラーが発生したかの情報を取得できるようにします。
      戻り値:
        最後に実行しているセル情報の文字列
      変更履歴:

        5.5.1.2 (2012/04/06) 新規追加
        5.5.8.2 (2012/11/09) エラー情報に、シート名も追加

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.