ca.sandoval.util
Class AbstractFormatter

java.lang.Object
  ca.sandoval.util.AbstractFormatter

Direct Known Subclasses:

Formatter

public abstract class AbstractFormatter
extends java.lang.Object

AbstractFormatter

Version:

29-Mar-2005

Author:

Sandoval Software Solutions Inc.

Field Summary

static java.lang.String	CURRENCYFORMAT_ENG_PRICE
static java.lang.String	CURRENCYFORMAT_FRE_PRICE
static java.lang.String	DATEFORMAT_ddMMMMyyyy
static java.lang.String	DATEFORMAT_ddMMMyyyy
static java.lang.String	DATEFORMAT_EEEEyyyy
static java.lang.String	DATEFORMAT_ENG_EEEEMMMMddyyyy
static java.lang.String	DATEFORMAT_ENG_MMMddEEEE
static java.lang.String	DATEFORMAT_ENG_MMMddyyyy
static java.lang.String	DATEFORMAT_ENG_MMMMdd
static java.lang.String	DATEFORMAT_FRE_EEEEddMMM
static java.lang.String	DATEFORMAT_FRE_EEEEMMMMddyyyy
static java.lang.String	DATEFORMAT_FRE_MMMddEEEE
static java.lang.String	DATEFORMAT_FRE_MMMddyyyy
static java.lang.String	DATEFORMAT_FRE_MMMMdd
static java.lang.String	DATEFORMAT_MMddyyyy
static java.lang.String	DATEFORMAT_MMddyyyy2
static java.lang.String	DATEFORMAT_MMMdd
static java.lang.String	DATEFORMAT_MMMMddyyyy
static java.lang.String	DATEFORMAT_MMMyyyy
static java.lang.String	DATEFORMAT_yyyyMMdd
static java.lang.String	DATETIMEFORMAT
static java.lang.String	DATETIMEFORMAT2
static java.lang.String	DATETIMEFORMAT3
static java.lang.String	DECIMALFORMAT_DECIMAL0
static java.lang.String	DECIMALFORMAT_PRICE
static java.lang.String	TIMEFORMAT

Constructor Summary

AbstractFormatter(java.util.Locale locale)
AbstractFormatter constructor comment.

Method Summary

abstract java.lang.String	formatDate(java.util.Date aDate) Abstract method - formateDate
java.lang.String	formatDateDMY(java.util.Date aDate) formatDateDMY method comment.
java.lang.String	formatDateMD(java.util.Date aDate) formatDateMD method comment.
java.lang.String	formatDateMDY(java.util.Date aDate) formatDateMDY method comment.
abstract java.lang.String	formatDateTime(java.util.Date aDate) formatDateTime method comment.
abstract java.lang.String	formatDecimal(java.math.BigDecimal aNumber, int aNumOfDecimals) Formats transaction units to include only specified number of decimal points.
abstract java.lang.String	formatDecimal(double aNumber, int aNumOfDecimals) Formats transaction unit to include only specified number of decimal points.
abstract java.lang.String	formatDollar(java.math.BigDecimal aDollar) formatDollar method comment.
abstract java.lang.String	formatDollar(double aDollar) formatDollar method comment.
abstract java.lang.String	formatPercent(java.math.BigDecimal aPercent) Formats a BigDecimal percentage value into a percentage (%) format.
abstract java.lang.String	formatPercent(double aPercent) Formats a double percentage value into a percentage (%) format.
abstract java.lang.String	formatTime(java.util.Date aDate) formatTime method comment.
protected java.util.Locale	getLocale() getLocale method comment.

Methods inherited from class java.lang.Object

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

Field Detail

DATEFORMAT_ddMMMMyyyy

public static final java.lang.String DATEFORMAT_ddMMMMyyyy

See Also:

Constant Field Values

DATEFORMAT_ENG_EEEEMMMMddyyyy

public static final java.lang.String DATEFORMAT_ENG_EEEEMMMMddyyyy

See Also:

Constant Field Values

DATEFORMAT_FRE_EEEEMMMMddyyyy

public static final java.lang.String DATEFORMAT_FRE_EEEEMMMMddyyyy

See Also:

Constant Field Values

DATEFORMAT_MMMyyyy

public static final java.lang.String DATEFORMAT_MMMyyyy

See Also:

Constant Field Values

DATEFORMAT_ENG_MMMddEEEE

public static final java.lang.String DATEFORMAT_ENG_MMMddEEEE

See Also:

Constant Field Values

DATEFORMAT_FRE_MMMddEEEE

public static final java.lang.String DATEFORMAT_FRE_MMMddEEEE

See Also:

Constant Field Values

DATEFORMAT_FRE_EEEEddMMM

public static final java.lang.String DATEFORMAT_FRE_EEEEddMMM

See Also:

Constant Field Values

DATEFORMAT_ENG_MMMddyyyy

public static final java.lang.String DATEFORMAT_ENG_MMMddyyyy

See Also:

Constant Field Values

DATEFORMAT_FRE_MMMddyyyy

public static final java.lang.String DATEFORMAT_FRE_MMMddyyyy

See Also:

Constant Field Values

DATEFORMAT_MMMMddyyyy

public static final java.lang.String DATEFORMAT_MMMMddyyyy

See Also:

Constant Field Values

DATEFORMAT_ddMMMyyyy

