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; 019import java.util.ArrayList; 020 021 022/** 023 * エラーメッセージを受け渡すときに使用するクラスです。 024 * 結果値として、0:正常 1:警告 2:異常 8:EXCEPTION 9:ORACLEエラー を持っています。 025 * 026 * @og.group エラー処理 027 * 028 * @version 4.0 029 * @author Kazuhiko Hasegawa 030 * @since JDK5.0, 031 */ 032public final class ErrorMessage { 033 /** 改行コード */ 034 public static final String CR = System.getProperty("line.separator"); // 5.1.9.0 (2010/08/01) 追加 035 036 /** バッファの初期容量を通常より多い目に設定します。 {@value} */ 037 public static final int BUFFER_MIDDLE = 200; // 5.1.9.0 (2010/08/01) 追加 038 039 /** 結果値 0:正常 {@value} */ 040 public static final int OK = 0; 041 /** 結果値 1:警告 {@value} */ 042 public static final int WARNING = 1; 043 /** 結果値 2:異常 {@value} */ 044 public static final int NG = 2; 045 /** 結果値 8:EXCEPTION {@value} */ 046 public static final int EXCEPTION = 8; 047 /** 結果値 9:ORACLEエラー {@value} */ 048 public static final int ORCL_ERR = 9; 049 050 private int maxKekka = OK; 051 private String title = ""; 052 private final List<ErrMsg> list = new ArrayList<ErrMsg>(); 053 054 private boolean setPgStep = false; // 3.8.9.5 (2007/09/12) 055 056 /** 057 * デフォルトコンストラクター 058 * 詳細メッセージを指定しないで ErrorMessage を構築します。 059 * (明示しないと、引き通付きコンストラクタのみのクラスになってしまいます。) 060 */ 061 public ErrorMessage() { 062 setTitle( "NO TITLE" ); 063 } 064 065 /** 066 * タイトルを指定して ErrorMessage を構築します。 067 * 068 * @param title タイトル 069 */ 070 public ErrorMessage( final String title ) { 071 setTitle( title ); 072 } 073 074 /** 075 * 指定されたエラー情報を追加登録します。 076 * これは、行番号0、結果:NG IDは無し(ゼロ文字列)です。 077 * 078 * @param args String... メッセージの引数(可変引数) 079 */ 080 public void addMessage( final String... args ) { 081 addMessage( 0,NG,"",args ); 082 } 083 084 /** 085 * 指定されたエラー情報を追加登録します。 086 * 087 * @param no 行番号 088 * @param kekka 結果 0:正常 1:警告 2:異常 089 * @param id メッセージID 090 * @param args String... メッセージの引数(可変引数) 091 */ 092 public void addMessage( final int no,final int kekka,final String id,final String... args ) { 093 if( id != null ) { 094 ErrMsg msg = new ErrMsg( no,kekka,null,null,id,args ); 095 list.add( msg ); 096 if( maxKekka < kekka ) { maxKekka = kekka; } 097 } 098 } 099 100 /** 101 * 指定されたエラーオブジェクトを追加登録します。 102 * 追加するErrMsgが、内部の結果値より大きい場合は、その結果値にセットします。 103 * つまり、内部結果値は、登録されたすべてのエラーオブジェクトの最大値です。 104 * 105 * @param msg エラーオブジェクト 106 */ 107 public void addMessage( final ErrMsg msg ) { 108 list.add( msg ); 109 if( maxKekka < msg.getKekka() ) { maxKekka = msg.getKekka(); } 110 if( msg.getPg() != null || msg.getStep() != null ) { setPgStep = true; } // 3.8.9.5 (2007/09/12) 111 } 112 113 /** 114 * 指定された ErrorMessageオブジェクトを追加登録します。 115 * タイトルは元のまま変わりません。 116 * 現状の ErrorMessage の続きに、追加していきます。 117 * 引数の ErrorMessageオブジェクト が null の場合は,何もしません。 118 * 119 * @param msg ErrorMessageオブジェクト 120 */ 121 public void append( final ErrorMessage msg ) { 122 if( msg != null ) { 123 if( maxKekka < msg.getKekka() ) { maxKekka = msg.getKekka(); } 124 125 ErrMsg[] emsg = msg.toArray(); 126 for( int i=0; i<emsg.length; i++ ) { 127 list.add( emsg[i] ); 128 } 129 } 130 } 131 132 /** 133 * 指定された ErrorMessageオブジェクトを行番号指定で追加登録します。 134 * タイトルは元のまま変わりません。 135 * 現状の ErrorMessage の続きに、追加していきます。 136 * 引数の ErrorMessageオブジェクト が null の場合は,何もしません。 137 * 138 * @param no 行番号 139 * @param msg ErrorMessageオブジェクト 140 */ 141 public void append( final int no,final ErrorMessage msg ) { 142 if( msg != null ) { 143 if( maxKekka < msg.getKekka() ) { maxKekka = msg.getKekka(); } 144 145 ErrMsg[] emsg = msg.toArray(); 146 for( int i=0; i<emsg.length; i++ ) { 147 list.add( emsg[i].copy( no ) ); 148 } 149 } 150 } 151 152 /** 153 * このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。 154 * 155 * @og.rev 4.0.0.0 (2004/12/31) 新規追加 156 * @og.rev 4.3.2.0 (2008/09/11) private ⇒ public に変更。 157 * 158 * @return すべての要素を正しい順序で保持するErrMsg配列 159 */ 160 public ErrMsg[] toArray() { 161 return list.toArray( new ErrMsg[list.size()] ) ; 162 } 163 164 /** 165 * リスト内のキーと値のマッピングの数を返します。 166 * 167 * @return リスト内の size 168 */ 169 public int size() { 170 return list.size() ; 171 } 172 173 /** 174 * タイトルを返します。 175 * 176 * @return タイトル 177 */ 178 public String getTitle() { 179 return title; 180 } 181 182 /** 183 * タイトルをセットします。 184 * 185 * @param title タイトル 186 */ 187 public void setTitle( final String title ) { 188 this.title = title; 189 } 190 191 /** 192 * このエラーメッセージの中で、最大の結果値(エラーの最大レベル)を返します。 193 * 194 * @return 結果 OK, WARNING, NG, ORCL_ERR 195 */ 196 public int getKekka() { 197 return maxKekka; 198 } 199 200 /** 201 * すべてのメッセージが 正常(OK)かを返します。 202 * 203 * @return 結果 すべてOK:true / それ以外 false 204 */ 205 public boolean isOK() { 206 return maxKekka == OK ; 207 } 208 209 /** 210 * 配列中にPG名またはステップ名が設定されているかを返します。 211 * 212 * @og.rev 3.8.9.5 (2007/09/12) 新規作成 213 * 214 * @return PG名またはステップ名が設定されているか 215 */ 216 public boolean isSetPgStep() { 217 return setPgStep; 218 } 219 220 /** 221 * メッセージの連結リストを返します。 222 * 223 * @return メッセージの連結リスト 224 */ 225 @Override 226 public String toString() { 227 StringBuilder rtn = new StringBuilder( BUFFER_MIDDLE ); 228 rtn.append( getTitle() ).append( CR ); 229 ErrMsg[] msg = list.toArray( new ErrMsg[list.size()] ); 230 for( int i=0; i<msg.length; i++ ) { 231 rtn.append( msg[i] ); 232 rtn.append( CR ); 233 } 234 return rtn.toString(); 235 } 236}