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 javax.faces.validator;
20  
21  import javax.faces.component.StateHolder;
22  import javax.faces.component.UIComponent;
23  import javax.faces.context.FacesContext;
24  
25  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFJspProperty;
26  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
27  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFValidator;
28  
29  /**
30   * Creates a validator and associateds it with the nearest parent
31   * UIComponent.  When invoked, the validator ensures that values are
32   * valid doubles that lie within the minimum and maximum values specified.
33   * 
34   * Commonly associated with a h:inputText entity.
35   * 
36   * Unless otherwise specified, all attributes accept static values or EL expressions.
37   * 
38   * see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
39   *
40   * @author Manfred Geiler (latest modification by $Author: lu4242 $)
41   * @author Thomas Spiegl
42   * @version $Revision: 693358 $ $Date: 2008-09-08 22:54:29 -0500 (Mon, 08 Sep 2008) $
43   */
44  @JSFValidator(
45      name="f:validateDoubleRange",
46      bodyContent="empty",
47      tagClass="org.apache.myfaces.taglib.core.ValidateDoubleRangeTag")
48  @JSFJspProperty(
49      name="binding", 
50      returnType = "javax.faces.validator.DoubleRangeValidator",
51      longDesc = "A ValueExpression that evaluates to a DoubleRangeValidator.")
52  public class DoubleRangeValidator
53          implements Validator, StateHolder
54  {
55      // FIELDS
56      public static final String VALIDATOR_ID       = "javax.faces.DoubleRange";
57      public static final String MAXIMUM_MESSAGE_ID = "javax.faces.validator.DoubleRangeValidator.MAXIMUM";
58      public static final String MINIMUM_MESSAGE_ID = "javax.faces.validator.DoubleRangeValidator.MINIMUM";
59      public static final String TYPE_MESSAGE_ID    = "javax.faces.validator.DoubleRangeValidator.TYPE";
60      public static final String NOT_IN_RANGE_MESSAGE_ID = "javax.faces.validator.DoubleRangeValidator.NOT_IN_RANGE";
61      
62      private Double _minimum = null;
63      private Double _maximum = null;
64      private boolean _transient = false;
65  
66      // CONSTRUCTORS
67      public DoubleRangeValidator()
68      {
69      }
70  
71      public DoubleRangeValidator(double maximum)
72      {
73          _maximum = new Double(maximum);
74      }
75  
76      public DoubleRangeValidator(double maximum,
77                                  double minimum)
78      {
79          _maximum = new Double(maximum);
80          _minimum = new Double(minimum);
81      }
82  
83      // VALIDATE
84      public void validate(FacesContext facesContext,
85                           UIComponent uiComponent,
86                           Object value)
87              throws ValidatorException
88      {
89          if (facesContext == null) throw new NullPointerException("facesContext");
90          if (uiComponent == null) throw new NullPointerException("uiComponent");
91  
92          if (value == null)
93          {
94              return;
95          }
96  
97          double dvalue = parseDoubleValue(facesContext, uiComponent,value);
98          if (_minimum != null && _maximum != null)
99          {
100             if (dvalue < _minimum.doubleValue() ||
101                 dvalue > _maximum.doubleValue())
102             {
103                 Object[] args = {_minimum, _maximum,_MessageUtils.getLabel(facesContext, uiComponent)};
104                 throw new ValidatorException(_MessageUtils.getErrorMessage(facesContext, NOT_IN_RANGE_MESSAGE_ID, args));
105             }
106         }
107         else if (_minimum != null)
108         {
109             if (dvalue < _minimum.doubleValue())
110             {
111                 Object[] args = {_minimum,_MessageUtils.getLabel(facesContext, uiComponent)};
112                 throw new ValidatorException(_MessageUtils.getErrorMessage(facesContext, MINIMUM_MESSAGE_ID, args));
113             }
114         }
115         else if (_maximum != null)
116         {
117             if (dvalue > _maximum.doubleValue())
118             {
119                 Object[] args = {_maximum,_MessageUtils.getLabel(facesContext, uiComponent)};
120                 throw new ValidatorException(_MessageUtils.getErrorMessage(facesContext, MAXIMUM_MESSAGE_ID, args));
121             }
122         }
123     }
124 
125     private double parseDoubleValue(FacesContext facesContext, UIComponent uiComponent, Object value)
126         throws ValidatorException
127     {
128         if (value instanceof Number)
129         {
130             return ((Number)value).doubleValue();
131         }
132         
133         try
134         {
135             return Double.parseDouble(value.toString());
136         }
137         catch (NumberFormatException e)
138         {
139             Object[] args = {_MessageUtils.getLabel(facesContext, uiComponent)};
140             throw new ValidatorException(_MessageUtils.getErrorMessage(facesContext, TYPE_MESSAGE_ID, args));
141         }
142     }
143 
144 
145     // GETTER & SETTER
146     
147     /** 
148      * The largest value that should be considered valid.
149      * 
150      */
151     @JSFProperty
152     public double getMaximum()
153     {
154         return _maximum != null ? _maximum.doubleValue() : Double.MAX_VALUE;
155     }
156 
157     public void setMaximum(double maximum)
158     {
159         _maximum = new Double(maximum);
160     }
161 
162     /**
163      * The smallest value that should be considered valid.
164      *  
165      */
166     @JSFProperty
167     public double getMinimum()
168     {
169         return _minimum != null ? _minimum.doubleValue() : Double.MIN_VALUE;
170     }
171 
172     public void setMinimum(double minimum)
173     {
174         _minimum = new Double(minimum);
175     }
176 
177 
178     // RESTORE/SAVE STATE
179     public Object saveState(FacesContext context)
180     {
181         Object values[] = new Object[2];
182         values[0] = _maximum;
183         values[1] = _minimum;
184         return values;
185     }
186 
187     public void restoreState(FacesContext context,
188                              Object state)
189     {
190         Object values[] = (Object[])state;
191         _maximum = (Double)values[0];
192         _minimum = (Double)values[1];
193     }
194 
195     public boolean isTransient()
196     {
197         return _transient;
198     }
199 
200     public void setTransient(boolean transientValue)
201     {
202         _transient = transientValue;
203     }
204 
205     // MISC
206     public boolean equals(Object o)
207     {
208         if (this == o) return true;
209         if (!(o instanceof DoubleRangeValidator)) return false;
210 
211         final DoubleRangeValidator doubleRangeValidator = (DoubleRangeValidator)o;
212 
213         if (_maximum != null ? !_maximum.equals(doubleRangeValidator._maximum) : doubleRangeValidator._maximum != null) return false;
214         if (_minimum != null ? !_minimum.equals(doubleRangeValidator._minimum) : doubleRangeValidator._minimum != null) return false;
215 
216         return true;
217     }
218 
219 }