fr.cnes.genius.unit

Class GPercentUnit

java.lang.Object

fr.cnes.genius.unit.GPercentUnit

All Implemented Interfaces:

GUnit

public class GPercentUnit
extends Object
implements GUnit

Class in charge of managing the conversions between the "%" and the "‰". The valid unit names are "%", "‰". The memory unit is the unitary value.

Author:

J. Fourcade

Constructor Summary

Constructors

Constructor and Description
GPercentUnit(String unitName) Constructor.

Method Summary

Modifier and Type	Method and Description
BigDecimal	convertFromMemory(BigDecimal value) Converts the value from the memory unit.
double	convertFromMemory(double value) Converts the value from the memory unit.
BigDecimal	convertToMemory(BigDecimal value) Converts the value to the memory unit.
double	convertToMemory(double value) Converts the value to the memory unit.
BigDecimal	convertToUnit(BigDecimal value, GUnit destUnit) Converts the units of value to unit.
double	convertToUnit(double value, GUnit destUnit) Converts the units of value to unit.
String	getCompactedName() Returns the name of the unit decomposed in basicUnits, without multipliers and sorted.
String	getName() Get the string representing the unit name.
boolean	isCompatible(GUnit unit) Determines if unit is compatible with the GUnit object.
boolean	isValidUnitName(String unitName) Verify if a unit name string represents a valid unit.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPercentUnit

public GPercentUnit(String unitName)

Constructor.

Parameters:

unitName - name of the unit. It must be a valid unit name.

Method Detail

isValidUnitName

public boolean isValidUnitName(String unitName)

Verify if a unit name string represents a valid unit.

Specified by:

isValidUnitName in interface GUnit

Parameters:

unitName - unit name string to test.

Returns:

true if the unit name represents a valid unit, false otherwise.

isCompatible

public boolean isCompatible(GUnit unit)

Determines if unit is compatible with the GUnit object. Allows to verify compatibility between 2 units.

Specified by:

isCompatible in interface GUnit

Parameters:

unit - to check if it is compatible.

Returns:

true if the unit is compatible, false otherwise.

convertToUnit

public double convertToUnit(double value,
                            GUnit destUnit)
                     throws GException

Converts the units of value to unit. The conversion is done passing converting to and from the memory unit.

Specified by:

convertToUnit in interface GUnit

Parameters:

value - to convert.

destUnit - the destination unit.

Returns:

the converted value.

Throws:

GException - in case of an error performing the conversion.

convertToMemory

public double convertToMemory(double value)

Converts the value to the memory unit. Convert the present value of unit to unit used in the configuration file.

Specified by:

convertToMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

convertFromMemory

public double convertFromMemory(double value)

Converts the value from the memory unit. Convert the value of unit used in the configuration file to unit selected at present.

Specified by:

convertFromMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

getName

public String getName()

Get the string representing the unit name. Name of unit for display.

Specified by:

getName in interface GUnit

Returns:

the string representing the unit name.

getCompactedName

public String getCompactedName()

Returns the name of the unit decomposed in basicUnits, without multipliers and sorted. Used to verify the compatibility between units.

Specified by:

getCompactedName in interface GUnit

Returns:

the name of the unit decomposed in basicUnits, without multipliers and sorted.

convertToUnit

public BigDecimal convertToUnit(BigDecimal value,
                                GUnit destUnit)
                         throws GException

Converts the units of value to unit. The conversion is done passing converting to and from the memory unit.

Specified by:

convertToUnit in interface GUnit

Parameters:

value - to convert.

destUnit - the destination unit.

Returns:

the converted value.

Throws:

GException - in case of an error performing the conversion.

convertToMemory

public BigDecimal convertToMemory(BigDecimal value)

Converts the value to the memory unit. Convert the present value of unit to unit used in the configuration file.

Specified by:

convertToMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

convertFromMemory

public BigDecimal convertFromMemory(BigDecimal value)

Converts the value from the memory unit. Convert the value of unit used in the configuration file to unit selected at present.

Specified by:

convertFromMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.