org.cyclos.model.utils

Class AbstractFormatter

java.lang.Object

org.cyclos.model.utils.AbstractFormatter

All Implemented Interfaces:

Formatter

public abstract class AbstractFormatter
extends java.lang.Object
implements Formatter

Base implementation for formatters

Author:

luis

Field Summary

Fields inherited from interface org.cyclos.utils.Formatter

VARIABLE_SCALE

Constructor Summary

Constructors

Constructor and Description
AbstractFormatter()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	fixSignIfZero(java.lang.String formattedValue) It removes the starting minus sign ('-') if the formatted value represents the zero number.
java.lang.String	format(AccountLimitVO entry, boolean creditLimit) Formats an account limit as negative or positive according to the given flag
java.lang.String	format(AccountOwner accountOwner) Formats an account owner
java.lang.String	format(java.lang.Boolean bool) Formats a boolean
java.lang.String	format(java.util.Collection<?> list) Formats a collection as a comma-separated string, invoking Formatter.format(Object) for each element
java.lang.String	format(DatePeriodDTO period) Formats a period
java.lang.String	format(FormattableTimeBasedRate rate) Formats a time based rate
java.lang.String	format(HasTransactionNumber htn) Formats an entity with transaction number
java.lang.String	format(ICurrencyAmount currencyAmount) Formats a currency amount
java.lang.String	format(ICustomFieldPossibleValue<?> possibleValue) Formats a custom field possible value
java.lang.String	format(ICustomFieldValue customFieldValue) Formats a custom field value
java.lang.String	format(IDimensions dimensions) Formats a dimensions
java.lang.String	format(IFileSize fileSize) Formats a file size
java.lang.String	format(INamedEntity namedEntity) Formats a named entity
java.lang.String	format(java.lang.Integer number) Formats an integer number
java.lang.String	format(ITimeInterval timeInterval) Formats a time interval
java.lang.String	format(java.lang.Long number) Formats a long number
java.lang.String	format(java.lang.Object object) Tests the object type, invoking one of the specific format methods
java.lang.String	format(ProfileField profileField) Formats an user profile field
java.lang.String	format(TranslationMessageSpecification tms) Formats a translation message
java.lang.String	formatAsDate(DatePeriodDTO period) Formats a period as date
java.lang.String	formatDuration(java.lang.Integer duration) Formats a duration (given in milliseconds) in a string like: 1h 12m 31s
java.lang.String	formatPercentage(java.math.BigDecimal number) Formats a percentage with variable scale
java.lang.String	formatPercentage(java.math.BigDecimal number, int scale) Formats a percentage with the given decimal fields
java.lang.String	formatPercentage(java.lang.Double number) Formats a percentage with variable scale
java.lang.String	formatPercentage(java.lang.Double number, int scale) Formats a percentage with the given decimal digits
java.lang.String	formatPercentage(java.lang.Integer value, java.lang.Integer total) Formats a percentage without decimal fields
java.lang.String	formatPercentage(java.lang.Integer value, java.lang.Integer total, int scale) Formats a percentage with the given decimal digits
protected java.lang.String	formatPeriod(java.lang.String begin, java.lang.String end)
java.lang.String	formatVariables(java.lang.String text, java.util.Map<java.lang.String,?> variables) Formats variables in form #name# with values retrieved from the given Map, keyed by the name (without #'s)
protected abstract java.lang.String	message(MessageKey key, java.lang.Object... arguments)
protected java.math.BigDecimal	roundHour(java.math.BigDecimal hour, java.math.BigDecimal minutes, java.math.BigDecimal seconds) Rounds the given hour half up with seconds precision
protected Pair<java.math.BigDecimal,java.math.BigDecimal>	splitDecimal(java.math.BigDecimal value) Returns a pair with the integer part and the decimal part of the given number

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.utils.Formatter

format, format, formatAsDate, formatAsTime, formatId, getDatePattern, getTimePattern

Constructor Detail

AbstractFormatter

public AbstractFormatter()

Method Detail

format

public java.lang.String format(AccountLimitVO entry,
                               boolean creditLimit)

Formats an account limit as negative or positive according to the given flag

format

public java.lang.String format(AccountOwner accountOwner)

Description copied from interface: Formatter

Formats an account owner

Specified by:

format in interface Formatter

format

public java.lang.String format(java.lang.Boolean bool)

Description copied from interface: Formatter

Formats a boolean

Specified by:

format in interface Formatter

format

public java.lang.String format(java.util.Collection<?> list)

Description copied from interface: Formatter

Formats a collection as a comma-separated string, invoking Formatter.format(Object) for each element

Specified by:

format in interface Formatter

format

public java.lang.String format(DatePeriodDTO period)

Description copied from interface: Formatter

Formats a period

Specified by:

format in interface Formatter

format

public java.lang.String format(FormattableTimeBasedRate rate)

Description copied from interface: Formatter

Formats a time based rate

Specified by:

format in interface Formatter

format

public java.lang.String format(HasTransactionNumber htn)