public static final java.lang.String DATEFORMAT_ddMMMyyyy

See Also:

Constant Field Values

DATEFORMAT_MMddyyyy

public static final java.lang.String DATEFORMAT_MMddyyyy

See Also:

Constant Field Values

DATEFORMAT_MMddyyyy2

public static final java.lang.String DATEFORMAT_MMddyyyy2

See Also:

Constant Field Values

DATEFORMAT_MMMdd

public static final java.lang.String DATEFORMAT_MMMdd

See Also:

Constant Field Values

DATEFORMAT_ENG_MMMMdd

public static final java.lang.String DATEFORMAT_ENG_MMMMdd

See Also:

Constant Field Values

DATEFORMAT_FRE_MMMMdd

public static final java.lang.String DATEFORMAT_FRE_MMMMdd

See Also:

Constant Field Values

DATEFORMAT_EEEEyyyy

public static final java.lang.String DATEFORMAT_EEEEyyyy

See Also:

Constant Field Values

DATEFORMAT_yyyyMMdd

public static final java.lang.String DATEFORMAT_yyyyMMdd

See Also:

Constant Field Values

DATETIMEFORMAT

public static final java.lang.String DATETIMEFORMAT

See Also:

Constant Field Values

DATETIMEFORMAT2

public static final java.lang.String DATETIMEFORMAT2

See Also:

Constant Field Values

DATETIMEFORMAT3

public static final java.lang.String DATETIMEFORMAT3

See Also:

Constant Field Values

TIMEFORMAT

public static final java.lang.String TIMEFORMAT

See Also:

Constant Field Values

DECIMALFORMAT_DECIMAL0

public static final java.lang.String DECIMALFORMAT_DECIMAL0

See Also:

Constant Field Values

DECIMALFORMAT_PRICE

public static final java.lang.String DECIMALFORMAT_PRICE

See Also:

Constant Field Values

CURRENCYFORMAT_ENG_PRICE

public static final java.lang.String CURRENCYFORMAT_ENG_PRICE

See Also:

Constant Field Values

CURRENCYFORMAT_FRE_PRICE

public static final java.lang.String CURRENCYFORMAT_FRE_PRICE

See Also:

Constant Field Values

Constructor Detail

AbstractFormatter

public AbstractFormatter(java.util.Locale locale)

AbstractFormatter constructor comment.

Parameters:

locale - Locale

Method Detail

formatDate

public abstract java.lang.String formatDate(java.util.Date aDate)

Abstract method - formateDate

Parameters:

aDate - Date

Returns:

java.lang.String

formatDateMDY

public java.lang.String formatDateMDY(java.util.Date aDate)

formatDateMDY method comment.

Parameters:

aDate - Date

Returns:

java.lang.String

formatDateMD

public java.lang.String formatDateMD(java.util.Date aDate)

formatDateMD method comment.

Parameters:

aDate - Date

Returns:

java.lang.String

formatDateDMY

public java.lang.String formatDateDMY(java.util.Date aDate)

formatDateDMY method comment.

Parameters:

aDate - Date

Returns:

java.lang.String

formatDateTime

public abstract java.lang.String formatDateTime(java.util.Date aDate)

formatDateTime method comment.

Parameters:

aDate - Date

Returns:

java.lang.String

formatTime

public abstract java.lang.String formatTime(java.util.Date aDate)

formatTime method comment.

Parameters:

aDate - Date

Returns:

java.lang.String

formatDollar

public abstract java.lang.String formatDollar(double aDollar)

formatDollar method comment.

Parameters:

aDollar - double

Returns:

java.lang.String

formatDollar

public abstract java.lang.String formatDollar(java.math.BigDecimal aDollar)

formatDollar method comment.

Parameters:

aDollar - java.math.BigDecimal

Returns:

java.lang.String

formatPercent

public abstract java.lang.String formatPercent(double aPercent)

Formats a double percentage value into a percentage (%) format.

Preconditions: a double percentage value.

PostConditions: returns a formatted string of percentage value.

Exceptions None

Parameters:

aPercent - double - A value to be formatted.

Returns:

java.lang.String

formatPercent

public abstract java.lang.String formatPercent(java.math.BigDecimal aPercent)

Formats a BigDecimal percentage value into a percentage (%) format.

Preconditions: a BigDecimal percentage value.

PostConditions: returns a formatted string of percentage value.

Exceptions None

Parameters:

aPercent - java.math.BigDecimal - A value to be formatted.

Returns:

java.lang.String

formatDecimal

public abstract java.lang.String formatDecimal(double aNumber,
                                               int aNumOfDecimals)

Formats transaction unit to include only specified number of decimal points.

Preconditions: an amount and a number of decimals

Postconditions: a formatted transaction units in string

Exceptions: None

Parameters:

aNumber - double

aNumOfDecimals - int

Returns:

java.lang.String

formatDecimal

public abstract java.lang.String formatDecimal(java.math.BigDecimal aNumber,
                                               int aNumOfDecimals)

Formats transaction units to include only specified number of decimal points.

Preconditions: an amount and a number of decimals

Postconditions: a formatted transaction units in string

Exceptions: None

Parameters:

aNumber - java.math.BigDecimal

aNumOfDecimals - int

Returns:

java.lang.String

getLocale

protected java.util.Locale getLocale()

getLocale method comment.