概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.0.0.1
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## 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 オブジェクトより作成されるコンストラクター すべての情報は、インスタンス作成時に設定します。

メソッドの概要
`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` | `getEventURL()` eventColumn利用時にJSで利用するURL
`int` | `getFieldSize(int maxlength)` 最大入力サイズ(maxlength)より、実際のフィールドのサイズを求めます。
`int` | `getFieldSize(int maxlength, int colums_maxsize)` 最大入力サイズ(maxlength)より、実際のフィールドのサイズを求めます。
`String` | `getLabel()` カラムのラベル名を返します。
`LabelData` | `getLabelData()` カラムのラベルデータオブジェクトを返します。
`String` | `getLang()` 言語を返します。
`String` | `getLongLabel()` カラムのラベル名を返します。
`String` | `getMaxlength()` フィールドの使用桁数を返します。
`String` | `getName()` カラム名を返します。
`NativeType` | `getNativeType()` データのNATIVEの型の識別コードを返します。
`String` | `getRawParam()` {@xxx}を変換していない状態の編集パラメータを返す
`String` | `getRenderer()` データの表示用レンデラーを返します。
`Attributes` | `getRendererAttributes()` 表示用レンデラーの追加属性を返します。
`String` | `getRendererParam()` 表示用レンデラーのパラメータを取得します。
`String` | `getRendererValue(int row, String value)` データ表示用のHTML文字列を作成します。
`String` | `getRendererValue(String value)` データの値そのものではなく、その値のラベル文字を返します。
`RoleMode` | `getRoleMode()` カラムオブジェクトのロールモードを返します。
`String` | `getRoles()` カラムロールを取得します。
`Selection` | `getSelection()` コードリソースSelection オブジェクトを返します。
`String` | `getShortLabel()` カラムのラベル名を返します。
`int` | `getSizeX()` フィールドの整数部のデータ長を返します。
`int` | `getSizeY()` フィールドの小数部のデータ長を返します。
`int` | `getTotalSize()` フィールドのデータ長を返します。
`String` | `getViewLength()` カラムの表示桁数を返します。
`String` | `getWriterValue(String value, String encode)` データ出力用の固定長文字列を作成します。
`boolean` | `isAddNoValue()` メニューに空の選択リストを追加するかどうかを取得します。
`boolean` | `isOfficial()` このカラムオブジェクトがカラムリソースより正式に作られたかどうかを取得します。
`boolean` | `isWritable()` カラムが書き込み可能かどうかを返します。
`String` | `valueAction(String action, String oldValue, String newValue)` action で指定されたコマンドを実行して、値の変換を行います。
`String` | `valueAdd(String value)` String引数の文字列を＋１した文字列を返します。
`ErrorMessage` | `valueCheck(String value)` データが登録可能かどうかをチェックします。
`String` | `valueSet(String value)` エディターで編集されたデータを登録する場合に、データそのものを 変換して、実登録データを作成します。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

### DBColumn

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

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

  パラメータ:
    `lang` - String
    `clmData` - ColumnData
    `lblData` - LabelData
    `cdData` - CodeData
  変更履歴:

    4.0.0 (2005/01/31) 新規追加
    4.0.0.0 (2007/11/07) Selectionオブジェクトをキャッシュする
    4.3.6.0 (2009/04/01) eventColumnの対応

### DBColumn

    public DBColumn(DBColumnConfig config)

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

  パラメータ:
    `config` - DBColumnConfig
  変更履歴:

    4.0.0.0 (2007/11/07) Selectionオブジェクトをキャッシュする

メソッドの詳細

### getLang

    public String getLang()

  言語を返します。

  戻り値:
    言語

### getName

    public String getName()

  カラム名を返します。

  戻り値:
    カラム名

### getLabel

    public String getLabel()

  カラムのラベル名を返します。

  戻り値:
    カラムのラベル名

### getShortLabel

    public String getShortLabel()

  カラムのラベル名を返します。

  戻り値:
    カラムのラベル名(名前(短))

