com.qcadoo.model.api.units

Interface PossibleUnitConversions

public interface PossibleUnitConversions

Object representing possible unit conversions

Since:

1.1.8

Method Summary

Modifier and Type	Method and Description
List<Entity>	asEntities(String ownerFieldName, Entity ownerEntity) Get all matching conversions as list of UnitConversionItem entities, belonging to specified owner Entity.
Map<String,BigDecimal>	asUnitToConversionMap()
BigDecimal	convertTo(BigDecimal value, String unitTo)
BigDecimal	convertTo(BigDecimal value, String unitTo, int roundMode)
Set<String>	getSupportedUnits()
String	getUnitFrom()
boolean	isDefinedFor(String unit)
boolean	isEmpty()

Method Detail

asEntities

List<Entity> asEntities(String ownerFieldName,
                        Entity ownerEntity)

Get all matching conversions as list of UnitConversionItem entities, belonging to specified owner Entity.

Parameters:

ownerFieldName - owner entity field name

ownerEntity - owner entity

Returns:

all matching conversions as list of UnitConversionItem entities

asUnitToConversionMap

Map<String,BigDecimal> asUnitToConversionMap()

Returns:

all matching conversions as map containing target unit -> conversion ratio pairs.

convertTo

BigDecimal convertTo(BigDecimal value,
                     String unitTo)

Parameters:

value -

unitTo -

Returns:

value in specified unit

Throws:

UnsupportedUnitConversionException - if conversion is not defined

convertTo

BigDecimal convertTo(BigDecimal value,
                     String unitTo,
                     int roundMode)

Parameters:

value -

unitTo -

roundMode -

Returns:

value in specified unit

Throws:

UnsupportedUnitConversionException - if conversion is not defined

getSupportedUnits

Set<String> getSupportedUnits()

Returns:

Set of supported target units

getUnitFrom

String getUnitFrom()

Returns:

source unit

isDefinedFor

boolean isDefinedFor(String unit)

Parameters:

unit -

Returns:

true if conversion to specified unit is defined

isEmpty

boolean isEmpty()

Returns:

true if there is no available conversions matching source unit (source unit can be obtained using getUnitFrom()).