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     */
016    package org.opengion.hayabusa.db;
017    
018    import org.opengion.fukurou.model.NativeType;
019    import org.opengion.fukurou.util.ErrorMessage;
020    
021    /**
022     * ãƒ??タベã?スã®ã‚«ãƒ©ãƒ?±žæ?ã®ã?¡ã€?™çš?«–ç†å±žæ?ã‚’è¦å®šã™ã‚‹æƒ…å ±ã‚’ä¿æŒã—ã¦ã?‚‹ã‚ªãƒ–ジェクトã§ã™ã?
023     * ã“ã?インターフェースを実è£?—ãŸã‚¯ãƒ©ã‚¹ã¯ã€ã‚«ãƒ©ãƒ??åå‰ã€ãƒ©ãƒ™ãƒ«ã€æ¡æ•°ã€?
024     * 種é¡?æ–?­—ã?æ•°å­—ã?æ—¥ä»?ã‚?‚¿ã‚¤ãƒ?全角ã?åŠè§’ã?大æ–?­—ã?å°æ–‡å­?ã®æƒ??ã‚?
025     * æŒã£ã¦ã?¾ã™ã?ã•らã«ã€ãã®ã‚«ãƒ©ãƒ??表示方æ³?CellRenderer)ã‚??
026     * ç·¨é›?–¹æ³?CellEditor)ã‚’é™çš?«å‰²ã‚Šå½“ã¦ã‚‹äº‹ãŒå¯èƒ½ã§ã™ã?
027     * ã“れらã??Œã‚«ãƒ©ãƒ??é™çš„æƒ??ã§ã‚ã£ã¦ã€ãã®ã‚«ãƒ©ãƒ?«å¯¾ã™ã‚‹å€¤ã‚’ä¿æŒã—ãŸã‚?
028     * å?‚¢ãƒ—リケーション毎ã«å¤‰æ›´ã•ã‚Œã‚‹æƒ…å ±ã¯æŒã£ã¦ã?¾ã›ã‚“。ã™ã¹ã¦ã®ç”»é¢ã§
029     * åŒä¸??æƒ??ã‚’ä¿æŒã—ã¦ã?¾ã™ã?
030     * ãƒ??タを登録ã™ã‚‹å ´åˆã?æœ?½Žé™ã®æ•´åˆæ?ãƒã‚§ãƒ?‚¯ã¯ã€ã“ã®ã‚¯ãƒ©ã‚¹ã‚’用ã?¦
031     * 行ã„ã¾ã™ã?
032     * ãƒã‚§ãƒ?‚¯æ–¹æ³•ã?ã€ç¨®é¡žã‚„タイプã§ç•°ãªã‚Šã¾ã™ãŒ?Œãれらã¯ã“ã?インターフェース
033     * を実è£?—ãŸã‚µãƒ–クラス毎ã«ç•°ãªã‚Šã¾ã™ã?
034     *
035     * @og.group ãƒ??タ属æ?
036     *
037     * @version  4.0
038     * @author   Kazuhiko Hasegawa
039     * @since    JDK5.0,
040     */
041    public interface DBType {
042    
043            // 5.1.6.0 (2010/05/01) åˆæœŸã‚¿ã‚¤ãƒ—ã‚’ XK ã¨ã—ã¾ã™ã?
044            static final String DEF_TYPE = "XK" ;
045    
046    // 4.1.1.2 (2008/02/28) fukurou.model.NativeTypeã«ç§»å‹?
047    //      /** NATIVEã®åž?[int] ã®è­˜åˆ¥ã‚³ãƒ¼ãƒ?({@value})  */
048    //      static final int NATIVE_INT  = 0 ;
049    //
050    //      /** NATIVEã®åž?[long] ã®è­˜åˆ¥ã‚³ãƒ¼ãƒ?({@value})  */
051    //      static final int NATIVE_LONG  = 1 ;
052    //
053    //      /** NATIVEã®åž?[double] ã®è­˜åˆ¥ã‚³ãƒ¼ãƒ?({@value})  */
054    //      static final int NATIVE_DOUBLE  = 2 ;
055    //
056    //      /** NATIVEã®åž?[String] ã®è­˜åˆ¥ã‚³ãƒ¼ãƒ?({@value})  */
057    //      static final int NATIVE_STRING  = 3 ;
058    //
059    //      /** NATIVEã®åž?[Calendar] ã®è­˜åˆ¥ã‚³ãƒ¼ãƒ?({@value})  */
060    //      static final int NATIVE_CALENDAR  = 4 ;
061    
062            /**
063             * NATIVEã®åž‹ã?識別コードを返ã—ã¾ã™ã?
064             *
065             * @og.rev 3.5.4.7 (2004/02/06) æ–°è¦ä½œæ?
066             * @og.rev 4.1.1.2 (2008/02/28) Enumåž?fukurou.model.NativeType)ã«å¤‰æ›´
067             *
068             * @return  NATIVEã®åž‹ã?識別コーãƒ?DBType ã§è¦å®?
069             * @see org.opengion.fukurou.model.NativeType
070             */
071            NativeType getNativeType() ;
072    
073            /**
074             * æ–?­—タイプã«å¿œã˜ãŸæ–¹æ³•ã§å›ºå®šé•·ã«å¤‰æ›ã—ãŸæ–?­—å?ã‚’è¿”ã—ã¾ã™ã?
075             * 例ãˆã°?Œå?è§’ãªã‚‰å?角スペã?スã§ã€æ•°å­—タイプãªã‚‰ã‚¼ãƒ­åŸ‹ã‚ã—ã¾ã™ã?
076             *
077             * @og.rev 3.5.4.5 (2004/01/23) エンコード指定ã«å¤‰æ›´ã—ã¾ã™ã?
078             *
079             * @param   value    ?¦?©?¬?¬åŸ‹ã‚ã™ã‚‹æ–?­—å?
080             * @param   sizeX    整数部åˆ??æ–?­—å?ã®é•·ã?
081             * @param   sizeY    少数部åˆ??æ–?­—å?ã®é•·ã?
082             * @param   encode   固定長ã§å¤‰æ›ã™ã‚‹æ–?­—エンコーãƒ?
083             *
084             * @return  ?¦?©?¬?¬åŸ‹ã‚ã—ãŸæ–°ã—ã„æ–?­—å?
085             */
086            String valueFill( String value ,int sizeX ,int sizeY,String encode ) ;
087    
088            /**
089             * ãã?DBTypeã®,ãƒ?ƒ•ォルトã?値(物ç?š„åˆæœŸè¨­å®šå?)ã‚’è¿”ã—ã¾ã™ã?
090             *
091             * ä¸?ˆ¬ã«ã€æ–‡å­—å?ã®å ´åˆã?,ゼロストリング""  æ•°å­—ã?å ´åˆã? "0" ã§ã™ã?
092             *
093             * @return  物ç?š„åˆæœŸè¨­å®šå?
094             */
095            String getDefault() ;
096    
097            /**
098             * Stringå¼•æ•°ã®æ–?­—å?を+1ã—ãŸæ–‡å­—å?ã‚’è¿”ã—ã¾ã™ã?
099             * ã“れã¯ã€è‹±å­—ã?å ´å?A,B,C ãªã©)ã¯ã€B,C,D ã®ã‚ˆã†ã«,æœ?µ‚æ¡ã?æ–?­—コードを
100             * ?‹ï¼?ã—ã¾ã™ã?
101             * æ–?­—å?ãŒæ•°å­—タイプã?å ´åˆã?, æ•°å­—ã«å¤‰æ›ã—ã¦ã€?1 ã—ã¾ã™ã?(æ¡ä¸ŠãŒã‚Šã‚‚ã‚り)
102             * 混在タイプã?å ´åˆã?,æœ?¾Œã?æ¡ã ã‘を確èªã—㦠?‹ï¼‘ã—ã¾ã™ã?
103             * 引数ã?null ã®å ´åˆã¨ã€ã‚¼ãƒ­æ–?­—å?("")ã®å ´åˆã?,物ç?š„åˆæœŸè¨­å®šå?(String getDefault())
104             * ã®å€¤ã‚’è¿”ã—ã¾ã™ã?
105             *
106             * @param   value  String引数
107             *
108             * @return  å¼•æ•°ã®æ–?­—å?を+1ã—ãŸæ–‡å­—å?ã€?
109             */
110            String valueAdd( String value ) ;
111    
112            /**
113             * Stringå¼•æ•°ã®æ–?­—å?ã«ã€ç¬¬?’å¼•æ•°ã«æŒ?®šã?æ–?­—å?(æ•°å­—ã?日付ç­?を加算ã—ã¦è¿”ã—ã¾ã™ã?
114             *
115             * ã“れã¯ã€valueAdd( String ) ã¨æœ¬è³ªçš?«ã¯åŒã˜å‹•ãã‚’ã—ã¾ã™ãŒã€ä»»æ„ã?æ–?­—å?を加算ã™ã‚?
116             * ãŸã‚ã€ä¸»ã¨ã—ã¦ã€æ•°å­—ç³»ã‚?—¥ä»˜ç³»ã® DBType ã«ã®ã¿å®Ÿè£?—ã¾ã™ã?
117             * 実è£?Œãªã??åˆã?ã€UnsupportedOperationException ã‚?throw ã—ã¾ã™ã?
118             * 
119             * 第?’引数 ãŒã?null ã®å ´åˆã?ã€?¼‹ï¼?ã™ã‚‹ valueAdd( String )ãŒå‘¼ã°ã‚Œã¾ã™ã?
120             * ã“れã¯ã€å°?¥çš?«ã¯ã€valueAdd( String ) ã‚’ç„¡ãã™ã“ã¨ã‚’æ„味ã—ã¾ã™ã?
121             *
122             * @og.rev 5.6.0.3 (2012/01/24) ADD ã«ã€å¼•æ•°ã®å€¤ã‚’加算ã™ã‚‹æ©Ÿè?を追åŠ?—ã¾ã™ã?
123             *
124             * @param   value  String引数
125             * @param   add    åŠ?®—ã™ã‚‹æ–‡å­—å?(null ã®å ´åˆã?ã€å¾“æ¥ã¨åŒã˜ã€?1 ã—ã¾ã™ã?)
126             *
127             * @return  å¼•æ•°ã®æ–?­—å?第?’å¼•æ•°ã«æŒ?®šã?æ–?­—å?(æ•°å­—ã?日付ç­?を加算ã—ãŸæ–‡å­—å?ã€?
128             * @throws UnsupportedOperationException 実è£?Œå­˜åœ¨ã—ãªã??å?
129             */
130            String valueAdd( final String value,final String add ) ;
131    
132            /**
133             * エãƒ?‚£ã‚¿ãƒ¼ã§ç·¨é›?•れãŸãƒ??タを登録ã™ã‚‹å ´åˆã«ã€ãƒ‡ãƒ¼ã‚¿ãã?ã‚‚ã?ã‚?
134             * 変æ›ã—ã¦ã€å®Ÿç™»éŒ²ãƒ??タを作æ?ã—ã¾ã™ã?
135             * 例ãˆã°,大æ–?­—ã?ã¿ã®ãƒ•ィールドãªã‚‰ã?大æ–?­—化ã—ã¾ã™ã?
136             * 実登録ãƒ??ã‚¿ã®ä½œæ?ã¯ã€DBType オブジェクトを利用ã—ã¾ã™ã?ã§,
137             * ã“れ㨠CellEditor ã¨ãŒã‚¢ãƒ³ãƒžãƒƒãƒã?å ´åˆã?ã€ã†ã¾ãデータ変æ›
138             * ã•れãªã?¯èƒ½æ€§ãŒã‚りã¾ã™ã?ã§ã€æ³¨æ„願ã„ã¾ã™ã?
139             *
140             * @param       value   (ä¸?ˆ¬ã«ç·¨é›?ƒ‡ãƒ¼ã‚¿ã¨ã—ã¦ç™»éŒ²ã•れãŸãƒ‡ãƒ¼ã‚¿)
141             *
142             * @return  修正後ã?æ–?­—å?(ä¸?ˆ¬ã«ãƒ??タベã?スã«ç™»éŒ²ã™ã‚‹ãƒ??ã‚¿)
143             */
144            String valueSet( String value ) ;
145    
146            /**
147             * action ã§æŒ?®šã•れãŸã‚³ãƒžãƒ³ãƒ‰ã‚’実行ã—ã¦ã€å?ã®å¤‰æ›ã‚’行ã„ã¾ã™ã?
148             * oldValue(æ—§ãƒ??ã‚¿)ã¯ã€å?ã®DBTableModelã«è¨­å®šã•れã¦ã?Ÿå€¤ã§ã™ã?通常ã¯ã€?
149             * ã“ã?値を使用ã—ã¦ã‚«ãƒ©ãƒ?¯Žã«å¤‰æ›ã‚’行ã„ã¾ã™ã?newValue(æ–°ãƒ??ã‚¿)ã¯ã€å¼•æ•°ã§
150             * æŒ?®šã•ã‚ŒãŸæ–°ã—ã„値ã§ã™ã?ã“ã?値ã«ã¯ã€ãƒ‘ラメータを指定ã—ã¦å¤‰æ›æ–¹æ³•ã‚’
151             * 制御ã™ã‚‹ã“ã¨ã‚‚å¯èƒ½ã§ã™ã?
152             * æŒ?®šã?アクションãŒã‚«ãƒ©ãƒ?§å‡¦ç?§ããªã??åˆã?ã€ã‚¨ãƒ©ãƒ¼ã«ãªã‚Šã¾ã™ã?
153             *
154             * @param action        アクションコマン�
155             * @param oldValue      入力データ(旧�?タ)
156             * @param newValue      入力データ(新�?タ)
157             *
158             * @return      実行後ã?ãƒ??ã‚¿
159             */
160            String valueAction( String action,String oldValue,String newValue ) ;
161    
162            /**
163             * ãƒ??ã‚¿ãŒç™»éŒ²å¯èƒ½ã‹ã©ã?‹ã‚’ãƒã‚§ãƒ?‚¯ã—ã¾ã™ã?
164             * ãƒ??ã‚¿ãŒã‚¨ãƒ©ãƒ¼ã®å ´åˆã?ã€ãã®ã‚¨ãƒ©ãƒ¼å†?®¹ã‚’è¿”ã—ã¾ã™ã?
165             *
166             * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータを引数ã«è¿½åŠ?
167             * @og.rev 5.2.2.0 (2010/11/01) 厳å¯?«ãƒã‚§ãƒ?‚¯(isStrict=true)ã™ã‚‹ãƒ•ラグを追åŠ?
168             *
169             * @param   key                 キー
170             * @param   value               値
171             * @param   sizeX               整数部åˆ??æ–?­—å?ã®é•·ã?
172             * @param   sizeY               少数部åˆ??æ–?­—å?ã®é•·ã?
173             * @param   typeParam   dbType パラメータ
174             * @param   isStrict    厳å¯?«ãƒã‚§ãƒ?‚¯ã™ã‚‹ã‹ã©ã?‹ [true:ã™ã‚‹/false:標準的]
175             *
176             * @return  エラーå†?®¹
177             */
178    //      ErrorMessage valueCheck( String key ,String value ,int sizeX ,int sizeY,String typeParam ) ;
179            ErrorMessage valueCheck( String key ,String value ,int sizeX ,int sizeY ,String typeParam ,boolean isStrict ) ;
180    }