org.tridas.io.util
Class UnitUtils

java.lang.Object
  org.tridas.io.util.UnitUtils

public class UnitUtils
extends Object

Constructor Summary

UnitUtils()

Method Summary

static Boolean	checkValuesFitInFields(org.tridas.schema.TridasValues tv, Integer maxDigits)
static BigDecimal	convertBigDecimal(org.tridas.schema.NormalTridasUnit inputunits, org.tridas.schema.NormalTridasUnit outputunits, BigDecimal value) Convert a BigDecimal value from one unit to another
static BigInteger	convertBigInteger(org.tridas.schema.NormalTridasUnit inputunits, org.tridas.schema.NormalTridasUnit outputunits, BigInteger value) Convert a BigInteger value from one unit to another
static Double	convertDouble(org.tridas.schema.NormalTridasUnit inputunits, org.tridas.schema.NormalTridasUnit outputunits, Double value) Convert a data value from one unit to another
static org.tridas.schema.TridasValues	convertTridasValues(org.tridas.schema.NormalTridasUnit outputunits, org.tridas.schema.TridasValues tv, Boolean outputAsIntegers) Convert a TridasValues tag from one unit to another.
static org.tridas.schema.TridasValues	convertTridasValues(org.tridas.schema.NormalTridasUnit outputunits, org.tridas.schema.TridasValues tv, Integer maxIntChars) Convert a TridasValues tag from one unit to another.
static org.tridas.schema.TridasValues	convertTridasValuesWithMaxDigits(org.tridas.schema.NormalTridasUnit outputunits, org.tridas.schema.TridasValues tv, Boolean outputAsIntegers, Integer maxDigits)
static DecimalFormat	getDecimalFormatForSigFigs(org.tridas.schema.NormalTridasUnit inputunits, org.tridas.schema.NormalTridasUnit outputunits) This function returns the DecimalFormat with the correct number of significant figures when converting from one unit type to another.
static org.tridas.schema.NormalTridasUnit	parseUnitString(String str) Parse a NormalTridasUnit from a string

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitUtils

public UnitUtils()

Method Detail

convertBigDecimal

public static BigDecimal convertBigDecimal(org.tridas.schema.NormalTridasUnit inputunits,
                                           org.tridas.schema.NormalTridasUnit outputunits,
                                           BigDecimal value)

Convert a BigDecimal value from one unit to another

Parameters:

inputunits -

outputunits -

value -

Returns:

convertBigInteger

public static BigInteger convertBigInteger(org.tridas.schema.NormalTridasUnit inputunits,
                                           org.tridas.schema.NormalTridasUnit outputunits,
                                           BigInteger value)

Convert a BigInteger value from one unit to another

Parameters:

inputunits -

outputunits -

value -

Returns:

parseUnitString

public static org.tridas.schema.NormalTridasUnit parseUnitString(String str)
                                                          throws Exception

Parse a NormalTridasUnit from a string

Parameters:

str -

Returns:

Throws:

Exception

convertDouble

public static Double convertDouble(org.tridas.schema.NormalTridasUnit inputunits,
                                   org.tridas.schema.NormalTridasUnit outputunits,
                                   Double value)

Convert a data value from one unit to another

Parameters:

inputunits -

outputunits -

value -

Returns:

convertTridasValues

public static org.tridas.schema.TridasValues convertTridasValues(org.tridas.schema.NormalTridasUnit outputunits,
                                                                 org.tridas.schema.TridasValues tv,
                                                                 Integer maxIntChars)
                                                          throws NumberFormatException,
                                                                 ConversionWarningException

Convert a TridasValues tag from one unit to another. The TridasVales must have NormalTridasUnit set otherwise it throws an IncompleteTridasDataException. The values returns are integers limited to maxIntChars in length. If any values are longer it throws an NumberFormatException.

Parameters:

outputunits -

tv -

maxIntChars -

Returns:

Throws:

NumberFormatException

IncompleteTridasDataException

ConversionWarningException

getDecimalFormatForSigFigs

public static DecimalFormat getDecimalFormatForSigFigs(org.tridas.schema.NormalTridasUnit inputunits,
                                                       org.tridas.schema.NormalTridasUnit outputunits)

This function returns the DecimalFormat with the correct number of significant figures when converting from one unit type to another.

Parameters:

inputunits -

outputunits -

Returns:

convertTridasValues

public static org.tridas.schema.TridasValues convertTridasValues(org.tridas.schema.NormalTridasUnit outputunits,
                                                                 org.tridas.schema.TridasValues tv,
                                                                 Boolean outputAsIntegers)
                                                          throws NumberFormatException,
                                                                 ConversionWarningException

Convert a TridasValues tag from one unit to another. The TridasValues must have NormalTridasUnit set otherwise it throws an IncompleteTridasDataException. If the outputAsIntegers flag is on, then the data values will be rounded to integers.

Parameters:

outputunits -

tv -

outputAsIntegers -

Returns:

Throws:

NumberFormatException

IncompleteTridasDataException

ConversionWarningException

convertTridasValuesWithMaxDigits

public static org.tridas.schema.TridasValues convertTridasValuesWithMaxDigits(org.tridas.schema.NormalTridasUnit outputunits,
                                                                              org.tridas.schema.TridasValues tv,
                                                                              Boolean outputAsIntegers,
                                                                              Integer maxDigits)
                                                                       throws NumberFormatException,
                                                                              ConversionWarningException

Throws:

NumberFormatException

ConversionWarningException

checkValuesFitInFields

public static Boolean checkValuesFitInFields(org.tridas.schema.TridasValues tv,
                                             Integer maxDigits)