    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.plugin.column;
    017
    018import org.opengion.fukurou.util.StringUtil;
    019import org.opengion.hayabusa.db.AbstractRenderer;
    020import org.opengion.hayabusa.db.CellRenderer;
    021import org.opengion.hayabusa.db.DBColumn;
    022
    023/**
    024 * NUMBER レンデラーは、カラムのデータを数字表示する場合に使用するクラスです。
    025 * x,yの形式で表示パラメータを指定可能です。
    026 * 負数の場合はspanタグclass="minus"を付けて出力します。
    027 *
    028 * フォーマットには、java.text.NumberFormat を使用せずに、独自クラスを使用しており
    029 * double 以上の精度をもつ値でも正確に変換できます。
    030 *  カラムの表示に必要な属性は, DBColumn オブジェクト より取り出します。
    031 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
    032 *
    033 * @og.group データ表示
    034 * @og.rev 5.4.3.6 (2012/01/19) コメント修正
    035 *
    036 * @version  4.0
    037 * @author       Kazuhiko Hasegawa
    038 * @since    JDK5.0,
    039 */
    040public class Renderer_NUMBER extends AbstractRenderer {
    041        /** このプログラムのVERSION文字列を設定します。   {@value} */
    042        private static final String VERSION = "6.8.3.1 (2017/12/01)" ;
    043
    044        private final String    defValue ;
    045        private final int               minFraction;
    046        private final String    noDisplayVal ;          // 5.6.2.3 (2013/03/22)
    047
    048        // 5.2.2.0 (2010/11/01) defval,size の初期値設定の変更
    049        private static final CellRenderer[] DB_CELL = {
    050                                                        new Renderer_NUMBER(),                          // 0
    051                                                        new Renderer_NUMBER("" ,1,null),        // 1
    052                                                        new Renderer_NUMBER("" ,2,null),        // 2
    053                                                        new Renderer_NUMBER("0",0,null),        // 3
    054                                                        new Renderer_NUMBER("0",1,null),        // 4
    055                                                        new Renderer_NUMBER("0",2,null)         // 5
    056        };
    057
    058        /**
    059         * デフォルトコンストラクター。
    060         * このコンストラクターで、基本オブジェクトを作成します。
    061         *
    062         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
    063         * @og.rev 3.3.0.0 (2003/06/23) 初期値設定追加。
    064         * @og.rev 4.0.0.0 (2007/11/29) 初期値を""に変更。
    065         * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数初期化
    066         *
    067         */
    068        public Renderer_NUMBER() {
    069                this( "",0,null );                      // 6.0.2.4 (2014/10/17)
    070        }
    071
    072        /**
    073         * コンストラクター。
    074         *
    075         * @og.rev 6.0.2.4 (2014/10/17) noDisplayVal 対応漏れのため、追加
    076         *
    077         * @param       defval  初期値
    078         * @param       size    小数点
    079         * @param       noDispVal       非表示文字の設定
    080         */
    081        private Renderer_NUMBER( final String defval , final int size , final String noDispVal ) {
    082                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
    083                defValue     = defval;
    084                minFraction  = size;
    085                noDisplayVal = noDispVal;               // 5.5.1.0 (2012/04/03)
    086        }
    087
    088        /**
    089         * 各オブジェクトから自分のインスタンスを返します。
    090         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
    091         * まかされます。
    092         *
    093         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
    094         * @og.rev 3.1.2.1 (2003/04/10) synchronized を、削除します。
    095         * @og.rev 5.2.2.0 (2010/11/01) defval,size の初期値設定の変更
    096         * @og.rev 5.3.5.0 (2011/05/01) ↑の判定ロジックのバグ修正
    097         * @og.rev 6.0.4.0 (2014/11/28) 表示は、ViewLength属性を元に行う。
    098         *
    099         * @param       clm     DBColumnオブジェクト
    100         *
    101         * @return      CellRendererオブジェクト
    102         * @og.rtnNotNull
    103         */
    104        public CellRenderer newInstance( final DBColumn clm ) {
    105                final String defval    = clm.getDefault();
    106                int   size             = clm.getSizeY();
    107                final String noDispVal = clm.getNoDisplayVal(); // 6.0.2.4 (2014/10/17)
    108
    109                // 6.0.4.0 (2014/11/28) 表示は、ViewLength属性があれば、それを使う。
    110                final String viewLength = clm.getViewLength();
    111                if( viewLength != null ) {
    112                        final int ch = viewLength.indexOf( ',' ) ;              // DBColumn で、"." を "," に変換済み
    113                        if( ch > 0 ) {
    114                                size = Integer.parseInt( viewLength.substring( ch+1 ) );
    115                        }
    116                        else {
    117                                size = 0;
    118                        }
    119                }
    120
    121                // 5.2.2.0 (2010/11/01) defval,size の初期値設定の変更
    122                // 5.3.5.0 (2011/05/01) ↑の判定ロジックのバグ修正
    123                if( size < 3 && noDispVal == null ) {           // 6.0.2.4 (2014/10/17)
    124                        if( defval == null || defval.isEmpty() ) {
    125                                return DB_CELL[size];                           // 0,1,2
    126                        }
    127                        else if( "0".equals( defval ) ) {               // 5.3.0.0 (2010/12/01) リテラルで比較する。
    128                                return DB_CELL[size+3];                         // 3,4,5
    129                        }
    130                }
    131
    132                return new Renderer_NUMBER( defval,size,noDispVal );    // 6.0.2.4 (2014/10/17)
    133        }
    134
    135        /**
    136         * データの表示用文字列を返します。
    137         *
    138         * @og.rev 3.1.0.0 (2003/03/20) 内部に、DBColumn オブジェクトをキープしないように変更
    139         * @og.rev 3.3.0.0 (2003/06/23) NumberFormatクラスは、廃止します。
    140         * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数追加
    141         *
    142         * @param       value 入力値
    143         *
    144         * @return      データの表示用文字列
    145         * @og.rtnNotNull
    146         */
    147        @Override
    148        public String getValue( final String value ) {
    149                return getValue( value , true );
    150        }
    151
    152        /**
    153         * データ出力用の文字列を作成します。
    154         * ファイル等に出力する形式を想定しますので、HTMLタグを含まない
    155         * データを返します。
    156         * 基本は、#getValue( String ) をそのまま返します。
    157         *
    158         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
    159         *
    160         * @param   value 入力値
    161         *
    162         * @return  データ出力用の文字列
    163         * @og.rtnNotNull
    164         * @see         #getValue( String )
    165         */
    166        @Override
    167        public String getWriteValue( final String value ) {
    168                return getValue( value , false );
    169        }
    170
    171        /**
    172         * データ表示用/出力用の文字列を作成します。
    173         * 第二引数の isView == true で、データ表示用文字列を、false で
    174         * データ出力用の文字列を作成します。
    175         * 処理の共通化を行うためのメソッドです。
    176         *
    177         * @og.rev 6.0.4.0 (2014/11/28) ロジックの共通化
    178         *
    179         * @param   value  入力値
    180         * @param   isView データ表示用かどうか(true:表示用/false:出力用)
    181         *
    182         * @return  データ表示用/出力用の文字列
    183         * @og.rtnNotNull
    184         * @see         #getValue( String )
    185         */
    186        private String getValue( final String value , final boolean isView ) {
    187                // 5.6.2.3 (2013/03/22) noDisplayVal 変数追加
    188                if( noDisplayVal != null && noDisplayVal.equalsIgnoreCase( value ) ) { return "" ; }
    189
    190                // 6.4.2.1 (2016/02/05) PMD refactoring.
    191                final String val = value == null || value.trim().isEmpty() ? defValue : value ;
    192
    193                final String rtn = StringUtil.numberFormat( val,minFraction );
    194
    195                return isView && StringUtil.startsChar( rtn , '-' )                                             // 6.2.0.0 (2015/02/27) １文字 String.startsWith
    196                                        ? "<span class=\"minus\">" + rtn + "</span>"
    197                                        : rtn;
    198        }
    199
    200        /**
    201         * name属性を変えた、データ表示用のHTML文字列を作成します。
    202         * レンデラーのため、row(行番号)は使いません。
    203         * 第３引数に、パラメータを渡すことが出来ます。これは、viewMarker で
    204         * [$XXXX param] 形式を渡すことで、行単位に表示形式を変更できます。
    205         *
    206         * @og.rev 6.8.3.1 (2017/12/01) パラメータを渡せるようにします。
    207         *
    208         * @param   row   行番号
    209         * @param   value 値
    210         * @param   param パラメータ
    211         *
    212         * @return  データ表示/編集用の文字列
    213         */
    214        @Override
    215        public String getValue( final int row,final String value,final String param ) {
    216                // 5.6.2.3 (2013/03/22) noDisplayVal 変数追加
    217                if( noDisplayVal != null && noDisplayVal.equalsIgnoreCase( value ) ) { return "" ; }
    218
    219                // 6.4.2.1 (2016/02/05) PMD refactoring.
    220                final String val = value == null || value.trim().isEmpty() ? defValue : value ;
    221                final int   size = param == null || param.isEmpty() ? 0 : Integer.parseInt( param );
    222                final String rtn = StringUtil.numberFormat( val,size );
    223
    224                return StringUtil.startsChar( rtn , '-' )                                               // 6.2.0.0 (2015/02/27) １文字 String.startsWith
    225                                        ? "<span class=\"minus\">" + rtn + "</span>"
    226                                        : rtn;
    227        }
    228}