some code cleanup. removed unnecessary semikolons, unused vars, etc.
[mir.git] / source / mir / session / ValidationHelper.java
1 /*
2  * Copyright (C) 2001, 2002 The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with  any library licensed under the Apache Software License,
22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
23  * (or with modified versions of the above that use the same license as the above),
24  * and distribute linked combinations including the two.  You must obey the
25  * GNU General Public License in all respects for all of the code used other than
26  * the above mentioned libraries.  If you modify this file, you may extend this
27  * exception to your version of the file, but you are not obligated to do so.
28  * If you do not wish to do so, delete this exception statement from your version.
29  */
30
31 package mir.session;
32
33 import java.util.List;
34
35
36 public class ValidationHelper {
37   /**
38    * Convenience validation method to test whether a field has been filled in
39    *
40    * @param aRequest
41    * @param aFieldName
42    * @param anErrorMessageResource
43    * @param aValidationResults
44    * @return
45    */
46
47   public static boolean testFieldEntered(Request aRequest, String aFieldName, String anErrorMessageResource, List aValidationResults) {
48     Object value = aRequest.getParameter(aFieldName);
49     if (value==null || !(value instanceof String) || ((String) value).trim().length()==0) {
50       aValidationResults.add(new ValidationError(aFieldName, anErrorMessageResource));
51       return false;
52     }
53                 return true;
54   }
55
56   /**
57    * Convenience validation method to test wether a field is numeric
58
59    * @param aRequest
60    * @param aFieldName
61    * @param anErrorMessageResource
62    * @param aValidationResults
63    * @return
64    */
65
66   public static boolean testFieldIsNumeric(Request aRequest, String aFieldName, String anErrorMessageResource, List aValidationResults) {
67     Object value = aRequest.getParameter(aFieldName);
68     if (value!=null) {
69       try {
70         Integer.parseInt((String) value);
71         return true;
72       }
73       catch (Throwable t) {
74         aValidationResults.add(new ValidationError(aFieldName, anErrorMessageResource));
75         return false;
76       }
77     }
78     return true;
79   }
80
81   /**
82    * Convenience validation method to test whether a field exceeds a given length
83
84    * @param aRequest
85    * @param aFieldName
86    * @param aMaxLength
87    * @param anErrorMessageResource
88    * @param aValidationResults
89    * @return
90    */
91
92   public static boolean testFieldLength(Request aRequest, String aFieldName, int aMaxLength, String anErrorMessageResource, List aValidationResults) {
93     String value = aRequest.getParameter(aFieldName);
94
95     if (value!=null) {
96       if (value.length()>aMaxLength) {
97         aValidationResults.add(new ValidationError(aFieldName, anErrorMessageResource));
98         return false;
99       }
100       else return true;
101     }
102     return true;
103   }
104 }