prajna.data

Class Measure

java.lang.Object

prajna.data.Measure

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Measure>

public class Measure
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<Measure>

Measurement class, which handles unit conversions and formatting. A particular measure class will measure one type of measurement, such as Length or Mass.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Measure(double measureValue, Unit unitOfMeasure) Instantiates a new measurement

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Measure other) Return if the object is greater than, less than, or equal to this measurement.
Measure	convertTo(Unit otherUnit) Convert to another compatible unit of measure.
java.lang.String	getMeasureType() Gets the measure type.
Unit	getUnit() Gets the unit.
double	getValue() Gets the value.
boolean	isEqualTo(Measure other) Checks this measure is equal to another measure.
static Measure	parse(java.lang.String str, java.lang.String type) Parses a string specifying measurement.
java.lang.String	toString() Convert the measurement to a string representation

Methods inherited from class java.lang.Object

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

Constructor Detail

Measure

public Measure(double measureValue,
       Unit unitOfMeasure)

Instantiates a new measurement

Parameters:

measureValue - the value of the measure

unitOfMeasure - the units used in the measurement

Method Detail

compareTo

public int compareTo(Measure other)

Return if the object is greater than, less than, or equal to this measurement. This measurement may only be compared to another measurement with the same unit type.

Specified by:

compareTo in interface java.lang.Comparable<Measure>

Parameters:

other - the other measure to be compared

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

convertTo

public Measure convertTo(Unit otherUnit)

Convert to another compatible unit of measure.

Parameters:

otherUnit - the other unit of measure

Returns:

the converted measure.

getMeasureType

public java.lang.String getMeasureType()

Gets the measure type. This method uses reflection and assumes that the measurement unit class is specified by a class ending in "Unit", e.g., "LengthUnit". Otherwise, it simply returns the class name of the unit class.

Returns:

the measure type

getUnit

public Unit getUnit()

Gets the unit.

Returns:

the unit for this measurement

getValue

public double getValue()

Gets the value.

Returns:

the value for this measurement

isEqualTo

public boolean isEqualTo(Measure other)

Checks this measure is equal to another measure. If the converted measure of both measurements is equal, this method returns true. For instance, this method would return true if one measure were 1 inch, and the other measure was 2.54 centimeters.

Parameters:

other - the other measurement

Returns:

true if this measurement is equal to the other measurement, false otherwise.

toString

public java.lang.String toString()

Convert the measurement to a string representation

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this measurement.

parse

public static Measure parse(java.lang.String str,
            java.lang.String type)
                     throws java.text.ParseException

Parses a string specifying measurement. This method tries to identify the correct unit and measurement

Parameters:

str - the string to parse

type - the measurement type

Returns:

the measurement

Throws:

java.text.ParseException - if there is an error parsing the measurement string.