org.eclipse.birt.core.format

Class DateFormatter

java.lang.Object

org.eclipse.birt.core.format.DateFormatter

All Implemented Interfaces:

IFormatter

public class DateFormatter
extends java.lang.Object
implements IFormatter

DateFormatter. Design for Class DateFormatter.This version is for open source, so we only apply the function which Java has provided. Beside these basic function, in this version, we also provide some new API for further implementation in the future

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.birt.core.format.IFormatter

IFormatter.DefaultFormatter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATE_UNFORMATTED
static java.lang.String	DATETIME_UNFORMATTED
protected static java.util.logging.Logger	logger logger used to log syntax errors.
static java.lang.String	TIME_UNFORMATTED

Constructor Summary

Constructors

Constructor and Description
DateFormatter() constuctor method with no paremeter
DateFormatter(java.lang.String pattern, ULocale localeLoc) constuctor method with two parameters, one is String type while the other is Locale type
DateFormatter(java.lang.String pattern, ULocale localeLoc, TimeZone timeZone)
DateFormatter(TimeZone timeZone)
DateFormatter(ULocale localeLoc) constuctor method with Locale parameters
DateFormatter(ULocale localeLoc, TimeZone timeZone)

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPattern(java.lang.String formatString)
java.lang.String	format(java.util.Date date)
java.lang.String	formatValue(java.lang.Object value) format the value object into a string.
java.lang.String	getFormatCode() Returns format code according to format type and current locale
SimpleDateFormat	getFormatter() Returns format code according to format type and current locale
java.lang.String	getLocalizedFormatCode() Returns format code according to format type and current locale
java.lang.String	getPattern() get the string pattern
java.util.Date	parse(java.lang.String date) Parses the input string into a formatted date type.

Methods inherited from class java.lang.Object

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

Field Detail

DATETIME_UNFORMATTED

public static final java.lang.String DATETIME_UNFORMATTED

See Also:

Constant Field Values

DATE_UNFORMATTED

public static final java.lang.String DATE_UNFORMATTED

See Also:

Constant Field Values

TIME_UNFORMATTED

public static final java.lang.String TIME_UNFORMATTED

See Also:

Constant Field Values

logger

protected static java.util.logging.Logger logger

logger used to log syntax errors.

Constructor Detail

DateFormatter

public DateFormatter()

constuctor method with no paremeter

DateFormatter

public DateFormatter(TimeZone timeZone)

DateFormatter

public DateFormatter(ULocale localeLoc)

constuctor method with Locale parameters

Parameters:

localeLoc -

DateFormatter

public DateFormatter(ULocale localeLoc,
             TimeZone timeZone)

DateFormatter

public DateFormatter(java.lang.String pattern,
             ULocale localeLoc)

constuctor method with two parameters, one is String type while the other is Locale type

Parameters:

pattern -

localeLoc -

DateFormatter

public DateFormatter(java.lang.String pattern,
             ULocale localeLoc,
             TimeZone timeZone)

Method Detail

getPattern

public java.lang.String getPattern()

get the string pattern

Returns:

applyPattern

public void applyPattern(java.lang.String formatString)

format

public java.lang.String format(java.util.Date date)

getFormatCode

public java.lang.String getFormatCode()

Returns format code according to format type and current locale

getLocalizedFormatCode

public java.lang.String getLocalizedFormatCode()

Returns format code according to format type and current locale

getFormatter

public SimpleDateFormat getFormatter()

Returns format code according to format type and current locale

parse

public java.util.Date parse(java.lang.String date)
                     throws java.text.ParseException

Parses the input string into a formatted date type.

Parameters:

date - the input string to parse

Returns:

the formatted date

Throws:

java.text.ParseException - if the beginning of the specified string cannot be parsed.

formatValue

public java.lang.String formatValue(java.lang.Object value)

Description copied from interface: IFormatter

format the value object into a string.

Specified by:

formatValue in interface IFormatter

Returns: