openGionopenGion
5.6.1.0

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 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)
          コンストラクター 引数は、すべて文字列型で渡します。
 
メソッドの概要
 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の取得 eventColumn利用時のJSから呼び出すためのURL取得
 java.lang.String getLabel()
          ラベル名を返します。
 LabelData getLabelData()
          ラベルデータオブジェクトを取得します。
 java.lang.String getLang()
          言語を返します。
 java.lang.String getMaxlength()
          カラムの文字桁数を返します。
 java.lang.String getName()
          カラム名を返します。
 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 isWritable()
          カラムが書き込み可能かどうか[true/false]を返します。
 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のセット イベントカラム利用時にコールされるURLのセット
 void setLabelData(LabelData labelData)
          ラベルデータオブジェクトを設定します。
 void setLang(java.lang.String lang)
          言語を設定します。
 void setMaxlength(java.lang.String maxlength)
          カラムの文字桁数を設定します。
 void setName(java.lang.String name)
          カラム名を設定します。
 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 setUseSlabel(java.lang.String use)
          MENU時にラベル短ベースで表示するかどうか[auto/true/その他]のコントロール auto/trueが有効。
 void setViewLength(java.lang.String viewLength)
          カラムの表示桁数を設定します。
 void setWritable(java.lang.String writable)
          カラムが書き込み可能かどうか[true/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 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 - カラムのクラスを文字列にした名称
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" とします。

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" とします。
メソッドの詳細

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 - カラムのクラス名

getViewLength

public java.lang.String getViewLength()
カラムの表示桁数を返します。 viewLength は、設定した場合のみ、使用できます。通常は、null が返ります。

戻り値:
カラムの表示桁数
変更履歴:
4.0.0 (2005/01/31) メソッド名変更 getSize() → getViewLength()

setViewLength

public void setViewLength(java.lang.String viewLength)
カラムの表示桁数を設定します。

パラメータ:
viewLength - カラムの表示桁数
変更履歴:
4.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 - 表示用レンデラー

getEditor

public java.lang.String getEditor()
データの編集用エディターを返します。

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

setEditor

public void setEditor(java.lang.String editor)
データの編集用エディターを設定します。

パラメータ:
editor - 編集用エディター

getDbType

public java.lang.String getDbType()
文字種別名を返します。

戻り値:
データの文字種別

setDbType

public void setDbType(java.lang.String dbType)
データのタイプを設定します。

パラメータ:
dbType - 文字種別
変更履歴:
5.1.6.0 (2010/05/01) DBTypeの初期値を "XK" とします。

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()
表示用レンデラーの追加属性を返します。

戻り値:
属性リスト

setRendererAttributes

public void setRendererAttributes(Attributes attri)
表示用レンデラーの追加属性を設定します。

パラメータ:
attri - 属性リスト

getEditorAttributes

public Attributes getEditorAttributes()
編集用エディター用の追加属性を返します。

戻り値:
追加属性

setEditorAttributes

public void setEditorAttributes(Attributes attri)
編集用エディター用の追加属性を設定します。

パラメータ:
attri - 属性リスト

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

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()
カラムデータオブジェクトを取得します。

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

setColumnData

public void setColumnData(ColumnData clmDt)
カラムデータオブジェクトを設定します。 ここでは、オブジェクトその物を持つのではなく、設定された値のみ持ちます。

パラメータ:
clmDt - カラムデータオブジェクト

getCodeData

public CodeData getCodeData()
コードデータオブジェクトを取得します。

戻り値:
コードデータオブジェクト
変更履歴:
4.0.0 (2005/01/31) 新規作成

setCodeData

public void setCodeData(CodeData codeData)
コードデータオブジェクトを設定します。

パラメータ:
codeData - コードデータオブジェクト
変更履歴:
4.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)

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)

openGion 5.6.1.0

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