no.g9.client.core.view.faces

Class DateConverter

java.lang.Object

javax.faces.convert.DateTimeConverter

no.g9.client.core.view.faces.DateConverter

All Implemented Interfaces:

javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.convert.Converter, G9Converter

public class DateConverter
extends javax.faces.convert.DateTimeConverter
implements G9Converter

The Class DateConverter is a custom DateTimeConverter which handles G9 display rules.

The getAsObject() method parses a String into a java.util.Date, according to the following algorithm:

• If the specified String is null, return a null. Otherwise, trim leading and trailing whitespace before proceeding.
• If the specified String - after trimming - has a zero length, return null.
• If the locale property is not null, use that Locale for managing parsing. Otherwise, use the Locale from the UIViewRoot.
• If a displayRule has been specified, its syntax must conform the rules specified by java.text.SimpleDateFormat. Such a displayRule will be used to parse, and the type, dateStyle, and timeStyle properties will be ignored.
• If a displayRule has not been specified, parsing will be based on the type property, which expects a date value, a time value, or both. Any date and time values included will be parsed in accordance to the styles specified by dateStyle and timeStyle, respectively.
• If a timezone has been specified, it must be passed to the underlying DateFormat instance. Otherwise the "GMT" timezone is used.
• In all cases, parsing must be non-lenient; the given string must strictly adhere to the parsing format.

The getAsString() method expects a value of type java.util.Date (or a subclass), and creates a formatted String according to the following algorithm:

• If the specified value is null, return a zero-length String.
• If the specified value is a String, return it unmodified.
• If the locale property is not null, use that Locale for managing formatting. Otherwise, use the Locale from the UIViewRoot.
• If a timezone has been specified, it must be passed to the underlying DateFormat instance. Otherwise the "GMT" timezone is used.
• If a displayRule has been specified, its syntax must conform the rules specified by java.text.SimpleDateFormat. Such a displayRule will be used to format, and the dataType, dateStyle, and timeStyle properties will be ignored.
• If a displayRule has not been specified, formatting will be based on the dataType property, which includes a date value, a time value, or both into the formatted String. Any date and time values included will be formatted in accordance to the styles specified by dateStyle and timeStyle, respectively.

Field Summary

Fields inherited from class javax.faces.convert.DateTimeConverter

CONVERTER_ID, DATE_ID, DATETIME_ID, STRING_ID, TIME_ID

Fields inherited from interface javax.faces.convert.Converter

DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
DateConverter() Create a new G9 date converter.

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String value) Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Apply Request Values phase of the request processing life cycle.
String	getAsString(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value)
String	getDataType()
String	getDisplayRule()
String	getTitle()
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setDataType(String dataType)
void	setDisplayRule(String displayRule) Set the format displayRule to be used when formatting and parsing dates and times.
void	setTitle(String title)

Methods inherited from class javax.faces.convert.DateTimeConverter

clearInitialState, getDateStyle, getLocale, getPattern, getTimeStyle, getTimeZone, getType, initialStateMarked, isTransient, markInitialState, setDateStyle, setLocale, setPattern, setTimeStyle, setTimeZone, setTransient, setType

Methods inherited from class java.lang.Object

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

Constructor Detail

DateConverter

public DateConverter()

Create a new G9 date converter. Sets the converter time zone to the current default time zone.

Method Detail

getAsObject

public Object getAsObject(javax.faces.context.FacesContext context,
                          javax.faces.component.UIComponent component,
                          String value)

Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Apply Request Values phase of the request processing life cycle.

Specified by:

getAsObject in interface javax.faces.convert.Converter

Overrides:

getAsObject in class javax.faces.convert.DateTimeConverter

See Also:

DateTimeConverter.getAsObject(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.String)

getAsString

public String getAsString(javax.faces.context.FacesContext context,
                          javax.faces.component.UIComponent component,
                          Object value)

Specified by:

getAsString in interface javax.faces.convert.Converter

Overrides:

getAsString in class javax.faces.convert.DateTimeConverter

setDisplayRule

public void setDisplayRule(String displayRule)

Set the format displayRule to be used when formatting and parsing dates and times. Valid values are those supported by java.text.SimpleDateFormat. An invalid value will cause a ConverterException when getAsObject() or getAsString() is called.

Specified by:

setDisplayRule in interface G9Converter

Parameters:

displayRule - The new format displayRule

setDataType

public void setDataType(String dataType)

Specified by:

setDataType in interface G9Converter

Parameters:

dataType - the data type to set

getDataType

public String getDataType()

Specified by:

getDataType in interface G9Converter

Returns:

the data type

getDisplayRule

public String getDisplayRule()

Specified by:

getDisplayRule in interface G9Converter

Returns:

the display rule

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface G9Converter

Parameters:

title - the title to set

getTitle

public String getTitle()

Specified by:

getTitle in interface G9Converter

Returns:

the title

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.convert.DateTimeConverter

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.convert.DateTimeConverter