ilog.views.util.text

Class IlvDateFormat

java.lang.Object

java.text.Format

java.text.DateFormat

ilog.views.util.text.IlvDateFormat

All Implemented Interfaces:

Serializable, Cloneable

public class IlvDateFormat
extends DateFormat

IlvDateFormat is a compatible replacement for the standard SimpleDateFormat class. It automatically uses ICU SimpleDateFormat when appropriate (namely, in a Polish locale or when the format pattern includes pattern characters like e for the day in the week). It also automatically detects if the FastDateFormat class from the Jakarta Commons Lang package is on the classpath. If so, IlvDateFormat transparently takes advantage of this and provides a significant speed improvement for formatted output. Although you can directly create instances of IlvDateFormat, you can achieve even better performance by creating instances via IlvDateFormatFactory. This factory implements caching techniques to improve the speed of creating format instances.

IlvDateFormat is compatible with the formatting styles of DateFormat and with the formatting patterns of SimpleDateFormat and com.ibm.icu.text.SimpleDateFormat. However, some this class's speed improvements derive from the fact that it treats certain attributes as immutable, in contrast to its DateFormat superclass. The following attributes of IlvDateFormat are immutable and attempting to change their value will result in an UnsupportedOperationException:

• setCalendar(java.util.Calendar)
• setTimeZone(java.util.TimeZone)
• setNumberFormat(java.text.NumberFormat)

Since:

JViews 7.5

See Also:

IlvDateFormatFactory, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.DateFormat

DateFormat.Field

Field Summary

Fields inherited from class java.text.DateFormat

AM_PM_FIELD, calendar, DATE_FIELD, DAY_OF_WEEK_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD, DAY_OF_YEAR_FIELD, DEFAULT, ERA_FIELD, FULL, HOUR_OF_DAY0_FIELD, HOUR_OF_DAY1_FIELD, HOUR0_FIELD, HOUR1_FIELD, LONG, MEDIUM, MILLISECOND_FIELD, MINUTE_FIELD, MONTH_FIELD, numberFormat, SECOND_FIELD, SHORT, TIMEZONE_FIELD, WEEK_OF_MONTH_FIELD, WEEK_OF_YEAR_FIELD, YEAR_FIELD

Constructor Summary

Constructors

Constructor and Description
IlvDateFormat(int dateStyle, int timeStyle, Locale locale, TimeZone timeZone) Deprecated. This method ignores the calendar specification in the ULocale. Please use IlvDateFormat(int, int, ULocale, TimeZone) instead.
IlvDateFormat(int dateStyle, int timeStyle, ULocale locale, TimeZone timeZone) Returns a formatter with the given date and time styles for the given locale and timezone.
IlvDateFormat(String pattern, ULocale locale, TimeZone timeZone) Creates a date/time formatter using the specified pattern for the given locale and timezone.
IlvDateFormat(ULocale locale) Creates a default date/time formatter that uses the DateFormat.SHORT style for both the date and the time in the given locale and the default timezone.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Returns whether an object is logically equal to this date format.
StringBuffer	format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) Formats a date into a date/time string.
Calendar	getCalendar() Returns the calendar associated with this date/time formatter.
Locale	getLocale() Returns the locale.
NumberFormat	getNumberFormat() Returns the number formatter which this date/time formatter uses to format and parse a time.
TimeZone	getTimeZone() Returns the time zone.
ULocale	getULocale() Returns the locale.
int	hashCode() Returns a hashcode for this format.
boolean	isLenient() Returns whether date/time parsing is lenient.
Date	parse(String source, ParsePosition pos) Parses text from a string to produce a Date.
static void	registerPreferenceForICU(String language) Registers a preference for ICU based formatting instead of JRE based formatting for the given language.
void	setCalendar(Calendar calendar) Sets the calendar to be used by this date format.
void	setLenient(boolean lenient) Specifies whether or not date/time parsing is to be lenient.
void	setNumberFormat(NumberFormat numberFormat) Sets the number formatter.
void	setTimeZone(TimeZone zone) Sets the time zone for the calendar of this DateFormat object.
String	toPattern() Returns a SimpleDateFormat or com.ibm.icu.text.SimpleDateFormat compatible pattern string describing this date format.

Methods inherited from class java.text.DateFormat

clone, format, format, getAvailableLocales, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getTimeInstance, getTimeInstance, getTimeInstance, parse, parseObject

Methods inherited from class java.text.Format

format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvDateFormat

public IlvDateFormat(ULocale locale)

Creates a default date/time formatter that uses the DateFormat.SHORT style for both the date and the time in the given locale and the default timezone.

Since:

JViews 8.8

IlvDateFormat

public IlvDateFormat(String pattern,
                     ULocale locale,
                     TimeZone timeZone)

Creates a date/time formatter using the specified pattern for the given locale and timezone.

Parameters:

pattern - A SimpleDateFormat or com.ibm.icu.text.SimpleDateFormat compatible pattern.

locale - The locale or null for the default locale.

timeZone - The timezone or null for the default timezone.

Throws:

IllegalArgumentException - if the pattern is invalid.

Since:

JViews 8.8

IlvDateFormat

@Deprecated
public IlvDateFormat(int dateStyle,
                                 int timeStyle,
                                 Locale locale,
                                 TimeZone timeZone)

Deprecated. This method ignores the calendar specification in the ULocale. Please use IlvDateFormat(int, int, ULocale, TimeZone) instead.

Returns a formatter with the given date and time styles for the given locale and timezone.

Parameters:

dateStyle - The date style. The value must be one of DateFormat.SHORT, DateFormat.MEDIUM, DateFormat.LONG, DateFormat.FULL, DateFormat.DEFAULT, or -1. If -1, then a time formatter is created and dates will not be formatted. For example, use DateFormat.SHORT for "M/d/yy" in the US locale.

