1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.commons.validator;
20
21 import javax.faces.application.FacesMessage;
22 import javax.faces.component.UIComponent;
23 import javax.faces.context.FacesContext;
24 import javax.faces.validator.ValidatorException;
25
26 import org.apache.commons.validator.GenericValidator;
27 import org.apache.myfaces.commons.validator.ValidatorBase;
28
29 /**
30 * A custom validator for reg. expr., based upons Jakarta Commons.
31 *
32 * Unless otherwise specified, all attributes accept static values or EL expressions.
33 *
34 * @JSFValidator
35 * name = "mcv:validateRegExpr"
36 * class = "org.apache.myfaces.commons.validator.RegExprValidator"
37 * tagClass = "org.apache.myfaces.commons.validator.ValidateRegExprTag"
38 * serialuidtag = "-449945949876262076L"
39 *
40 * @author mwessendorf (latest modification by $Author: skitching $)
41 * @version $Revision: 673801 $ $Date: 2008-07-03 15:58:48 -0500 (Thu, 03 Jul 2008) $
42 */
43
44 public abstract class AbstractRegExprValidator extends ValidatorBase {
45 /**
46 * <p>The standard converter id for this converter.</p>
47 */
48 public static final String VALIDATOR_ID = "org.apache.myfaces.commons.validator.RegExpr";
49
50 /**
51 * <p>The message identifier of the {@link FacesMessage} to be created if
52 * the regex check fails.</p>
53 */
54 public static final String REGEXPR_MESSAGE_ID = "org.apache.myfaces.commons.validator.RegExpr.INVALID";
55
56 public AbstractRegExprValidator(){
57 }
58
59 public void validate(
60 FacesContext facesContext,
61 UIComponent uiComponent,
62 Object value)
63 throws ValidatorException {
64
65 if (facesContext == null) throw new NullPointerException("facesContext");
66 if (uiComponent == null) throw new NullPointerException("uiComponent");
67
68 if (value == null)
69 {
70 return;
71 }
72 Object[] args = {value.toString()};
73 if(!GenericValidator.matchRegexp(value.toString(),"^"+getPattern()+"$")){
74 throw new ValidatorException(getFacesMessage(REGEXPR_MESSAGE_ID, args));
75 }
76 }
77
78 // -------------------------------------------------------- GETTER & SETTER
79
80 /**
81 * the pattern, which is the base of the validation
82 *
83 * @JSFProperty
84 * literalOnly = "true"
85 * @return the pattern, on which a value should be validated
86 */
87 public abstract String getPattern();
88
89 /**
90 * @param string the pattern, on which a value should be validated
91 */
92 public abstract void setPattern(String string);
93
94 }