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     */
016    package org.opengion.fukurou.util;
017    
018    import java.util.List;
019    import java.util.ArrayList;
020    
021    
022    /**
023     * 繧ｨ繝ｩ繝ｼ繝｡繝?そ繝ｼ繧ｸ繧貞女縺第ｸ｡縺吶→縺阪↓菴ｿ逕ｨ縺吶ｋ繧ｯ繝ｩ繧ｹ縺ｧ縺吶?
024     * 邨先棡蛟､縺ｨ縺励※縲?:豁｣蟶ｸ 1:隴ｦ蜻?2:逡ｰ蟶ｸ 8:EXCEPTION 9:ORACLE繧ｨ繝ｩ繝ｼ 繧呈戟縺｣縺ｦ縺?∪縺吶?
025     *
026     * @og.group 繧ｨ繝ｩ繝ｼ蜃ｦ逅?
027     *
028     * @version  4.0
029     * @author   Kazuhiko Hasegawa
030     * @since    JDK5.0,
031     */
032    public 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             * 縺薙ｌ縺ｯ縲∬｡檎分蜿ｷ?舌?邨先棡?哢G 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             * 霑ｽ蜉?☆繧畿rrMsg縺後?蜀?Κ縺ｮ邨先棡蛟､繧医ｊ螟ｧ縺阪＞蝣ｴ蜷医?縲√◎縺ｮ邨先棡蛟､縺ｫ繧ｻ繝?ヨ縺励∪縺吶?
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    //      private ErrMsg[] toArray() {
161            public ErrMsg[] toArray() {
162                    return list.toArray( new ErrMsg[list.size()] ) ;
163            }
164    
165            /**
166             * 繝ｪ繧ｹ繝亥?縺ｮ繧ｭ繝ｼ縺ｨ蛟､縺ｮ繝槭ャ繝斐Φ繧ｰ縺ｮ謨ｰ繧定ｿ斐＠縺ｾ縺吶?
167             *
168             * @return   繝ｪ繧ｹ繝亥?縺ｮ size
169             */
170            public int size() {
171                    return list.size() ;
172            }
173    
174            /**
175             *  繧ｿ繧､繝医Ν繧定ｿ斐＠縺ｾ縺吶?
176             *
177             * @return   繧ｿ繧､繝医Ν
178             */
179            public String getTitle() {
180                    return title;
181            }
182    
183            /**
184             *  繧ｿ繧､繝医Ν繧偵そ繝?ヨ縺励∪縺吶?
185             *
186             * @param       title   繧ｿ繧､繝医Ν
187             */
188            public void setTitle( final String title ) {
189                    this.title = title;
190            }
191    
192            /**
193             *  謖?ｮ壹?陦後?菴咲ｽｮ縺ｮ繧ｨ繝ｩ繝ｼ陦檎分蜿ｷ繧定ｿ斐＠縺ｾ縺吶?
194             *
195             * @og.rev 4.3.2.0 (2008/09/11) 蟒?ｭ｢
196             *
197             * @param    row 陦後?菴咲ｽｮ
198             *
199             * @return   陦檎分蜿ｷ
200             */
201    //      public int getNo( final int row ) {
202    //              return list.get(row).getNo();
203    //      }
204    
205            /**
206             *  謖?ｮ壹?陦後?菴咲ｽｮ縺ｮ繧ｨ繝ｩ繝ｼ繧ｪ繝悶ず繧ｧ繧ｯ繝医ｒ霑斐＠縺ｾ縺吶?
207             *
208             * @og.rev 4.0.0.0 (2004/12/31) 譁ｰ隕剰ｿｽ蜉?
209             * @og.rev 4.3.2.0 (2008/09/11) 蟒?ｭ｢
210             *
211             * @param    row 陦後?菴咲ｽｮ
212             *
213             * @return   繧ｨ繝ｩ繝ｼ繧ｪ繝悶ず繧ｧ繧ｯ繝?
214             */
215    //      public ErrMsg getErrMsg( final int row ) {
216    //              return list.get(row);
217    //      }
218    
219            /**
220             *  縺薙?繧ｨ繝ｩ繝ｼ繝｡繝?そ繝ｼ繧ｸ縺ｮ荳ｭ縺ｧ縲∵怙螟ｧ縺ｮ邨先棡蛟､(繧ｨ繝ｩ繝ｼ縺ｮ譛?､ｧ繝ｬ繝吶Ν)繧定ｿ斐＠縺ｾ縺吶?
221             *
222             * @return   邨先棡   OK, WARNING, NG, ORCL_ERR
223             */
224            public int getKekka() {
225                    return maxKekka;
226            }
227    
228            /**
229             *  謖?ｮ壹?陦後?菴咲ｽｮ縺ｮ邨先棡繧定ｿ斐＠縺ｾ縺吶?
230             *
231             * @og.rev 4.3.2.0 (2008/09/11) 蟒?ｭ｢
232             *
233             * @param    row 陦後?菴咲ｽｮ
234             *
235             * @return   邨先棡  OK, WARNING, NG, EXCEPTION , ORCL_ERR
236             */
237    //      public int getKekka( final int row ) {
238    //              return list.get(row).getKekka();
239    //      }
240    
241            /**
242             *  縺吶∋縺ｦ縺ｮ繝｡繝?そ繝ｼ繧ｸ縺?豁｣蟶ｸ(OK)縺九ｒ霑斐＠縺ｾ縺吶?
243             *
244             * @return   邨先棡 縺吶∋縺ｦOK?嗾rue / 縺昴ｌ莉･螟?false
245             */
246            public boolean isOK() {
247                    return ( maxKekka == OK );
248            }
249    
250            /**
251             *  謖?ｮ壹?陦後?菴咲ｽｮ縺ｮ繧ｨ繝ｩ繝ｼ繧ｳ繝ｼ繝迂D繧定ｿ斐＠縺ｾ縺吶?
252             *
253             * @og.rev 4.3.2.0 (2008/09/11) 蟒?ｭ｢
254             *
255             * @param    row 陦後?菴咲ｽｮ
256             *
257             * @return   繧ｨ繝ｩ繝ｼ繧ｳ繝ｼ繝迂D
258             */
259    //      public String getId( final int row ) {
260    //              return list.get(row).getId();
261    //      }
262    
263            /**
264             *  謖?ｮ壹?陦後?菴咲ｽｮ縺ｮPG蜷阪ｒ霑斐＠縺ｾ縺吶?
265             *
266             * @og.rev 3.8.9.5 (2007/09/12) 譁ｰ隕丈ｽ懈?
267             * @og.rev 4.3.2.0 (2008/09/11) 蟒?ｭ｢
268             *
269             * @param    row 陦後?菴咲ｽｮ
270             *
271             * @return   PG蜷?
272             */
273    //      public String getPg( final int row ) {
274    ////            return ((ErrMsg)list.get(row)).getPg();
275    //              return (list.get(row)).getPg();         // 4.0.0.0 (2007/09/25)
276    //      }
277    
278            /**
279             *  謖?ｮ壹?陦後?菴咲ｽｮ縺ｮ繧ｹ繝?ャ繝怜錐繧定ｿ斐＠縺ｾ縺吶?
280             *
281             * @og.rev 3.8.9.5 (2007/09/12) 譁ｰ隕丈ｽ懈?
282             * @og.rev 4.3.2.0 (2008/09/11) 蟒?ｭ｢
283             *
284             * @param    row 陦後?菴咲ｽｮ
285             *
286             * @return   繧ｹ繝?ャ繝怜錐
287             */
288    //      public String getStep( final int row ) {
289    ////            return ((ErrMsg)list.get(row)).getStep();
290    //              return (list.get(row)).getStep();               // 4.0.0.0 (2007/09/25)
291    //      }
292    
293            /**
294             *  驟榊?荳ｭ縺ｫPG蜷阪∪縺溘?繧ｹ繝?ャ繝怜錐縺瑚ｨｭ螳壹＆繧後※縺?ｋ縺九ｒ霑斐＠縺ｾ縺吶?
295             *
296             * @og.rev 3.8.9.5 (2007/09/12) 譁ｰ隕丈ｽ懈?
297             *
298             * @return   PG蜷阪∪縺溘?繧ｹ繝?ャ繝怜錐縺瑚ｨｭ螳壹＆繧後※縺?ｋ縺?
299             */
300            public boolean isSetPgStep() {
301                    return setPgStep;
302            }
303    
304            /**
305             *  繝｡繝?そ繝ｼ繧ｸ縺ｮ騾｣邨舌Μ繧ｹ繝医ｒ霑斐＠縺ｾ縺吶?
306             *
307             * @return   繝｡繝?そ繝ｼ繧ｸ縺ｮ騾｣邨舌Μ繧ｹ繝?
308             */
309            @Override
310            public String toString() {
311    //              StringBuilder rtn = new StringBuilder( HybsSystem.BUFFER_MIDDLE );
312                    StringBuilder rtn = new StringBuilder( BUFFER_MIDDLE );
313    //              rtn.append( getTitle() ).append( HybsSystem.CR );
314                    rtn.append( getTitle() ).append( CR );
315                    ErrMsg[] msg = list.toArray( new ErrMsg[list.size()] );
316                    for( int i=0; i<msg.length; i++ ) {
317                            rtn.append( msg[i] );
318    //                      rtn.append( HybsSystem.CR );
319                            rtn.append( CR );
320                    }
321                    return rtn.toString();
322            }
323    }