This project has retired. For details please refer to its Attic page.

org.apache.cocoon.woody.datatype.convertor
Class FormattingDateConvertor

java.lang.Object
  org.apache.cocoon.woody.datatype.convertor.FormattingDateConvertor

All Implemented Interfaces:

Convertor

public class FormattingDateConvertor
extends Object
implements Convertor

A Convertor for Date objects backed by the SimpleDateFormat class.

It can be configured to use one of three variants: date, time or datetime and one of four styles: long, full, medium or short.

Alternatively, a formatting pattern can be used. This can either be a locale-dependent or locale-independent formatting pattern. When looking up a formatting pattern, a mechansim similar to resource bundle lookup is used. Suppose the locale is nl-BE, then first a formatting pattern for nl-BE will be sought, then one for nl, and if that is not found, finally the locale-independent formatting pattern will be used.

NOTE: the earlier statement about the fact that this class uses java.text.SimpleDateFormat is not entirely correct. In fact, it uses a small wrapper class that will either delegate to java.text.SimpleDateFormat or com.ibm.icu.text.SimpleDateFormat. The com.ibm version will automatically be used if it is present on the classpath, otherwise the java.text version will be used.

Version:

CVS $Id: FormattingDateConvertor.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cocoon.woody.datatype.convertor.Convertor

Convertor.FormatCache

Field Summary

static int	DATE
static int	DATE_TIME
static int	TIME

Constructor Summary

FormattingDateConvertor()

Method Summary

void	addFormattingPattern(Locale locale, String pattern)
Object	convertFromString(String value, Locale locale, Convertor.FormatCache formatCache) Converts string representation into the object of convertor's type.
String	convertToString(Object value, Locale locale, Convertor.FormatCache formatCache)
protected DateFormat	getDateFormat(Locale locale)
Class	getTypeClass()
void	setNonLocalizedPattern(String pattern)
void	setStyle(int style)
void	setVariant(int variant)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATE

public static final int DATE

See Also:

Constant Field Values

TIME

public static final int TIME

See Also:

Constant Field Values

DATE_TIME

public static final int DATE_TIME

See Also:

Constant Field Values

Constructor Detail

FormattingDateConvertor

public FormattingDateConvertor()

Method Detail

convertFromString

public Object convertFromString(String value,
                                Locale locale,
                                Convertor.FormatCache formatCache)

Description copied from interface: Convertor

Converts string representation into the object of convertor's type. Returns null if conversion fails.

Specified by:

convertFromString in interface Convertor

formatCache - can be null if not needed

convertToString

public String convertToString(Object value,
                              Locale locale,
                              Convertor.FormatCache formatCache)

Specified by:

convertToString in interface Convertor

getDateFormat

protected DateFormat getDateFormat(Locale locale)

getTypeClass

public Class getTypeClass()

Specified by:

getTypeClass in interface Convertor

setStyle

public void setStyle(int style)

Parameters:

style - one of the constants FULL, LONG, MEDIUM or SHORT defined in the Date class.

setVariant

public void setVariant(int variant)

addFormattingPattern

public void addFormattingPattern(Locale locale,
                                 String pattern)

setNonLocalizedPattern

public void setNonLocalizedPattern(String pattern)