    001/*
    002 * Copyright (c) 2009 The openGion Project.
    003 *
    004 * Licensed under the Apache License, Version 2.0 (the "License");
    005 * you may not use this file except in compliance with the License.
    006 * You may obtain a copy of the License at
    007 *
    008 *     http://www.apache.org/licenses/LICENSE-2.0
    009 *
    010 * Unless required by applicable law or agreed to in writing, software
    011 * distributed under the License is distributed on an "AS IS" BASIS,
    012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
    013 * either express or implied. See the License for the specific language
    014 * governing permissions and limitations under the License.
    015 */
    016package org.opengion.hayabusa.resource;
    017
    018import static org.opengion.fukurou.util.StringUtil.nval2;
    019
    020/**
    021 * systemId に対応したカラムデータを作成します。
    022 *
    023 * カラムデータは、項目(CLM)に対して、各種カラム情報を持っています。
    024 * エンジン内部で使用している DBColumn オブジェクトは、RENDERER や EDITOR など
    025 * 実際にはオブジェクトで管理していますが、この ColumnData では、それらのキーとなる
    026 * 文字列を持っています。実際に DBColumn オブジェクトの構築時に、各属性オブジェクトを
    027 * 生成(または、キャッシュから取り出し)ます。
    028 *
    029 * カラムデータを作成する場合は、同一カラムで、作成区分(KBSAKU)違いの場合は、
    030 * 最も大きな作成区分を持つコードを使用します。
    031 * 作成区分(KBSAKU)は、0:システム予約、1:アプリ設定、2:ユーザー設定 という具合に
    032 * カスタマイズの度合いに応じて大きな数字を割り当てることで、キー情報を上書き修正
    033 * することが可能になります。(削除することは出来ません。)
    034 *
    035 * @og.rev 4.0.0.0 (2004/12/31) 新規作成
    036 * @og.group リソース管理
    037 *
    038 * @version  4.0
    039 * @author   Kazuhiko Hasegawa
    040 * @since    JDK5.0,
    041 */
    042public final class ColumnData {
    043
    044        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    045        public static final int CLM                             = 0 ;
    046        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    047        public static final int CLS_NAME                = 1 ;
    048        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    049        public static final int USE_LENGTH              = 2 ;
    050        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    051        public static final int VIEW_LENGTH             = 3 ;
    052        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    053        public static final int RENDERER                = 4 ;
    054        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    055        public static final int EDITOR                  = 5 ;
    056        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    057        public static final int DBTYPE                  = 6 ;
    058        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    059        public static final int DATA_DEFAULT    = 7 ;
    060        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    061        public static final int LABEL_CLM               = 8 ;
    062        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    063        public static final int CODE_CLM                = 9 ;
    064        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    065        public static final int CLM_PARAM               = 10 ;
    066        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    067        public static final int RENDERER_PARAM  = 11 ;
    068        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    069        public static final int EDITOR_PARAM    = 12 ;
    070        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    071        public static final int TYPE_PARAM              = 13 ;
    072        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    073        public static final int ROLES                   = 14 ;
    074        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    075        public static final int FIELD_SIZE              = 15 ;                  // 6.2.0.0 (2015/02/27) フィールドサイズ 追加
    076
    077        /** 内部データのカラム数 {@value} */
    078        public static final int DATA_SIZE               = 16 ;                  // 6.2.0.0 (2015/02/27) 件数を増やす
    079
    080        /** リソース読み込みのために一時利用 4.3.5.7 (2009/03/22) */
    081        /* default */ static final int FG_LOAD                  = 16 ;                  // 6.2.0.0 (2015/02/27) 位置をずらす
    082        /** FGLOAD の読み込み済み設定用のUNIQ 6.3.1.1 (2015/07/10) */
    083        /* default */ static final int UNIQ                             = 17 ;
    084        /** FGLOAD の読み込み済み設定用のSYSTEM_ID 6.3.1.1 (2015/07/10) */
    085        /* default */ static final int SYSTEM_ID                = 18 ;
    086
    087        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    088        public static final int KBSAKU                  = 19 ;  // 7.4.2.0 (2021/05/18) 内部的に使ってないが定義しておく
    089        /** 内部ﾃﾞｰﾀのｶﾗﾑ番号 {@value}       */
    090        public static final int SNO                             = 20 ;  // 7.2.6.1 (2020/07/17) 内部的に使ってないが定義しておく
    091
    092        private final String    name                    ;               // カラム名
    093        private final String    className               ;               // データの属性(VARCHAR2,NUMBER...)
    094        private final String    maxlength               ;               // 最大桁数
    095        private final String    viewLength              ;               // 表示桁数
    096        private final String    fieldSize               ;               // 6.2.0.0 (2015/02/27) 入力枠サイズ
    097        private final String    renderer                ;               // 表示種別
    098        private final String    editor                  ;               // 編集種別
    099        private final String    dbType                  ;               // 文字種別(S9,X...)
    100        private final String    dataDef                 ;               // データのデフォルト値
    101        private final String    labelClm                ;               // ラベルカラム
    102        private final String    codeClm                 ;               // コードカラム
    103        private final String    columnPrm               ;               // カラムパラメータ
    104        private final String    rendererPrm             ;               // 表示パラメータ
    105        private final String    editorPrm               ;               // 編集パラメータ
    106        private final String    dbTypePrm               ;               // 文字パラメータ
    107        private final String    roles                   ;               // カラムロール
    108        private final RoleMode  roleMode                ;               // 4.3.0.0 (2008/07/04) ロールズとモードを管理するオブジェクト
    109
    110        private final int               totalSize               ;               // 総桁数(小数点も含む)
    111        private final int               sizeX                   ;               // カラムの文字桁数(整数部)
    112        private final int               sizeY                   ;               // カラムの文字桁数(小数部)
    113        private final boolean   official                ;               // リソースＤＢから作成されたかどうか
    114
    115        /**
    116         * 配列文字列のデータを元に、ColumnDataオブジェクトを構築します。
    117         * このコンストラクタは、他のパッケージから呼び出せないように、
    118         * パッケージプライベートにしておきます。
    119         * このコンストラクタは、ＤＢリソースファイルを想定しています。
    120         *
    121         * @og.rev 4.3.0.0 (2008/07/04) ロールモードマルチ対応
    122         * @og.rev 5.1.6.0 (2010/05/01) DBTypeの初期値を "XK" とします。
    123         * @og.rev 5.2.2.0 (2010/11/01) パラメーターもVer3互換のためNVAL2で処理します。
    124         * @og.rev 5.5.8.5 (2012/11/27) 編集パラメータで、"=" と記述されている場合は、表示パラメータを利用する。
    125         * @og.rev 6.1.0.0 (2014/12/26) カラムの表示桁数(小数部)対応
    126         * @og.rev 6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)
    127         *
    128         * @param       data    CLM,CLS_NAME,USE_LENGTH,VIEW_LENGTH,
    129         *                      RENDERER,EDITOR,DBTYPE,DATA_DEFAULT,LABEL_CLM,CODE_CLM,
    130         *                      CLM_PARAM,RENDERER_PARAM,EDITOR_PARAM,TYPE_PARAM,ROLES,FIELD_SIZE
    131         *
    132         */
    133        public ColumnData( final String[] data ) {
    134                name            = data[CLM].intern() ;                                          // カラム名
    135                className       = data[CLS_NAME].intern() ;                                     // データの属性
    136                maxlength       = data[USE_LENGTH].replace( '.',',' ).intern();         // 最大桁数
    137                renderer        = nval2( data[RENDERER]          , null ) ;             // 表示種別
    138                editor          = nval2( data[EDITOR]            , null ) ;             // 編集種別
    139                dbType          = nval2( data[DBTYPE]            , "XK" ) ;             // 文字種別  5.1.6.0 (2010/05/01)
    140                dataDef         = nval2( data[DATA_DEFAULT]      , ""   ) ;             // データのデフォルト値
    141                labelClm        = nval2( data[LABEL_CLM]         , name ) ;             // ラベルカラム
    142                codeClm         = nval2( data[CODE_CLM]          , name ) ;             // コードカラム
    143                columnPrm       = nval2( data[CLM_PARAM]         , null ) ;             // カラムパラメータ
    144                rendererPrm     = nval2( data[RENDERER_PARAM], null ) ;         // 表示パラメータ
    145                dbTypePrm       = nval2( data[TYPE_PARAM]        , null ) ;             // 文字パラメータ
    146                roles           = nval2( data[ROLES]             , null ) ;             // カラムロール
    147                fieldSize       = nval2( data[FIELD_SIZE]        , null ) ;             // 6.2.0.0 (2015/02/27) 入力枠サイズ
    148                official        = true;                                                                         // リソースＤＢから作成されたかどうか
    149
    150                // 6.1.0.0 (2014/12/26) カラムの表示桁数(小数部)対応と、カンマ置換処理
    151                final String viewLen = nval2( data[VIEW_LENGTH] , null ) ;
    152                viewLength = viewLen == null ? null : viewLen.replace( '.',',' ).intern();
    153
    154        //      // 7.2.7.0 (2020/08/07) fieldSize には、viewLength を設定する(昔に戻る)。
    155        //      if( viewLength != null && viewLength.indexOf( ',' ) > 0 ) {             // ｶﾝﾏを含む場合は、10桁固定にします。
    156        //              fieldSize = "10" ;
    157        //      }
    158        //      else {
    159        //              fieldSize = viewLength;
    160        //      }
    161
    162                // 5.5.8.5 (2012/11/27) 編集パラメータで、"=" と記述されている場合は、表示パラメータを利用する。
    163                final String tempEditPrm = nval2( data[EDITOR_PARAM], null ) ;
    164                if( "=".equals( tempEditPrm ) ) {
    165                        editorPrm = rendererPrm ;
    166                }
    167                else {
    168                        editorPrm = tempEditPrm ;
    169                }
    170
    171                roleMode        = RoleMode.newInstance( roles );        // ロールモード
    172
    173                // x,y 形式の場合、x + 2 桁で表されます。(マイナス記号と小数点記号)
    174                // 7,3 は、 xxxx,yyy のフォーマットで、データ長は、9 になります。
    175                final int ch = maxlength.indexOf( ',' ) ;
    176                if( ch > 0 ) {
    177                        sizeY = Integer.parseInt( maxlength.substring( ch+1 ) );
    178                        sizeX = Integer.parseInt( maxlength.substring( 0,ch ) ) - sizeY;
    179                        totalSize = sizeX + sizeY+ 2;
    180                }
    181                else {
    182                        sizeY = 0;
    183                        sizeX = Integer.parseInt( maxlength );
    184                        if( "S9".equals( dbType ) ) {
    185                                totalSize = sizeX + 1;  // 数字型の場合は、マイナス記号分を加える。
    186                        }
    187                        else {
    188                                totalSize = sizeX ;
    189                        }
    190                }
    191        }
    192
    193        /**
    194         * カラム名を返します。
    195         *
    196         * @return  カラム名
    197         */
    198        public String getName() { return name; }
    199
    200        /**
    201         * カラムのデータの属性を返します。
    202         *
    203         * @return  カラムのデータの属性
    204         */
    205        public String getClassName() { return className; }
    206
    207        /**
    208         * フィールドの使用桁数を返します。
    209         * 小数指定の場合は、"7,3" のようなカンマで整数部、小数部を区切った書式になります。
    210         * 7,3 は、 xxxx,yyy のフォーマットで、整数部４桁、小数部３桁を意味します。
    211         *
    212         * @return  使用桁数
    213         */
    214        public String getMaxlength() { return maxlength; }
    215
    216        /**
    217         * フィールドのデータ長を返します。
    218         * 通常は、整数型の文字列とデータ長は同じですが,小数点を表すデータ長は
    219         * x.y 形式の場合、x + 1 桁で表されます。
    220         * 6.2 は、 xxxx.yy のフォーマットです。
    221         *
    222         * @return  データ長定義文字列
    223         */
    224        public int getTotalSize() { return totalSize; }
    225
    226        /**
    227         * フィールドの整数部のデータ長を返します。
    228         *
    229         * @return  データ長定義文字列
    230         */
    231        public int getSizeX() { return sizeX ; }
    232
    233        /**
    234         * フィールドの小数部のデータ長を返します。
    235         *
    236         * @return  データ長定義文字列
    237         */
    238        public int getSizeY() { return sizeY ; }
    239
    240        /**
    241         * 文字列の表示文字数を返します。
    242         *
    243         * これは、テキストフィールドのサイズではなく、Renderer系の表示に使用する
    244         * 文字数指定に使われます。
    245         * 無指定の場合は、null が返されます。
    246         *
    247         * @return  表示文字数
    248         */
    249        public String getViewLength() { return viewLength; }
    250
    251        /**
    252         * フィールドの入力枠サイズを返します。
    253         *
    254         * テキストフィールドのサイズに該当します。
    255         * 何も指定しない場合は、null が返ります。
    256         * その場合の、入力枠サイズは、maxlength が使用されます。
    257         * ただし、桁数が大きい場合は、システム定数の HTML_COLUMNS_MAXSIZE や、
    258         * HTML_VIEW_COLUMNS_MAXSIZE で指定された値が使われます。
    259         * それらの値よりも、ここで取得 した fieldSize が優先されます。
    260         *
    261         * @og.rev 6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)
    262         *
    263         * @return  入力枠サイズ
    264         */
    265        public String getFieldSize() { return fieldSize; }
    266
    267        /**
    268         * 表示種別を返します。
    269         *
    270         * @return  表示種別の文字列
    271         */
    272        public String getRenderer() { return renderer; }
    273
    274        /**
    275         * 編集種別を返します。
    276         *
    277         * @return  編集種別
    278         */
    279        public String getEditor() { return editor; }
    280
    281        /**
    282         * 文字種別を返します。
    283         *
    284         * @return  文字種別
    285         */
    286        public String getDbType() { return dbType; }
    287
    288        /**
    289         * ラベルカラムを返します。
    290         *
    291         * @return  ラベルカラム
    292         */
    293        public String getLabelColumn() { return labelClm; }
    294
    295        /**
    296         * コードカラムを返します。
    297         *
    298         * @return  コードカラム
    299         */
    300        public String getCodeColumn() { return codeClm; }
    301
    302        /**
    303         * データのデフォルト値を返します。
    304         *
    305         * @return  データのデフォルト値
    306         */
    307        public String getDefault() { return dataDef; }
    308
    309        /**
    310         * カラムのパラメータを取得します。
    311         *
    312         * @return      カラムパラメータ
    313         */
    314        public String getColumnParam() { return columnPrm; }
    315
    316        /**
    317         * 表示用レンデラーのパラメータを取得します。
    318         *
    319         * @return      表示パラメータ
    320         */
    321        public String getRendererParam() { return rendererPrm; }
    322
    323        /**
    324         * 編集用エディターのパラメータを取得します。
    325         *
    326         * @return      編集パラメータ
    327         */
    328        public String getEditorParam() { return editorPrm; }
    329
    330        /**
    331         * データタイプのパラメータを取得します。
    332         *
    333         * @return      データタイプのパラメータ
    334         */
    335        public String getDbTypeParam() { return dbTypePrm; }
    336
    337        /**
    338         * カラムロールを取得します。
    339         *
    340         * @return      カラムロール
    341         */
    342        public String getRoles() { return roles; }
    343
    344        /**
    345         * カラムオブジェクトのロールモードを返します。
    346         *
    347         * @og.rev 4.3.0.0 (2008/07/04) ロールモードマルチ対応
    348         *
    349         * @return カラムオブジェクトのロールモード
    350         */
    351        public RoleMode getRoleMode() { return roleMode; }
    352
    353        /**
    354         * リソースＤＢから作成されたかどうかを返します。
    355         * 正式な場合は、true / リソースになく、独自に作成された場合は、false になります。
    356         *
    357         * @return      リソースＤＢから作成されたかどうか
    358         *
    359         */
    360        public boolean isOfficial() { return official; }
    361
    362        /**
    363         * 内部データの文字列配列を返します。
    364         *
    365         * @og.rev 6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)
    366         *
    367         * @return      内部データの文字列配列
    368         */
    369        public String[] getColumnData() {
    370                String[] data = new String[DATA_SIZE];
    371
    372                data[CLM                        ] = name                ;
    373                data[CLS_NAME           ] = className   ;
    374                data[USE_LENGTH         ] = maxlength   ;
    375                data[VIEW_LENGTH        ] = viewLength  ;
    376                data[RENDERER           ] = renderer    ;
    377                data[EDITOR             ] = editor              ;
    378                data[DBTYPE             ] = dbType              ;
    379                data[DATA_DEFAULT       ] = dataDef             ;
    380                data[LABEL_CLM          ] = labelClm    ;
    381                data[CODE_CLM           ] = codeClm             ;
    382                data[CLM_PARAM          ] = columnPrm   ;
    383                data[RENDERER_PARAM     ] = rendererPrm ;
    384                data[EDITOR_PARAM       ] = editorPrm   ;
    385                data[TYPE_PARAM         ] = dbTypePrm   ;
    386                data[ROLES                      ] = roles               ;
    387                data[FIELD_SIZE         ] = fieldSize   ;                       // 6.2.0.0 (2015/02/27)
    388
    389                return data ;
    390        }
    391}