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.text.DecimalFormat; 019 020import org.opengion.hayabusa.db.AbstractRenderer; 021import org.opengion.hayabusa.db.CellRenderer; 022import org.opengion.hayabusa.db.DBColumn; 023import org.opengion.fukurou.util.StringUtil; 024 025/** 026 * DECIMAL レンデラーは、カラムのデータをDecimal(１０進数、小数)表示する場合に 027 * 使用するクラスです。 028 * 負数の場合はspanタグclass="minus"を付けて出力します。 029 * 030 * 表示パラメータに与えられた文字列は、java.text.DecimalFormat を 031 * 使用してフォーマットされます。 032 * フォーマット変換前に、カンマなどの数値変換時にエラーになる情報を削除しておきます。 033 * 034 * フォーマットルールは、{@link java.text.DecimalFormat} を参照願います。 035 * 標準のフォーマットは"#,##0.#"です。 036 * 037 * カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。 038 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。 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_DECIMAL extends AbstractRenderer { 049 /** このプログラムのVERSION文字列を設定します。 {@value} */ 050 private static final String VERSION = "6.8.3.1 (2017/12/01)" ; 051 052 private final DecimalFormat format ; 053 private final String defValue ; 054 private final String noDisplayVal ; // 5.6.2.3 (2013/03/22) 055 056 /** 6.8.3.1 (2017/12/01) 標準オブジェクトのキャッシュ */ 057 private static final CellRenderer DB_CELL = new Renderer_DECIMAL(); 058 059 /** 060 * デフォルトコンストラクター。 061 * このコンストラクターで、基本オブジェクトを作成します。 062 * 063 * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数初期化 064 * @og.rev 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。 065 */ 066 public Renderer_DECIMAL() { 067 super(); // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor 068 format = new DecimalFormat( "#,##0.#" ); // 6.8.3.1 (2017/12/01) 069 defValue = ""; // 5.1.1.0 (2009/12/01) 070 noDisplayVal = null; // 5.5.1.0 (2012/04/03) 071 } 072 073 /** 074 * DBColumnオブジェクトを指定したprivateコンストラクター。 075 * 076 * @param clm DBColumnオブジェクト 077 * 078 * @og.rev 5.1.1.0 (2009/12/01) 初期値がnullの場合は、defValueはnullとする。 079 * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数追加 080 */ 081 private Renderer_DECIMAL( final DBColumn clm ) { 082 super(); // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor 083 084 String fm = clm.getRendererParam(); 085// if( fm == null || fm.isEmpty() || fm.equals( "_" ) ) { 086 if( fm == null || fm.isEmpty() || "_".equals( fm ) ) { // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons 087 fm = "#,##0.#"; 088 } 089 format = new DecimalFormat( fm ); 090 091 // 5.1.1.0 (2009/12/01) 092 final String defv = clm.getDefault(); 093 if( defv == null || defv.isEmpty() ) { 094 defValue = ""; 095 } 096 else { 097 final double dd = StringUtil.parseDouble( defv ); 098 defValue = format.format( dd ); 099 } 100 noDisplayVal = clm.getNoDisplayVal(); // 5.6.2.3 (2013/03/22) 101 } 102 103 /** 104 * 各オブジェクトから自分のインスタンスを返します。 105 * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に 106 * まかされます。 107 * 108 * @og.rev 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。 109 * 110 * @param clm DBColumnオブジェクト 111 * @return CellRendererオブジェクト 112 * @og.rtnNotNull 113 */ 114 public CellRenderer newInstance( final DBColumn clm ) { 115 // 6.8.3.1 (2017/12/01) 標準オブジェクトとして、利用できる形にして、キャッシュします。 116 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.isEmpty() || 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 || defv.isEmpty() || "_".equals( defv ) ) ) { // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons 125// return DB_CELL; 126// } 127// 128// return new Renderer_DECIMAL( 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 || defv.isEmpty() || "_".equals( defv ) ) // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons 132 ? DB_CELL 133 : new Renderer_DECIMAL( clm ); 134 } 135 136 /** 137 * データの表示用文字列を返します。 138 * 139 * ここでは、値が 0 の場合に、初期値を使うロジックが組み込まれており、 140 * 従来はこれを利用して、初期値にゼロ文字列を設定することで、"0" を 141 * 非表示文字として扱っていました。 142 * 互換性の問題があるので、既存の機能は残しますが、この処理は、noDisplayVal を 143 * 利用した処理に置き換えてください。 144 * 他の処理（NUMBER,MONEY,DBMENUなど）は、noDisplayVal を使います。 145 * 146 * @og.rev 3.8.5.2 (2006/05/31) カンマ編集された数字の対応 147 * @og.rev 5.3.1.0 (2009/12/01) 値が0の場合は、初期値を適用する。 148 * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数追加 149 * @og.rev 6.0.4.0 (2014/11/28) ロジックの共通化 150 * 151 * @param value 入力値 152 * @return データの表示用文字列 153 */ 154 @Override 155 public String getValue( final String value ) { 156 return getValue( value , true ); 157 } 158 159 /** 160 * データ出力用の文字列を作成します。 161 * ファイル等に出力する形式を想定しますので、HTMLタグを含まない 162 * データを返します。 163 * 基本は、#getValue( String ) をそのまま返します。 164 * 165 * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー 166 * 167 * @param value 入力値 168 * @return データ出力用の文字列 169 * @see #getValue( String ) 170 */ 171 @Override 172 public String getWriteValue( final String value ) { 173 return getValue( value , false ); 174 } 175 176 /** 177 * データ表示用/出力用の文字列を作成します。 178 * 第二引数の isView == true で、データ表示用文字列を、false で 179 * データ出力用の文字列を作成します。 180 * 処理の共通化を行うためのメソッドです。 181 * 182 * @og.rev 6.0.4.0 (2014/11/28) ロジックの共通化 183 * 184 * @param value 入力値 185 * @param isView データ表示用かどうか(true:表示用/false:出力用) 186 * @return データ表示用/出力用の文字列 187 * @see #getValue( String ) 188 */ 189 private String getValue( final String value , final boolean isView ) { 190 // 8.5.5.1 (2024/02/29) PMD 7.0.0 OnlyOneReturn メソッドには終了ポイントが 1 つだけ必要 191 // 5.6.2.3 (2013/03/22) noDisplayVal 変数追加 192// if( noDisplayVal != null && noDisplayVal.equalsIgnoreCase( value ) ) { return "" ; } 193 194 final String rtnVal; 195 if( noDisplayVal != null && noDisplayVal.equalsIgnoreCase( value ) ) { 196 rtnVal = ""; 197 } 198 199 // 8.5.4.2 (2024/01/12) PMD 7.0.0 InefficientEmptyStringCheck 対応 200// if( value == null || value.trim().isEmpty() || "0".equals( value ) ) { 201 else if( StringUtil.isNull( value ) || "0".equals( value ) ) { 202// return defValue; 203 rtnVal = defValue; 204 } 205 else { 206 final double dd = StringUtil.parseDouble( value ); 207 208 // 6.4.2.1 (2016/02/05) PMD refactoring. 209 final String rtn; 210 synchronized( format ) { 211 rtn = format.format( dd ); 212 } 213 214// return isView && dd < 0.0 215 rtnVal = isView && dd < 0.0 216 ? ("<span class=\"minus\">" + rtn + "</span>") 217 : rtn; 218 } 219 return rtnVal; 220 } 221 222 /** 223 * name属性を変えた、データ表示用のHTML文字列を作成します。 224 * レンデラーのため、row(行番号)は使いません。 225 * 第３引数に、パラメータを渡すことが出来ます。これは、viewMarker で 226 * [$XXXX param] 形式を渡すことで、行単位に表示形式を変更できます。 227 * 228 * @og.rev 6.8.3.1 (2017/12/01) パラメータを渡せるようにします。 229 * 230 * @param row 行番号 231 * @param value 値 232 * @param param パラメータ 233 * @return データ表示/編集用の文字列 234 */ 235 @Override 236 public String getValue( final int row,final String value,final String param ) { 237 // 8.5.5.1 (2024/02/29) PMD 7.0.0 OnlyOneReturn メソッドには終了ポイントが 1 つだけ必要 238 // 5.6.2.3 (2013/03/22) noDisplayVal 変数追加 239// if( noDisplayVal != null && noDisplayVal.equalsIgnoreCase( value ) ) { return "" ; } 240 241 final String rtnVal; 242 if( noDisplayVal != null && noDisplayVal.equalsIgnoreCase( value ) ) { 243 rtnVal = ""; 244 } 245 246 // 8.5.4.2 (2024/01/12) PMD 7.0.0 InefficientEmptyStringCheck 対応 247// if( value == null || value.trim().isEmpty() || "0".equals( value ) ) { 248 else if( StringUtil.isNull( value ) || "0".equals( value ) ) { 249// return defValue; 250 rtnVal = defValue; 251 } 252 else { 253 final double dd = StringUtil.parseDouble( value ); 254 255 String fm = param; 256 // if( fm == null || fm.isEmpty() || fm.equals( "_" ) ) { 257 if( fm == null || fm.isEmpty() || "_".equals( fm ) ) { // 8.5.4.2 (2024/01/12) PMD 7.0.0 LiteralsFirstInComparisons 258 fm = "#,##0.#"; 259 } 260 final DecimalFormat format = new DecimalFormat( fm ); 261 final String rtn = format.format( dd ); 262 263// return dd < 0.0 264 rtnVal = dd < 0.0 265 ? ("<span class=\"minus\">" + rtn + "</span>") 266 : rtn; 267 } 268 return rtnVal; 269 } 270}