    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.db;
    017
    018import org.opengion.fukurou.model.NativeType;
    019import 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 */
    041public interface DBType {
    042
    043        // 5.1.6.0 (2010/05/01) 初期タイプを XK とします。
    044        String DEF_TYPE = "XK" ;
    045
    046        /**
    047         * NATIVEの型の識別コードを返します。
    048         *
    049         * @og.rev 3.5.4.7 (2004/02/06) 新規作成
    050         * @og.rev 4.1.1.2 (2008/02/28) Enum型(fukurou.model.NativeType)に変更
    051         *
    052         * @return  NATIVEの型の識別コード(DBType で規定)
    053         * @see org.opengion.fukurou.model.NativeType
    054         */
    055        NativeType getNativeType() ;
    056
    057        /**
    058         * 文字タイプに応じた方法で固定長に変換した文字列を返します。
    059         * 例えば，全角なら全角スペースで、数字タイプならゼロ埋めします。
    060         *
    061         * @og.rev 3.5.4.5 (2004/01/23) エンコード指定に変更します。
    062         *
    063         * @param   value    ＦＩＬＬ埋めする文字列
    064         * @param   sizeX    整数部分の文字列の長さ
    065         * @param   sizeY    小数部分の文字列の長さ
    066         * @param   encode   固定長で変換する文字エンコード
    067         *
    068         * @return  ＦＩＬＬ埋めした新しい文字列
    069         */
    070        String valueFill( String value ,int sizeX ,int sizeY,String encode ) ;
    071
    072        /**
    073         * そのDBTypeの,デフォルトの値(物理的初期設定値)を返します。
    074         *
    075         * 一般に、文字列の場合は,ゼロストリング""  数字の場合は "0" です。
    076         *
    077         * @return  物理的初期設定値
    078         */
    079        String getDefault() ;
    080
    081        /**
    082         * String引数の文字列を＋１した文字列を返します。
    083         * これは、英字の場合(A,B,C など)は、B,C,D のように,最終桁の文字コードを
    084         * ＋１ します。
    085         * 文字列が数字タイプの場合は, 数字に変換して、+1 します。(桁上がりもあり)
    086         * 混在タイプの場合は,最後の桁だけを確認して ＋１します。
    087         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
    088         * の値を返します。
    089         *
    090         * @param   value  String引数
    091         *
    092         * @return  引数の文字列を＋１した文字列。
    093         */
    094        String valueAdd( String value ) ;
    095
    096        /**
    097         * String引数の文字列に、第２引数に指定の文字列(数字、日付等)を加算して返します。
    098         *
    099         * これは、valueAdd( String ) と本質的には同じ動きをしますが、任意の文字列を加算する
    100         * ため、主として、数字系や日付系の DBType にのみ実装します。
    101         * 実装がない場合は、UnsupportedOperationException を throw します。
    102         *
    103         * 第２引数 が、null の場合は、＋１ する valueAdd( String )が呼ばれます。
    104         * これは、将来的には、valueAdd( String ) を無くすことを意味します。
    105         *
    106         * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。
    107         *
    108         * @param   value  String引数
    109         * @param   add    加算する文字列(null の場合は、従来と同じ、+1 します。)
    110         *
    111         * @return  引数の文字列第２引数に指定の文字列(数字、日付等)を加算した文字列。
    112         * @throws UnsupportedOperationException 実装が存在しない場合
    113         */
    114        String valueAdd( final String value,final String add ) ;
    115
    116        /**
    117         * エディターで編集されたデータを登録する場合に、データそのものを
    118         * 変換して、実登録データを作成します。
    119         * 例えば,大文字のみのフィールドなら、大文字化します。
    120         * 実登録データの作成は、DBType オブジェクトを利用しますので,
    121         * これと CellEditor とがアンマッチの場合は、うまくデータ変換
    122         * されない可能性がありますので、注意願います。
    123         *
    124         * @param       value   (一般に編集データとして登録されたデータ)
    125         *
    126         * @return  修正後の文字列(一般にデータベースに登録するデータ)
    127         */
    128        String valueSet( String value ) ;
    129
    130        /**
    131         * action で指定されたコマンドを実行して、値の変換を行います。
    132         * oldValue(旧データ)は、元のDBTableModelに設定されていた値です。通常は、
    133         * この値を使用してカラム毎に変換を行います。newValue(新データ)は、引数で
    134         * 指定された新しい値です。この値には、パラメータを指定して変換方法を
    135         * 制御することも可能です。
    136         * 指定のアクションがカラムで処理できない場合は、エラーになります。
    137         *
    138         * @param action        アクションコマンド
    139         * @param oldValue      入力データ(旧データ)
    140         * @param newValue      入力データ(新データ)
    141         *
    142         * @return      実行後のデータ
    143         */
    144        String valueAction( String action,String oldValue,String newValue ) ;
    145
    146        /**
    147         * データが登録可能かどうかをチェックします。
    148         * データがエラーの場合は、そのエラー内容を返します。
    149         *
    150         * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータを引数に追加
    151         * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
    152         *
    153         * @param   key                 キー
    154         * @param   value               値
    155         * @param   sizeX               整数部分の文字列の長さ
    156         * @param   sizeY               小数部分の文字列の長さ
    157         * @param   typeParam   dbType パラメータ
    158         * @param   isStrict    厳密にチェックするかどうか [true:する/false:標準的]
    159         *
    160         * @return  エラー内容
    161         */
    162        ErrorMessage valueCheck( String key ,String value ,int sizeX ,int sizeY ,String typeParam ,boolean isStrict ) ;
    163}