org.opengion.hayabusa.db

## クラス DBColumnConfig

- java.lang.Object
- - org.opengion.hayabusa.db.DBColumnConfig

-     public final class DBColumnConfig
      extends java.lang.Object

       DBColumnオブジェクトを構築する為の 引数を持っているデータクラスです。
       このクラス自身は、書き換え可能ですが、DBColumnオブジェクトは、読込み専用の
       オブジェクトのため、別のオブジェクトを作成したい場合は,このクラスを
       DBColumnオブジェクトより取得し、内容を書き換えて、再度 DBColumnオブジェクトを
       構築することになります。

  機能分類
    テーブル管理
  変更履歴:
    3.4.0.0 (2003/09/01) 表示パラメータ、編集パラメータ、文字パラメータの追加。
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

    コンストラクタ
    コンストラクタと説明
    `DBColumnConfig(java.lang.String name)` 簡易コンストラクター キーのみを設定して作成する、簡易的な DBColumnConfig オブジェクトを 作成します。
    `DBColumnConfig(java.lang.String lang, java.lang.String name, LabelData labelData, java.lang.String className, java.lang.String fieldSize, java.lang.String viewLength, java.lang.String maxlength, java.lang.String writable, java.lang.String renderer, java.lang.String editor, CodeData codeData, java.lang.String dbType, java.lang.String dataDef, java.lang.String rendererPrm, java.lang.String editorPrm, java.lang.String dbTypePrm, java.lang.String roles, boolean official, java.lang.String dbid)` コンストラクター 引数は、すべて文字列型で渡します。

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getAddKeyLabel()` セレクトメニューの場合、キー:ラベル形式で表示するかどうか[true/false/null]を返します。
    `java.lang.String` | `getClassName()` カラムのクラスを文字列にした名称を返します。
    `CodeData` | `getCodeData()` コードデータオブジェクトを取得します。
    `ColumnData` | `getColumnData()` カラムデータオブジェクトを取得します。
    `java.lang.String` | `getDbid()` 接続先IDを返します。
    `java.lang.String` | `getDbType()` 文字種別名を返します。
    `java.lang.String` | `getDbTypeParam()` データタイプのパラメータを取得します。
    `java.lang.String` | `getDefault()` データのデフォルト値を返します。
    `java.lang.String` | `getEditor()` データの編集用エディターを返します。
    `Attributes` | `getEditorAttributes()` 編集用エディター用の追加属性を返します。
    `java.lang.String` | `getEditorParam()` 編集用エディターのパラメータを取得します。
    `java.lang.String` | `getEventColumn()` イベントカラム(親カラム)の取得 イベントカラムを取得します。
    `java.lang.String` | `getEventURL()` イベントURLの取得。
    `java.lang.String` | `getEventValue()` イベントカラムの子カラムの値を出力するためのSQL文の取得 イベントカラムの子カラムの値を出力するためのSQL文を取得します。
    `java.lang.String` | `getFieldSize()` カラムの入力枠サイズ(横幅)を文字数で取得します。
    `java.lang.String` | `getLabel()` ラベル名を返します。
    `LabelData` | `getLabelData()` ラベルデータオブジェクトを取得します。
    `java.lang.String` | `getLang()` 言語を返します。
    `java.lang.String` | `getMaxlength()` カラムの文字桁数を返します。
    `java.lang.String` | `getName()` カラム名を返します。
    `java.lang.String` | `getNoDisplayVal()` 非表示文字列を返します。
    `java.lang.String` | `getRawEditParameter()` {@XXXX}を変換していない状態の編集パラメータ 生のパラメータを取得します。
    `java.lang.String` | `getRawRendParameter()` {@XXXX}を変換していない状態の表示パラメータ 生のパラメータを取得します。
    `java.lang.String` | `getRenderer()` データの表示用レンデラーを返します。
    `Attributes` | `getRendererAttributes()` 表示用レンデラーの追加属性を返します。
    `java.lang.String` | `getRendererParam()` 表示用レンデラーのパラメータを取得します。
    `java.lang.String` | `getRoles()` カラムロールを返します。
    `java.lang.String` | `getUseSLabel()` MENU時にラベル短ベースで表示するかどうかのコントロール。
    `java.lang.String` | `getViewLength()` カラムの表示桁数を返します。
    `boolean` | `isAddNoValue()` メニューに空の選択リストを追加するかどうかを取得します。
    `boolean` | `isOfficial()` このカラムオブジェクトがカラムリソースより正式に作られたかどうかを取得します。
    `boolean` | `isStringOutput()` レンデラー利用ファイル出力時に数値等も文字タイプ固定にするかどうか (初期値:USE_STRING_EXCEL_OUTPUT[=])。
    `boolean` | `isWritable()` カラムが書き込み可能かどうか[true/false]を返します。
    `boolean` | `isWriteControl()` 設定値に "_" が含まれる書込み禁止カラムかどうかを返します。
    `boolean` | `isWriteKeyLabel()` セレクトメニューの場合、キーとラベルを分けて出力するかどうか[true/false]を取得します。
    `void` | `removeEditorAttributes(java.lang.String key, java.lang.String val)` 編集用エディター用の属性を削除します。
    `void` | `setAddKeyLabel(java.lang.String addKeyLbl)` セレクトメニューの場合、キー:ラベル形式で表示するかどうか[true/false/null]を指定します(初期値:null)。
    `void` | `setAddNoValue(boolean add)` メニューに空の選択リストを追加するかどうかを設定します。
    `void` | `setClassName(java.lang.String className)` カラムのクラスを文字列にした名称を設定します。
    `void` | `setCodeData(CodeData codeData)` コードデータオブジェクトを設定します。
    `void` | `setColumnData(ColumnData clmDt)` カラムデータオブジェクトを設定します。
    `void` | `setDbid(java.lang.String dbid)` 接続先IDを設定します。
    `void` | `setDbType(java.lang.String dbType)` データのタイプを設定します。
    `void` | `setDbTypeParam(java.lang.String inParam)` データタイプのパラメータをします。
    `void` | `setDefault(java.lang.String dataDef)` データのデフォルト値を設定します。
    `void` | `setEditor(java.lang.String editor)` データの編集用エディターを設定します。
    `void` | `setEditorAttributes(Attributes attri)` 編集用エディター用の追加属性を設定します。
    `void` | `setEditorParam(java.lang.String inParam)` 編集用エディターのパラメータを設定します。
    `void` | `setEventColumn(java.lang.String col)` イベントカラム(親カラム)のセット イベントカラムをセットします。
    `void` | `setEventURL(java.lang.String url)` イベントURLのセット。
    `void` | `setEventValue(java.lang.String val)` イベントカラムの子カラムの値を出力するためのSQL文のセット イベントカラムの子カラムの値を出力するためのSQL文をセットします。
    `void` | `setFieldSize(java.lang.String fieldSize)` カラムの入力枠サイズ(横幅)を文字数で設定します。
    `void` | `setLabelData(LabelData labelData)` ラベルデータオブジェクトを設定します。
    `void` | `setLang(java.lang.String lang)` 言語を設定します。
    `void` | `setMaxlength(java.lang.String maxlength)` カラムの文字桁数を設定します。
    `void` | `setName(java.lang.String name)` カラム名を設定します。
    `void` | `setNoDisplayVal(java.lang.String val)` 非表示文字列を設定します。
    `void` | `setOfficial(boolean official)` このカラムオブジェクトがカラムリソースより正式に作られたかどうかを設定します。
    `void` | `setParameter(java.lang.String inParam)` パラメータを設定します。
    `void` | `setRawEditParameter(java.lang.String param)` {@XXXX}を変換していない状態の編集種別 parameterセット用 DBColumn とのデータ変換のため、内部変数として、編集種別・表示種別を分けて管理します。
    `void` | `setRawParameter(java.lang.String param)` {@XXXX}を変換していない状態のparameterセット用 編集種別・表示種別 生のパラメータをセットします。
    `void` | `setRawRendParameter(java.lang.String param)` {@XXXX}を変換していない状態の表示種別 parameterセット用 DBColumn とのデータ変換のため、内部変数として、編集種別・表示種別を分けて管理します。
    `void` | `setRenderer(java.lang.String renderer)` データの表示用レンデラーを設定します。
    `void` | `setRendererAttributes(Attributes attri)` 表示用レンデラーの追加属性を設定します。
    `void` | `setRendererParam(java.lang.String inParam)` 表示用レンデラーのパラメータを設定します。
    `void` | `setRoles(java.lang.String roles)` カラムロールを設定します。
    `void` | `setStringOutput(boolean flag)` レンデラー利用ファイル出力時に数値等も文字タイプ固定にするかどうかを設定します (初期値:USE_STRING_EXCEL_OUTPUT[=])。
    `void` | `setUseSLabel(java.lang.String use)` MENU時にラベル短ベースで表示するかどうか[auto/true/その他]のコントロール auto/trueが有効。
    `void` | `setViewLength(java.lang.String viewLength)` カラムの表示桁数を設定します。
    `void` | `setWritable(java.lang.String writable)` カラムが書き込み可能かどうか[true/false]を設定します。
    `void` | `setWriteControl(boolean flag)` 設定値に "_" が含まれる書込み禁止カラムでかどうかを指定します。
    `void` | `setWriteKeyLabel(boolean flag)` セレクトメニューの場合、キーとラベルを分けて出力するかどうか[true/false]を指定します(初期値:false)。

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

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

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

    - #### DBColumnConfig

          public DBColumnConfig(java.lang.String lang,
                                java.lang.String name,
                                LabelData labelData,
                                java.lang.String className,
                                java.lang.String fieldSize,
                                java.lang.String viewLength,
                                java.lang.String maxlength,
                                java.lang.String writable,
                                java.lang.String renderer,
                                java.lang.String editor,
                                CodeData codeData,
                                java.lang.String dbType,
                                java.lang.String dataDef,
                                java.lang.String rendererPrm,
                                java.lang.String editorPrm,
                                java.lang.String dbTypePrm,
                                java.lang.String roles,
                                boolean official,
                                java.lang.String dbid)

      コンストラクター 引数は、すべて文字列型で渡します。
      パラメータ:
        `lang` - 言語
        `name` - カラム名
        `labelData` - カラムのラベルデータオブジェクト
        `className` - カラムのクラスを文字列にした名称
        `fieldSize` - 入力枠サイズ // 6.2.0.0 (2015/02/27)
        `viewLength` - カラムの表示文字数 // 6.2.0.0 (2015/02/27)
        `maxlength` - カラムの最大桁数
        `writable` - カラムが書き込み可能かどうか
        `renderer` - データの表示用レンデラー
        `editor` - データの編集用エディター
        `codeData` - メニューの項目オブジェクト
        `dbType` - データのタイプ
        `dataDef` - データのデフォルト値
        `rendererPrm` - 表示用レンデラーのパラメータ
        `editorPrm` - 編集用エディターのパラメータ
        `dbTypePrm` - データのタイプのパラメータ
        `roles` - カラムロール
        `official` - 正規カラムかどうか
        `dbid` - データベース接続先ID
      変更履歴:
        3.4.0.0 (2003/09/01) 表示パラメータ、編集パラメータ、文字パラメータの追加。, 3.5.5.7 (2004/05/10) CodeSelection を、codeName を元に構築できるように設定します。, 3.6.0.3 (2004/10/05) dbTypePrm は、editorPrm と無関係に設定します。, 3.6.0.7 (2004/11/06) カラムリソースから作成されたかどうか(official属性追加), 5.1.6.0 (2010/05/01) DBTypeの初期値を "XK" とします。, 5.7.3.0 (2014/02/07) labelData の null 対応, 6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)

    - #### DBColumnConfig

          public DBColumnConfig(java.lang.String name)

      簡易コンストラクター キーのみを設定して作成する、簡易的な DBColumnConfig オブジェクトを 作成します。
      パラメータ:
        `name` - カラム名
      変更履歴:
        3.4.0.0 (2003/09/01) 表示パラメータ、編集パラメータ、文字パラメータの追加。, 3.6.0.7 (2004/11/06) カラムリソースから作成されたかどうか(official属性追加), 5.1.6.0 (2010/05/01) DBTypeの初期値を "XK" とします。, 5.7.3.0 (2014/02/07) labelData の null 対応, 6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする), 6.2.3.0 (2015/05/01) もう一つのコンストラクタを呼びように変更。

  - ### メソッドの詳細

    - #### getLang

          public java.lang.String getLang()

      言語を返します。
      戻り値:
        言語

    - #### setLang

          public void setLang(java.lang.String lang)

      言語を設定します。
      パラメータ:
        `lang` - 言語

    - #### getName

          public java.lang.String getName()

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

    - #### setName

          public void setName(java.lang.String name)

      カラム名を設定します。
      パラメータ:
        `name` - カラム名

    - #### getLabel

          public java.lang.String getLabel()

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

    - #### getClassName

          public java.lang.String getClassName()

      カラムのクラスを文字列にした名称を返します。
      戻り値:
        カラムのクラスを文字列にした名称

    - #### setClassName

          public void setClassName(java.lang.String className)

      カラムのクラスを文字列にした名称を設定します。 "既存値:設定値" という指定を行えば、既存値を持っている場合のみ、設定値に置き換えます。
      パラメータ:
        `className` - カラムのクラス名
      変更履歴:
        6.4.1.1 (2016/01/16) "既存値:設定値" という指定を行えば、既存値を持っている場合のみ、設定値に置き換えます。

    - #### getFieldSize

          public java.lang.String getFieldSize()

      カラムの入力枠サイズ(横幅)を文字数で取得します。 fieldSize は、設定した場合のみ、使用できます。通常は、null が返ります。
      戻り値:
        カラムの入力枠サイズ
      変更履歴:
        6.2.0.0 (2015/02/27) fieldSize 属性の追加

    - #### setFieldSize

          public void setFieldSize(java.lang.String fieldSize)

      カラムの入力枠サイズ(横幅)を文字数で設定します。 従来の #setViewLength(String) で指定していた値です。
      パラメータ:
        `fieldSize` - カラムの入力枠サイズ
      変更履歴:
        6.2.0.0 (2015/02/27) fieldSize 属性の追加

    - #### getViewLength

          public java.lang.String getViewLength()

      カラムの表示桁数を返します。 viewLength は、設定した場合のみ、使用できます。通常は、null が返ります。
      戻り値:
        カラムの表示桁数
      変更履歴:
        4.0.0.0 (2005/01/31) メソッド名変更 getSize() → getViewLength()

    - #### setViewLength

          public void setViewLength(java.lang.String viewLength)

      カラムの表示桁数を設定します。
      パラメータ:
        `viewLength` - カラムの表示桁数
      変更履歴:
        4.0.0.0 (2005/01/31) メソッド名変更 setSize() → setViewLength()

    - #### getMaxlength

          public java.lang.String getMaxlength()

      カラムの文字桁数を返します。
      戻り値:
        カラムの文字桁数
      変更履歴:
        3.5.5.5 (2004/04/23) 新規追加

    - #### setMaxlength

          public void setMaxlength(java.lang.String maxlength)

      カラムの文字桁数を設定します。
      パラメータ:
        `maxlength` - カラムの文字桁数
      変更履歴:
        3.5.5.5 (2004/04/23) 新規追加

    - #### isWritable

          public boolean isWritable()

      カラムが書き込み可能かどうか[true/false]を返します。
      戻り値:
        カラムが書き込み可能かどうか[true/false]

    - #### setWritable

          public void setWritable(java.lang.String writable)

      カラムが書き込み可能かどうか[true/false]を設定します。
      パラメータ:
        `writable` - 書き込み可能かどうか[true/false]

    - #### getRenderer

          public java.lang.String getRenderer()

      データの表示用レンデラーを返します。
      戻り値:
        データの表示用レンデラー
      変更履歴:
        3.1.0.0 (2003/03/20) Renderer をキーのみ返すように変更

    - #### setRenderer

          public void setRenderer(java.lang.String renderer)

      データの表示用レンデラーを設定します。 "既存値:設定値" という指定を行えば、既存値を持っている場合のみ、設定値に置き換えます。
      パラメータ:
        `renderer` - 表示用レンデラー
      変更履歴:
        6.4.1.1 (2016/01/16) "既存値:設定値" という指定を行えば、既存値を持っている場合のみ、設定値に置き換えます。

    - #### getEditor

          public java.lang.String getEditor()

      データの編集用エディターを返します。
      戻り値:
        データの編集用エディター
      変更履歴:
        3.1.0.0 (2003/03/20) Editor をキーのみ返すように変更

    - #### setEditor

          public void setEditor(java.lang.String editor)

      データの編集用エディターを設定します。 "既存値:設定値" という指定を行えば、既存値を持っている場合のみ、設定値に置き換えます。
      パラメータ:
        `editor` - 編集用エディター
      変更履歴:
        6.4.1.1 (2016/01/16) "既存値:設定値" という指定を行えば、既存値を持っている場合のみ、設定値に置き換えます。

    - #### getDbType

          public java.lang.String getDbType()

      文字種別名を返します。
      戻り値:
        データの文字種別

    - #### setDbType

          public void setDbType(java.lang.String dbType)

      データのタイプを設定します。 "既存値:設定値" という指定を行えば、既存値を持っている場合のみ、設定値に置き換えます。
      パラメータ:
        `dbType` - 文字種別
      変更履歴:
        5.1.6.0 (2010/05/01) DBTypeの初期値を "XK" とします。, 6.4.1.1 (2016/01/16) "既存値:設定値" という指定を行えば、既存値を持っている場合のみ、設定値に置き換えます。

    - #### getRoles

          public java.lang.String getRoles()

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

    - #### setRoles

          public void setRoles(java.lang.String roles)

      カラムロールを設定します。
      パラメータ:
        `roles` - カラムロール

    - #### getDefault

          public java.lang.String getDefault()

      データのデフォルト値を返します。
      戻り値:
        データのデフォルト値
      変更履歴:
        5.1.8.0 (2010/07/01) メソッド名変更(getDefValue ⇒ getDefault)

    - #### setDefault

          public void setDefault(java.lang.String dataDef)

      データのデフォルト値を設定します。
      パラメータ:
        `dataDef` - デフォルト値
      変更履歴:
        5.1.8.0 (2010/07/01) メソッド名変更(setDefValue ⇒ setDefault)

    - #### getRendererAttributes

          public Attributes getRendererAttributes()

      表示用レンデラーの追加属性を返します。
      戻り値:
        属性リスト
      このメソッドは、nullを返しません

    - #### setRendererAttributes

          public void setRendererAttributes(Attributes attri)

      表示用レンデラーの追加属性を設定します。 元のrendAttriが、何も設定されていない場合は、引数のAttributesに 置き換えます。 すでに、設定済みの場合は、putAll で、すべての属性を追加します。 既存の属性は、そのまま残りますので、クリアしたい場合は、 先に、getRendererAttributes() で取り出した Attributes を、 clear() してから、セットしてください。
      パラメータ:
        `attri` - 属性リスト
      変更履歴:
        6.4.5.2 (2016/05/06) Attributesは、既存のAttributesに、ADDする。

    - #### getEditorAttributes

          public Attributes getEditorAttributes()

      編集用エディター用の追加属性を返します。
      戻り値:
        追加属性
      このメソッドは、nullを返しません

    - #### setEditorAttributes

          public void setEditorAttributes(Attributes attri)

      編集用エディター用の追加属性を設定します。 元のrendAttriが、何も設定されていない場合は、引数のAttributesに 置き換えます。 すでに、設定済みの場合は、putAll で、すべての属性を追加します。 既存の属性は、そのまま残りますので、クリアしたい場合は、 先に、getEditorAttributes() で取り出した Attributes を、 clear() してから、セットしてください。
      パラメータ:
        `attri` - 属性リスト
      変更履歴:
        6.4.5.2 (2016/05/06) Attributesは、既存のAttributesに、ADDする。

    - #### removeEditorAttributes

          public void removeEditorAttributes(java.lang.String key,
                                             java.lang.String val)

      編集用エディター用の属性を削除します。 属性を、入れ替えではなく、追加したことで、削除が困難になりました。 そこで、属性の削除が出来るようにします。 キーとなる設定値から、値の文字列を切り取ります。 class 属性など、スペース連結の場合は、問題はありませんが、カンマ連結では カンマが連続で並びますので、うまく対応できません。 属性値が、一致する場合と、val がnullの場合は、そのキー自体を削除します。
      パラメータ:
        `key` - 属性キー
        `val` - 属性値
      変更履歴:
        6.8.1.4 (2017/08/25) must="false"で、setEditorAttributes の属性の取り消しが出来ないための対応。

    - #### setParameter

          public void setParameter(java.lang.String inParam)

      パラメータを設定します。 ここで設定された値は、すべて(表示、編集、文字)のパラメータにセットされます。
      パラメータ:
        `inParam` - 入力パラメータ
      変更履歴:
        3.4.0.0 (2003/09/01) 表示パラメータ、編集パラメータ、文字パラメータの追加。

    - #### getRendererParam

          public java.lang.String getRendererParam()

      表示用レンデラーのパラメータを取得します。
      戻り値:
        表示用レンデラーのパラメータ
      変更履歴:
        3.4.0.0 (2003/09/01) 新規追加

    - #### setRendererParam

          public void setRendererParam(java.lang.String inParam)

      表示用レンデラーのパラメータを設定します。
      パラメータ:
        `inParam` - 表示用レンデラーのパラメータ
      変更履歴:
        3.4.0.0 (2003/09/01) 新規追加

    - #### getEditorParam

          public java.lang.String getEditorParam()

      編集用エディターのパラメータを取得します。
      戻り値:
        編集用エディターのパラメータ
      変更履歴:
        3.4.0.0 (2003/09/01) 新規追加

    - #### setEditorParam

          public void setEditorParam(java.lang.String inParam)

      編集用エディターのパラメータを設定します。
      パラメータ:
        `inParam` - 編集用エディターのパラメータ
      変更履歴:
        3.4.0.0 (2003/09/01) 新規追加

    - #### getDbTypeParam

          public java.lang.String getDbTypeParam()

      データタイプのパラメータを取得します。
      戻り値:
        データタイプのパラメータ
      変更履歴:
        3.4.0.0 (2003/09/01) 新規追加

    - #### setDbTypeParam

          public void setDbTypeParam(java.lang.String inParam)

      データタイプのパラメータをします。
      パラメータ:
        `inParam` - データタイプのパラメータ
      変更履歴:
        3.4.0.0 (2003/09/01) 新規追加

    - #### isAddNoValue

          public boolean isAddNoValue()

      メニューに空の選択リストを追加するかどうかを取得します。
      戻り値:
        選択リストを追加するかどうか(true:追加する/false:追加しない)
      変更履歴:
        3.5.5.7 (2004/05/10) 新規追加

    - #### setAddNoValue

          public void setAddNoValue(boolean add)

      メニューに空の選択リストを追加するかどうかを設定します。
      パラメータ:
        `add` - [true:追加する/false:追加しない]
      変更履歴:
        3.5.5.7 (2004/05/10) 新規追加

    - #### setAddKeyLabel

          public void setAddKeyLabel(java.lang.String addKeyLbl)

      セレクトメニューの場合、キー:ラベル形式で表示するかどうか[true/false/null]を指定します(初期値:null)。 カラムがプルダウンメニュー形式の場合、キー:ラベル形式で表示するか、ラベルだけで表示するかを 選択できます。 true を指定すると、「強制的に」キー:ラベル形式で表示します。 false の場合は、「強制的に」ラベルのみで表示されます。 初期値の null の場合、コードリソースや、SQL文に準拠した指定通りの形式で表示します。 <og:column name="CDC" addKeyLabel="true" />
      パラメータ:
        `addKeyLbl` - [true:キー:ラベル形式/false:ラベルのみ/null:指定通り]
      関連項目:
        `getAddKeyLabel()`
      変更履歴:
        6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか。新規追加

    - #### getAddKeyLabel

          public java.lang.String getAddKeyLabel()

      セレクトメニューの場合、キー:ラベル形式で表示するかどうか[true/false/null]を返します。 これは、上位入れ子のタグの OptionTag で、addKeyLabel を取り出して、 true であれば、キー:ラベル形式 のオプションを、#addOption( String ) で 登録させます。
      戻り値:
        true:キー:ラベル形式/false:ラベルのみ/null:指定通り
      関連項目:
        `setAddKeyLabel( String )`
      変更履歴:
        6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか。新規追加

    - #### setWriteKeyLabel

          public void setWriteKeyLabel(boolean flag)

      セレクトメニューの場合、キーとラベルを分けて出力するかどうか[true/false]を指定します(初期値:false)。 カラムがプルダウンメニュー形式の場合、ファイル出力時に、キーとラベルを分離して出力する事ができます。 この属性と、addKeyLabel とは、微妙に関連していて、addKeyLabel="true" のみの場合は、 キー:ラベル形式で、出力されますが、writeKeyLabel="true" も指定されている場合は、こちらが優先されます。 なお、この指定が有効なのは、セレクトメニューのカラムのみです。 初期値は、false です。
      パラメータ:
        `flag` - キー／ラベル分離出力するかどうか [true:分離出力/false:通常]
      変更履歴:
        6.2.3.0 (2015/05/01) キー／ラベルで分離して出力するかどうか。

    - #### isWriteKeyLabel

          public boolean isWriteKeyLabel()

      セレクトメニューの場合、キーとラベルを分けて出力するかどうか[true/false]を取得します。 カラムがプルダウンメニュー形式の場合、ファイル出力時に、キーとラベルを分離して出力する事ができます。 この属性と、addKeyLabel とは、微妙に関連していて、addKeyLabel="true" のみの場合は、 キー:ラベル形式で、出力されますが、writeKeyLabel="true" も指定されている場合は、こちらが優先されます。 なお、この指定が有効なのは、セレクトメニューのカラムのみです。
      戻り値:
        キー／ラベル分離出力するかどうか[true:分離出力/false:通常]
      変更履歴:
        6.2.3.0 (2015/05/01) キー／ラベルで分離して出力するかどうか。

    - #### isOfficial

          public boolean isOfficial()

      このカラムオブジェクトがカラムリソースより正式に作られたかどうかを取得します。 カラムリソースが無い場合は、仮オブジェクトかデータベースメタデータより作成されます。 その場合は、チェック機能が緩くなるため、正式なカラムオブジェクトと区別する為に この属性を持ちます。
      戻り値:
        カラムリソースより正式に作られたかどうか(true:正式/false:暫定)
      変更履歴:
        3.6.0.7 (2004/11/06) 新規追加

    - #### setOfficial

          public void setOfficial(boolean official)

      このカラムオブジェクトがカラムリソースより正式に作られたかどうかを設定します。 従来は、自動判定で、再セット不可能でしたが、動的カラムを実現する場合に、 エラーチェックで引っかかるため、再設定可能にします。
      パラメータ:
        `official` - 正式かどうか [true:正式/false:暫定]
      変更履歴:
        5.4.3.4 (2012/01/12) 新規追加

    - #### setDbid

          public void setDbid(java.lang.String dbid)

      接続先IDを設定します。
      パラメータ:
        `dbid` - 接続先ID

    - #### getDbid

          public java.lang.String getDbid()

      接続先IDを返します。
      戻り値:
        接続先ID

    - #### getColumnData

          public ColumnData getColumnData()

      カラムデータオブジェクトを取得します。
      戻り値:
        カラムデータオブジェクト
      このメソッドは、nullを返しません

    - #### setColumnData

          public void setColumnData(ColumnData clmDt)

      カラムデータオブジェクトを設定します。 ここでは、オブジェクトその物を持つのではなく、設定された値のみ持ちます。
      パラメータ:
        `clmDt` - カラムデータオブジェクト

    - #### getCodeData

          public CodeData getCodeData()

      コードデータオブジェクトを取得します。
      戻り値:
        コードデータオブジェクト
      変更履歴:
        4.0.0.0 (2005/01/31) 新規作成

    - #### setCodeData

          public void setCodeData(CodeData codeData)

      コードデータオブジェクトを設定します。
      パラメータ:
        `codeData` - コードデータオブジェクト
      変更履歴:
        4.0.0.0 (2005/01/31) 新規作成

    - #### getLabelData

          public LabelData getLabelData()

      ラベルデータオブジェクトを取得します。
      戻り値:
        ラベルデータオブジェクト

    - #### setLabelData

          public void setLabelData(LabelData labelData)

      ラベルデータオブジェクトを設定します。
      パラメータ:
        `labelData` - ラベルデータオブジェクト

    - #### setEventColumn

          public void setEventColumn(java.lang.String col)

      イベントカラム(親カラム)のセット イベントカラムをセットします。
      パラメータ:
        `col` - 親カラムID
      変更履歴:
        4.3.6.0 (2009/04/01)

    - #### getEventColumn

          public java.lang.String getEventColumn()

      イベントカラム(親カラム)の取得 イベントカラムを取得します。
      戻り値:
        イベントカラム
      変更履歴:
        4.3.6.0 (2009/04/01)

    - #### setEventValue

          public void setEventValue(java.lang.String val)

      イベントカラムの子カラムの値を出力するためのSQL文のセット イベントカラムの子カラムの値を出力するためのSQL文をセットします。
      パラメータ:
        `val` - イベントカラムの値SQL文
      変更履歴:
        6.3.3.0 (2015/07/25) eventValue 追加

    - #### getEventValue

          public java.lang.String getEventValue()

      イベントカラムの子カラムの値を出力するためのSQL文の取得 イベントカラムの子カラムの値を出力するためのSQL文を取得します。
      戻り値:
        イベントカラムの値SQL文
      変更履歴:
        6.3.3.0 (2015/07/25) eventValue 追加

    - #### getRawEditParameter

          public java.lang.String getRawEditParameter()

      {@XXXX}を変換していない状態の編集パラメータ 生のパラメータを取得します。
      戻り値:
        生編集パラメータ
      変更履歴:
        4.3.6.0 (2009/04/01)

    - #### getRawRendParameter

          public java.lang.String getRawRendParameter()

      {@XXXX}を変換していない状態の表示パラメータ 生のパラメータを取得します。
      戻り値:
        生表示パラメータ
      変更履歴:
        5.1.7.0 (2010/06/01) 動的プルダウン実装見直し

    - #### setRawParameter

          public void setRawParameter(java.lang.String param)

      {@XXXX}を変換していない状態のparameterセット用 編集種別・表示種別 生のパラメータをセットします。(編集種別・表示種別の両方に適用されます。)
      パラメータ:
        `param` - パラメータ
      変更履歴:
        4.3.6.0 (2009/04/01), 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し

    - #### setRawEditParameter

          public void setRawEditParameter(java.lang.String param)

      {@XXXX}を変換していない状態の編集種別 parameterセット用 DBColumn とのデータ変換のため、内部変数として、編集種別・表示種別を分けて管理します。
      パラメータ:
        `param` - パラメータ
      変更履歴:
        5.1.8.0 (2010/07/01) 新規追加

    - #### setRawRendParameter

          public void setRawRendParameter(java.lang.String param)

      {@XXXX}を変換していない状態の表示種別 parameterセット用 DBColumn とのデータ変換のため、内部変数として、編集種別・表示種別を分けて管理します。
      パラメータ:
        `param` - パラメータ
      変更履歴:
        5.1.8.0 (2010/07/01) 新規追加

    - #### setEventURL

          public void setEventURL(java.lang.String url)

      イベントURLのセット。 イベントカラム利用時にコールされるURLのセット
      パラメータ:
        `url` - イベントURL
      変更履歴:
        4.3.6.0 (2009/04/01)

    - #### getEventURL

          public java.lang.String getEventURL()

      イベントURLの取得。 eventColumn利用時のJSから呼び出すためのURL取得
      戻り値:
        イベントURL
      変更履歴:
        4.3.6.0 (2009/04/01)

    - #### setUseSLabel

          public void setUseSLabel(java.lang.String use)

      MENU時にラベル短ベースで表示するかどうか[auto/true/その他]のコントロール auto/trueが有効。それ以外はfalse扱いとする。標準auto
      パラメータ:
        `use` - 表示するかどうか[auto/true/その他]
      変更履歴:
        5.5.1.0 (2012/04/03)

    - #### getUseSLabel

          public java.lang.String getUseSLabel()

      MENU時にラベル短ベースで表示するかどうかのコントロール。
      戻り値:
        イベントURL
      変更履歴:
        5.5.1.0 (2012/04/03)

    - #### setNoDisplayVal

          public void setNoDisplayVal(java.lang.String val)

      非表示文字列を設定します。 これは、例えば、数字型の場合は、0 がデフォルトなどの場合、 あえて表示したくないなどのケースに使います。 そのような状況が設定されていない場合は、null を設定してください。 初期値は、null です。
      パラメータ:
        `val` - 非表示にする文字列
      変更履歴:
        5.6.2.3 (2013/03/22) 新規追加

    - #### getNoDisplayVal

          public java.lang.String getNoDisplayVal()

      非表示文字列を返します。 これは、例えば、数字型の場合は、0 がデフォルトなどの場合、 あえて表示したくないなどのケースに使います。 そのような状況が設定されていない場合は、null が返されます。 初期値は、null です。
      戻り値:
        非表示文字
      変更履歴:
        5.6.2.3 (2013/03/22) 新規追加

    - #### setStringOutput

          public void setStringOutput(boolean flag)

      レンデラー利用ファイル出力時に数値等も文字タイプ固定にするかどうかを設定します (初期値:USE_STRING_EXCEL_OUTPUT[=])。 これは、レンデラーでのExcel出力時のセルタイプに影響します。 trueの場合は数値も全て文字として出力します。 falseの場合はDBTYPEに従った出力になりるため、数値型の DBTYPE では、doubleに一度変換されます。 (初期値:USE_STRING_EXCEL_OUTPUT[=])。
      パラメータ:
        `flag` - レンデラー利用時の出力方法 (true:String出力/false:DBTYPEに従う)
      変更履歴:
        5.7.6.3 (2014/05/23) 新規追加

    - #### isStringOutput

          public boolean isStringOutput()

      レンデラー利用ファイル出力時に数値等も文字タイプ固定にするかどうか (初期値:USE_STRING_EXCEL_OUTPUT[=])。 これは、レンデラーでのExcel出力時のセルタイプに影響します。 trueの場合は数値も全て文字として出力します。 falseの場合はDBTYPEに従った出力になりるため、数値型の DBTYPE では、doubleに一度変換されます。 (初期値:USE_STRING_EXCEL_OUTPUT[=])。
      戻り値:
        レンデラー利用時の出力方法 (true:String出力/false:DBTYPEに従う)
      変更履歴:
        5.7.6.3 (2014/05/23) 新規追加

    - #### setWriteControl

          public void setWriteControl(boolean flag)

      設定値に "_" が含まれる書込み禁止カラムでかどうかを指定します。 true に設定された場合は、#getWriteValue( String ) で、先頭のアンダーバーを 削除して返します。 初期値は、false:使わないです。
      パラメータ:
        `flag` - writableControlを使うかどうか [true:使う/false:使わない]
      変更履歴:
        7.0.1.5 (2018/12/10) writeCtrlで出力時のアンダーバー削除

    - #### isWriteControl

          public boolean isWriteControl()

      設定値に "_" が含まれる書込み禁止カラムかどうかを返します。 true に設定された場合は、#getWriteValue( String ) で、先頭のアンダーバーを 削除して返します。 初期値は、false:使わないです。
      戻り値:
        writableControlを使うかどうか [true:使う/false:使わない]
      変更履歴:
        7.0.1.5 (2018/12/10) writeCtrlで出力時のアンダーバー削除

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