Package org.goplanit.utils.unit

Class GroupUnit

java.lang.Object

org.goplanit.utils.unit.GroupUnit

All Implemented Interfaces:

Unit

public class GroupUnit
extends Object
implements Unit

A combined unit consisting of multiple simple (single) units

Author:

markr

Field Summary

Fields inherited from interface org.goplanit.utils.unit.Unit

HOUR, KM, KM_HOUR, METER, METER_SECOND, MINUTE, NONE, PCU, PCU_HOUR, PCU_KM, SECOND, SRS, VEH, VEH_HOUR, VEH_KM

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GroupUnit(GroupUnit other, SimpleUnit... denominatorUnits)	Constructor
protected	GroupUnit(SimpleUnit... numeratorUnits)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	canConvertTo(Unit to)	Verify if unit can be converted to the desired unit
double	convertTo(Unit to, double value)	Convert one unit to the other for a given value
boolean	equals(Object o)
protected List<SimpleUnit>	getDenominatorUnitTypes()	All registered units in the denominator
protected List<SimpleUnit>	getNumeratorUnitTypes()	All registered units in the numerator
boolean	isCombinedUnit()	Is the unit a single or combined unit
GroupUnit	per(SimpleUnit... denominatorUnits)	Factory method to create a new groupUnit with this unit's numerator and additionally added denominator units, e.g., KM per Hour
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupUnit

protected GroupUnit(SimpleUnit... numeratorUnits)

Constructor

Parameters:

numeratorUnits - to use

GroupUnit

protected GroupUnit(GroupUnit other,
                    SimpleUnit... denominatorUnits)

Constructor

Parameters:

other - to copy numerator units from

denominatorUnits - to use

Method Detail

per

public GroupUnit per(SimpleUnit... denominatorUnits)

Factory method to create a new groupUnit with this unit's numerator and additionally added denominator units, e.g., KM per Hour

Parameters:

denominatorUnits - to use

Returns:

newly combined group unit

isCombinedUnit

public boolean isCombinedUnit()

Is the unit a single or combined unit

Specified by:

isCombinedUnit in interface Unit

Returns:

false when single, true when combined

getNumeratorUnitTypes

protected List<SimpleUnit> getNumeratorUnitTypes()

All registered units in the numerator

Returns:

numerator units

getDenominatorUnitTypes

protected List<SimpleUnit> getDenominatorUnitTypes()

All registered units in the denominator

Returns:

numerator units

convertTo

public double convertTo(Unit to,
                        double value)
                 throws PlanItException

Convert one unit to the other for a given value

Specified by:

convertTo in interface Unit

Parameters:

to - to unit

value - value to convert

Returns:

converted value

Throws:

PlanItException - thrown if not possible to perform conversion

canConvertTo

public boolean canConvertTo(Unit to)

Verify if unit can be converted to the desired unit

Specified by:

canConvertTo in interface Unit

Parameters:

to - to unit

Returns:

true when compatible, false otherwise

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object