timeStyle - The time style. The value must be one of DateFormat.SHORT, DateFormat.MEDIUM, DateFormat.LONG, DateFormat.FULL, DateFormat.DEFAULT, or -1. If -1, then a date formatter is created and times will not be formatted. For example, use DateFormat.SHORT for "h:mm a" in the US locale.

locale - The locale or null for the default locale.

timeZone - The timezone or null for the default timezone.

IlvDateFormat

public IlvDateFormat(int dateStyle,
                     int timeStyle,
                     ULocale locale,
                     TimeZone timeZone)

Returns a formatter with the given date and time styles for the given locale and timezone.

Parameters:

dateStyle - The date style. The value must be one of DateFormat.SHORT, DateFormat.MEDIUM, DateFormat.LONG, DateFormat.FULL, DateFormat.DEFAULT, or -1. If -1, then a time formatter is created and dates will not be formatted. For example, use DateFormat.SHORT for "M/d/yy" in the US locale.

timeStyle - The time style. The value must be one of DateFormat.SHORT, DateFormat.MEDIUM, DateFormat.LONG, DateFormat.FULL, DateFormat.DEFAULT, or -1. If -1, then a date formatter is created and times will not be formatted. For example, use DateFormat.SHORT for "h:mm a" in the US locale.

locale - The locale or null for the default locale.

timeZone - The timezone or null for the default timezone.

Since:

JViews 8.8

Method Detail

registerPreferenceForICU

public static void registerPreferenceForICU(String language)

Registers a preference for ICU based formatting instead of JRE based formatting for the given language.

Parameters:

language - An ISO 639 language code.

Since:

JViews 8.8

format

public StringBuffer format(Date date,
                           StringBuffer toAppendTo,
                           FieldPosition fieldPosition)

Formats a date into a date/time string.

Specified by:

format in class DateFormat

Parameters:

date - The date to be formatted.

toAppendTo - The buffer to append the formatted string.

fieldPosition - This parameter is ignored.

Returns:

The buffer passed in with the formatted date/time appended.

parse

public Date parse(String source,
                  ParsePosition pos)

Parses text from a string to produce a Date. This method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index of pos is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed date is returned. The updated pos can be used to indicate the starting point for the next call to this method. If an error occurs, then the index of pos is not changed, the error index of pos is set to the index of the character where the error occurred, and null is returned.

Specified by:

parse in class DateFormat

Parameters:

source - The source text, part of which should be parsed.

pos - A ParsePosition object with index and error index information as described above.

Returns:

A Date parsed from the string. In case of error, returns null or throws a NumberFormatException.

getLocale

public Locale getLocale()

Returns the locale.

Returns:

The locale of this format.

getULocale

public ULocale getULocale()

Returns the locale.

Returns:

The locale of this format.

Since:

JViews 8.8

toPattern

public String toPattern()

Returns a SimpleDateFormat or com.ibm.icu.text.SimpleDateFormat compatible pattern string describing this date format.

Returns:

A pattern string describing this date format.

setCalendar

public void setCalendar(Calendar calendar)

Sets the calendar to be used by this date format. This method throws an UnsupportedOperationException because IlvDateFormat objects consider the calendar to be immutable.

Overrides:

setCalendar in class DateFormat

Parameters:

calendar - The new calendar to be used by the date format.

Throws:

UnsupportedOperationException - because IlvDateFormat objects consider the calendar to be immutable.

getCalendar

public Calendar getCalendar()

Returns the calendar associated with this date/time formatter.

Overrides:

getCalendar in class DateFormat

Returns:

The calendar associated with this date/time formatter.

setNumberFormat

public void setNumberFormat(NumberFormat numberFormat)

Sets the number formatter. This method throws an UnsupportedOperationException because IlvDateFormat objects consider the number format to be immutable.

Overrides:

setNumberFormat in class DateFormat

Parameters:

numberFormat - The new number format.

Throws:

UnsupportedOperationException - because IlvDateFormat objects consider the number format to be immutable.

getNumberFormat

public NumberFormat getNumberFormat()

Returns the number formatter which this date/time formatter uses to format and parse a time.

Overrides:

getNumberFormat in class DateFormat

Returns:

The number formatter.

setTimeZone

public void setTimeZone(TimeZone zone)

Sets the time zone for the calendar of this DateFormat object. This method throws an UnsupportedOperationException because IlvDateFormat objects consider the timezone to be immutable.

Overrides:

setTimeZone in class DateFormat

Parameters:

zone - The new time zone.

Throws:

UnsupportedOperationException - because IlvDateFormat objects consider the timezone to be immutable.

getTimeZone

public TimeZone getTimeZone()

Returns the time zone.

Overrides:

getTimeZone in class DateFormat

Returns:

The time of this format.

setLenient

public void setLenient(boolean lenient)

Specifies whether or not date/time parsing is to be lenient. With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match this object's format. With strict parsing, inputs must match this object's format.

Overrides:

setLenient in class DateFormat

Parameters:

lenient - Indicates whether parsing is lenient.

isLenient

public boolean isLenient()

Returns whether date/time parsing is lenient.

Overrides:

isLenient in class DateFormat

Returns:

Indicates whether date/time parsing is lenient.

equals

public boolean equals(Object obj)

Returns whether an object is logically equal to this date format.

Overrides:

equals in class DateFormat

Parameters:

obj - The object to compare with.

Returns:

true if the object is equal to this format; false otherwise.

hashCode

public int hashCode()

Returns a hashcode for this format.

Overrides:

hashCode in class DateFormat

Returns:

A hash code value..