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.fukurou.util; 017 018import java.util.List; // 8.5.4.2 (2024/01/12) PMD 7.0.0 LooseCoupling 019import java.util.ArrayList; 020import java.util.Map; 021import java.util.HashMap; 022 023import static org.opengion.fukurou.system.HybsConst.CR; // 6.1.0.0 (2014/12/26) refactoring 024import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE; // 6.1.0.0 (2014/12/26) refactoring 025import org.opengion.fukurou.system.OgRuntimeException ; // 6.4.2.0 (2016/01/29) 026 027/** 028 * SystemParameter は、{@XXXX} 文字列を処理するクラスです。 029 * このクラスでは、{@XXXX} 文字列を別の文字列と置き換えることや、 030 * 予め予約されている予約語 {@DATE.XXXX} 文字列を置き換えます。 031 * 通常の {@XXXX} 文字列の置き換えは、キーと値のペアを、HybsEntry オブジェクトに 032 * セットして、その配列を受け取って処理します。 033 * 034 * 以下の値はあらかじめ、動的に作成されます。 035 * ・DATE.YMD ８byte の今日のシステム日付(yyyyMMdd) 036 * ・DATE.YMDH １４byte の今日のシステム日時(yyyyMMddHHmmss) 037 * ・DATE.HMS ６byte の今日のシステム時間(HHmmss) 038 * 039 * @og.group ユーティリティ 040 * 041 * @version 4.0 042 * @author Kazuhiko Hasegawa 043 * @since JDK5.0, 044 */ 045public final class SystemParameter { 046 047 private final String original ; 048 049 private final String[] clms; 050 private final String[] formats; 051 052 /** 053 * {@XXXX} の特殊文字を含む文字列を、置き換えます。 054 * 対象外の文字列は、そのまま、残されます。 055 * 056 * @og.rev 5.1.8.0 (2010/07/01) パース方法見直し(StringTokenizerでは、{@XXXX}が連続してある場合に対応できない) 057 * @og.rev 5.3.2.0 (2011/02/01) original データを、パース結果を利用するように修正する。 058 * @og.rev 5.3.4.0 (2011/04/01) {@DATE.XXXX} を処理できるように機能追加 059 * @og.rev 5.3.5.0 (2011/05/01) {@SYS.XXXX} は、廃止 060 * @og.rev 5.5.7.2 (2012/10/09) rightNow をCalendarオブジェクト ではなく、String時刻とします。 061 * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。 062 * 063 * @param orig 変換する文字列(オリジナル) 064 */ 065 public SystemParameter( final String orig ) { 066 if( orig == null || orig.isEmpty() || orig.indexOf( "{@" ) < 0 ) { 067 clms = null; 068 formats = null; 069 original = orig; // 5.3.2.0 (2011/02/01) 070 } 071 else { 072 final StringBuilder buf = new StringBuilder(orig.length()); // 5.3.2.0 (2011/02/01) 073 074// final ArrayList<String> fmtList = new ArrayList<>(); 075// final ArrayList<String> clmList = new ArrayList<>(); 076 final List<String> fmtList = new ArrayList<>(); // 8.5.4.2 (2024/01/12) PMD 7.0.0 LooseCoupling 077 final List<String> clmList = new ArrayList<>(); // 8.5.4.2 (2024/01/12) PMD 7.0.0 LooseCoupling 078 079 // 5.1.8.0 (2010/07/01) パース方法見直し 080 int start = 0; 081 int index = orig.indexOf( "{@" ); 082 String val ; 083 while( index >= 0 ) { 084 val = orig.substring( start, index ); // 5.3.4.0 (2011/04/01) 085 buf.append( val ); 086 fmtList.add( val ); 087 final int end = orig.indexOf( '}',index ); 088 if( end < 0 ) { 089 final String errMsg = "{@ と } との対応関係がずれています。" + CR 090 + "str=[" + orig + "] : index=" + index ; 091 throw new OgRuntimeException( errMsg ); 092 } 093 final String param = orig.substring( index+2,end ); 094 if( param.startsWith( "DATE." ) ) { // 5.3.5.0 (2011/05/01) {@SYS.XXXX} は、廃止 095 val = getDateFormat( param.substring( 5 ) ); // 5.5.7.2 (2012/10/09) HybsDateUtil を利用時に "DATE." は不要 096 clmList.add( null ); // パースした場合は、clmList は、使用しない。 097 buf.append( val ); 098 } 099 else { 100 clmList.add( param ); 101 buf.append( "{@" ).append( param ).append( '}' ); // 元のままの文字列を生成 // 6.0.2.5 (2014/10/31) char を append する。 102 } 103 start = end+1; 104 index = orig.indexOf( "{@",start ); 105 } 106 val = orig.substring( start, orig.length() ); // 5.3.4.0 (2011/04/01) 107 buf.append( val ); 108 fmtList.add( val ); 109 110 original = buf.toString(); // 5.3.2.0 (2011/02/01) 111 if( original.indexOf( "{@" ) < 0 ) { 112 clms = null; 113 formats = null; 114 } 115 else { 116// clms = clmList.toArray( new String[clmList.size()] ); 117// formats = fmtList.toArray( new String[fmtList.size()] ); 118 clms = clmList.toArray( new String[0] ); // 8.5.4.2 (2024/01/12) PMD 7.0.0 OptimizableToArrayCall 対応 119 formats = fmtList.toArray( new String[0] ); // 8.5.4.2 (2024/01/12) PMD 7.0.0 OptimizableToArrayCall 対応 120 } 121 } 122 } 123 124 /** 125 * 日付関係の情報を簡易的に取り出す処理を行います。 126 * 127 * 引数は、"KEY AA(第1引数) BB(第2引数) CC(第3引数)" という状態で受け取ります。 128 * 引数は、なくてもかまいません。ただし、引数にリクエストパラメータ(@で始まる引数)は使えません。 129 * 130 * 処理の詳細は、{@link org.opengion.fukurou.util.HybsDateUtil#getDateFormat( String,String,String,int ) } 131 * または、{@link org.opengion.hayabusa.taglib.CommonTagSupport#getDateFormat( String ) } を 132 * 参照してください。 133 * 134 * @og.rev 5.3.4.0 (2011/04/01) 新規追加 135 * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。 136 * @og.rev 5.5.8.2 (2012/11/09) prmA の判定に、null と ゼロ文字列を判定する。 137 * @og.rev 5.7.4.1 (2014/03/14) AA 引数の@解析後のコマンド判定方法を、８ケタ以下から先頭が数字以外に変更します。 138 * @og.rev 5.7.4.1 (2014/03/14) taglib.CommonTagSupport#getDateFormat( String ) と処理を合わせます。 139 * @og.rev 5.7.4.2 (2014/03/20) リクエストパラメータ(@で始まる引数)は使えません。 140 * @og.rev 6.4.1.1 (2016/01/16) StringUtil#csv2Array(String,char) → StringUtil#csv2Array(String,char,int) で、配列長を固定化する。 141 * 142 * @param value パラメータ(引数は、"DATE.KEY AA BB" などという状態) 143 * 144 * @return メッセージ情報 145 * @og.rtnNotNull 146 * @see org.opengion.fukurou.util.HybsDateUtil#getDateFormat( String,String,String,int ) 147 * @see org.opengion.hayabusa.taglib.CommonTagSupport#getDateFormat( String ) 148 */ 149 private String getDateFormat( final String value ) { 150 // 6.4.1.1 (2016/01/16) StringUtil#csv2Array(String,char) → StringUtil#csv2Array(String,char,int) で、配列長を固定化する。 151 // 足りない分は、null ではなく、"" がセットされてくる。 152 final String[] vals = StringUtil.csv2Array( value,' ',4 ); 153 154 // 5.7.4.2 (2014/03/20) 現時点では、SystemParameter 処理にはリクエスト変数は使えないので、@変数も使えない。 155 // vals[0] は、key なので、vals[1] から回す。 156 for( int i=1; i<vals.length; i++ ) { 157 if( !vals[i].isEmpty() && vals[i].charAt(0) == '@' ) { 158 final String errMsg = "第" + i + "引数に、リクエストパラメータ(@で始まる引数)は使えません。value=[" + value + "]" ; 159 throw new OgRuntimeException( errMsg ); 160 } 161 } 162 163 // 5.7.4.1 (2014/03/14) AA 引数の@解析後のコマンド判定方法を、８ケタ以下から先頭が数字以外に変更します。 164 if( !vals[1].isEmpty() ) { 165 final char chA = vals[1].charAt(0); 166 if( chA < '0' || chA > '9' ) { // 先頭が、数字以外の場合は、コマンドなので、一つずつずらす。 167 vals[3] = vals[2]; 168 vals[2] = vals[1]; 169 vals[1] = null; 170 } 171 } 172 173 // 5.7.4.1 (2014/03/14) CC(第3引数)を、"H" , "D" , "M" 以外でも使用できるように拡張します。 174 int intC = 0; 175 if( !vals[3].isEmpty() ) { 176 try { 177 intC = Integer.parseInt( vals[3] ); 178 } 179 catch( final NumberFormatException ex ) { 180 final String errMsg = "第3引数が数字ではありません。value=[" + value + "]" 181 + ex.getMessage() ; 182 System.err.println( errMsg ); 183 } 184 } 185 186 // AA(第1引数) が null か、isEmpty() の場合は、現在時刻が使用される。 187 return HybsDateUtil.getDateFormat( vals[0],vals[1],vals[2],intC ); // 5.7.4.1 (2014/03/14) CC第3引数を拡張します。 188 } 189 190 /** 191 * {@XXXX} の特殊文字を含む文字列を、置き換えます。 192 * 対象外の文字列は、そのまま、残されます。 193 * 194 * @og.rev 5.3.4.0 (2011/04/01) 判定方法 修正 195 * 196 * @param entry 置換文字列のキーと値のペアを管理しているEntryオブジェクトの配列(可変長引数) 197 * 198 * @return 置換後の文字列 199 */ 200 public String replace( final HybsEntry... entry ) { 201 // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。 202 if( formats == null || entry == null || entry.length == 0 ) { return original; } 203 204 // HybsEntry[] データを、Mapにマッピングします。 205 final Map<String, String> sysMap = new HashMap<>(); 206 final int size = entry.length; 207 for( int i=0; i<size; i++ ) { 208 sysMap.put( entry[i].getKey(),entry[i].getValue() ); 209 } 210 211 return replace( sysMap ); 212 } 213 214 /** 215 * {@XXXX} の特殊文字を含む文字列を、置き換えます。 216 * 対象外の文字列は、そのまま、残されます。 217 * 218 * @param map 置換文字列のキーと値のペアを管理しているMapオブジェクト 219 * 220 * @return 置換後の文字列 221 */ 222 public String replace( final Map<String,String> map ) { 223 // 8.5.5.1 (2024/02/29) PMD 7.0.0 OnlyOneReturn メソッドには終了ポイントが 1 つだけ必要 224 if( formats == null || map == null || map.isEmpty() ) { return original; } 225// if( formats == null ) { return original; } // 5.3.4.0 (2011/04/01) 判定方法 修正 226// if( map == null || map.isEmpty() ) { return original; } 227 228 final StringBuilder sb = new StringBuilder( BUFFER_MIDDLE ); 229 for( int i=0; i<formats.length; i++ ) { 230 sb.append( formats[i] ); 231 if( i < clms.length && clms[i] != null ) { // 5.3.4.0 (2011/04/01) nullチェック追加 232 sb.append( StringUtil.nval( map.get( clms[i] ), "" ) ); 233 } 234 } 235 236 return sb.toString(); 237 } 238 239 /** 240 * フォーマットをパースした結果から、カラム一覧を配列形式で返します。 241 * 242 * @og.rev 5.1.7.0 (2010/06/01) 新規作成 243 * 244 * @return カラム配列 245 * @og.rtnNotNull 246 */ 247 public String[] getColumns() { 248 // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method 249 return clms == null ? new String[0] : clms.clone(); 250 } 251 252 /** 253 * フォーマットをパースした結果から、フォーマット一覧を配列形式で返します。 254 * 255 * @og.rev 5.1.7.0 (2010/06/01) 新規作成 256 * 257 * @return フォーマット配列 258 * @og.rtnNotNull 259 */ 260 public String[] getFormats() { 261 // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method 262 return formats == null ? new String[0] : formats.clone(); 263 } 264}