### getLongLabel

    public String getLongLabel()

  カラムのラベル名を返します。

  戻り値:
    カラムのラベル名(名前(長))

### getClassName

    public String getClassName()

  カラムのクラスを文字列にした名称を返します。 これは，HTML上の各種タグに，データベース定義に応じたクラス名を 表します。(VARCHAR2、NUMBER など) これは、カラムのデータタイプ(X,S9など)と機能的に重複しますが､ そのカラムが、大まかな分類で、文字列であるか、数字であるかを示します。 画面表示上の右寄せ、左寄せや、IMEのON/OFFなどの CSSファイルの指定は、 カラムのデータタイプ(X,S9など)ですが、テーブルソート時のソート条件 は、この クラス文字列(VARCHAR2、NUMBER)を参照します。

  戻り値:
    カラムのクラスを文字列にした名称(VARCHAR2、NUMBER など)

### getTotalSize

    public int getTotalSize()

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

  戻り値:
    データ長定義文字列
  変更履歴:

    2.1.1.2 (2002/11/21) 最大桁数入力時の桁数チェックの間違いを訂正。
    4.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 (2005/01/31) メソッド名変更 getSize() → getViewLength()

### isWritable

    public boolean isWritable()

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

  戻り値:
    カラムが書き込み可能かどうか

### getRendererValue

    public String getRendererValue(String value)

  データの値そのものではなく、その値のラベル文字を返します。

  パラメータ:
    `value` - String
  戻り値:
    データ表示用の文字列
  変更履歴:

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

### getRendererValue

    public String getRendererValue(int row,
                                   String value)

  データ表示用のHTML文字列を作成します。 行番号毎に異なる値を返すことの出来る DBCellRenderer を使用することが出来ます。

  パラメータ:
    `row` - int
    `value` - String
  戻り値:
    データ編集用の文字列
  変更履歴:

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

### getEditorValue

    public String getEditorValue(String value)

  データ編集用のHTML文字列を作成します。

  パラメータ:
    `value` - String
  戻り値:
    データ編集用の文字列
  変更履歴:

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

### getEditorValue

    public String getEditorValue(int row,
                                 String value)

  データ編集用のHTML文字列を作成します。 行番号付の編集データを作成します。名前_行番号 で登録する為、 リクエスト情報を１つ毎のフィールドで処理できます。

  パラメータ:
    `row` - int
    `value` - String
  戻り値:
    データ編集用の文字列

### getWriterValue

    public String getWriterValue(String value,
                                 String encode)

  データ出力用の固定長文字列を作成します。 HOST送信用桁数がセットされていれば、そちらを優先します。

  パラメータ:
    `value` - String
    `encode` - 固定長で変換する文字エンコード
  戻り値:
    データ編集用の文字列
  変更履歴:

    3.5.4.5 (2004/01/23) エンコード指定に変更します。

### 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 (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引数の文字列を＋１した文字列を返します。 これは、英字の場合（A,B,C など）は、B,C,D のように,最終桁の文字コードを ＋１ します。 文字列が数字タイプの場合は, 数字に変換して、+1 します。（桁上がりもあり） 混在タイプの場合は,最後の桁だけを確認して ＋１します。 引数が null の場合と、ゼロ文字列（""）の場合は,引数を,そのまま返します。

  パラメータ:
    `value` - String
  戻り値:
    引数の文字列を＋１した文字列

### valueCheck

    public ErrorMessage valueCheck(String value)

  データが登録可能かどうかをチェックします。 データがエラーの場合は、そのエラー内容を返します。

  パラメータ:
    `value` - String
  戻り値:
    エラー内容 正常時は 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タグを削除する。

### valueSet

    public String valueSet(String value)

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

  パラメータ:
    `value` - String （一般に編集データとして登録されたデータ）
  戻り値:
    修正後の文字列（一般にデータベースに登録するデータ）

### valueAction

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

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

  パラメータ:
    `action` - アクションコマンド
    `oldValue` - 入力データ（旧データ）
    `newValue` - 入力データ（新データ）
  戻り値:
    実行後のデータ

