KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > controller > ValidationItem


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.core.controller;
66
67 /**
68  * ValidationItem.java
69  *
70  * Copyright 2000, 2001 Jcorporate Ltd.
71  */
72
73 import com.jcorporate.expresso.core.misc.StringUtil;
74
75
76 /**
77  * A ValidationItem encapsulates a single item to be validated,
78  * typically an input collected from a web page submission.
79  * <p/>
80  * Creation date: (7/19/00 3:30:40 PM)
81  *
82  * @author Adam Rossi, PlatinumSolutions
83  */
84 public class ValidationItem {
85     private String JavaDoc fieldName = null;
86     private String JavaDoc friendlyFieldName = null;
87     private String JavaDoc dbFieldName = null;
88     private boolean isRequired = false;
89     private String JavaDoc checkClassName = null;
90
91     /**
92      * ValidationItem constructor comment.
93      *
94      * @param fieldName
95      * @param friendlyFieldName
96      * @param dbFieldName
97      * @param isRequired
98      * @param checkClassName
99      */
100     public ValidationItem(String JavaDoc newFieldName, String JavaDoc newFriendlyFieldName,
101                           String JavaDoc newDbFieldName, boolean newIsRequired,
102                           String JavaDoc newCheckClassName) {
103         super();
104         fieldName = newFieldName;
105         friendlyFieldName = newFriendlyFieldName;
106         dbFieldName = newDbFieldName;
107         isRequired = newIsRequired;
108         checkClassName = newCheckClassName;
109     } /* ValidationItem(String, String, String, boolean, String) */
110
111     /**
112      * ValidationItem constructor comment.
113      *
114      * @param fieldName
115      * @param friendlyFieldName
116      * @param isRequired
117      * @param checkClassName
118      */
119     public ValidationItem(String JavaDoc newFieldName, String JavaDoc newFriendlyFieldName,
120                           boolean newIsRequired, String JavaDoc newCheckClassName) {
121         super();
122         fieldName = newFieldName;
123         friendlyFieldName = newFriendlyFieldName;
124         isRequired = newIsRequired;
125         checkClassName = newCheckClassName;
126     } /* ValidationItem(String, String, boolean, String) */
127
128     /**
129      * ValidationItem constructor comment.
130      *
131      * @param fieldName
132      * @param isRequired
133      */
134     public ValidationItem(String JavaDoc newFieldName, boolean newIsRequired) {
135         super();
136         fieldName = newFieldName;
137         isRequired = newIsRequired;
138     } /* ValidationItem(String, boolean) */
139
140     /**
141      * ValidationItem constructor comment.
142      *
143      * @param fieldName
144      * @param isRequired
145      * @param checkClassName
146      */
147     public ValidationItem(String JavaDoc newFieldName, boolean newIsRequired,
148                           String JavaDoc newCheckClassName) {
149         super();
150         StringUtil.assertNotBlank(newFieldName, "Field name may not be blank");
151         StringUtil.assertNotBlank(newCheckClassName,
152                 "Check class name may not be blank");
153         fieldName = newFieldName;
154         isRequired = newIsRequired;
155         checkClassName = newCheckClassName;
156     } /* ValidationItem(String, boolean) */
157
158     /**
159      * Creation date: (7/19/00 5:42:08 PM)
160      *
161      * @throws com.jcorporate.expresso.core.controller.ValidationError
162      * The
163      * exception description.
164      * @author
165      */
166     public void checkThisItem()
167             throws ValidationException {
168         if (getFieldName() == null) {
169             throw new ValidationException("The ValidationItem must have a fieldName.");
170         }
171     } /* checkThisItem() */
172
173
174     /**
175      * Creation date: (7/19/00 3:39:59 PM)
176      *
177      * @return java.lang.String
178      * @author Adam Rossi, PlatinumSolutions
179      */
180     public String JavaDoc getCheckClassName() {
181         return checkClassName;
182     } /* getCheckClassName() */
183
184     /**
185      * Creation date: (7/19/00 5:36:16 PM)
186      *
187      * @return java.lang.String
188      * @author Adam Rossi, PlatinumSolutions
189      */
190     public String JavaDoc getDbFieldName() {
191         return dbFieldName;
192     } /* getDbFieldName() */
193
194     /**
195      * Creation date: (7/19/00 3:36:25 PM)
196      *
197      * @return java.lang.String
198      * @author Adam Rossi, PlatinumSolutions
199      */
200     public String JavaDoc getFieldName() {
201         return fieldName;
202     } /* getFieldName() */
203
204     /**
205      * Creation date: (7/19/00 3:57:23 PM)
206      *
207      * @return java.lang.String
208      * @author Adam Rossi, PlatinumSolutions
209      */
210     public String JavaDoc getFriendlyFieldName() {
211         return friendlyFieldName;
212     } /* getFriendlyFieldName() */
213
214     /**
215      * Creation date: (7/19/00 3:37:33 PM)
216      *
217      * @return boolean
218      * @author Adam Rossi, PlatinumSolutions
219      */
220     public boolean isRequired() {
221         return isRequired;
222     } /* isRequired() */
223
224 } /* ValidationItem */
225
226 /* ValidationItem */
Popular Tags