JScience v4.3

javax.measure.unit
Class TransformedUnit<Q extends Quantity>

java.lang.Object
  extended by javax.measure.unit.Unit<Q>
      extended by javax.measure.unit.DerivedUnit<Q>
          extended by javax.measure.unit.TransformedUnit<Q>
All Implemented Interfaces:
java.io.Serializable

public final class TransformedUnit<Q extends Quantity>
extends DerivedUnit<Q>

This class represents the units derived from other units using converters.

Examples of transformed units:

         CELSIUS = KELVIN.add(273.15);
         FOOT = METER.multiply(0.3048);
         MILLISECOND = MILLI(SECOND); 
     

Transformed units have no label. But like any other units, they may have labels attached to them:

         UnitFormat.getStandardInstance().label(FOOT, "ft");
     
or aliases:
         UnitFormat.getStandardInstance().alias(CENTI(METER)), "centimeter");
         UnitFormat.getStandardInstance().alias(CENTI(METER)), "centimetre");
     

Version:
3.1, April 22, 2006
Author:
Jean-Marie Dautelle
See Also:
Unit.plus(double), Unit.times(double), Unit.transform(UnitConverter), UnitFormat, Serialized Form

Field Summary
 
Fields inherited from class javax.measure.unit.Unit
ONE
 
Method Summary
 boolean equals(java.lang.Object that)
          Indicates if this transformed unit is considered equals to the specified object (both are transformed units with equal parent unit and equal converter to parent unit).
 Unit<Q> getParentUnit()
          Returns the parent unit for this unit.
 Unit<? super Q> getStandardUnit()
          Returns the base unit, alternate unit or product of base units and alternate units this unit is derived from.
 int hashCode()
          Returns the hash code for this unit.
 UnitConverter toParentUnit()
          Returns the converter to the parent unit.
 UnitConverter toStandardUnit()
          Returns the converter from this unit to its system unit.
 
Methods inherited from class javax.measure.unit.Unit
alternate, asType, compound, divide, divide, divide, getConverterTo, getDimension, inverse, isCompatible, isStandardUnit, plus, pow, root, times, times, times, toString, transform, valueOf
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getParentUnit

public Unit<Q> getParentUnit()
Returns the parent unit for this unit. The parent unit is the untransformed unit from which this unit is derived.

Returns:
the untransformed unit from which this unit is derived.

toParentUnit

public UnitConverter toParentUnit()
Returns the converter to the parent unit.

Returns:
the converter to the parent unit.

equals

public boolean equals(java.lang.Object that)
Indicates if this transformed unit is considered equals to the specified object (both are transformed units with equal parent unit and equal converter to parent unit).

Specified by:
equals in class Unit<Q extends Quantity>
Parameters:
that - the object to compare for equality.
Returns:
true if this and that are considered equals; falseotherwise.

hashCode

public int hashCode()
Description copied from class: Unit
Returns the hash code for this unit.

Specified by:
hashCode in class Unit<Q extends Quantity>
Returns:
this unit hashcode value.

getStandardUnit

public Unit<? super Q> getStandardUnit()
Description copied from class: Unit
Returns the base unit, alternate unit or product of base units and alternate units this unit is derived from. The standard unit identifies the "type" of quantity for which this unit is employed. For example:
    boolean isAngularVelocity(Unit<?> u) {
       return u.getStandardUnit().equals(RADIAN.divide(SECOND));
    }
    assert(REVOLUTION.divide(MINUTE).isAngularVelocity());  
 

Note: Having the same system unit is not sufficient to ensure that a converter exists between the two units (e.g. °C/m and K/m).

Specified by:
getStandardUnit in class Unit<Q extends Quantity>
Returns:
the system unit this unit is derived from.

toStandardUnit

public UnitConverter toStandardUnit()
Description copied from class: Unit
Returns the converter from this unit to its system unit.

Specified by:
toStandardUnit in class Unit<Q extends Quantity>
Returns:
this.getConverterTo(this.getSystemUnit())

JScience v4.3

Copyright © 2006 JScience.