Description copied from interface: Formatter

Formats an entity with transaction number

Specified by:

format in interface Formatter

format

public java.lang.String format(ICurrencyAmount currencyAmount)

Description copied from interface: Formatter

Formats a currency amount

Specified by:

format in interface Formatter

format

public java.lang.String format(ICustomFieldPossibleValue<?> possibleValue)

Description copied from interface: Formatter

Formats a custom field possible value

Specified by:

format in interface Formatter

format

public java.lang.String format(ICustomFieldValue customFieldValue)

Description copied from interface: Formatter

Formats a custom field value

Specified by:

format in interface Formatter

format

public java.lang.String format(IDimensions dimensions)

Description copied from interface: Formatter

Formats a dimensions

Specified by:

format in interface Formatter

format

public java.lang.String format(IFileSize fileSize)

Description copied from interface: Formatter

Formats a file size

Specified by:

format in interface Formatter

format

public java.lang.String format(INamedEntity namedEntity)

Description copied from interface: Formatter

Formats a named entity

Specified by:

format in interface Formatter

format

public java.lang.String format(java.lang.Integer number)

Description copied from interface: Formatter

Formats an integer number

Specified by:

format in interface Formatter

format

public java.lang.String format(ITimeInterval timeInterval)

Description copied from interface: Formatter

Formats a time interval

Specified by:

format in interface Formatter

format

public java.lang.String format(java.lang.Long number)

Description copied from interface: Formatter

Formats a long number

Specified by:

format in interface Formatter

format

public java.lang.String format(java.lang.Object object)

Description copied from interface: Formatter

Tests the object type, invoking one of the specific format methods

Specified by:

format in interface Formatter

format

public java.lang.String format(ProfileField profileField)

Description copied from interface: Formatter

Formats an user profile field

Specified by:

format in interface Formatter

format

public java.lang.String format(TranslationMessageSpecification tms)

Description copied from interface: Formatter

Formats a translation message

Specified by:

format in interface Formatter

formatAsDate

public java.lang.String formatAsDate(DatePeriodDTO period)

Description copied from interface: Formatter

Formats a period as date

Specified by:

formatAsDate in interface Formatter

formatDuration

public java.lang.String formatDuration(java.lang.Integer duration)

Description copied from interface: Formatter

Formats a duration (given in milliseconds) in a string like: 1h 12m 31s

Specified by:

formatDuration in interface Formatter

formatPercentage

public java.lang.String formatPercentage(java.math.BigDecimal number)

Description copied from interface: Formatter

Formats a percentage with variable scale

Specified by:

formatPercentage in interface Formatter

formatPercentage

public java.lang.String formatPercentage(java.math.BigDecimal number,
                                         int scale)

Description copied from interface: Formatter

Formats a percentage with the given decimal fields

Specified by:

formatPercentage in interface Formatter

formatPercentage

public java.lang.String formatPercentage(java.lang.Double number)

Description copied from interface: Formatter

Formats a percentage with variable scale

Specified by:

formatPercentage in interface Formatter

formatPercentage

public java.lang.String formatPercentage(java.lang.Double number,
                                         int scale)

Description copied from interface: Formatter

Formats a percentage with the given decimal digits

Specified by:

formatPercentage in interface Formatter

formatPercentage

public java.lang.String formatPercentage(java.lang.Integer value,
                                         java.lang.Integer total)

Description copied from interface: Formatter

Formats a percentage without decimal fields

Specified by:

formatPercentage in interface Formatter

formatPercentage

public java.lang.String formatPercentage(java.lang.Integer value,
                                         java.lang.Integer total,
                                         int scale)

Description copied from interface: Formatter

Formats a percentage with the given decimal digits

Specified by:

formatPercentage in interface Formatter

formatVariables

public java.lang.String formatVariables(java.lang.String text,
                                        java.util.Map<java.lang.String,?> variables)

Description copied from interface: Formatter

Formats variables in form #name# with values retrieved from the given Map, keyed by the name (without #'s)

Specified by:

formatVariables in interface Formatter

fixSignIfZero

protected java.lang.String fixSignIfZero(java.lang.String formattedValue)

It removes the starting minus sign ('-') if the formatted value represents the zero number.

Parameters:

formattedValue - an already formatted value with some scale

Returns:

the formattedValue parameter without the minus sign if it represents the zero number.

formatPeriod

protected java.lang.String formatPeriod(java.lang.String begin,
                                        java.lang.String end)

message

protected abstract java.lang.String message(MessageKey key,
                                            java.lang.Object... arguments)

roundHour

protected java.math.BigDecimal roundHour(java.math.BigDecimal hour,
                                         java.math.BigDecimal minutes,
                                         java.math.BigDecimal seconds)

Rounds the given hour half up with seconds precision

splitDecimal

protected Pair<java.math.BigDecimal,java.math.BigDecimal> splitDecimal(java.math.BigDecimal value)

Returns a pair with the integer part and the decimal part of the given number