### getConfig

    public DBColumnConfig getConfig()

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

  戻り値:
    DBColumnConfig
  変更履歴:

    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属性追加)

### getRendererAttributes

    public Attributes getRendererAttributes()

  表示用レンデラーの追加属性を返します。

  戻り値:
    attri Attributes
  変更履歴:

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

### getEditorAttributes

    public Attributes getEditorAttributes()

  編集用エディター用の追加属性を返します。

  戻り値:
    attri Attributes
  変更履歴:

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

### isAddNoValue

    public boolean isAddNoValue()

  メニューに空の選択リストを追加するかどうかを取得します。

  戻り値:
    addNoValue (true:追加する/false:追加しない)
  変更履歴:

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

### isOfficial

    public boolean isOfficial()

  このカラムオブジェクトがカラムリソースより正式に作られたかどうかを取得します。 カラムリソースが無い場合は、仮オブジェクトかデータベースメタデータより作成されます。 その場合は、チェック機能が緩くなるため、正式なカラムオブジェクトと区別する為に この属性を持ちます。

  戻り値:
    official (true:正式/false:暫定)
  変更履歴:

    3.6.0.7 (2004/11/06) 新規追加

### getLabelData

    public LabelData getLabelData()

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

  戻り値:
    カラムのラベルデータオブジェクト

### getCodeData

    public CodeData getCodeData()

  カラムのコードデータオブジェクトを返します。

  戻り値:
    カラムのコードデータオブジェクト

### getFieldSize

    public int getFieldSize(int maxlength,
                            int colums_maxsize)

  最大入力サイズ(maxlength)より、実際のフィールドのサイズを求めます。 maxlength : colums_maxsize ～ ⇒ size="maxlength" 変換しません。 ただし、maxlength が、colums_maxsize を超える場合は、colums_maxsize とします。

  パラメータ:
    `maxlength` - 実際の最大桁数
    `colums_maxsize` - 表示上の最大桁数。
  戻り値:
    表示すべきサイズ
  関連項目:
    `getFieldSize( int )`
  変更履歴:

    4.0.0 (2005/01/31) getFieldSize メソッドを XHTMLTag から DBColumn へ移動
    4.0.0 (2007/02/05) ADJUSTMENT 処理を廃止します。(CSSにて対応)

### getFieldSize

    public int getFieldSize(int maxlength)

  最大入力サイズ(maxlength)より、実際のフィールドのサイズを求めます。 maxlength : colums_maxsize ～ ⇒ size="maxlength" 変換しません。 ただし、maxlength が、COLUMNS_MAXSIZE を超える場合は、COLUMNS_MAXSIZE とします。

  パラメータ:
    `maxlength` - 実際の最大桁数
  戻り値:
    表示すべきサイズ
  関連項目:
    `getFieldSize( int ,int )`
  変更履歴:

    4.0.0 (2005/01/31) getFieldSize メソッドを XHTMLTag から DBColumn へ移動
    4.0.0 (2007/02/05) ADJUSTMENT 処理を廃止します。(CSSにて対応)

### getSelection

    public Selection getSelection()

  コードリソースSelection オブジェクトを返します。

  戻り値:
    コードSelectionオブジェクト
  変更履歴:

    4.0.0.0 (2007/11/02) 新規追加

### getEventColumn

    public String getEventColumn()

  イベントカラム（親カラム）

  戻り値:
    イベントカラム
  変更履歴:

    4.3.6.0 (2009/04/01)

### getRawParam

    public String getRawParam()

  {@xxx}を変換していない状態の編集パラメータを返す

  戻り値:
    生編集パラメータ
  変更履歴:

    4.3.6.0 (2009/04/01)

### getEventURL

    public String getEventURL()

  eventColumn利用時にJSで利用するURL

  戻り値:
    イベントURL
  変更履歴:

    4.3.6.0 (2009/04/01)

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.0.0.1
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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