1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479

/*
 * Copyright 2004-2010 the Seasar Foundation and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.slim3.controller.validator;

import java.text.DecimalFormat;
import java.text.SimpleDateFormat;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.slim3.controller.ControllerConstants;
import org.slim3.util.ArrayMap;
import org.slim3.util.RequestMap;

/**
 * A class to control validation process. The error messages of validation are
 * stored in application[_locale].properties.
 * 
 * @author higa
 * @since 1.0.0
 * 
 */
public class Validators {

    /**
     * The registered validators.
     */
    protected ArrayMap<String, Validator[]> validatorsMap =
        new ArrayMap<String, Validator[]>();

    /**
     * The parameters.
     */
    protected Map<String, Object> parameters;

    /**
     * The error messages.
     */
    protected Errors errors;

    /**
     * Constructor.
     * 
     * @param request
     *            the request
     */
    public Validators(HttpServletRequest request) {
        this(new RequestMap(request));
    }

    /**
     * Constructor.
     * 
     * @param parameters
     *            the parameters
     * @throws NullPointerException
     *             if the parameters parameter is null
     */
    public Validators(Map<String, Object> parameters)
            throws NullPointerException {
        if (parameters == null) {
            throw new NullPointerException(
                "The parameters parameter must not be null.");
        }
        this.parameters = parameters;
        errors = (Errors) parameters.get(ControllerConstants.ERRORS_KEY);
        if (errors == null) {
            errors = new Errors();
            parameters.put(ControllerConstants.ERRORS_KEY, errors);
        }
    }

    /**
     * Adds the validators.
     * 
     * @param name
     *            the parameter name
     * @param validators
     *            the validators
     * @return this instance
     * @throws NullPointerException
     *             if the name parameter is null
     */
    public Validators add(CharSequence name, Validator... validators)
            throws NullPointerException {
        if (name == null) {
            throw new NullPointerException(
                "The name parameter must not be null.");
        }
        validatorsMap.put(name.toString(), validators);
        return this;
    }

    /**
     * Validates input values.
     * 
     * @return whether input values are valid. Returns true if input values are
     *         valid.
     */
    public boolean validate() {
        boolean valid = true;
        for (int i = 0; i < validatorsMap.size(); i++) {
            String name = validatorsMap.getKey(i);
            for (Validator v : validatorsMap.get(i)) {
                String message = v.validate(parameters, name);
                if (message != null) {
                    valid = false;
                    errors.put(name, message);
                    break;
                }
            }
        }
        return valid;
    }

    /**
     * Returns the error messages.
     * 
     * @return the error messages
     */
    public Errors getErrors() {
        return errors;
    }

    /**
     * Returns {@link RequiredValidator}. The key of error message is
     * "validator.required".
     * 
     * @return {@link RequiredValidator}
     */
    public RequiredValidator required() {
        return RequiredValidator.INSTANCE;
    }

    /**
     * Returns {@link RequiredValidator}.
     * 
     * @param message
     *            the error message
     * @return {@link RequiredValidator}
     */
    public RequiredValidator required(String message) {
        return new RequiredValidator(message);
    }

    /**
     * Returns {@link ByteTypeValidator}. The key of error message is
     * "validator.byteType".
     * 
     * @return {@link ByteTypeValidator}
     */
    public ByteTypeValidator byteType() {
        return ByteTypeValidator.INSTANCE;
    }

    /**
     * Returns {@link ByteTypeValidator}.
     * 
     * @param message
     *            the error message
     * @return {@link ByteTypeValidator}
     */
    public ByteTypeValidator byteType(String message) {
        return new ByteTypeValidator(message);
    }

    /**
     * Returns {@link ShortTypeValidator}. The key of error message is
     * "validator.shortType".
     * 
     * @return {@link ShortTypeValidator}
     */
    public ShortTypeValidator shortType() {
        return ShortTypeValidator.INSTANCE;
    }

    /**
     * Returns {@link ShortTypeValidator}.
     * 
     * @param message
     *            the error message
     * @return {@link ShortTypeValidator}
     */
    public ShortTypeValidator shortType(String message) {
        return new ShortTypeValidator(message);
    }

    /**
     * Returns {@link IntegerTypeValidator}. The key of error message is
     * "validator.integerType".
     * 
     * @return {@link IntegerTypeValidator}
     */
    public IntegerTypeValidator integerType() {
        return IntegerTypeValidator.INSTANCE;
    }

    /**
     * Returns {@link IntegerTypeValidator}.
     * 
     * @param message
     *            the error message
     * @return {@link IntegerTypeValidator}
     */
    public IntegerTypeValidator integerType(String message) {
        return new IntegerTypeValidator(message);
    }

    /**
     * Returns {@link LongTypeValidator}. The key of error message is
     * "validator.longType".
     * 
     * @return {@link LongTypeValidator}
     */
    public LongTypeValidator longType() {
        return LongTypeValidator.INSTANCE;
    }

    /**
     * Returns {@link LongTypeValidator}.
     * 
     * @param message
     *            the error message
     * @return {@link LongTypeValidator}
     */
    public LongTypeValidator longType(String message) {
        return new LongTypeValidator(message);
    }

    /**
     * Returns {@link FloatTypeValidator}. The key of error message is
     * "validator.floatType".
     * 
     * @return {@link FloatTypeValidator}
     */
    public FloatTypeValidator floatType() {
        return FloatTypeValidator.INSTANCE;
    }

    /**
     * Returns {@link FloatTypeValidator}.
     * 
     * @param message
     *            the error message
     * @return {@link FloatTypeValidator}
     */
    public FloatTypeValidator floatType(String message) {
        return new FloatTypeValidator(message);
    }

