jidefx.utils.converter

Class AbstractDateConverter<T>

java.lang.Object

javafx.util.StringConverter<T>

jidefx.utils.converter.DefaultObjectConverter<T>

jidefx.utils.converter.AbstractDateConverter<T>

All Implemented Interfaces:

ObjectConverter<T>

Direct Known Subclasses:

CalendarConverter, DateConverter, NumberDateConverter

public abstract class AbstractDateConverter<T>
extends DefaultObjectConverter<T>

ObjectConverter implementation for <code>Date</code>, <code>Calendar</code> or <code>Number</code>. All of aforementioned data types can be accepted by the toString method. For the fromString method, it will only return <code>Date</code>. Its subclasses might return Calendar or Number.

Field Summary

Fields

Modifier and Type	Field and Description
static ConverterContext	CONTEXT_DATE A converter context to tell the DateConverter using a DateFormat from SimpleDateFormat.getDateInstance to do the conversion.
static ConverterContext	CONTEXT_DATETIME A converter context to tell the DateConverter using a DateFormat from SimpleDateFormat.getDateTimeInstance to do the conversion.
static ConverterContext	CONTEXT_TIME A converter context to tell the DateConverter using a DateFormat from SimpleDateFormat.getTimeInstance to do the conversion.
static java.lang.String	PROPERTY_DATE_FORMAT A property for the converter context.

Constructor Summary

Constructors

Constructor and Description
AbstractDateConverter() Creates a DateConverter.

Method Summary

Modifier and Type	Method and Description
java.lang.String	anyDateToString(java.lang.Object object, ConverterContext context) Converts the object to String.
java.lang.Object	fromStringToDate(java.lang.String string, ConverterContext context) Converts from a String to a Date.
java.text.DateFormat	getDefaultDateFormat() Gets the default format for date.
java.text.DateFormat	getDefaultDateTimeFormat() Gets the default format for date/time.
java.text.DateFormat	getDefaultTimeFormat() Gets the default format for time.
void	setDefaultDateFormat(java.text.DateFormat defaultDateFormat) Sets the default format to format date.
void	setDefaultDateTimeFormat(java.text.DateFormat defaultDateTimeFormat) Sets the default format to format date/time.
void	setDefaultTimeFormat(java.text.DateFormat defaultTimeFormat) Sets the default format to format time.

Methods inherited from class jidefx.utils.converter.DefaultObjectConverter

fromString, fromString, getObjectConverterManager, toString, toString, toStringConverter

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_DATETIME

public static final ConverterContext CONTEXT_DATETIME

A converter context to tell the DateConverter using a DateFormat from SimpleDateFormat.getDateTimeInstance to do the conversion.

CONTEXT_TIME

public static final ConverterContext CONTEXT_TIME

A converter context to tell the DateConverter using a DateFormat from SimpleDateFormat.getTimeInstance to do the conversion.

CONTEXT_DATE

public static final ConverterContext CONTEXT_DATE

A converter context to tell the DateConverter using a DateFormat from SimpleDateFormat.getDateInstance to do the conversion. It is the same as using CONTEXT_DEFAULT.

PROPERTY_DATE_FORMAT

public static final java.lang.String PROPERTY_DATE_FORMAT

A property for the converter context. You can set a <code>DateFormat</code> to it and the converter will use it to do the conversion.

See Also:

Constant Field Values

Constructor Detail

AbstractDateConverter

public AbstractDateConverter()

Creates a DateConverter.

Method Detail

anyDateToString

public java.lang.String anyDateToString(java.lang.Object object,
                                        ConverterContext context)

Converts the object to String. The object can be a Calendar, a Date or a Number. As long as the DateFormat can format it correctly, it will be converted to a String. If the object is already a String, we will return it directly as it is.

Parameters:

object - the object to be converted

context - the converter context.

Returns:

the string

fromStringToDate

public java.lang.Object fromStringToDate(java.lang.String string,
                                         ConverterContext context)

Converts from a String to a Date. It will use the DateFormat defined as PROPERTY_DATE_FORMAT if any. Otherwise it will try different default DateFormat according to the context (Date, Time or DateTime). At last it will try the following commonly used format patterns in order of "M/d/yyyy", "MM/dd/yyyy", "yyyy-MM-dd", "yy-MM-dd", "yyyyMMdd", "yyMMdd", "dd-MMM-yy", "dd-MMM-yyyy", until it finds a match. We do that so that users could type in other date formats and still could be recognized.

Parameters:

string - the string to be converted.

context - the context.

Returns:

the Date. If the string is null or empty, null will be returned. If the string cannot be parsed as a date, the string itself will be returned.

getDefaultDateFormat

public java.text.DateFormat getDefaultDateFormat()

Gets the default format for date. This is used only when context is CONTEXT_DATE.

Returns:

the default format for date.

setDefaultDateFormat

public void setDefaultDateFormat(java.text.DateFormat defaultDateFormat)

Sets the default format to format date. This is used only when context is CONTEXT_DATE.

Parameters:

defaultDateFormat - the new default format for date.

getDefaultTimeFormat

public java.text.DateFormat getDefaultTimeFormat()

Gets the default format for time. This is used only when context is CONTEXT_TIME.

Returns:

the default format for time.

setDefaultTimeFormat

public void setDefaultTimeFormat(java.text.DateFormat defaultTimeFormat)

Sets the default format to format time. This is used only when context is CONTEXT_TIME.

Parameters:

defaultTimeFormat - the new default format for time.

getDefaultDateTimeFormat

public java.text.DateFormat getDefaultDateTimeFormat()

Gets the default format for date/time. This is used only when context is CONTEXT_DATETIME.

Returns:

the default format for date/time.

setDefaultDateTimeFormat

public void setDefaultDateTimeFormat(java.text.DateFormat defaultDateTimeFormat)

Sets the default format to format date/time. This is used only when context is CONTEXT_DATETIME.

Parameters:

defaultDateTimeFormat - the new default format for date/time.