com.screenscraper.profiling.session.units

Interface MeasureEnum<T extends MeasureEnum>

All Known Implementing Classes:

TimeSize

public interface MeasureEnum<T extends MeasureEnum>

Interface defining the operations that any measurement size should be able to perform Author: Mike Date: 2/27/12 Time: 5:41 PM

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAbbreviation() Returns the most common abbreviation for this measure
java.util.Collection<java.lang.String>	getAbbreviations() Returns a set of all possible abbreviations for this unit
T	getBaseUnit() Returns the base unit used as a base in this type
RationalNumber	getConversionRateFromBase() Gets a rational number that represents the conversion rate from the a base size to this size.
RationalNumber	getConversionRateTo(T otherSize) Gets a rational number that represents the conversion rate from the a base size to this size.
RationalNumber	getConversionRateToBase() Gets a rational number that represents the conversion rate from the given size to the base measure for this size.
MeasurementSystem	getMeasurementSystem() Returns the measurement system this is a part of
java.lang.String	getName() Returns the name of this measure.
java.lang.String	getPluralName() Returns the name of this measure in plural.

Method Detail

getBaseUnit

@NotNull
T getBaseUnit()

Returns the base unit used as a base in this type

Returns:

The unit being used as the base

getAbbreviation

@Nullable
java.lang.String getAbbreviation()

Returns the most common abbreviation for this measure

Returns:

The abbreviation for the measurement

getAbbreviations

@NotNull
java.util.Collection<java.lang.String> getAbbreviations()

Returns a set of all possible abbreviations for this unit

Returns:

All possible abbreviations for this unit

getName

java.lang.String getName()

Returns the name of this measure. This is given since some measures will match keywords, etc...

Returns:

The name of this measurement

getPluralName

java.lang.String getPluralName()

Returns the name of this measure in plural.

Returns:

The name of this measurement in plural form

getConversionRateToBase

RationalNumber getConversionRateToBase()

Gets a rational number that represents the conversion rate from the given size to the base measure for this size. The base measure is simply defined by each class, and is used to convert between sizes

Returns:

The conversion rate to a base size

getConversionRateFromBase

@NotNull
RationalNumber getConversionRateFromBase()

Gets a rational number that represents the conversion rate from the a base size to this size.

Returns:

The conversion rate from a base size to this size

getConversionRateTo

@NotNull
RationalNumber getConversionRateTo(T otherSize)

Gets a rational number that represents the conversion rate from the a base size to this size.

Parameters:

otherSize - The size to convert to

Returns:

The conversion rate from a base size to this size

getMeasurementSystem

MeasurementSystem getMeasurementSystem()

Returns the measurement system this is a part of

Returns:

The measurement system this is a part of