    /**
     * Returns {@link DoubleTypeValidator}. The key of error message is
     * "validator.doubleType".
     * 
     * @return {@link DoubleTypeValidator}
     */
    public DoubleTypeValidator doubleType() {
        return DoubleTypeValidator.INSTANCE;
    }

    /**
     * Returns {@link DoubleTypeValidator}.
     * 
     * @param message
     *            the error message
     * @return {@link DoubleTypeValidator}
     */
    public DoubleTypeValidator doubleType(String message) {
        return new DoubleTypeValidator(message);
    }

    /**
     * Returns {@link NumberTypeValidator}. The key of error message is
     * "validator.numberType".
     * 
     * @param pattern
     *            the pattern of {@link DecimalFormat}
     * 
     * @return {@link NumberTypeValidator}
     */
    public NumberTypeValidator numberType(String pattern) {
        return new NumberTypeValidator(pattern);
    }

    /**
     * Returns {@link NumberTypeValidator}.
     * 
     * @param pattern
     *            the pattern of {@link DecimalFormat}
     * @param message
     *            the error message
     * 
     * @return {@link NumberTypeValidator}
     */
    public NumberTypeValidator numberType(String pattern, String message) {
        return new NumberTypeValidator(pattern, message);
    }

    /**
     * Returns {@link DateTypeValidator}. The key of error message is
     * "validator.dateType".
     * 
     * @param pattern
     *            the pattern of {@link SimpleDateFormat}
     * 
     * @return {@link DateTypeValidator}
     */
    public DateTypeValidator dateType(String pattern) {
        return new DateTypeValidator(pattern);
    }

    /**
     * Returns {@link DateTypeValidator}.
     * 
     * @param pattern
     *            the pattern of {@link SimpleDateFormat}
     * @param message
     *            the error message
     * @return {@link DateTypeValidator}
     */
    public DateTypeValidator dateType(String pattern, String message) {
        return new DateTypeValidator(pattern, message);
    }

    /**
     * Returns {@link MinlengthValidator}. The key of error message is
     * "validator.minlength".
     * 
     * @param minlength
     *            the minimum length
     * 
     * @return {@link MinlengthValidator}
     */
    public MinlengthValidator minlength(int minlength) {
        return new MinlengthValidator(minlength);
    }

    /**
     * Returns {@link MinlengthValidator}.
     * 
     * @param minlength
     *            the minimum length
     * @param message
     *            the error message
     * @return {@link MinlengthValidator}
     */
    public MinlengthValidator minlength(int minlength, String message) {
        return new MinlengthValidator(minlength, message);
    }

    /**
     * Returns {@link MaxlengthValidator}. The key of error message is
     * "validator.maxlength".
     * 
     * @param maxlength
     *            the maximum length
     * 
     * @return {@link MaxlengthValidator}
     */
    public MaxlengthValidator maxlength(int maxlength) {
        return new MaxlengthValidator(maxlength);
    }

    /**
     * Returns {@link MaxlengthValidator}.
     * 
     * @param maxlength
     *            the maximum length
     * @param message
     *            the error message
     * @return {@link MaxlengthValidator}
     */
    public MaxlengthValidator maxlength(int maxlength, String message) {
        return new MaxlengthValidator(maxlength, message);
    }

    /**
     * Returns {@link LongRangeValidator}. The key of error message is
     * "validator.range".
     * 
     * @param minimum
     *            the minimum value
     * @param maximum
     *            the maximum value
     * @return {@link LongRangeValidator}
     */
    public LongRangeValidator longRange(long minimum, long maximum) {
        return new LongRangeValidator(minimum, maximum);
    }

    /**
     * Returns {@link LongRangeValidator}.
     * 
     * @param minimum
     *            the minimum value
     * @param maximum
     *            the maximum value
     * @param message
     *            the error message
     * @return {@link LongRangeValidator}
     */
    public LongRangeValidator longRange(long minimum, long maximum,
            String message) {
        return new LongRangeValidator(minimum, maximum, message);
    }

    /**
     * Returns {@link DoubleRangeValidator}. The key of error message is
     * "validator.range".
     * 
     * @param minimum
     *            the minimum value
     * @param maximum
     *            the maximum value
     * @return {@link DoubleRangeValidator}
     */
    public DoubleRangeValidator doubleRange(double minimum, double maximum) {
        return new DoubleRangeValidator(minimum, maximum);
    }

    /**
     * Returns {@link DoubleRangeValidator}.
     * 
     * @param minimum
     *            the minimum value
     * @param maximum
     *            the maximum value
     * @param message
     *            the error message
     * @return {@link DoubleRangeValidator}
     */
    public DoubleRangeValidator doubleRange(double minimum, double maximum,
            String message) {
        return new DoubleRangeValidator(minimum, maximum, message);
    }

    /**
     * Returns {@link RegexpValidator}. The key of error message is
     * "validator.regexp".
     * 
     * @param pattern
     *            the pattern for regular expression
     * @return {@link RegexpValidator}
     * @throws NullPointerException
     *             if the pattern parameter is null
     */
    public RegexpValidator regexp(String pattern) throws NullPointerException {
        return new RegexpValidator(pattern);
    }

    /**
     * Returns {@link RegexpValidator}.
     * 
     * @param pattern
     *            the pattern for regular expression
     * @param message
     *            the error message
     * @return {@link RegexpValidator}
     * @throws NullPointerException
     *             if the pattern parameter is null
     */
    public RegexpValidator regexp(String pattern, String message)
            throws NullPointerException {
        return new RegexpValidator(pattern, message);
    }
}