org.opengion.hayabusa.db

## クラス DBColumn

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

-     public final class DBColumn
      extends Object

       DBType インターフェースを継承した Abstractクラスです。
       getRendererValue( String value ) 、getEditorValue( String value ) 、
       isValueChack( String ) メソッドを、サブクラスで実装する必要があります。

  変更履歴:

    3.4.0.0 (2003/09/01) 表示パラメータ、編集パラメータ、文字パラメータの追加。

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

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

    コンストラクタ
    コンストラクタと説明
    `DBColumn(DBColumnConfig config)` DBColumnConfig オブジェクトより作成されるコンストラクター すべての情報は、インスタンス作成時に設定します。
    `DBColumn(String lang, ColumnData clmData, LabelData lblData, CodeData cdData)` DBColumnConfig オブジェクトより作成されるコンストラクター すべての情報は、インスタンス作成時に設定します。

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `String` | `getAddKeyLabel()` セレクトメニューの場合、キー:ラベル形式で表示するかどうか[true/false/null]を返します。
    `String` | `getClassName()` カラムのクラスを文字列にした名称を返します。
    `CodeData` | `getCodeData()` カラムのコードデータオブジェクトを返します。
    `DBColumnConfig` | `getConfig()` 内部の設定情報オブジェクトを返します。
    `String` | `getDbid()` 接続先IDを返します。
    `String` | `getDbType()` 文字種別名を返します。
    `String` | `getDbTypeParam()` データタイプのパラメータを取得します。
    `String` | `getDefault()` そのカラムの,デフォルト値の値を返します。
    `String` | `getEditor()` データの編集用エディターを返します。
    `Attributes` | `getEditorAttributes()` 編集用エディター用の追加属性を返します。
    `String` | `getEditorParam()` 編集用エディターのパラメータを取得します。
    `String` | `getEditorValue(int row, String value)` データ編集用のHTML文字列を作成します。
    `String` | `getEditorValue(String value)` データ編集用のHTML文字列を作成します。
    `String` | `getEventColumn()` イベントカラム(親カラム)。
    `String` | `getEventColumnTag(String tag, String initVal, boolean writable)` 引数のタグ文字列に対して、イベントカラムの実行に必要なspanタグを付加した 文字列を返します。
    `String` | `getEventColumnTag(String tag, String initVal, int row, boolean writable)` 引数のタグ文字列に対して、イベントカラムの実行に必要なspanタグを付加した 文字列を返します。
    `String` | `getEventURL()` eventColumn利用時にJSで利用するURL。
    `String` | `getEventValue()` イベントカラムの子カラムの値を出力するためのSQL文を返します。
    `String` | `getFieldSize()` フィールドの入力枠サイズを返します。
    `int` | `getFieldSize(int maxlength)` 引数の最大入力サイズより、実際のフィールドのサイズを求めます。
    `String` | `getFixedValue(String value, String encode)` データ出力用の固定長文字列を作成します。
    `String` | `getLabel()` カラムのラベル名を返します。
    `LabelData` | `getLabelData()` カラムのラベルデータオブジェクトを返します。
    `String` | `getLang()` 言語を返します。
    `String` | `getLongLabel()` カラムのラベル名を返します。
    `String` | `getMaxlength()` フィールドの使用桁数を返します。
    `String` | `getName()` カラム名を返します。
    `NativeType` | `getNativeType()` データのNATIVEの型の識別コードを返します。
    `String` | `getNoDisplayVal()` 非表示文字列を返します。
    `String` | `getRawEditParam()` {@XXXX}を変換していない状態の編集パラメータを返します。
    `String` | `getRawRendParam()` {@XXXX}を変換していない状態の編集パラメータを返します。
    `String` | `getReaderValue(String value)` データ入力用の文字列を作成します。
    `String` | `getRenderer()` データの表示用レンデラーを返します。
    `Attributes` | `getRendererAttributes()` 表示用レンデラーの追加属性を返します。
    `String` | `getRendererParam()` 表示用レンデラーのパラメータを取得します。
    `String` | `getRendererValue(int row, String value)` データ表示用のHTML文字列を作成します。
    `String` | `getRendererValue(String value)` データの値そのものではなく、その値のラベル文字を返します。
    `RoleMode` | `getRoleMode()` カラムオブジェクトのロールモードを返します。
    `String` | `getRoles()` カラムロールを取得します。
    `String` | `getShortLabel()` カラムのラベル名を返します。
    `int` | `getSizeX()` フィールドの整数部のデータ長を返します。
    `int` | `getSizeY()` フィールドの小数部のデータ長を返します。
    `int` | `getTotalSize()` フィールドのデータ長を返します。
    `String` | `getUseSLabel()` ラベル短ベースのメニューにするかどうか。
    `String` | `getViewLength()` カラムの表示桁数を返します。
    `String` | `getWriteValue(String value)` データ出力用の文字列を作成します。
    `boolean` | `isAddNoValue()` メニューに空の選択リストを追加するかどうかを取得します。
    `boolean` | `isDateType()` このカラムが、日付型かどうかを返します。
    `boolean` | `isNeedsParamParse()` セットされている表示パラメータ、編集パラメータに"{@XXXX}"が含まれているか(パラメーターのパースが必要か)を 返します。
    `boolean` | `isNumberType()` このカラムが、数値型かどうかを返します。
    `boolean` | `isOfficial()` このカラムオブジェクトがカラムリソースより正式に作られたかどうかを取得します。
    `boolean` | `isStringOutput()` レンデラー利用ファイル出力時に数値等も文字タイプに固定するかどうか (初期値:USE_STRING_EXCEL_OUTPUT[=false])。
    `boolean` | `isWritable()` カラムが書き込み可能かどうかを返します。
    `boolean` | `isWriteKeyLabel()` セレクトメニューの場合、キーとラベルを分けて出力するかどうか[true/false]を取得します。
    `String` | `toString()` オブジェクトの文字列表現を返します。
    `boolean` | `useMultiSelect()` マルチ・キーセレクトを使用するかどうかを返します。
    `String` | `valueAction(String action, String oldValue, String newValue)` action で指定されたコマンドを実行して、値の変換を行います。
    `String` | `valueAdd(String value, String add)` String引数の文字列を＋１した文字列を返します。
    `ErrorMessage` | `valueCheck(String value)` データが登録可能かどうかをチェックします。
    `ErrorMessage` | `valueCheck(String value, boolean isStrict)` データが登録可能かどうかをチェックします。
    `String` | `valueSet(String value)` エディターで編集されたデータを登録する場合に、データそのものを 変換して、実登録データを作成します。

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

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

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

    - #### DBColumn

          public DBColumn(String lang,
                          ColumnData clmData,
                          LabelData lblData,
                          CodeData cdData)

      DBColumnConfig オブジェクトより作成されるコンストラクター すべての情報は、インスタンス作成時に設定します。 このオブジェクトは、１度作成されると変更されることはありません。
      パラメータ:
        `lang` - 言語
        `clmData` - カラムデータオブジェクト
        `lblData` - ラベルデータオブジェクト
        `cdData` - コードデータオブジェクト
      変更履歴:

        4.0.0.0 (2005/01/31) 新規追加
        4.0.0.0 (2007/11/07) Selectionオブジェクトをキャッシュする
        4.3.6.0 (2009/04/01) eventColumnの対応
        5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
        5.5.1.0 (2012/04/03) useSLabel対応
        5.6.2.3 (2013/03/22) 非表示文字の設定。noDisplayVal追加
        5.7.3.0 (2014/02/07) SelectionFactory 対応
        5.7.6.3 (2014/05/23) stringOutput対応
        6.0.4.0 (2014/11/28) selection は、Column から取得するのではなく、Factory で作成する。
        6.0.4.0 (2014/11/28) addKeyLabel 属性を追加
        6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
        6.3.3.0 (2015/07/25) eventValue 追加
        6.4.5.2 (2016/05/06) rendAttri,editAttri は、not null にします。
        6.4.6.0 (2016/05/27) isNumber , isDate 追加。

    - #### DBColumn

          public DBColumn(DBColumnConfig config)

      DBColumnConfig オブジェクトより作成されるコンストラクター すべての情報は、インスタンス作成時に設定します。 このオブジェクトは、１度作成されると変更されることはありません。
      パラメータ:
        `config` - DBColumnConfigオブジェクト
      変更履歴:

        4.0.0.0 (2007/11/07) Selectionオブジェクトをキャッシュする
        5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
        5.1.8.0 (2010/07/01) メソッド名変更(getDefValue ⇒ getDefault)
        5.5.1.0 (2012/04/03) useSLabel対応
        5.6.2.3 (2013/03/22) 非表示文字の設定。noDisplayVal追加
        5.6.6.0 (2013/07/05) codeKeyVal 属性を使用した、Selection_KEYVAL オブジェクトの作成
        5.7.3.0 (2014/02/07) SelectionFactory 対応
        5.7.6.3 (2014/05/23) stringOutput対応
        6.0.4.0 (2014/11/28) selection は、Column から取得するのではなく、Factory で作成する。
        6.0.4.0 (2014/11/28) addKeyLabel 属性を追加
        6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
        6.3.3.0 (2015/07/25) eventValue 追加
        6.4.6.0 (2016/05/27) isNumber , isDate 追加。

  - ### メソッドの詳細

    - #### getLang

          public String getLang()

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

    - #### getName

          public String getName()

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

    - #### getLabel

          public String getLabel()

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

    - #### getShortLabel

          public String getShortLabel()

      カラムのラベル名を返します。
      戻り値:
        カラムのラベル名(名前(短))

    - #### getLongLabel

          public String getLongLabel()

      カラムのラベル名を返します。
      戻り値:
        カラムのラベル名(名前(長))

    - #### isNumberType

          public boolean isNumberType()

      このカラムが、数値型かどうかを返します。 ColumnDataのgetClassName() の値が、"NUMBER" , "INTEGER" , "DECIMAL" , "INT64" の場合、true:数値型 を返します。
      戻り値:
        カラムが、数値型かどうか
      変更履歴:

        6.4.6.0 (2016/05/27) isNumber , isDate 追加。

    - #### isDateType

          public boolean isDateType()

      このカラムが、日付型かどうかを返します。 ColumnDataのgetClassName() の値が、"DATE" , "TIMESTAMP" の場合、true:数値型 を返します。
      戻り値:
        カラムが、日付型かどうか
      変更履歴:

        6.4.6.0 (2016/05/27) isNumber , isDate 追加。

    - #### getClassName

          public String getClassName()

      カラムのクラスを文字列にした名称を返します。 内容的には、カラムの className の値と、dbTypeの値をマージした値になります。 さらに、editorAttributesの "class"キーワードの値もマージします。 ただし、この値には、must属性も設定されているため、それだけは除外します。 各種スタイルを表現するのに使用します。
      戻り値:
        カラムのクラスを文字列にした名称(X9,X,など)
      関連項目:
        `getDbType()`
      変更履歴:

        6.4.4.2 (2016/04/01) editAttri に clazz属性が設定されている場合は、スペースで連結して返します。
        6.4.5.0 (2016/04/08) className , dbType , editAttriのclass属性(除くmust)をスペースで連結して返します。
        6.4.5.1 (2016/04/28) class属性の連結で、noinput も除外する。(mustAny,must,noinput が除外)
        6.4.5.2 (2016/05/06) rendAttri,editAttri は、not null にします。
        6.4.6.0 (2016/05/27) ColumnDataのclassName は使わない。

    - #### getTotalSize

          public int getTotalSize()

      フィールドのデータ長を返します。 通常は、整数型の文字列とデータ長は同じですが,小数点を表すデータ長は x,y 形式の場合、x + 2 桁で表されます。(マイナス記号と小数点記号) 7,3 は、 xxxx,yyy のフォーマットで、データ長は、9 になります。
      戻り値:
        データ長定義文字列
      変更履歴:

        2.1.1.2 (2002/11/21) 最大桁数入力時の桁数チェックの間違いを訂正。
        4.0.0.0 (2005/01/31) メソッド名変更 getMaxlength() → getTotalSize()

    - #### getMaxlength

          public String getMaxlength()

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

    - #### getSizeX

          public int getSizeX()

      フィールドの整数部のデータ長を返します。 通常は、整数型の文字列とデータ長は同じですが,小数点を表すデータ長は x,y 形式の場合、x - y 桁で表されます。(マイナス記号含まず) 7,3 は、 xxxx,yyy のフォーマットで、データ長は、4 になります。
      戻り値:
        データ長定義文字列

    - #### getSizeY

          public int getSizeY()

      フィールドの小数部のデータ長を返します。 通常は、整数型の文字列では、0 になりますが,小数点を表すデータ長は x,y 形式の場合、y 桁で表されます。 7,3 は、 xxxx,yyy のフォーマットで、データ長は、3 になります。
      戻り値:
        データ長定義文字列

    - #### getViewLength

          public String getViewLength()

      カラムの表示桁数を返します。 viewLength は、設定した場合のみ、使用できます。通常は、null が返ります。
      戻り値:
        カラムの文字桁数
      変更履歴:

        3.5.5.5 (2004/04/23) 新規追加
        4.0.0.0 (2005/01/31) メソッド名変更 getSize() → getViewLength()

    - #### isWritable

          public boolean isWritable()

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

    - #### getRendererValue

          public String getRendererValue(String value)

      データの値そのものではなく、その値のラベル文字を返します。
      パラメータ:
        `value` - 入力値
      戻り値:
        データ表示用の文字列
      変更履歴:

        3.5.5.4 (2004/04/15) value が null の場合は、""(ゼロストリング)にする。

      このメソッドは、nullを返しません

    - #### getRendererValue

          public String getRendererValue(int row,
                                         String value)

      データ表示用のHTML文字列を作成します。 行番号毎に異なる値を返すことの出来る DBCellRenderer を使用することが出来ます。
      パラメータ:
        `row` - 行番号
        `value` - 入力値
      戻り値:
        データ編集用の文字列
      変更履歴:

        3.5.5.7 (2004/05/10) 行番号に無関係に、値を返すように変更します。
        4.0.0.0 (2005/11/30) 行番号に対応した値を返すように変更します。

      このメソッドは、nullを返しません

    - #### getWriteValue

          public String getWriteValue(String value)

      データ出力用の文字列を作成します。 ファイル等に出力する形式を想定しますので、HTMLタグを含まない データを返します。 writeKeyLabel == true かつ addKeyLabel == "true" の場合は、":" で分離して、 ﾗﾍﾞﾙのみを返します。 IO側で、カラムを分けて出力するので、VAL:LBL ではなく、LBL だけ出力します。
      パラメータ:
        `value` - 入力値
      戻り値:
        データ出力用の文字列
      変更履歴:

        6.0.4.0 (2014/11/28) データ出力用のレンデラー
        6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加

      このメソッドは、nullを返しません

    - #### getReaderValue

          public String getReaderValue(String value)

      データ入力用の文字列を作成します。 ファイル等から、読み取る場合に、このメソッド経由で、必要な形式変換を行います。 現時点では、KEY:VAL形式の Selection オブジェクト経由でデータを取り込む場合、 KEY に分解処理します。
      パラメータ:
        `value` - 入力値
      戻り値:
        データ入力用の文字列
      変更履歴:

        6.2.2.0 (2015/03/27) SelectionCellEditor I/Fを追加

      このメソッドは、nullを返しません

    - #### getEditorValue

          public String getEditorValue(String value)

      データ編集用のHTML文字列を作成します。
      パラメータ:
        `value` - 入力値
      戻り値:
        データ編集用の文字列
      変更履歴:

        3.5.5.4 (2004/04/15) value が null の場合は、""(ゼロストリング)にする。

      このメソッドは、nullを返しません

    - #### getEditorValue

          public String getEditorValue(int row,
                                       String value)

      データ編集用のHTML文字列を作成します。 行番号付の編集データを作成します。名前_行番号 で登録する為、 リクエスト情報を１つ毎のフィールドで処理できます。
      パラメータ:
        `row` - 行番号
        `value` - 入力値
      戻り値:
        データ編集用の文字列
      このメソッドは、nullを返しません

    - #### getFixedValue

          public String getFixedValue(String value,
                                      String encode)

      データ出力用の固定長文字列を作成します。 HOST送信用桁数がセットされていれば、そちらを優先します。
      パラメータ:
        `value` - 対象の値
        `encode` - 固定長で変換する文字エンコード
      戻り値:
        データ編集用の文字列
      変更履歴:

        3.5.4.5 (2004/01/23) エンコード指定に変更します。
        6.0.4.0 (2014/11/28) データ出力用のレンデラーと名称がかぶるので、変更します。

    - #### getRenderer

          public String getRenderer()

      データの表示用レンデラーを返します。
      戻り値:
        データの表示用レンデラー
      変更履歴:

        3.8.0.2 (2005/07/11) 新規追加

    - #### getEditor

          public String getEditor()

      データの編集用エディターを返します。
      戻り値:
        データの編集用エディター
      変更履歴:

        3.8.0.2 (2005/07/11) 新規追加

    - #### getDbType

          public String getDbType()

      文字種別名を返します。 カラムの文字種別名名称を返します。 これは，HTML上の各種タグに，データベース定義に応じたクラスを セットし,CSS(Cascading Style Sheet)の class="xxxxx" とする事により 各種スタイルを表現するのに使用します。 ここでは, カラムリソースの DBTYPE 属性で指定の文字列(X,S9,KXなど)を返します。
      戻り値:
        データの文字種別(X,KX,S9 など)

    - #### getNativeType

          public NativeType getNativeType()

      データのNATIVEの型の識別コードを返します。
      戻り値:
        NATIVEの型の識別コード(DBType で規定)
      関連項目:
        `NativeType`
      変更履歴:

        4.1.1.2 (2008/02/28) Enum型(fukurou.model.NativeType)に変更

    - #### getDefault

          public String getDefault()

      そのカラムの,デフォルト値の値を返します。 カラムリソースに デフォルト情報が登録されている場合は,その値を返します。 デフォルト値が設定されていない場合は, null を返します。
      戻り値:
        デフォルト値(無ければ null)

    - #### getRendererParam

          public String getRendererParam()

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

        3.4.0.0 (2003/09/01) 新規追加

    - #### getEditorParam

          public String getEditorParam()

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

        3.4.0.0 (2003/09/01) 新規追加

    - #### getDbTypeParam

          public String getDbTypeParam()

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

        3.4.0.0 (2003/09/01) 新規追加

    - #### getRoles

          public String getRoles()

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

        4.0.0.0 (2005/11/30) 新規追加

    - #### getRoleMode

          public RoleMode getRoleMode()

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

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

    - #### getDbid

          public String getDbid()

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

    - #### valueAdd

          public String valueAdd(String value,
                                 String add)

      String引数の文字列を＋１した文字列を返します。 これは、英字の場合(A,B,C など)は、B,C,D のように,最終桁の文字コードを ＋１ します。 文字列が数字タイプの場合は, 数字に変換して、+1 します。(桁上がりもあり) 混在タイプの場合は,最後の桁だけを確認して ＋１します。 引数が null の場合と、ゼロ文字列("")の場合は,引数を,そのまま返します。 ※ 機能拡張：第２引数に指定の文字列(数字、日付等)を指定する事で、 引数の文字列に、任意の値を加算できるようにします。 ただし、すべての DBTypeではなく、ある程度特定します。 対象外の DBTypeで、第２引数が null 出ない場合は、Exception を Throwsします。 第２引数が、null の場合は、従来と同じ＋１します。
      パラメータ:
        `value` - 引数の文字列
        `add` - 加算する文字列(null の場合は、従来と同じ、+1 します。)
      戻り値:
        引数の文字列を＋１した文字列。または、任意の値を加算した文字列。
      変更履歴:

        5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。

    - #### valueCheck

          public ErrorMessage valueCheck(String value)

      データが登録可能かどうかをチェックします。 データがエラーの場合は、そのエラー内容を返します。
      パラメータ:
        `value` - チェック対象の値
      戻り値:
        エラー内容 正常時は null
      関連項目:
        `valueCheck( String , boolean )`
      変更履歴:

        3.6.0.0 (2004/09/22) dbType パラメータを引数に追加
        3.6.0.7 (2004/11/06) official属性がfalseの場合、チェックレベルに対応したチェックを行う。
        3.8.0.8 (2005/10/03) 企画改善 61200-050921-02 ラベルからHTMLタグを削除する。
        5.2.2.0 (2010/11/01) 内部処理を、#valueCheck( value , true ) に委譲。

    - #### valueCheck

          public ErrorMessage valueCheck(String value,
                                         boolean isStrict)

      データが登録可能かどうかをチェックします。 データがエラーの場合は、そのエラー内容を返します。
      パラメータ:
        `value` - チェック対象の値
        `isStrict` - 厳密にチェック(isStrict=true)するかどうか
      戻り値:
        エラー内容 正常時は null
      変更履歴:

        3.6.0.0 (2004/09/22) dbType パラメータを引数に追加
        3.6.0.7 (2004/11/06) official属性がfalseの場合、チェックレベルに対応したチェックを行う。
        3.8.0.8 (2005/10/03) 企画改善 61200-050921-02 ラベルからHTMLタグを削除する。
        5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加

    - #### valueSet

          public String valueSet(String value)

      エディターで編集されたデータを登録する場合に、データそのものを 変換して、実登録データを作成します。 例えば,大文字のみのフィールドなら、大文字化します。 実登録データの作成は、DBType オブジェクトを利用しますので, これと DBCellEditor とがアンマッチの場合は、うまくデータ変換 されない可能性がありますので、注意願います。
      パラメータ:
        `value` - 一般に編集データとして登録されたデータ
      戻り値:
        修正後の文字列(一般にデータベースに登録するデータ)

    - #### valueAction

          public String valueAction(String action,
                                    String oldValue,
                                    String newValue)

      action で指定されたコマンドを実行して、値の変換を行います。 oldValue(旧データ)は、元のDBTableModelに設定されていた値です。通常は、 この値を使用してカラム毎に変換を行います。newValue(新データ)は、引数で 指定された新しい値です。この値には、パラメータを指定して変換方法を 制御することも可能です。 指定のアクションがカラムで処理できない場合は、エラーになります。
      パラメータ:
        `action` - アクションコマンド
        `oldValue` - 入力データ(旧データ)
        `newValue` - 入力データ(新データ)
      戻り値:
        実行後のデータ

    - #### getConfig

          public DBColumnConfig getConfig()

      内部の設定情報オブジェクトを返します。 このオブジェクトを ローカルで書き換えて、DBColumn を作るようにします。
      戻り値:
        設定情報オブジェクト
      変更履歴:

        3.1.0.0 (2003/03/20) DBColumnConfig 関係の見直し。
        3.4.0.0 (2003/09/01) 表示パラメータ、編集パラメータ、文字パラメータの追加。
        3.5.5.5 (2004/04/23) size 属性の意味を変更、maxlength 属性を追加。
        3.5.5.8 (2004/05/20) codeName 属性を追加。
        3.6.0.7 (2004/11/06) カラムリソースから作成されたかどうか(official属性追加)
        5.1.8.0 (2010/07/01) すべての属性を設定するようにします。
        5.5.1.0 (2012/04/03) useSLabel対応
        5.6.2.3 (2013/03/22) 非表示文字の設定。noDisplayVal追加
        5.7.6.3 (2014/05/23) stringOutput対応
        6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)
        6.2.3.0 (2015/05/01) writeKeyLabel 属性を追加
        6.3.3.0 (2015/07/25) eventValue 追加

    - #### getRendererAttributes

          public Attributes getRendererAttributes()

      表示用レンデラーの追加属性を返します。
      戻り値:
        属性リスト
      変更履歴:

        3.1.0.0 (2003/03/20) DBColumnConfig オブジェクトの内部キープを廃止

      このメソッドは、nullを返しません

    - #### getEditorAttributes

          public Attributes getEditorAttributes()

      編集用エディター用の追加属性を返します。
      戻り値:
        属性リスト
      変更履歴:

        3.1.0.0 (2003/03/20) DBColumnConfig オブジェクトの内部キープを廃止

      このメソッドは、nullを返しません

    - #### isAddNoValue

          public boolean isAddNoValue()

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

        3.5.5.7 (2004/05/10) 新規追加

    - #### getAddKeyLabel

          public String getAddKeyLabel()

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

        6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか。新規追加

    - #### 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) 新規追加

    - #### getLabelData

          public LabelData getLabelData()

      カラムのラベルデータオブジェクトを返します。
      戻り値:
        カラムのラベルデータオブジェクト

    - #### getCodeData

          public CodeData getCodeData()

      カラムのコードデータオブジェクトを返します。 コードデータが存在しない場合は、null を返します。 受け取り側で、null かどうか判定してから使用してください。
      戻り値:
        カラムのコードデータオブジェクト
      変更履歴:

        5.2.1.0 (2010/10/01) codeData が null でも、そのまま返します。

    - #### getFieldSize

          public String getFieldSize()

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

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

    - #### getFieldSize

          public int getFieldSize(int maxlength)

      引数の最大入力サイズより、実際のフィールドのサイズを求めます。 計算方法 ① fieldSize があれば、その値を返します。 ② ColumnData#getTotalSize() を求め、あれば、その値を返す。 ③ totalSizeが、引数の最大入力サイズより大きい場合は、引数の最大入力サイズを返す。 各呼び出すメソッドは、引数の最大入力サイズ のみ指定します。それ以外の値は、内部の値を使います。 最大入力サイズは、システム定数の、HTML_COLUMNS_MAXSIZE か、HTML_VIEW_COLUMNS_MAXSIZE が 一般的です。
      パラメータ:
        `maxlength` - 最大入力サイズ
      戻り値:
        表示すべきサイズ
      関連項目:
        `getFieldSize()`
      変更履歴:

        4.0.0.0 (2005/01/31) getFieldSize メソッドを XHTMLTag から DBColumn へ移動
        4.0.0.0 (2007/02/05) ADJUSTMENT 処理を廃止します。(CSSにて対応)
        6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)
        6.2.3.0 (2015/05/01) maxlength 変数は、0 の場合は、無制限になります。

    - #### getEventColumn

          public String getEventColumn()

      イベントカラム(親カラム)。
      戻り値:
        イベントカラム
      変更履歴:

        4.3.6.0 (2009/04/01)

    - #### getEventValue

          public String getEventValue()

      イベントカラムの子カラムの値を出力するためのSQL文を返します。
      戻り値:
        イベントカラムの値SQL文
      変更履歴:

        6.3.3.0 (2015/07/25) eventValue 追加

    - #### getRawEditParam

          public String getRawEditParam()

      {@XXXX}を変換していない状態の編集パラメータを返します。
      戻り値:
        生編集パラメータ
      変更履歴:

        4.3.6.0 (2009/04/01)

    - #### getRawRendParam

          public String getRawRendParam()

      {@XXXX}を変換していない状態の編集パラメータを返します。
      戻り値:
        生表示パラメータ
      変更履歴:

        5.1.7.0 (2010/06/01) 動的プルダウン実装見直し

    - #### getEventURL

          public String getEventURL()

      eventColumn利用時にJSで利用するURL。
      戻り値:
        イベントURL
      変更履歴:

        4.3.6.0 (2009/04/01)

    - #### getEventColumnTag

          public String getEventColumnTag(String tag,
                                          String initVal,
                                          boolean writable)

      引数のタグ文字列に対して、イベントカラムの実行に必要なspanタグを付加した 文字列を返します。
      パラメータ:
        `tag` - タグ文字列
        `initVal` - 子カラムの初期値
        `writable` - タグの要素が書き込み可能かどうか
      戻り値:
        spanタグを付加したタグ文字列

    - #### getEventColumnTag

          public String getEventColumnTag(String tag,
                                          String initVal,
                                          int row,
                                          boolean writable)

      引数のタグ文字列に対して、イベントカラムの実行に必要なspanタグを付加した 文字列を返します。
      パラメータ:
        `tag` - タグ文字列
        `initVal` - 子カラムの初期値
        `row` - 行番号
        `writable` - タグの要素が書き込み可能かどうか
      戻り値:
        spanタグを付加したタグ文字列
      このメソッドは、nullを返しません

    - #### isNeedsParamParse

          public boolean isNeedsParamParse()

      セットされている表示パラメータ、編集パラメータに"{@XXXX}"が含まれているか(パラメーターのパースが必要か)を 返します。
      戻り値:
        "{@XXXX}"が含まれているか(含まれている場合true)
      変更履歴:

        6.0.0.1 (2014/04/25) 内部処理変更

    - #### getUseSLabel

          public String getUseSLabel()

      ラベル短ベースのメニューにするかどうか。
      戻り値:
        イベントカラム
      変更履歴:

        5.5.1.0 (2012/04/03)

    - #### getNoDisplayVal

          public String getNoDisplayVal()

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

        5.6.2.3 (2013/03/22) 新規追加

    - #### isStringOutput

          public boolean isStringOutput()

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

        5.7.6.3 (2014/05/23) 新規追加

    - #### useMultiSelect

          public boolean useMultiSelect()

      マルチ・キーセレクトを使用するかどうかを返します。 true：使用する。false:使用しない です。 ただし、実際に使用するかどうかは、HTML出力時に決めることが出来ます。 ここでは、USE_MULTI_KEY_SELECT が true で、USE_SIZE(=20)以上の場合に true を返します。
      戻り値:
        選択リストで、マルチ・キーセレクトを使用するかどうか(true:使用する)
      変更履歴:

        6.0.4.0 (2014/11/28) Selection 側から移動。
        6.3.9.1 (2015/11/27) ３項演算子を || or && で簡素化できる(PMD)。

    - #### toString

          public String toString()

      オブジェクトの文字列表現を返します。 n=Name,l=Label,c=ClassName,r=Renderer,e=Editor,d=DbType という形式を作成します。
      オーバーライド:
        `toString` クラス内 `Object`
      戻り値:
        文字列表現
      変更履歴:

        6.2.2.0 (2015/03/27) DBColumnオブジェクトの文字列表現(#toString())を実装します。

      このメソッドは、nullを返しません

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