org.opengion.hayabusa.resource

## クラス ColumnData

- java.lang.Object
- - org.opengion.hayabusa.resource.ColumnData

-     public final class ColumnData
      extends Object

       systemId に対応したカラムデータを作成します。

       カラムデータは、項目(CLM)に対して、各種カラム情報を持っています。
       エンジン内部で使用している DBColumn オブジェクトは、RENDERER や EDITOR など
       実際にはオブジェクトで管理していますが、この ColumnData では、それらのキーとなる
       文字列を持っています。実際に DBColumn オブジェクトの構築時に、各属性オブジェクトを
       生成(または、キャッシュから取り出し)ます。

       カラムデータを作成する場合は、同一カラムで、作成区分(KBSAKU)違いの場合は、
       最も大きな作成区分を持つコードを使用します。
       作成区分(KBSAKU)は、0:システム予約、1:アプリ設定、2:ユーザー設定 という具合に
       カスタマイズの度合いに応じて大きな数字を割り当てることで、キー情報を上書き修正
       することが可能になります。(削除することは出来ません。)

  変更履歴:

    4.0.0.0 (2004/12/31) 新規作成

  機能分類
    リソース管理
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `static int` | `CLM` 内部データのカラム番号 0
    `static int` | `CLM_PARAM` 内部データのカラム番号 10
    `static int` | `CLS_NAME` 内部データのカラム番号 1
    `static int` | `CODE_CLM` 内部データのカラム番号 9
    `static int` | `DATA_DEFAULT` 内部データのカラム番号 7
    `static int` | `DATA_SIZE` 内部データのカラム数 16
    `static int` | `DBTYPE` 内部データのカラム番号 6
    `static int` | `EDITOR` 内部データのカラム番号 5
    `static int` | `EDITOR_PARAM` 内部データのカラム番号 12
    `(package private) static int` | `FG_LOAD` リソース読み込みのために一時利用 4.3.5.7 (2009/03/22)
    `static int` | `FIELD_SIZE` 内部データのカラム番号 15
    `static int` | `LABEL_CLM` 内部データのカラム番号 8
    `static int` | `RENDERER` 内部データのカラム番号 4
    `static int` | `RENDERER_PARAM` 内部データのカラム番号 11
    `static int` | `ROLES` 内部データのカラム番号 14
    `(package private) static int` | `SYSTEM_ID` FGLOAD の読み込み済み設定用のSYSTEM_ID 6.3.1.1 (2015/07/10)
    `static int` | `TYPE_PARAM` 内部データのカラム番号 13
    `(package private) static int` | `UNIQ` FGLOAD の読み込み済み設定用のUNIQ 6.3.1.1 (2015/07/10)
    `static int` | `USE_LENGTH` 内部データのカラム番号 2
    `static int` | `VIEW_LENGTH` 内部データのカラム番号 3

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

    コンストラクタ
    コンストラクタと説明
    `ColumnData(String[] data)` 配列文字列のデータを元に、ColumnDataオブジェクトを構築します。

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `String` | `getClassName()` カラムのデータの属性を返します。
    `String` | `getCodeColumn()` コードカラムを返します。
    `String[]` | `getColumnData()` 内部データの文字列配列を返します。
    `String` | `getColumnParam()` カラムのパラメータを取得します。
    `String` | `getDbType()` 文字種別を返します。
    `String` | `getDbTypeParam()` データタイプのパラメータを取得します。
    `String` | `getDefault()` データのデフォルト値を返します。
    `String` | `getEditor()` 編集種別を返します。
    `String` | `getEditorParam()` 編集用エディターのパラメータを取得します。
    `String` | `getFieldSize()` フィールドの入力枠サイズを返します。
    `String` | `getLabelColumn()` ラベルカラムを返します。
    `String` | `getMaxlength()` フィールドの使用桁数を返します。
    `String` | `getName()` カラム名を返します。
    `String` | `getRenderer()` 表示種別を返します。
    `String` | `getRendererParam()` 表示用レンデラーのパラメータを取得します。
    `RoleMode` | `getRoleMode()` カラムオブジェクトのロールモードを返します。
    `String` | `getRoles()` カラムロールを取得します。
    `int` | `getSizeX()` フィールドの整数部のデータ長を返します。
    `int` | `getSizeY()` フィールドの小数部のデータ長を返します。
    `int` | `getTotalSize()` フィールドのデータ長を返します。
    `String` | `getViewLength()` 文字列の表示文字数を返します。
    `boolean` | `isOfficial()` リソースＤＢから作成されたかどうかを返します。

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

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

