View Javadoc

1   package org.apache.turbine.services.intake.model;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.turbine.services.intake.IntakeException;
23  import org.apache.turbine.services.intake.validator.DoubleValidator;
24  import org.apache.turbine.services.intake.xmlmodel.XmlField;
25  
26  /***
27   * Creates Double Field objects.
28   *
29   * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a>
30   * @version $Id: DoubleField.java 646288 2008-04-09 11:51:16Z tv $
31   */
32  public class DoubleField
33          extends Field
34  {
35      /***
36       * Constructor.
37       *
38       * @param field xml field definition object
39       * @param group xml group definition object
40       * @throws IntakeException thrown by superclass
41       */
42      public DoubleField(XmlField field, Group group)
43              throws IntakeException
44      {
45          super(field, group);
46      }
47  
48      /***
49       * Sets the default value for a Double Field
50       *
51       * @param prop Parameter for the default values
52       */
53      public void setDefaultValue(String prop)
54      {
55          defaultValue = null;
56  
57          if (prop == null)
58          {
59              return;
60          }
61  
62          defaultValue = new Double(prop);
63      }
64  
65      /***
66       * Set the empty Value. This value is used if Intake
67       * maps a field to a parameter returned by the user and
68       * the corresponding field is either empty (empty string)
69       * or non-existant.
70       *
71       * @param prop The value to use if the field is empty.
72       */
73      public void setEmptyValue(String prop)
74      {
75          emptyValue = null;
76  
77          if (prop == null)
78          {
79              return;
80          }
81  
82          emptyValue = new Double(prop);
83      }
84  
85      /***
86       * Provides access to emptyValue such that the value returned will be
87       * acceptable as an argument parameter to Method.invoke.  Subclasses
88       * that deal with primitive types should ensure that they return an
89       * appropriate value wrapped in the object wrapper class for the
90       * primitive type.
91       *
92       * @return the value to use when the field is empty or an Object that
93       * wraps the empty value for primitive types.
94       */
95      protected Object getSafeEmptyValue()
96      {
97          if (isMultiValued)
98          {
99              return new double[0];
100         }
101         else
102         {
103             return (null == getEmptyValue())
104                     ? new Double(0.0) : getEmptyValue();
105         }
106     }
107 
108     /***
109      * A suitable validator.
110      *
111      * @return A suitable validator
112      */
113     protected String getDefaultValidator()
114     {
115         return DoubleValidator.class.getName();
116     }
117 
118     /***
119      * Sets the value of the field from data in the parser.
120      */
121     protected void doSetValue()
122     {
123         if (isMultiValued)
124         {
125             Double[] inputs = parser.getDoubleObjects(getKey());
126             double[] values = new double[inputs.length];
127 
128             for (int i = 0; i < inputs.length; i++)
129             {
130                 values[i] = inputs[i] == null 
131                         ? ((Double) getEmptyValue()).doubleValue() 
132                         : inputs[i].doubleValue();
133             }
134 
135             setTestValue(values);
136         }
137         else
138         {
139             setTestValue(parser.getDoubleObject(getKey(), (Double)getEmptyValue()));
140         }
141     }
142 
143 }