015b9ab90eb3ba177239033225a095e16f4f2bac
[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 import mir.session.Request;
36 import mir.session.ValidationError;
37
38
39 public class ValidationHelper {
40   /**
41    * Convenience validation method to test whether a field has been filled in
42    *
43    * @param aRequest
44    * @param aFieldName
45    * @param anErrorMessageResource
46    * @param aValidationResults
47    * @return
48    */
49
50   public static boolean testFieldEntered(Request aRequest, String aFieldName, String anErrorMessageResource, List aValidationResults) {
51     Object value = aRequest.getParameter(aFieldName);
52     if (value==null || !(value instanceof String) || ((String) value).trim().length()==0) {
53       aValidationResults.add(new ValidationError(aFieldName, anErrorMessageResource));
54       return false;
55     }
56     else
57       return true;
58   }
59
60   /**
61    * Convenience validation method to test wether a field is numeric
62
63    * @param aRequest
64    * @param aFieldName
65    * @param anErrorMessageResource
66    * @param aValidationResults
67    * @return
68    */
69
70   public static boolean testFieldIsNumeric(Request aRequest, String aFieldName, String anErrorMessageResource, List aValidationResults) {
71     Object value = aRequest.getParameter(aFieldName);
72     if (value!=null) {
73       try {
74         Integer.parseInt((String) value);
75         return true;
76       }
77       catch (Throwable t) {
78         aValidationResults.add(new ValidationError(aFieldName, anErrorMessageResource));
79         return false;
80       }
81     }
82     return true;
83   }
84
85   /**
86    * Convenience validation method to test whether a field exceeds a given length
87
88    * @param aRequest
89    * @param aFieldName
90    * @param aMaxLength
91    * @param anErrorMessageResource
92    * @param aValidationResults
93    * @return
94    */
95
96   public static boolean testFieldLength(Request aRequest, String aFieldName, int aMaxLength, String anErrorMessageResource, List aValidationResults) {
97     String value = aRequest.getParameter(aFieldName);
98
99     if (value!=null) {
100       if (value.length()>aMaxLength) {
101         aValidationResults.add(new ValidationError(aFieldName, anErrorMessageResource));
102         return false;
103       }
104       else return true;
105     }
106     return true;
107   }
108 }