com.bayesia.api.format

Class NumberFormatter

java.lang.Object

com.bayesia.api.format.NumberFormatter

public class NumberFormatter
extends java.lang.Object

The class NumberFormatter is used to format the computed FunctionValue of a function node, when the value is a Number.

It allows formatting the result Number.

Version:

4.0

Author:

Bayesia S.A.S.

Constructor Summary

Constructors

Constructor and Description
NumberFormatter(java.lang.String prefix, java.lang.String suffix, int digits, boolean groupingUsed, boolean scientificNotationUsed, boolean percent, boolean trailingZerosTrimmed) Creates an instance of the formatter with the specified parameters.

Method Summary

Modifier and Type	Method and Description
int	getDigits() Returns the number of decimals to display.
java.lang.String	getPrefix() Returns the prefix of the formatted Number.
java.lang.String	getSuffix() Returns the suffix of the formatted Number.
boolean	isGroupingUsed() Tests if the grouping (by 3) is used
boolean	isPercent() Tests if the percent format is used
boolean	isScientificNotationUsed() Tests if the scientific notation is used
boolean	isTrailingZerosTrimmed() Tests if the not useful decimal zeros are trimmed
void	setDigits(int digits) Sets the number of decimals to display.
void	setGroupingUsed(boolean groupingUsed) Sets the grouping of the numbers (by 3) to the given value
void	setPercent(boolean percent) Sets the percent format to the given value
void	setPrefix(java.lang.String prefix) Sets the prefix of the formatted Number.
void	setScientificNotationUsed(boolean scientificNotationUsed) Sets the scientific notation mode to the given value
void	setSuffix(java.lang.String suffix) Sets the suffix of the formatted Number.
void	setTrailingZerosTrimmed(boolean trailingZerosTrimmed) Sets the trim mode for the trailing zeros to the given value

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberFormatter

public NumberFormatter(java.lang.String prefix,
                       java.lang.String suffix,
                       int digits,
                       boolean groupingUsed,
                       boolean scientificNotationUsed,
                       boolean percent,
                       boolean trailingZerosTrimmed)

Creates an instance of the formatter with the specified parameters.

Parameters:

prefix - a String written before the formatted Number

suffix - a String written after the formatted Number

digits - an int representing the number of decimals to display

groupingUsed - tells whether or not the groups of 3 numbers are separated

scientificNotationUsed - indicates if the number is formatted with E+0 scientific notation

percent - tells if the number is converted in percentt and displayed with %

trailingZerosTrimmed - removes the decimal zeros that are not useful

Method Detail

getPrefix

public java.lang.String getPrefix()

Returns the prefix of the formatted Number.

Returns:

the String representing the prefix of null if there is no prefix

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the prefix of the formatted Number.

Parameters:

prefix - a String representing the prefix of null if there is no prefix

getSuffix

public java.lang.String getSuffix()

Returns the suffix of the formatted Number.

Returns:

the String representing the suffix of null if there is no suffix

setSuffix

public void setSuffix(java.lang.String suffix)

Sets the suffix of the formatted Number.

Parameters:

suffix - a String representing the suffix of null if there is no suffix

getDigits

public int getDigits()

Returns the number of decimals to display.

Returns:

an int representing the number of decimals displayed

setDigits

public void setDigits(int digits)

Sets the number of decimals to display.

Parameters:

digits - the number of decimal to display between 0 and 14

isGroupingUsed

public boolean isGroupingUsed()

Tests if the grouping (by 3) is used

Returns:

true is the grouping is used false otherwise

setGroupingUsed

public void setGroupingUsed(boolean groupingUsed)

Sets the grouping of the numbers (by 3) to the given value

Parameters:

groupingUsed - the grouping mode to use

isScientificNotationUsed

public boolean isScientificNotationUsed()

Tests if the scientific notation is used

Returns:

true is the scientific notation is used false otherwise

setScientificNotationUsed

public void setScientificNotationUsed(boolean scientificNotationUsed)

Sets the scientific notation mode to the given value

Parameters:

scientificNotationUsed - the scientific notation to use

isPercent

public boolean isPercent()

Tests if the percent format is used

Returns:

true is the percent format is used false otherwise

setPercent

public void setPercent(boolean percent)

Sets the percent format to the given value

Parameters:

percent - the percent format to use

isTrailingZerosTrimmed

public boolean isTrailingZerosTrimmed()

Tests if the not useful decimal zeros are trimmed

Returns:

true is the not useful decimal zeros are trimmed false otherwise

setTrailingZerosTrimmed

public void setTrailingZerosTrimmed(boolean trailingZerosTrimmed)

Sets the trim mode for the trailing zeros to the given value

Parameters:

trailingZerosTrimmed - the trim mode to use