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.system.DateSet;                                                     // 6.4.2.0 (2016/01/29)
019import org.opengion.fukurou.util.HybsDateUtil;
020import org.opengion.hayabusa.common.HybsSystem;
021import org.opengion.hayabusa.db.AbstractRenderer;
022import org.opengion.hayabusa.db.CellRenderer;
023import org.opengion.hayabusa.db.DBColumn;
024
025import java.util.Calendar;
026
027/**
028 * DATE レンデラーは、カラムのデータを表示パラメータで指定されたフォーマットで
029 * 日付表示する場合に使用するクラスです。
030 * 6桁未満のデータの場合はフォーマットをかけずにそのまま出力します。
031 *
032 * 表示パラメータで指定されたフォーマットを、java.text.SimpleDateFormat で
033 * 解析してフォーマット変換します。
034 * フォーマットルールは、{@link java.text.SimpleDateFormat} を参照願います。
035 * フォーマット初期値はシステムリソースのSYS_TIMEです。
036 *
037 *  カラムの表示に必要な属性は, DBColumn オブジェクト より取り出します。
038 * このクラスは、DBColumn オブジェクト毎に1つ作成されます。
039 *
040 * @og.rev 3.5.0.0 (2003/09/17) 新規作成
041 * @og.rev 5.4.3.6 (2012/01/19) コメント修正
042 * @og.group データ表示
043 *
044 * @version  4.0
045 * @author       Kazuhiko Hasegawa
046 * @since    JDK5.0,
047 */
048public class Renderer_DATE extends AbstractRenderer {
049        /** このプログラムのVERSION文字列を設定します。   {@value} */
050        private static final String VERSION = "6.8.3.1 (2017/12/01)" ;
051
052        private final String    format ;                        // 5.5.7.2 (2012/10/09) HybsDateUtil を利用
053        private final String    defValue ;
054
055        // 6.8.3.1 (2017/12/01) 標準オブジェクトのキャッシュ
056        private static final CellRenderer DB_CELL = new Renderer_DATE();
057
058        /**
059         * デフォルトコンストラクター。
060         * このコンストラクターで、基本オブジェクトを作成します。
061         *
062         * @og.rev 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。
063         */
064        public Renderer_DATE() {
065                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
066                format          = HybsSystem.sys( "SYS_TIME" );
067                defValue        = "";
068        }
069
070        /**
071         * 引数つきコンストラクター。
072         *
073         * @og.rev 3.5.1.0 (2003/10/03) 初期値が nullの場合は、""、8桁以下はそのまま返す。
074         * @og.rev 3.8.5.3 (2006/08/01) 日付を6桁以上 とし、それ以下はそのまま返す。
075         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
076         * @og.rev 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。
077         *
078         * @param       clm     DBColumnオブジェクト
079         */
080        private Renderer_DATE( final DBColumn clm ) {
081                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
082
083                String fm = clm.getRendererParam();
084                if( fm == null || fm.isEmpty() || fm.equals( "_" ) ) {
085                        fm = HybsSystem.sys( "SYS_TIME" );
086                }
087                format = fm;                    // 5.5.7.2 (2012/10/09) HybsDateUtil を利用
088
089                final String defv = clm.getDefault();
090                if( defv == null || defv.equals( "_" ) ) {
091                        defValue = "";
092                }
093                else if( defv.length() < 6 ) {
094                        defValue = defv;
095                }
096                else {
097                        final Calendar cal = HybsDateUtil.getCalendar( defv );
098                        defValue = DateSet.getDate( cal.getTimeInMillis() , format );
099                }
100        }
101
102        /**
103         * 各オブジェクトから自分のインスタンスを返します。
104         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
105         * まかされます。
106         *
107         * @og.rev 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。
108         *
109         * @param       clm     DBColumnオブジェクト
110         * @return      CellRendererオブジェクト
111         * @og.rtnNotNull
112         */
113        public CellRenderer newInstance( final DBColumn clm ) {
114                // 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。
115                final String fm   = clm.getRendererParam();
116                final String defv = clm.getDefault();
117
118                if( ( fm == null || fm.isEmpty() || fm.equals( "_" ) ) &&
119                        ( defv == null || defv.equals( "_" ) ) ) {
120                                return DB_CELL;
121                }
122
123                return new Renderer_DATE( clm );
124        }
125
126        /**
127         * データの表示用文字列を返します。
128         *
129         * @og.rev 3.5.1.0 (2003/10/03) データが nullの場合は、デフォルト値を、8桁以下はそのまま返す。
130         * @og.rev 3.8.5.3 (2006/08/01) 日付を6桁以上 とし、それ以下はそのまま返す。
131         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
132         *
133         * @param       value 入力値
134         * @return      データの表示用文字列
135         */
136        @Override
137        public String getValue( final String value ) {
138                if( value == null      ) { return defValue; }
139                if( value.length() < 6 ) { return value; }
140
141                final Calendar cal = HybsDateUtil.getCalendar( value );
142                return DateSet.getDate( cal.getTimeInMillis() , format );
143        }
144
145        /**
146         * name属性を変えた、データ表示用のHTML文字列を作成します。
147         * レンデラーのため、row(行番号)は使いません。
148         * 第3引数に、パラメータを渡すことが出来ます。これは、viewMarker で
149         * [$XXXX param] 形式を渡すことで、行単位に表示形式を変更できます。
150         *
151         * @og.rev 6.8.3.1 (2017/12/01) パラメータを渡せるようにします。
152         *
153         * @param   row   行番号
154         * @param   value 値
155         * @param   param パラメータ
156         * @return  データ表示/編集用の文字列
157         */
158        @Override
159        public String getValue( final int row,final String value,final String param ) {
160                if( value == null      ) { return defValue; }
161                if( value.length() < 6 ) { return value; }
162
163                String fm = param;
164                if( fm == null || fm.isEmpty() || fm.equals( "_" ) ) {
165                        fm = HybsSystem.sys( "SYS_TIME" );
166                }
167
168                final Calendar cal = HybsDateUtil.getCalendar( value );
169                return DateSet.getDate( cal.getTimeInMillis() , fm );
170        }
171}