Coverage Report

Coverage Report - javax.faces.convert.DateTimeConverter

Classes in this File

0/117

0/58

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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 javax.faces.convert;
 
 import java.text.DateFormat;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.Locale;
 import java.util.TimeZone;
 
 import javax.faces.component.PartialStateHolder;
 import javax.faces.component.UIComponent;
 import javax.faces.context.FacesContext;
 
 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFConverter;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFJspProperty;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
 
 /**
  * This tag associates a date time converter with the nearest parent UIComponent.
  * 
  * Unless otherwise specified, all attributes accept static values or EL expressions.
  * 
  * see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
  *
  * @author Thomas Spiegl (latest modification by $Author: lu4242 $)
  * @version $Revision: 881558 $ $Date: 2009-11-17 16:55:58 -0500 (Tue, 17 Nov 2009) $
  */
 @JSFConverter(
     name="f:convertDateTime",
     bodyContent="empty",
     tagClass="org.apache.myfaces.taglib.core.ConvertDateTimeTag")
 @JSFJspProperty(
     name="binding", 
     returnType = "javax.faces.convert.DateTimeConverter",
     longDesc = "A ValueExpression that evaluates to a DateTimeConverter.")
 public class DateTimeConverter
         implements Converter, PartialStateHolder
 {
 
     // API field
     public static final String CONVERTER_ID = "javax.faces.DateTime";
     public static final String DATE_ID = "javax.faces.converter.DateTimeConverter.DATE";
     public static final String DATETIME_ID = "javax.faces.converter.DateTimeConverter.DATETIME";
     public static final String STRING_ID = "javax.faces.converter.STRING";
     public static final String TIME_ID = "javax.faces.converter.DateTimeConverter.TIME";
 
     // internal constants
     private static final String TYPE_DATE = "date";
     private static final String TYPE_TIME = "time";
     private static final String TYPE_BOTH = "both";
     private static final String STYLE_DEFAULT = "default";
     private static final String STYLE_MEDIUM = "medium";
     private static final String STYLE_SHORT = "short";
     private static final String STYLE_LONG = "long";
     private static final String STYLE_FULL = "full";
     private static final TimeZone TIMEZONE_DEFAULT = TimeZone.getTimeZone("GMT");
 
     private String _dateStyle;
     private Locale _locale;
     private String _pattern;
     private String _timeStyle;
     private TimeZone _timeZone;
     private String _type;
     private boolean _transient;
 
     // CONSTRUCTORS
     public DateTimeConverter()
     {
     }
 
     // METHODS
     public Object getAsObject(FacesContext facesContext, UIComponent uiComponent, String value)
     {
         if (facesContext == null) throw new NullPointerException("facesContext");
         if (uiComponent == null) throw new NullPointerException("uiComponent");
 
         if (value != null)
         {
             value = value.trim();
             if (value.length() > 0)
             {
                 DateFormat format = getDateFormat();
                 TimeZone tz = getTimeZone();
                 if( tz != null )
                     format.setTimeZone( tz );
                 try
                 {
                     return format.parse(value);
                 }
                 catch (ParseException e)
                 {
                     String type = getType();
                     Object[] args = new Object[]{value,format.format(new Date()),_MessageUtils.getLabel(facesContext, uiComponent)};
                     
                     if(type.equals(TYPE_DATE))
                         throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,DATE_ID,args));
                     else if (type.equals(TYPE_TIME))
                         throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,TIME_ID,args));
                     else if (type.equals(TYPE_BOTH))
                         throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,DATETIME_ID,args));
                     else
                         throw new ConverterException("invalid type '" + _type + "'");
                 }
             }
         }
         return null;
     }
 
     public String getAsString(FacesContext facesContext, UIComponent uiComponent, Object value)
     {
         if (facesContext == null) throw new NullPointerException("facesContext");
         if (uiComponent == null) throw new NullPointerException("uiComponent");
 
         if (value == null)
         {
             return "";
         }
         if (value instanceof String)
         {
             return (String)value;
         }
 
         DateFormat format = getDateFormat();
         TimeZone tz = getTimeZone(); 
         if (tz != null)
         {
             format.setTimeZone(tz);
         }
         try
         {
             return format.format(value);
         }
         catch (Exception e)
         {
             throw new ConverterException(_MessageUtils.getErrorMessage(facesContext, STRING_ID, new Object[]{value,_MessageUtils.getLabel(facesContext, uiComponent)}),e);
         }
     }
 
     private DateFormat getDateFormat()
     {
         String type = getType();
         DateFormat format;
         if (_pattern != null)
         {
             try 
             {
                 format = new SimpleDateFormat(_pattern, getLocale());
             } 
                 catch (IllegalArgumentException iae)
             {
                 throw new ConverterException("Invalid pattern", iae);    
             }
         }
         else if (type.equals(TYPE_DATE))
         {
             format = DateFormat.getDateInstance(calcStyle(getDateStyle()), getLocale());
         }
         else if (type.equals(TYPE_TIME))
         {
             format = DateFormat.getTimeInstance(calcStyle(getTimeStyle()), getLocale());
         }
         else if (type.equals(TYPE_BOTH))
         {
             format = DateFormat.getDateTimeInstance(calcStyle(getDateStyle()),
                                                     calcStyle(getTimeStyle()),
                                                     getLocale());
         }
         else
         {
             throw new ConverterException("invalid type '" + _type + "'");
         }
         
         // format cannot be lenient (JSR-127)
         format.setLenient(false);
         return format;
     }
 
     private int calcStyle(String name)
     {
         if (name.equals(STYLE_DEFAULT))
         {
             return DateFormat.DEFAULT;
         }
         if (name.equals(STYLE_MEDIUM))
         {
             return DateFormat.MEDIUM;
         }
         if (name.equals(STYLE_SHORT))
         {
             return DateFormat.SHORT;
         }
         if (name.equals(STYLE_LONG))
         {
             return DateFormat.LONG;
         }
         if (name.equals(STYLE_FULL))
         {
             return DateFormat.FULL;
         }
 
         throw new ConverterException("invalid style '" + name + "'");
     }
 
     // STATE SAVE/RESTORE
     public void restoreState(FacesContext facesContext, Object state)
     {
         if (state != null)
         {
             Object[] values = (Object[])state;
             _dateStyle = (String)values[0];
             _locale = (Locale)values[1];
             _pattern = (String)values[2];
             _timeStyle = (String)values[3];
             _timeZone = (TimeZone)values[4];
             _type = (String)values[5];
         }
     }
 
     public Object saveState(FacesContext facesContext)
     {
         if (!initialStateMarked())
         {
             Object[] values = new Object[6];
             values[0] = _dateStyle;
             values[1] = _locale;
             values[2] = _pattern;
             values[3] = _timeStyle;
             values[4] = _timeZone;
             values[5] = _type;
             return values;
         }
         return null;
     }
 
     // GETTER & SETTER
     
     /**
      * The style of the date.  Values include: default, short, medium, 
      * long, and full.
      * 
      */
     @JSFProperty
     public String getDateStyle()
     {
         return _dateStyle != null ? _dateStyle : STYLE_DEFAULT;
     }
 
     public void setDateStyle(String dateStyle)
     {
         //TODO: validate timeStyle
         _dateStyle = dateStyle;
         clearInitialState();
     }
 
     /**
      * The name of the locale to be used, instead of the default.
      * 
      */
     @JSFProperty
     public Locale getLocale()
     {
         if (_locale != null) return _locale;
         FacesContext context = FacesContext.getCurrentInstance();
         return context.getViewRoot().getLocale();
     }
 
     public void setLocale(Locale locale)
     {
         _locale = locale;
         clearInitialState();
     }
 
     /**
      * A custom Date formatting pattern, in the format used by java.text.SimpleDateFormat.
      * 
      */
     @JSFProperty
     public String getPattern()
     {
         return _pattern;
     }
 
     public void setPattern(String pattern)
     {
         _pattern = pattern;
         clearInitialState();
     }
 
     /**
      * The style of the time.  Values include:  default, short, medium, long, 
      * and full.
      * 
      */
     @JSFProperty
     public String getTimeStyle()
     {
         return _timeStyle != null ? _timeStyle : STYLE_DEFAULT;
     }
 
     public void setTimeStyle(String timeStyle)
     {
         //TODO: validate timeStyle
         _timeStyle = timeStyle;
         clearInitialState();
     }
 
     /**
      * The time zone to use instead of GMT (the default timezone). When
      * this value is a value-binding to a TimeZone instance, that
      * timezone is used. Otherwise this value is treated as a String
      * containing a timezone id, ie as the ID parameter of method
      * java.util.TimeZone.getTimeZone(String).
      * 
      */
     @JSFProperty
     public TimeZone getTimeZone()
     {
         return _timeZone != null ? _timeZone : TIMEZONE_DEFAULT;
     }
 
     public void setTimeZone(TimeZone timeZone)
     {
         _timeZone = timeZone;
         clearInitialState();
     }
 
     public boolean isTransient()
     {
         return _transient;
     }
 
     public void setTransient(boolean aTransient)
     {
         _transient = aTransient;
     }
 
     /**
      * Specifies whether the date, time, or both should be 
      * parsed/formatted.  Values include:  date, time, and both.
      * Default based on setting of timeStyle and dateStyle.
      * 
      */
     @JSFProperty
     public String getType()
     {
         return _type != null ? _type : TYPE_DATE;
     }
 
     public void setType(String type)
     {
         //TODO: validate type
         _type = type;
         clearInitialState();
     }
     
     private boolean _initialStateMarked = false;
 
     public void clearInitialState()
     {
         _initialStateMarked = false;
     }
 
     public boolean initialStateMarked()
     {
         return _initialStateMarked;
     }
 
     public void markInitialState()
     {
         _initialStateMarked = true;
     }
 }

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.convert;
20
21		import java.text.DateFormat;
22		import java.text.ParseException;
23		import java.text.SimpleDateFormat;
24		import java.util.Date;
25		import java.util.Locale;
26		import java.util.TimeZone;
27
28		import javax.faces.component.PartialStateHolder;
29		import javax.faces.component.UIComponent;
30		import javax.faces.context.FacesContext;
31
32		import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFConverter;
33		import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFJspProperty;
34		import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
35
36		/**
37		* This tag associates a date time converter with the nearest parent UIComponent.
38		*
39		* Unless otherwise specified, all attributes accept static values or EL expressions.
40		*
41		* see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
42		*
43		* @author Thomas Spiegl (latest modification by $Author: lu4242 $)
44		* @version $Revision: 881558 $ $Date: 2009-11-17 16:55:58 -0500 (Tue, 17 Nov 2009) $
45		*/
46		@JSFConverter(
47		name="f:convertDateTime",
48		bodyContent="empty",
49		tagClass="org.apache.myfaces.taglib.core.ConvertDateTimeTag")
50		@JSFJspProperty(
51		name="binding",
52		returnType = "javax.faces.convert.DateTimeConverter",
53		longDesc = "A ValueExpression that evaluates to a DateTimeConverter.")
54		public class DateTimeConverter
55		implements Converter, PartialStateHolder
56		{
57
58		// API field
59		public static final String CONVERTER_ID = "javax.faces.DateTime";
60		public static final String DATE_ID = "javax.faces.converter.DateTimeConverter.DATE";
61		public static final String DATETIME_ID = "javax.faces.converter.DateTimeConverter.DATETIME";
62		public static final String STRING_ID = "javax.faces.converter.STRING";
63		public static final String TIME_ID = "javax.faces.converter.DateTimeConverter.TIME";
64
65		// internal constants
66		private static final String TYPE_DATE = "date";
67		private static final String TYPE_TIME = "time";
68		private static final String TYPE_BOTH = "both";
69		private static final String STYLE_DEFAULT = "default";
70		private static final String STYLE_MEDIUM = "medium";
71		private static final String STYLE_SHORT = "short";
72		private static final String STYLE_LONG = "long";
73		private static final String STYLE_FULL = "full";
74	0	private static final TimeZone TIMEZONE_DEFAULT = TimeZone.getTimeZone("GMT");
75
76		private String _dateStyle;
77		private Locale _locale;
78		private String _pattern;
79		private String _timeStyle;
80		private TimeZone _timeZone;
81		private String _type;
82		private boolean _transient;
83
84		// CONSTRUCTORS
85		public DateTimeConverter()
86	0	{
87	0	}
88
89		// METHODS
90		public Object getAsObject(FacesContext facesContext, UIComponent uiComponent, String value)
91		{
92	0	if (facesContext == null) throw new NullPointerException("facesContext");
93	0	if (uiComponent == null) throw new NullPointerException("uiComponent");
94
95	0	if (value != null)
96		{
97	0	value = value.trim();
98	0	if (value.length() > 0)
99		{
100	0	DateFormat format = getDateFormat();
101	0	TimeZone tz = getTimeZone();
102	0	if( tz != null )
103	0	format.setTimeZone( tz );
104		try
105		{
106	0	return format.parse(value);
107		}
108	0	catch (ParseException e)
109		{
110	0	String type = getType();
111	0	Object[] args = new Object[]{value,format.format(new Date()),_MessageUtils.getLabel(facesContext, uiComponent)};
112
113	0	if(type.equals(TYPE_DATE))
114	0	throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,DATE_ID,args));
115	0	else if (type.equals(TYPE_TIME))
116	0	throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,TIME_ID,args));
117	0	else if (type.equals(TYPE_BOTH))
118	0	throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,DATETIME_ID,args));
119		else
120	0	throw new ConverterException("invalid type '" + _type + "'");
121		}
122		}
123		}
124	0	return null;
125		}
126
127		public String getAsString(FacesContext facesContext, UIComponent uiComponent, Object value)
128		{
129	0	if (facesContext == null) throw new NullPointerException("facesContext");
130	0	if (uiComponent == null) throw new NullPointerException("uiComponent");
131
132	0	if (value == null)
133		{
134	0	return "";
135		}
136	0	if (value instanceof String)
137		{
138	0	return (String)value;
139		}
140
141	0	DateFormat format = getDateFormat();
142	0	TimeZone tz = getTimeZone();
143	0	if (tz != null)
144		{
145	0	format.setTimeZone(tz);
146		}
147		try
148		{
149	0	return format.format(value);
150		}
151	0	catch (Exception e)
152		{
153	0	throw new ConverterException(_MessageUtils.getErrorMessage(facesContext, STRING_ID, new Object[]{value,_MessageUtils.getLabel(facesContext, uiComponent)}),e);
154		}
155		}
156
157		private DateFormat getDateFormat()
158		{
159	0	String type = getType();
160		DateFormat format;
161	0	if (_pattern != null)
162		{
163		try
164		{
165	0	format = new SimpleDateFormat(_pattern, getLocale());
166		}
167	0	catch (IllegalArgumentException iae)
168		{
169	0	throw new ConverterException("Invalid pattern", iae);
170	0	}
171		}
172	0	else if (type.equals(TYPE_DATE))
173		{
174	0	format = DateFormat.getDateInstance(calcStyle(getDateStyle()), getLocale());
175		}
176	0	else if (type.equals(TYPE_TIME))
177		{
178	0	format = DateFormat.getTimeInstance(calcStyle(getTimeStyle()), getLocale());
179		}
180	0	else if (type.equals(TYPE_BOTH))
181		{
182	0	format = DateFormat.getDateTimeInstance(calcStyle(getDateStyle()),
183		calcStyle(getTimeStyle()),
184		getLocale());
185		}
186		else
187		{
188	0	throw new ConverterException("invalid type '" + _type + "'");
189		}
190
191		// format cannot be lenient (JSR-127)
192	0	format.setLenient(false);
193	0	return format;
194		}
195
196		private int calcStyle(String name)
197		{
198	0	if (name.equals(STYLE_DEFAULT))
199		{
200	0	return DateFormat.DEFAULT;
201		}
202	0	if (name.equals(STYLE_MEDIUM))
203		{
204	0	return DateFormat.MEDIUM;
205		}
206	0	if (name.equals(STYLE_SHORT))
207		{
208	0	return DateFormat.SHORT;
209		}
210	0	if (name.equals(STYLE_LONG))
211		{
212	0	return DateFormat.LONG;
213		}
214	0	if (name.equals(STYLE_FULL))
215		{
216	0	return DateFormat.FULL;
217		}
218
219	0	throw new ConverterException("invalid style '" + name + "'");
220		}
221
222		// STATE SAVE/RESTORE
223		public void restoreState(FacesContext facesContext, Object state)
224		{
225	0	if (state != null)
226		{
227	0	Object[] values = (Object[])state;
228	0	_dateStyle = (String)values[0];
229	0	_locale = (Locale)values[1];
230	0	_pattern = (String)values[2];
231	0	_timeStyle = (String)values[3];
232	0	_timeZone = (TimeZone)values[4];
233	0	_type = (String)values[5];
234		}
235	0	}
236
237		public Object saveState(FacesContext facesContext)
238		{
239	0	if (!initialStateMarked())
240		{
241	0	Object[] values = new Object[6];
242	0	values[0] = _dateStyle;
243	0	values[1] = _locale;
244	0	values[2] = _pattern;
245	0	values[3] = _timeStyle;
246	0	values[4] = _timeZone;
247	0	values[5] = _type;
248	0	return values;
249		}
250	0	return null;
251		}
252
253		// GETTER & SETTER
254
255		/**
256		* The style of the date. Values include: default, short, medium,
257		* long, and full.
258		*
259		*/
260		@JSFProperty
261		public String getDateStyle()
262		{
263	0	return _dateStyle != null ? _dateStyle : STYLE_DEFAULT;
264		}
265
266		public void setDateStyle(String dateStyle)
267		{
268		//TODO: validate timeStyle
269	0	_dateStyle = dateStyle;
270	0	clearInitialState();
271	0	}
272
273		/**
274		* The name of the locale to be used, instead of the default.
275		*
276		*/
277		@JSFProperty
278		public Locale getLocale()
279		{
280	0	if (_locale != null) return _locale;
281	0	FacesContext context = FacesContext.getCurrentInstance();
282	0	return context.getViewRoot().getLocale();
283		}
284
285		public void setLocale(Locale locale)
286		{
287	0	_locale = locale;
288	0	clearInitialState();
289	0	}
290
291		/**
292		* A custom Date formatting pattern, in the format used by java.text.SimpleDateFormat.
293		*
294		*/
295		@JSFProperty
296		public String getPattern()
297		{
298	0	return _pattern;
299		}
300
301		public void setPattern(String pattern)
302		{
303	0	_pattern = pattern;
304	0	clearInitialState();
305	0	}
306
307		/**
308		* The style of the time. Values include: default, short, medium, long,
309		* and full.
310		*
311		*/
312		@JSFProperty
313		public String getTimeStyle()
314		{
315	0	return _timeStyle != null ? _timeStyle : STYLE_DEFAULT;
316		}
317
318		public void setTimeStyle(String timeStyle)
319		{
320		//TODO: validate timeStyle
321	0	_timeStyle = timeStyle;
322	0	clearInitialState();
323	0	}
324
325		/**
326		* The time zone to use instead of GMT (the default timezone). When
327		* this value is a value-binding to a TimeZone instance, that
328		* timezone is used. Otherwise this value is treated as a String
329		* containing a timezone id, ie as the ID parameter of method
330		* java.util.TimeZone.getTimeZone(String).
331		*
332		*/
333		@JSFProperty
334		public TimeZone getTimeZone()
335		{
336	0	return _timeZone != null ? _timeZone : TIMEZONE_DEFAULT;
337		}
338
339		public void setTimeZone(TimeZone timeZone)
340		{
341	0	_timeZone = timeZone;
342	0	clearInitialState();
343	0	}
344
345		public boolean isTransient()
346		{
347	0	return _transient;
348		}
349
350		public void setTransient(boolean aTransient)
351		{
352	0	_transient = aTransient;
353	0	}
354
355		/**
356		* Specifies whether the date, time, or both should be
357		* parsed/formatted. Values include: date, time, and both.
358		* Default based on setting of timeStyle and dateStyle.
359		*
360		*/
361		@JSFProperty
362		public String getType()
363		{
364	0	return _type != null ? _type : TYPE_DATE;
365		}
366
367		public void setType(String type)
368		{
369		//TODO: validate type
370	0	_type = type;
371	0	clearInitialState();
372	0	}
373
374	0	private boolean _initialStateMarked = false;
375
376		public void clearInitialState()
377		{
378	0	_initialStateMarked = false;
379	0	}
380
381		public boolean initialStateMarked()
382		{
383	0	return _initialStateMarked;
384		}
385
386		public void markInitialState()
387		{
388	0	_initialStateMarked = true;
389	0	}
390		}