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 java.util.Calendar;
019
020import org.opengion.fukurou.system.DateSet;                                                     // 6.4.2.0 (2016/01/29)
021import org.opengion.fukurou.util.HybsDateUtil;
022import org.opengion.hayabusa.common.HybsSystem;
023import org.opengion.hayabusa.db.AbstractRenderer;
024import org.opengion.hayabusa.db.CellRenderer;
025import org.opengion.hayabusa.db.DBColumn;
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         * DBColumnオブジェクトを指定したprivateコンストラクター。
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                if( fm == null || fm.isEmpty() || "_".equals( fm ) ) {  // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons
086                        fm = HybsSystem.sys( "SYS_TIME" );
087                }
088                format = fm;                    // 5.5.7.2 (2012/10/09) HybsDateUtil を利用
089
090                final String defv = clm.getDefault();
091//              if( defv == null || defv.equals( "_" ) ) {
092                if( defv == null || "_".equals( defv ) ) {      // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons
093                        defValue = "";
094                }
095                else if( defv.length() < 6 ) {
096                        defValue = defv;
097                }
098                else {
099                        final Calendar cal = HybsDateUtil.getCalendar( defv );
100                        defValue = DateSet.getDate( cal.getTimeInMillis() , format );
101                }
102        }
103
104        /**
105         * 各オブジェクトから自分のインスタンスを返します。
106         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
107         * まかされます。
108         *
109         * @og.rev 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。
110         *
111         * @param       clm     DBColumnオブジェクト
112         * @return      CellRendererオブジェクト
113         * @og.rtnNotNull
114         */
115        public CellRenderer newInstance( final DBColumn clm ) {
116                // 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。
117                final String fm   = clm.getRendererParam();
118                final String defv = clm.getDefault();
119
120                // 8.5.5.1 (2024/02/29) PMD 7.0.0 OnlyOneReturn メソッドには終了ポイントが 1 つだけ必要
121////            if( ( fm == null || fm.isEmpty() || fm.equals( "_" ) ) &&
122////                    ( defv == null || defv.equals( "_" ) ) ) {
123//              if( ( fm == null || fm.isEmpty() || "_".equals( fm ) ) &&       // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons
124//                      ( defv == null || "_".equals( defv ) ) ) {                              // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons
125//                              return DB_CELL;
126//              }
127//
128//              return new Renderer_DATE( clm );
129
130                return  ( fm == null || fm.isEmpty() || "_".equals( fm ) ) &&   // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons
131                                ( defv == null || "_".equals( defv ) )                                  // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons
132                        ? DB_CELL
133                        : new Renderer_DATE( clm );
134        }
135
136        /**
137         * データの表示用文字列を返します。
138         *
139         * @og.rev 3.5.1.0 (2003/10/03) データが nullの場合は、デフォルト値を、8桁以下はそのまま返す。
140         * @og.rev 3.8.5.3 (2006/08/01) 日付を6桁以上 とし、それ以下はそのまま返す。
141         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
142         *
143         * @param       value 入力値
144         * @return      データの表示用文字列
145         */
146        @Override
147        public String getValue( final String value ) {
148                if( value == null      ) { return defValue; }
149                if( value.length() < 6 ) { return value; }
150
151                final Calendar cal = HybsDateUtil.getCalendar( value );
152                return DateSet.getDate( cal.getTimeInMillis() , format );
153        }
154
155        /**
156         * name属性を変えた、データ表示用のHTML文字列を作成します。
157         * レンデラーのため、row(行番号)は使いません。
158         * 第3引数に、パラメータを渡すことが出来ます。これは、viewMarker で
159         * [$XXXX param] 形式を渡すことで、行単位に表示形式を変更できます。
160         *
161         * @og.rev 6.8.3.1 (2017/12/01) パラメータを渡せるようにします。
162         *
163         * @param   row   行番号
164         * @param   value 値
165         * @param   param パラメータ
166         * @return  データ表示/編集用の文字列
167         */
168        @Override
169        public String getValue( final int row,final String value,final String param ) {
170                if( value == null      ) { return defValue; }
171                if( value.length() < 6 ) { return value; }
172
173                String fm = param;
174//              if( fm == null || fm.isEmpty() || fm.equals( "_" ) ) {
175                if( fm == null || fm.isEmpty() || "_".equals( fm ) ) {  // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons
176                        fm = HybsSystem.sys( "SYS_TIME" );
177                }
178
179                final Calendar cal = HybsDateUtil.getCalendar( value );
180                return DateSet.getDate( cal.getTimeInMillis() , fm );
181        }
182}