- - ### フィールドの詳細

    - #### CLM

          public static final int CLM

      内部データのカラム番号 0
      関連項目:
        定数フィールド値

    - #### CLS_NAME

          public static final int CLS_NAME

      内部データのカラム番号 1
      関連項目:
        定数フィールド値

    - #### USE_LENGTH

          public static final int USE_LENGTH

      内部データのカラム番号 2
      関連項目:
        定数フィールド値

    - #### VIEW_LENGTH

          public static final int VIEW_LENGTH

      内部データのカラム番号 3
      関連項目:
        定数フィールド値

    - #### RENDERER

          public static final int RENDERER

      内部データのカラム番号 4
      関連項目:
        定数フィールド値

    - #### EDITOR

          public static final int EDITOR

      内部データのカラム番号 5
      関連項目:
        定数フィールド値

    - #### DBTYPE

          public static final int DBTYPE

      内部データのカラム番号 6
      関連項目:
        定数フィールド値

    - #### DATA_DEFAULT

          public static final int DATA_DEFAULT

      内部データのカラム番号 7
      関連項目:
        定数フィールド値

    - #### LABEL_CLM

          public static final int LABEL_CLM

      内部データのカラム番号 8
      関連項目:
        定数フィールド値

    - #### CODE_CLM

          public static final int CODE_CLM

      内部データのカラム番号 9
      関連項目:
        定数フィールド値

    - #### CLM_PARAM

          public static final int CLM_PARAM

      内部データのカラム番号 10
      関連項目:
        定数フィールド値

    - #### RENDERER_PARAM

          public static final int RENDERER_PARAM

      内部データのカラム番号 11
      関連項目:
        定数フィールド値

    - #### EDITOR_PARAM

          public static final int EDITOR_PARAM

      内部データのカラム番号 12
      関連項目:
        定数フィールド値

    - #### TYPE_PARAM

          public static final int TYPE_PARAM

      内部データのカラム番号 13
      関連項目:
        定数フィールド値

    - #### ROLES

          public static final int ROLES

      内部データのカラム番号 14
      関連項目:
        定数フィールド値

    - #### FIELD_SIZE

          public static final int FIELD_SIZE

      内部データのカラム番号 15
      関連項目:
        定数フィールド値

    - #### DATA_SIZE

          public static final int DATA_SIZE

      内部データのカラム数 16
      関連項目:
        定数フィールド値

    - #### FG_LOAD

          static final int FG_LOAD

      リソース読み込みのために一時利用 4.3.5.7 (2009/03/22)
      関連項目:
        定数フィールド値

    - #### UNIQ

          static final int UNIQ

      FGLOAD の読み込み済み設定用のUNIQ 6.3.1.1 (2015/07/10)
      関連項目:
        定数フィールド値

    - #### SYSTEM_ID

          static final int SYSTEM_ID

      FGLOAD の読み込み済み設定用のSYSTEM_ID 6.3.1.1 (2015/07/10)
      関連項目:
        定数フィールド値

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

    - #### ColumnData

          public ColumnData(String[] data)

      配列文字列のデータを元に、ColumnDataオブジェクトを構築します。 このコンストラクタは、他のパッケージから呼び出せないように、 パッケージプライベートにしておきます。 このコンストラクタは、ＤＢリソースファイルを想定しています。
      パラメータ:
        `data` - CLM,CLS_NAME,USE_LENGTH,VIEW_LENGTH, RENDERER,EDITOR,DBTYPE,DATA_DEFAULT,LABEL_CLM,CODE_CLM, CLM_PARAM,RENDERER_PARAM,EDITOR_PARAM,TYPE_PARAM,ROLES,FIELD_SIZE
      変更履歴:

        4.3.0.0 (2008/07/04) ロールモードマルチ対応
        5.1.6.0 (2010/05/01) DBTypeの初期値を "XK" とします。
        5.2.2.0 (2010/11/01) パラメーターもVer3互換のためNVAL2で処理します。
        5.5.8.5 (2012/11/27) 編集パラメータで、"=" と記述されている場合は、表示パラメータを利用する。
        6.1.0.0 (2014/12/26) カラムの表示桁数(小数部)対応
        6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)

  - ### メソッドの詳細

    - #### getName

          public String getName()

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

    - #### getClassName

          public String getClassName()

      カラムのデータの属性を返します。
      戻り値:
        カラムのデータの属性

    - #### getMaxlength

          public String getMaxlength()

      フィールドの使用桁数を返します。 小数指定の場合は、"7,3" のようなカンマで整数部、小数部を区切った書式になります。 7,3 は、 xxxx,yyy のフォーマットで、整数部４桁、小数部３桁を意味します。
      戻り値:
        使用桁数

    - #### getTotalSize

          public int getTotalSize()

      フィールドのデータ長を返します。 通常は、整数型の文字列とデータ長は同じですが,小数点を表すデータ長は x.y 形式の場合、x + 1 桁で表されます。 6.2 は、 xxxx.yy のフォーマットです。
      戻り値:
        データ長定義文字列

    - #### getSizeX

          public int getSizeX()

      フィールドの整数部のデータ長を返します。
      戻り値:
        データ長定義文字列

    - #### getSizeY

          public int getSizeY()

      フィールドの小数部のデータ長を返します。
      戻り値:
        データ長定義文字列

    - #### getViewLength

          public String getViewLength()

      文字列の表示文字数を返します。 これは、テキストフィールドのサイズではなく、Renderer系の表示に使用する 文字数指定に使われます。 無指定の場合は、null が返されます。
      戻り値:
        表示文字数

    - #### getFieldSize

          public String getFieldSize()

      フィールドの入力枠サイズを返します。 テキストフィールドのサイズに該当します。 何も指定しない場合は、null が返ります。 その場合の、入力枠サイズは、maxlength が使用されます。 ただし、桁数が大きい場合は、システム定数の HTML_COLUMNS_MAXSIZE や、 HTML_VIEW_COLUMNS_MAXSIZE で指定された値が使われます。 それらの値よりも、ここで取得 した fieldSize が優先されます。
      戻り値:
        入力枠サイズ
      変更履歴:

        6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)

    - #### getRenderer

          public String getRenderer()

      表示種別を返します。
      戻り値:
        表示種別の文字列

    - #### getEditor

          public String getEditor()

      編集種別を返します。
      戻り値:
        編集種別

    - #### getDbType

          public String getDbType()

      文字種別を返します。
      戻り値:
        文字種別

    - #### getLabelColumn

          public String getLabelColumn()

      ラベルカラムを返します。
      戻り値:
        ラベルカラム

    - #### getCodeColumn

          public String getCodeColumn()

      コードカラムを返します。
      戻り値:
        コードカラム

    - #### getDefault

          public String getDefault()

      データのデフォルト値を返します。
      戻り値:
        データのデフォルト値

    - #### getColumnParam

          public String getColumnParam()

      カラムのパラメータを取得します。
      戻り値:
        カラムパラメータ

    - #### getRendererParam

          public String getRendererParam()

      表示用レンデラーのパラメータを取得します。
      戻り値:
        表示パラメータ

    - #### getEditorParam

          public String getEditorParam()

      編集用エディターのパラメータを取得します。
      戻り値:
        編集パラメータ

    - #### getDbTypeParam

          public String getDbTypeParam()

      データタイプのパラメータを取得します。
      戻り値:
        データタイプのパラメータ

    - #### getRoles

          public String getRoles()

      カラムロールを取得します。
      戻り値:
        カラムロール

    - #### getRoleMode

          public RoleMode getRoleMode()

      カラムオブジェクトのロールモードを返します。
      戻り値:
        カラムオブジェクトのロールモード
      変更履歴:

        4.3.0.0 (2008/07/04) ロールモードマルチ対応

    - #### isOfficial

          public boolean isOfficial()

      リソースＤＢから作成されたかどうかを返します。 正式な場合は、true / リソースになく、独自に作成された場合は、false になります。
      戻り値:
        リソースＤＢから作成されたかどうか

    - #### getColumnData

          public String[] getColumnData()

      内部データの文字列配列を返します。
      戻り値:
        内部データの文字列配列
      変更履歴:

        6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)

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