org.opengion.hayabusa.report

## クラス ExcelLayoutData

- java.lang.Object
- - org.opengion.hayabusa.report.ExcelLayoutData

- すべての実装されたインタフェース:
    Comparable<ExcelLayoutData>

      public class ExcelLayoutData
      extends Object
      implements Comparable<ExcelLayoutData>

  雛形EXCELの {@カラム} 解析情報 を管理するローカルクラスです。 このクラスは、雛形EXCELより取得した、{@カラム} および、{@カラム_枝番}より カラム、行番号、列番号、枝番を取り出し、セルと１対１で管理する為のクラスです。 枝番が付かないカラムは、ヘッダー情報になる為、枝番を、－１ で設定します。 シート単位に呼び出す必要があります。 ｢注意：このクラスは、equals と一致しない自然な順序を持っています。｣
  機能分類
    帳票システム
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

    コンストラクタ
    コンストラクタと説明
    `ExcelLayoutData(String inkey, int rowNo, short colNo)` コンストラクター 雛形EXCELの{@カラム}を含むセルの値と、行列番号を設定します。

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `compareTo(ExcelLayoutData other)` 自然比較メソッド インタフェース Comparable の 実装です。
    `ExcelLayoutData` | `copy(int newRowNo, int newEdbn)` 行番号と枝番が異なる新しい ExcelLayoutData を返します。
    `boolean` | `equals(Object object)` この文字列と指定されたオブジェクトを比較します。
    `String` | `getClm()` カラム名を取得します。
    `short` | `getColNo()` 列番号を取得します。
    `int` | `getEdbn()` 枝番を取得します。
    `String` | `getKey()` 登録時のオリジナルのキー({@カラム_枝番})を取得します。
    `int` | `getRowNo()` 行番号を取得します。
    `int` | `hashCode()` このオブジェクトのハッシュコードを取得します。
    `String` | `toString()` このクラスの文字列表現を返します。

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

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

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

    - #### ExcelLayoutData

          public ExcelLayoutData(String inkey,
                         int rowNo,
                         short colNo)

      コンストラクター 雛形EXCELの{@カラム}を含むセルの値と、行列番号を設定します。 整合性チェックの条件は、先頭が "{@" で、最後が、"}" で、文字列の途中に、 "{@" が含まれていない場合のみとします。 内部で、カラムと枝番に分解します。
      パラメータ:
        `inkey` - 処理カラム({@カラム}形式)
        `rowNo` - 行番号
        `colNo` - 列番号

  - ### メソッドの詳細

    - #### getEdbn

          public int getEdbn()

      枝番を取得します。
      戻り値:
        ハッシュコード

    - #### getClm

          public String getClm()

      カラム名を取得します。
      戻り値:
        カラム名

    - #### getRowNo

          public int getRowNo()

      行番号を取得します。
      戻り値:
        行番号

    - #### getColNo

          public short getColNo()

      列番号を取得します。
      戻り値:
        列番号

    - #### getKey

          public String getKey()

      登録時のオリジナルのキー({@カラム_枝番})を取得します。
      戻り値:
        オリジナルのキー

    - #### copy

          public ExcelLayoutData copy(int newRowNo,
                             int newEdbn)

      行番号と枝番が異なる新しい ExcelLayoutData を返します。
      パラメータ:
        `newRowNo` - 行番号
        `newEdbn` - 枝番
      戻り値:
        新しいExcelLayoutData

    - #### hashCode

          public int hashCode()

      このオブジェクトのハッシュコードを取得します。 内部文字列(uniqKey)のハッシュコードと同じ値です。
      オーバーライド:
        `hashCode` クラス内 `Object`
      戻り値:
        ハッシュコード

    - #### equals

          public boolean equals(Object object)

      この文字列と指定されたオブジェクトを比較します。 引数が null でなく、このオブジェクトと同じ内部文字列(uniqKey)を持つ ExcelLayoutData オブジェクトである場合にだけ、結果は true になります。
      オーバーライド:
        `equals` クラス内 `Object`
      パラメータ:
        `object` - 比較するオブジェクト
      戻り値:
        Objectが等しい場合は true、そうでない場合は false

    - #### compareTo

          public int compareTo(ExcelLayoutData other)

      自然比較メソッド インタフェース Comparable の 実装です。 edbn 、clm 、rowNo 、colNo の順で比較します。
      定義:
        `compareTo` インタフェース内 `Comparable<ExcelLayoutData>`
      パラメータ:
        `other` - 比較対象のObject
      戻り値:
        このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数

    - #### toString

          public String toString()

      このクラスの文字列表現を返します。 内部文字列(uniqKey)と同じ値です。 ヘッダー：clm + ":[" + rowNo + "," + colNo + "]" 明細 ：clm + "_" + edbn + ":[" + rowNo + "," + colNo + "]"
      オーバーライド:
        `toString` クラス内 `Object`
      戻り値:
        文字列表現

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