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        private final String    name                    ;               // カラム名
088        private final String    className               ;               // データの属性(VARCHAR2,NUMBER...)
089        private final String    maxlength               ;               // 最大桁数
090        private final String    viewLength              ;               // 表示桁数
091        private final String    fieldSize               ;               // 6.2.0.0 (2015/02/27) 入力枠サイズ
092        private final String    renderer                ;               // 表示種別
093        private final String    editor                  ;               // 編集種別
094        private final String    dbType                  ;               // 文字種別(S9,X...)
095        private final String    dataDef                 ;               // データのデフォルト値
096        private final String    labelClm                ;               // ラベルカラム
097        private final String    codeClm                 ;               // コードカラム
098        private final String    columnPrm               ;               // カラムパラメータ
099        private final String    rendererPrm             ;               // 表示パラメータ
100        private final String    editorPrm               ;               // 編集パラメータ
101        private final String    dbTypePrm               ;               // 文字パラメータ
102        private final String    roles                   ;               // カラムロール
103        private final RoleMode  roleMode                ;               // 4.3.0.0 (2008/07/04) ロールズとモードを管理するオブジェクト
104
105        private final int               totalSize               ;               // 総桁数(小数点も含む)
106        private final int               sizeX                   ;               // カラムの文字桁数(整数部)
107        private final int               sizeY                   ;               // カラムの文字桁数(小数部)
108        private final boolean   official                ;               // リソースDBから作成されたかどうか
109
110        /**
111         * 配列文字列のデータを元に、ColumnDataオブジェクトを構築します。
112         * このコンストラクタは、他のパッケージから呼び出せないように、
113         * パッケージプライベートにしておきます。
114         * このコンストラクタは、DBリソースファイルを想定しています。
115         *
116         * @og.rev 4.3.0.0 (2008/07/04) ロールモードマルチ対応
117         * @og.rev 5.1.6.0 (2010/05/01) DBTypeの初期値を "XK" とします。
118         * @og.rev 5.2.2.0 (2010/11/01) パラメーターもVer3互換のためNVAL2で処理します。
119         * @og.rev 5.5.8.5 (2012/11/27) 編集パラメータで、"=" と記述されている場合は、表示パラメータを利用する。
120         * @og.rev 6.1.0.0 (2014/12/26) カラムの表示桁数(小数部)対応
121         * @og.rev 6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)
122         *
123         * @param       data    CLM,CLS_NAME,USE_LENGTH,VIEW_LENGTH,
124         *                      RENDERER,EDITOR,DBTYPE,DATA_DEFAULT,LABEL_CLM,CODE_CLM,
125         *                      CLM_PARAM,RENDERER_PARAM,EDITOR_PARAM,TYPE_PARAM,ROLES,FIELD_SIZE
126         *
127         */
128        public ColumnData( final String[] data ) {
129                name            = data[CLM].intern() ;                                          // カラム名
130                className       = data[CLS_NAME].intern() ;                                     // データの属性
131                maxlength       = data[USE_LENGTH].replace( '.',',' ).intern();         // 最大桁数
132                fieldSize       = nval2( data[FIELD_SIZE]        , null ) ;             // 6.2.0.0 (2015/02/27) 入力枠サイズ
133                renderer        = nval2( data[RENDERER]          , null ) ;             // 表示種別
134                editor          = nval2( data[EDITOR]            , null ) ;             // 編集種別
135                dbType          = nval2( data[DBTYPE]            , "XK" ) ;             // 文字種別  5.1.6.0 (2010/05/01)
136                dataDef         = nval2( data[DATA_DEFAULT]      , ""   ) ;             // データのデフォルト値
137                labelClm        = nval2( data[LABEL_CLM]         , name ) ;             // ラベルカラム
138                codeClm         = nval2( data[CODE_CLM]          , name ) ;             // コードカラム
139                columnPrm       = nval2( data[CLM_PARAM]         , null ) ;             // カラムパラメータ
140                rendererPrm     = nval2( data[RENDERER_PARAM], null ) ;         // 表示パラメータ
141                dbTypePrm       = nval2( data[TYPE_PARAM]        , null ) ;             // 文字パラメータ
142                roles           = nval2( data[ROLES]             , null ) ;             // カラムロール
143                official        = true;                                                                         // リソースDBから作成されたかどうか
144
145                // 6.1.0.0 (2014/12/26) カラムの表示桁数(小数部)対応と、カンマ置換処理
146                final String viewLen = nval2( data[VIEW_LENGTH] , null ) ;
147                viewLength = viewLen == null ? null : viewLen.replace( '.',',' ).intern();
148
149                // 5.5.8.5 (2012/11/27) 編集パラメータで、"=" と記述されている場合は、表示パラメータを利用する。
150                final String tempEditPrm = nval2( data[EDITOR_PARAM], null ) ;
151                if( "=".equals( tempEditPrm ) ) {
152                        editorPrm = rendererPrm ;
153                }
154                else {
155                        editorPrm = tempEditPrm ;
156                }
157
158                roleMode        = RoleMode.newInstance( roles );        // ロールモード
159
160                // x,y 形式の場合、x + 2 桁で表されます。(マイナス記号と小数点記号)
161                // 7,3 は、 xxxx,yyy のフォーマットで、データ長は、9 になります。
162                final int ch = maxlength.indexOf( ',' ) ;
163                if( ch > 0 ) {
164                        sizeY = Integer.parseInt( maxlength.substring( ch+1 ) );
165                        sizeX = Integer.parseInt( maxlength.substring( 0,ch ) ) - sizeY;
166                        totalSize = sizeX + sizeY+ 2;
167                }
168                else {
169                        sizeY = 0;
170                        sizeX = Integer.parseInt( maxlength );
171                        if( "S9".equals( dbType ) ) {
172                                totalSize = sizeX + 1;  // 数字型の場合は、マイナス記号分を加える。
173                        }
174                        else {
175                                totalSize = sizeX ;
176                        }
177                }
178        }
179
180        /**
181         * カラム名を返します。
182         *
183         * @return  カラム名
184         */
185        public String getName() { return name; }
186
187        /**
188         * カラムのデータの属性を返します。
189         *
190         * @return  カラムのデータの属性
191         */
192        public String getClassName() { return className; }
193
194        /**
195         * フィールドの使用桁数を返します。
196         * 小数指定の場合は、"7,3" のようなカンマで整数部、小数部を区切った書式になります。
197         * 7,3 は、 xxxx,yyy のフォーマットで、整数部4桁、小数部3桁を意味します。
198         *
199         * @return  使用桁数
200         */
201        public String getMaxlength() { return maxlength; }
202
203        /**
204         * フィールドのデータ長を返します。
205         * 通常は、整数型の文字列とデータ長は同じですが,小数点を表すデータ長は
206         * x.y 形式の場合、x + 1 桁で表されます。
207         * 6.2 は、 xxxx.yy のフォーマットです。
208         *
209         * @return  データ長定義文字列
210         */
211        public int getTotalSize() { return totalSize; }
212
213        /**
214         * フィールドの整数部のデータ長を返します。
215         *
216         * @return  データ長定義文字列
217         */
218        public int getSizeX() { return sizeX ; }
219
220        /**
221         * フィールドの小数部のデータ長を返します。
222         *
223         * @return  データ長定義文字列
224         */
225        public int getSizeY() { return sizeY ; }
226
227        /**
228         * 文字列の表示文字数を返します。
229         *
230         * これは、テキストフィールドのサイズではなく、Renderer系の表示に使用する
231         * 文字数指定に使われます。
232         * 無指定の場合は、null が返されます。
233         *
234         * @return  表示文字数
235         */
236        public String getViewLength() { return viewLength; }
237
238        /**
239         * フィールドの入力枠サイズを返します。
240         *
241         * テキストフィールドのサイズに該当します。
242         * 何も指定しない場合は、null が返ります。
243         * その場合の、入力枠サイズは、maxlength が使用されます。
244         * ただし、桁数が大きい場合は、システム定数の HTML_COLUMNS_MAXSIZE や、
245         * HTML_VIEW_COLUMNS_MAXSIZE で指定された値が使われます。
246         * それらの値よりも、ここで取得 した fieldSize が優先されます。
247         *
248         * @og.rev 6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)
249         *
250         * @return  入力枠サイズ
251         */
252        public String getFieldSize() { return fieldSize; }
253
254        /**
255         * 表示種別を返します。
256         *
257         * @return  表示種別の文字列
258         */
259        public String getRenderer() { return renderer; }
260
261        /**
262         * 編集種別を返します。
263         *
264         * @return  編集種別
265         */
266        public String getEditor() { return editor; }
267
268        /**
269         * 文字種別を返します。
270         *
271         * @return  文字種別
272         */
273        public String getDbType() { return dbType; }
274
275        /**
276         * ラベルカラムを返します。
277         *
278         * @return  ラベルカラム
279         */
280        public String getLabelColumn() { return labelClm; }
281
282        /**
283         * コードカラムを返します。
284         *
285         * @return  コードカラム
286         */
287        public String getCodeColumn() { return codeClm; }
288
289        /**
290         * データのデフォルト値を返します。
291         *
292         * @return  データのデフォルト値
293         */
294        public String getDefault() { return dataDef; }
295
296        /**
297         * カラムのパラメータを取得します。
298         *
299         * @return      カラムパラメータ
300         */
301        public String getColumnParam() { return columnPrm; }
302
303        /**
304         * 表示用レンデラーのパラメータを取得します。
305         *
306         * @return      表示パラメータ
307         */
308        public String getRendererParam() { return rendererPrm; }
309
310        /**
311         * 編集用エディターのパラメータを取得します。
312         *
313         * @return      編集パラメータ
314         */
315        public String getEditorParam() { return editorPrm; }
316
317        /**
318         * データタイプのパラメータを取得します。
319         *
320         * @return      データタイプのパラメータ
321         */
322        public String getDbTypeParam() { return dbTypePrm; }
323
324        /**
325         * カラムロールを取得します。
326         *
327         * @return      カラムロール
328         */
329        public String getRoles() { return roles; }
330
331        /**
332         * カラムオブジェクトのロールモードを返します。
333         *
334         * @og.rev 4.3.0.0 (2008/07/04) ロールモードマルチ対応
335         *
336         * @return カラムオブジェクトのロールモード
337         */
338        public RoleMode getRoleMode() { return roleMode; }
339
340        /**
341         * リソースDBから作成されたかどうかを返します。
342         * 正式な場合は、true / リソースになく、独自に作成された場合は、false になります。
343         *
344         * @return      リソースDBから作成されたかどうか
345         *
346         */
347        public boolean isOfficial() { return official; }
348
349        /**
350         * 内部データの文字列配列を返します。
351         *
352         * @og.rev 6.2.0.0 (2015/02/27) フィールドサイズ 追加(VIEW_LENGTHと分離して、役割を明確にする)
353         *
354         * @return      内部データの文字列配列
355         */
356        public String[] getColumnData() {
357                String[] data = new String[DATA_SIZE];
358
359                data[CLM                        ] = name                ;
360                data[CLS_NAME           ] = className   ;
361                data[USE_LENGTH         ] = maxlength   ;
362                data[VIEW_LENGTH        ] = viewLength  ;
363                data[FIELD_SIZE         ] = fieldSize   ;                       // 6.2.0.0 (2015/02/27)
364                data[RENDERER           ] = renderer    ;
365                data[EDITOR             ] = editor              ;
366                data[DBTYPE             ] = dbType              ;
367                data[DATA_DEFAULT       ] = dataDef             ;
368                data[LABEL_CLM          ] = labelClm    ;
369                data[CODE_CLM           ] = codeClm             ;
370                data[CLM_PARAM          ] = columnPrm   ;
371                data[RENDERER_PARAM     ] = rendererPrm ;
372                data[EDITOR_PARAM       ] = editorPrm   ;
373                data[TYPE_PARAM         ] = dbTypePrm   ;
374                data[ROLES                      ] = roles               ;
375
376                return data ;
377        }
378}