java.lang.Object
- org.cyclos.model.utils.AbstractFormatter

All Implemented Interfaces:: Formatter

public abstract class AbstractFormatter
extends Object
implements Formatter

Base implementation for formatters

Field Summary
- Fields inherited from interface org.cyclos.utils.Formatter
  VARIABLE_SCALE

Constructor Summary

Constructors
Constructor Description

AbstractFormatter()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`fixSignIfZero(String formattedValue)`	It removes the starting minus sign ('-') if the formatted value represents the zero number.
`String`	`format(Boolean bool)`	Formats a boolean
`String`	`format(Integer number)`	Formats an integer number
`String`	`format(Long number)`	Formats a long number
`String`	`format(Number size, FileSizeUnit unit)`	Formats a size showing its units
`String`	`format(Object object)`	Tests the object type, invoking one of the specific format methods
`String`	`format(Collection<?> list)`	Formats a collection as a comma-separated string, invoking `Formatter.format(Object)` for each element
`String`	`format(AccountOwner accountOwner)`	Formats an account owner
`String`	`format(ICurrency currency, BigDecimal amount)`	Formats an amount with the given currency
`String`	`format(FormattableTimeBasedRate rate)`	Formats a time based rate
`String`	`format(IBinaryFile file)`	Formats a binary file
`String`	`format(INamedEntity namedEntity)`	Formats a named entity
`String`	`format(ICustomFieldPossibleValue<?> possibleValue)`	Formats a custom field possible value
`String`	`format(ICustomFieldValue<?,?,?,?> customFieldValue)`	Formats a custom field value
`String`	`format(IDynamicFieldValue dynamicValue)`	Formats a custom field dynamic value
`String`	`format(IImage image)`	Formats an image
`String`	`format(ProfileField profileField)`	Formats a user profile field
`String`	`format(HasDisplay hasDisplay)`	Formats the given object as the display value
`String`	`format(ICurrencyAmount currencyAmount)`	Formats a currency amount
`String`	`format(ICurrencyAmountRange range)`	Formats a currency amount range
`String`	`format(IDatePeriod period)`	Formats a period
`String`	`format(IDecimalRange range, int scale)`	Formats a decimal range with the given scale
`String`	`format(IDimensions dimensions)`	Formats a dimensions
`String`	`format(IFileSize fileSize)`	Formats a file size
`String`	`format(ILatLong latLong)`	Formats a geographical coordinate
`String`	`format(ITimeInterval timeInterval)`	Formats a time interval
`String`	`format(Range<?> range)`	Formats a range
`String`	`format(HasMessageKey hasKey)`	Formats an object that has a mapping to the translation message key.
`String`	`format(TranslationMessageSpecification tms)`	Formats a translation message
`String`	`formatAsDate(IDatePeriod period)`	Formats a period as date
`String`	`formatDuration(Long duration)`	Formats a duration (given in milliseconds) in a string like: 1h 12m 31s
`String`	`formatPercentage(Double number)`	Formats a percentage with variable scale
`String`	`formatPercentage(Double number, int scale)`	Formats a percentage with the given decimal digits
`String`	`formatPercentage(Integer value, Integer total)`	Formats a percentage without decimal fields
`String`	`formatPercentage(Integer value, Integer total, int scale)`	Formats a percentage with the given decimal digits
`String`	`formatPercentage(BigDecimal number)`	Formats a percentage with variable scale
`String`	`formatPercentage(BigDecimal number, int scale)`	Formats a percentage with the given decimal fields
`protected String`	`formatPeriod(String begin, String end)`
`protected String`	`formatRange(String min, String max)`
`String`	`formatVariables(String text, Map<String,?> variables)`	Formats variables in form #name# with values retrieved from the given Map, keyed by the name (without #'s)
`protected abstract String`	`message(MessageFormat format, MessageKey key, Object... arguments)`
`protected String`	`message(MessageKey key, Object... arguments)`
`protected BigDecimal`	`roundHour(BigDecimal hour, BigDecimal minutes, BigDecimal seconds)`	Rounds the given hour half up with seconds precision
`protected Pair<BigDecimal,BigDecimal>`	`splitDecimal(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 String format(AccountOwner accountOwner)
```
    Description copied from interface: Formatter
    
    Formats an account owner
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(Boolean bool)
```
    Description copied from interface: Formatter
    
    Formats a boolean
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(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 String format(FormattableTimeBasedRate rate)
```
    Description copied from interface: Formatter
    
    Formats a time based rate
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(HasDisplay hasDisplay)
```
    Description copied from interface: Formatter
    
    Formats the given object as the display value
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(HasMessageKey hasKey)
```
    Description copied from interface: Formatter
    
    Formats an object that has a mapping to the translation message key.
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(IBinaryFile file)
```
    Description copied from interface: Formatter
    
    Formats a binary file
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(ICurrency currency,
                     BigDecimal amount)
```
    Description copied from interface: Formatter
    
    Formats an amount with the given currency
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(ICurrencyAmount currencyAmount)
```
    Description copied from interface: Formatter
    
    Formats a currency amount
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(ICurrencyAmountRange range)
```
    Description copied from interface: Formatter
    
    Formats a currency amount range
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(ICustomFieldPossibleValue<?> possibleValue)
```
    Description copied from interface: Formatter
    
    Formats a custom field possible value
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(ICustomFieldValue<?,?,?,?> customFieldValue)
```
    Description copied from interface: Formatter
    
    Formats a custom field value
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(IDatePeriod period)
```
    Description copied from interface: Formatter
    
    Formats a period
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(IDecimalRange range,
                     int scale)
```
    Description copied from interface: Formatter
    
    Formats a decimal range with the given scale
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(IDimensions dimensions)
```
    Description copied from interface: Formatter
    
    Formats a dimensions
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(IDynamicFieldValue dynamicValue)
```
    Description copied from interface: Formatter
    
    Formats a custom field dynamic value
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(IFileSize fileSize)
```
    Description copied from interface: Formatter
    
    Formats a file size
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(IImage image)
```
    Description copied from interface: Formatter
    
    Formats an image
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(ILatLong latLong)
```
    Description copied from interface: Formatter
    
    Formats a geographical coordinate
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(INamedEntity namedEntity)
```
    Description copied from interface: Formatter
    
    Formats a named entity
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(Integer number)
```
    Description copied from interface: Formatter
    
    Formats an integer number
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(ITimeInterval timeInterval)
```
    Description copied from interface: Formatter
    
    Formats a time interval
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(Long number)
```
    Description copied from interface: Formatter
    
    Formats a long number
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(Number size,
                     FileSizeUnit unit)
```
    Description copied from interface: Formatter
    
    Formats a size showing its units
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(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 String format(ProfileField profileField)
```
    Description copied from interface: Formatter
    
    Formats a user profile field
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(Range<?> range)
```
    Description copied from interface: Formatter
    
    Formats a range
    
    Specified by:
    
    format in interface Formatter
  - format
```
public String format(TranslationMessageSpecification tms)
```
    Description copied from interface: Formatter
    
    Formats a translation message
    
    Specified by:
    
    format in interface Formatter
  - formatAsDate
```
public String formatAsDate(IDatePeriod period)
```
    Description copied from interface: Formatter
    
    Formats a period as date
    
    Specified by:
    
    formatAsDate in interface Formatter
  - formatDuration
```
public String formatDuration(Long 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 String formatPercentage(BigDecimal number)
```
    Description copied from interface: Formatter
    
    Formats a percentage with variable scale
    
    Specified by:
    
    formatPercentage in interface Formatter
  - formatPercentage
```
public String formatPercentage(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 String formatPercentage(Double number)
```
    Description copied from interface: Formatter
    
    Formats a percentage with variable scale
    
    Specified by:
    
    formatPercentage in interface Formatter
  - formatPercentage
```
public String formatPercentage(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 String formatPercentage(Integer value,
                               Integer total)
```
    Description copied from interface: Formatter
    
    Formats a percentage without decimal fields
    
    Specified by:
    
    formatPercentage in interface Formatter
  - formatPercentage
```
public String formatPercentage(Integer value,
                               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 String formatVariables(String text,
                              Map<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 String fixSignIfZero(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 String formatPeriod(String begin,
                              String end)
```
  - formatRange
```
protected String formatRange(String min,
                             String max)
```
  - message
```
protected abstract String message(MessageFormat format,
                                  MessageKey key,
                                  Object... arguments)
```
  - message
```
protected final String message(MessageKey key,
                               Object... arguments)
```
  - roundHour
```
protected BigDecimal roundHour(BigDecimal hour,
                               BigDecimal minutes,
                               BigDecimal seconds)
```
    Rounds the given hour half up with seconds precision
  - splitDecimal
```
protected Pair<BigDecimal,BigDecimal> splitDecimal(BigDecimal value)
```
    Returns a pair with the integer part and the decimal part of the given number

Class AbstractFormatter

Field Summary

Fields inherited from interface org.cyclos.utils.Formatter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.cyclos.utils.Formatter

Constructor Detail

AbstractFormatter

Method Detail

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

format

formatAsDate

formatDuration

formatPercentage

formatPercentage

formatPercentage

formatPercentage

formatPercentage

formatPercentage

formatVariables

fixSignIfZero

formatPeriod

formatRange

message

message

roundHour

splitDecimal