View Javadoc

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.buildtools.maven2.plugin.builder.annotation.JSFProperty;
28  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFValidator;
29  
30  /**
31   * A custom validator for reg. expr., based upons Jakarta Commons. 
32   * 
33   * Unless otherwise specified, all attributes accept static values or EL expressions.
34   * 
35   * 
36   * @author mwessendorf (latest modification by $Author: lu4242 $)
37   * @version $Revision: 1038268 $ $Date: 2010-11-23 13:47:14 -0500 (Tue, 23 Nov 2010) $
38   */
39  @JSFValidator(
40     name = "mcv:validateRegExpr",
41     clazz = "org.apache.myfaces.commons.validator.RegExprValidator",
42     tagClass = "org.apache.myfaces.commons.validator.ValidateRegExprTag",
43     serialuidtag = "-449945949876262076L")
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          String pattern = getPattern();
74          if (pattern == null)
75          {
76              pattern = getPatternExpression();
77          }
78          else if (pattern != null && pattern.length() <= 0)
79          {
80              pattern = getPatternExpression();
81          }
82          if(!GenericValidator.matchRegexp(value.toString(),"^"+pattern+"$")){
83              throw new ValidatorException(getFacesMessage(REGEXPR_MESSAGE_ID, args));
84          }
85      }
86  
87      // -------------------------------------------------------- GETTER & SETTER
88  
89      /**
90       * the pattern, which is the base of the validation. It does
91       * not allow EL expressions (jsp special case).
92       * 
93       * @return the pattern, on which a value should be validated
94       */
95      @JSFProperty(
96         literalOnly = true)
97      public abstract String getPattern();
98  
99      /**
100      * @param string the pattern, on which a value should be validated
101      */
102     public abstract void setPattern(String string);
103 
104     /**
105      * the pattern, which is the base of the validation. It 
106      * allow EL expressions.
107      * 
108      * @return the pattern, on which a value should be validated
109      */
110     @JSFProperty
111     public abstract String getPatternExpression();
112     
113     
114 }