com.screenscraper.profiling.session.units

Class Measure<T extends MeasureEnum>

java.lang.Object

com.screenscraper.profiling.session.units.Measure<T>

All Implemented Interfaces:

java.lang.Comparable<Measure<T>>

Direct Known Subclasses:

TimeMeasurement

public abstract class Measure<T extends MeasureEnum>
extends java.lang.Object
implements java.lang.Comparable<Measure<T>>

The default format of the classes that store number information with units of some kind. Methods were implemented using generics so that each child class specifies what type of size it is, but the outside user doesn't have to deal with it, yet will be restricted to doing math only between correct sizes Author: Mike Date: 2/27/12 Time: 6:02 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected RationalNumber	amount
protected static java.util.regex.Pattern	PARSE_PATTERN The general pattern for parsing measurements
protected static java.lang.String	PARSED_AMOUNT_NAME The group name representing the amount of the measure
protected static java.lang.String	PARSED_UNIT_NAME The group name representing the unit of measure
protected T	size

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Measure(double amount, T measure) Creates a storage amount
protected	Measure(Measure<T> other) Creates a copy of the other measurement and returns it
protected	Measure(RationalNumber amount, T measure) Creates a storage amount

Method Summary

Modifier and Type	Method and Description
<U extends Measure<T>> U	add(U other) Adds an amount to the current amount
int	compareTo(Measure<T> other)
<U extends Measure<T>> U	convertSize(T newSize) Converts one measure to another, by changing the size type.
<U extends Measure<T>> U	convertToBaseSize() Converts this measurement to it's base size
<U extends Measure<T>> U	convertToBestSize() Converts this to the best size fit to write out with the smallest fraction part in acceptable sizes
<U extends Measure<T>> U	convertToBestSize(MeasurementSystem... allowedSystems) Converts this to the best size fit to write out with the smallest fraction part in acceptable sizes
<U extends Measure<T>> U	divideBy(double amount) Divides the current amount by a given constant
<U extends Measure<T>> U	divideBy(RationalNumber amount) Divides the current amount by a given constant
<U extends Measure<T>> RationalNumber	divideBy(U amount) Divides the current amount by a given amount
boolean	equals(java.lang.Object o) Checks to see if this is equal to another measurement, but converts to the same units first.
RationalNumber	getAmount() Returns the amount of the measurement
RationalNumber	getAmountAs(T measure) Returns the amount of this measure in a different size
protected RationalNumber	getAmountInBaseSize() Returns the size of this measurement in it's base form, as an amount
protected int	getGoodDenominator() The value at which a value is "good" if it has a denominator less than this.
T	getSize() Returns the current measurement unit
java.lang.String	getSizeString() Returns the name portion of the measure
boolean	greaterThan(Measure<T> other) Returns this > other
boolean	greaterThanOrEqualTo(Measure<T> other) Returns this >= other
int	hashCode()
boolean	lessThan(Measure<T> other) Returns this < other
boolean	lessThanOrEqualTo(Measure<T> other) Returns this <= other
protected java.util.List<T>	listSizes(T smallestSize, T largestSize, MeasurementSystem... allowedSystems) Lists all the sizes in this size, from largest to smallest with the given filtering criteria
<U extends Measure<T>> U	minus(U other) Subtracts an amount from the current amount
<U extends Measure<T>> U	multiply(double amount) Multiplies the current amount by a given constant
<U extends Measure<T>> U	multiply(RationalNumber amount) Multiplies the current amount by a given constant
(package private) static <U extends MeasureEnum,V extends Measure<U>> V	parseGeneric(java.lang.String text, java.lang.Class<V> measureClass, U baseSize) Generic parse method
static <U extends Measure> U	parseMeasure(java.lang.String text) Parses the text to the given type of measure
<U extends Measure<T>> U	plus(U other) Adds an amount to the current amount
<U extends Measure<T>> U	roundToNearestFraction(RationalNumber multiple) Returns a measurement in the current size that is the nearest whole multiple of the given size.
<U extends Measure<T>> U	roundToNearestFractionInSize(RationalNumber multiple, T newSize) Returns a measurement in the given size that is the nearest whole multiple of the given size.
<U extends Measure<T>> U	subtract(U other) Subtracts an amount from the current amount
<U extends Measure<T>> U	times(double amount) Multiplies the current amount by a given constant
<U extends Measure<T>> U	times(RationalNumber amount) Multiplies the current amount by a given constant
java.lang.String	toExpandedDecimalString(T smallestSize, T largestSize, int maxToShow, boolean showIntermediateZeroValues, boolean limitFromFirstFound, int decimalPlacesToShow, MeasurementSystem... allowedSystems) Outputs the measurement in a pretty string format.
java.lang.String	toExpandedString() Outputs the measurement in a pretty string format.
java.lang.String	toExpandedString(int maxToShow) Outputs the measurement in a pretty string format.
java.lang.String	toExpandedString(int maxToShow, boolean limitFromFirstFound) Outputs the measurement in a pretty string format.
java.lang.String	toExpandedString(T smallestSize, T largestSize) Outputs the measurement in a pretty string format.
java.lang.String	toExpandedString(T smallestSize, T largestSize, int maxToShow, boolean showIntermediateZeroValues, boolean limitFromFirstFound) Outputs the measurement in a pretty string format.
java.lang.String	toExpandedString(T smallestSize, T largestSize, int maxToShow, boolean showIntermediateZeroValues, boolean limitFromFirstFound, boolean truncateFinalValue, MeasurementSystem... allowedSystems) Outputs the measurement in a pretty string format.
java.lang.String	toExpandedString(T smallestSize, T largestSize, int maxToShow, boolean showIntermediateZeroValues, boolean limitFromFirstFound, MeasurementSystem... allowedSystems) Outputs the measurement in a pretty string format.
java.lang.String	toString()
java.lang.String	toStringWithWholePart() Returns a string representation of this measurement, but splits the number portion into both a whole quantity and a fraction
static <U extends Measure> U	valueOf(java.lang.String text) Parses the text to the given type of measure.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

amount

protected final RationalNumber amount

size

protected final T extends MeasureEnum size

PARSE_PATTERN

protected static final java.util.regex.Pattern PARSE_PATTERN

The general pattern for parsing measurements

PARSED_AMOUNT_NAME

protected static final java.lang.String PARSED_AMOUNT_NAME

The group name representing the amount of the measure

See Also:

Constant Field Values

PARSED_UNIT_NAME

protected static final java.lang.String PARSED_UNIT_NAME

The group name representing the unit of measure

See Also:

Constant Field Values

Constructor Detail

Measure

protected Measure(double amount,
                  T measure)

Creates a storage amount

Parameters:

amount - The amount

measure - The measurement measure

Measure

protected Measure(RationalNumber amount,
                  T measure)

Creates a storage amount

Parameters:

amount - The amount

measure - The measurement measure

Measure

protected Measure(@NotNull
                  Measure<T> other)

Creates a copy of the other measurement and returns it

Parameters:

other - The other measurement

Method Detail

valueOf

@NotNull
public static <U extends Measure> U valueOf(java.lang.String text)
                                               throws java.text.ParseException

Parses the text to the given type of measure. The valueOf method may return the same object each time it is called for text that parses to the given measurement.

Parameters:

text - The text to parse

Returns:

The measurement

Throws:

java.text.ParseException - If the text could not be parsed into the measurement

parseMeasure

@NotNull
public static <U extends Measure> U parseMeasure(java.lang.String text)
                                                    throws java.text.ParseException

Parses the text to the given type of measure

Parameters:

text - The text to parse

Returns:

The measurement

Throws:

java.text.ParseException - If the text could not be parsed into the measurement

parseGeneric

@Nullable
static <U extends MeasureEnum,V extends Measure<U>> V parseGeneric(@NotNull
                                                                              java.lang.String text,
                                                                              java.lang.Class<V> measureClass,
                                                                              @NotNull
                                                                              U baseSize)
                                                                       throws java.text.ParseException

Generic parse method

Type Parameters:

U - The Measurement Size type

V - The Measure type

Parameters:

text - The text to parse

measureClass - The measurement class

baseSize - The base size

Returns:

The parsed measurement, or null if parsing failed with no errors

Throws:

java.text.ParseException - If an error occurs while parsing the given text

getGoodDenominator

protected int getGoodDenominator()

The value at which a value is "good" if it has a denominator less than this. For example, 1/4 is good and should be shown as a size

convertSize

public <U extends Measure<T>> U convertSize(T newSize)

Converts one measure to another, by changing the size type.

In this implementation, this method is implemented with reflection. This allows the abstract class to define the method It will fail if there is no constructor that takes (RationalNumber, newSize).

Type Parameters:

U - The same type of measurement

Parameters:

newSize - The new size type

Returns:

The measure converted to the new size

roundToNearestFraction

public <U extends Measure<T>> U roundToNearestFraction(@NotNull
                                                       RationalNumber multiple)

Returns a measurement in the current size that is the nearest whole multiple of the given size. See RationalNumber.roundToNearestMultiple(RationalNumber) for more details.

Type Parameters:

U - The same type of measurement

Parameters:

multiple - The multiple to fraction multiple to

Returns:

The measure rounded to the new multiple

roundToNearestFractionInSize

public <U extends Measure<T>> U roundToNearestFractionInSize(@NotNull
                                                             RationalNumber multiple,
                                                             T newSize)

Returns a measurement in the given size that is the nearest whole multiple of the given size. See RationalNumber.roundToNearestMultiple(RationalNumber) for more details.

Type Parameters:

U - The same type of measurement

Parameters:

multiple - The multiple to fraction multiple to

newSize - The new measurement size for the measurement

Returns:

The measure rounded to the new multiple and in the new size

plus

public <U extends Measure<T>> U plus(@NotNull
                                     U other)

Adds an amount to the current amount

Type Parameters:

U - The same type of measurement

Parameters:

other - The amount to add

Returns:

A reference to the object that was just updated

add

public <U extends Measure<T>> U add(@NotNull
                                    U other)

Adds an amount to the current amount

Type Parameters:

U - The same type of measurement

Parameters:

other - The amount to add

Returns:

A reference to the object that was just updated

minus

public <U extends Measure<T>> U minus(@NotNull
                                      U other)

Subtracts an amount from the current amount

Type Parameters:

U - The same type of measurement

Parameters:

other - The amount to subtract

Returns:

A new measure with the requested conversion applied

subtract

public <U extends Measure<T>> U subtract(@NotNull
                                         U other)

Subtracts an amount from the current amount

Type Parameters:

U - The same type of measurement

Parameters:

other - The amount to subtract

Returns:

A new measure with the requested conversion applied

multiply

public <U extends Measure<T>> U multiply(double amount)

Multiplies the current amount by a given constant

Type Parameters:

U - The same type of measurement

Parameters:

amount - The amount to multiply by

Returns:

A new measure with the requested conversion applied

multiply

public <U extends Measure<T>> U multiply(@NotNull
                                         RationalNumber amount)

Multiplies the current amount by a given constant

Type Parameters:

U - The same type of measurement

Parameters:

amount - The amount to multiply by

Returns:

A new measure with the requested conversion applied

times

public <U extends Measure<T>> U times(double amount)

Multiplies the current amount by a given constant

Type Parameters:

U - The same type of measurement

Parameters:

amount - The amount to multiply by

Returns:

A reference to the object that was just updated

times

public <U extends Measure<T>> U times(@NotNull
                                      RationalNumber amount)

Multiplies the current amount by a given constant

Type Parameters:

U - The same type of measurement

Parameters:

amount - The amount to multiply by

Returns:

A reference to the object that was just updated

divideBy

public <U extends Measure<T>> U divideBy(double amount)

Divides the current amount by a given constant

Type Parameters:

U - The same type of measurement

Parameters:

amount - The amount to divide by

Returns:

A reference to the object that was just updated

divideBy

public <U extends Measure<T>> U divideBy(@NotNull
                                         RationalNumber amount)

Divides the current amount by a given constant

Type Parameters:

U - The same type of measurement

Parameters:

amount - The amount to divide by

Returns:

A reference to the object that was just updated

divideBy

public <U extends Measure<T>> RationalNumber divideBy(@NotNull
                                                      U amount)

Divides the current amount by a given amount

Type Parameters:

U - The same type of measurement

Parameters:

amount - The amount to divide by

Returns:

A reference to the object that was just updated

getSize

public T getSize()

Returns the current measurement unit

Returns:

The measurement unit this is in

getAmount

public RationalNumber getAmount()

Returns the amount of the measurement

Returns:

The amount of the measurement

getAmountInBaseSize

protected RationalNumber getAmountInBaseSize()

Returns the size of this measurement in it's base form, as an amount

Returns:

The quantity in the base unit

getSizeString

public java.lang.String getSizeString()

Returns the name portion of the measure

Returns:

The name portion of the measure

convertToBaseSize

public <U extends Measure<T>> U convertToBaseSize()

Converts this measurement to it's base size

Type Parameters:

U - The measure type

Returns:

The measurement in its base size

toExpandedString

@NotNull
public java.lang.String toExpandedString()

Outputs the measurement in a pretty string format. This, for time, might be something like 5 min 6 sec.

Returns:

The pretty string representation of the given measure

toExpandedString

@NotNull
public java.lang.String toExpandedString(@Nullable
                                                   T smallestSize,
                                                   @Nullable
                                                   T largestSize)

Outputs the measurement in a pretty string format. This, for time, might be something like 5 min 6 sec.

Parameters:

smallestSize - The smallest size that should be output (smaller values are truncated)

largestSize - The largest size that should be output (larger values are added in, so you may get something like 3600 seconds)

Returns:

The pretty string representation of the given measure

toExpandedString

@NotNull
public java.lang.String toExpandedString(int maxToShow)

Outputs the measurement in a pretty string format. This, for time, might be something like 5 min 6 sec.

Parameters:

maxToShow - The maximum sizes to show total. This can be used so if a value is output in years, milliseconds won't have to be shown. Set to <=0 to show all values

Returns:

The pretty string representation of the given measure

toExpandedString

@NotNull
public java.lang.String toExpandedString(int maxToShow,
                                                   boolean limitFromFirstFound)

Outputs the measurement in a pretty string format. This, for time, might be something like 5 min 6 sec.

Parameters:

maxToShow - The maximum sizes to show total. This can be used so if a value is output in years, milliseconds won't have to be shown. Set to <=0 to show all values

limitFromFirstFound - True if the maxToShow should count each zero value after the first non-zero value. False to only count values >= 1

Returns:

The pretty string representation of the given measure

toExpandedString

@NotNull
public java.lang.String toExpandedString(@Nullable
                                                   T smallestSize,
                                                   @Nullable
                                                   T largestSize,
                                                   int maxToShow,
                                                   boolean showIntermediateZeroValues,
                                                   boolean limitFromFirstFound)

Outputs the measurement in a pretty string format. This, for time, might be something like 5 min 6 sec.

Parameters:

smallestSize - The smallest size that should be output (smaller values are truncated)

largestSize - The largest size that should be output (larger values are added in, so you may get something like 3600 seconds)

maxToShow - The maximum sizes to show total. This can be used so if a value is output in years, milliseconds won't have to be shown. Set to <=0 to show all values

showIntermediateZeroValues - True if values after the first non-zero value should still show, even if they are 0. False to only show values >=1

limitFromFirstFound - True if the maxToShow should count each zero value after the first non-zero value. False to only count values >= 1

Returns:

The pretty string representation of the given measure

toExpandedString

@NotNull
public java.lang.String toExpandedString(@Nullable
                                                   T smallestSize,
                                                   @Nullable
                                                   T largestSize,
                                                   int maxToShow,
                                                   boolean showIntermediateZeroValues,
                                                   boolean limitFromFirstFound,
                                                   MeasurementSystem... allowedSystems)

Outputs the measurement in a pretty string format. This, for time, might be something like 5 min 6 sec.

Parameters:

smallestSize - The smallest size that should be output (smaller values are truncated)

largestSize - The largest size that should be output (larger values are added in, so you may get something like 3600 seconds)

maxToShow - The maximum sizes to show total. This can be used so if a value is output in years, milliseconds won't have to be shown. Set to <=0 to show all values

showIntermediateZeroValues - True if values after the first non-zero value should still show, even if they are 0. False to only show values >=1

limitFromFirstFound - True if the maxToShow should count each zero value after the first non-zero value. False to only count values >= 1

allowedSystems - The systems of measurement to allow in the expanded string version

Returns:

The pretty string representation of the given measure

toExpandedString

@NotNull
public java.lang.String toExpandedString(@Nullable
                                                   T smallestSize,
                                                   @Nullable
                                                   T largestSize,
                                                   int maxToShow,
                                                   boolean showIntermediateZeroValues,
                                                   boolean limitFromFirstFound,
                                                   boolean truncateFinalValue,
                                                   @Nullable
                                                   MeasurementSystem... allowedSystems)

Outputs the measurement in a pretty string format. This, for time, might be something like 5 min 6 sec.

Parameters:

smallestSize - The smallest size that should be output (smaller values are truncated)

largestSize - The largest size that should be output (larger values are added in, so you may get something like 3600 seconds)

maxToShow - The maximum sizes to show total. This can be used so if a value is output in years, milliseconds won't have to be shown. Set to <=0 to show all values

showIntermediateZeroValues - True if values after the first non-zero value should still show, even if they are 0. False to only show values >=1

limitFromFirstFound - True if the maxToShow should count each zero value after the first non-zero value. False to only count values >= 1

truncateFinalValue - True if the final value should be shown only as a whole number (as opposed to a fraction). If the fraction has a good denominator, it will not be truncated

allowedSystems - The systems of measurement to allow in the expanded string version

Returns:

The pretty string representation of the given measure

toExpandedDecimalString

@NotNull
public java.lang.String toExpandedDecimalString(@Nullable
                                                          T smallestSize,
                                                          @Nullable
                                                          T largestSize,
                                                          int maxToShow,
                                                          boolean showIntermediateZeroValues,
                                                          boolean limitFromFirstFound,
                                                          int decimalPlacesToShow,
                                                          @Nullable
                                                          MeasurementSystem... allowedSystems)

Outputs the measurement in a pretty string format. This, for time, might be something like 5 min 6 sec.

Parameters:

smallestSize - The smallest size that should be output (smaller values are truncated)

largestSize - The largest size that should be output (larger values are added in, so you may get something like 3600 seconds)

maxToShow - The maximum sizes to show total. This can be used so if a value is output in years, milliseconds won't have to be shown. Set to <=0 to show all values

showIntermediateZeroValues - True if values after the first non-zero value should still show, even if they are 0. False to only show values >=1

limitFromFirstFound - True if the maxToShow should count each zero value after the first non-zero value. False to only count values >= 1

decimalPlacesToShow - The number of decimal places to display instead of a fractional value for the final value. If truncateFinalValue is true, this value does nothing. Negative means force trailing 0s on the decimal, with the magnitude being how many to show max

allowedSystems - The systems of measurement to allow in the expanded string version

Returns:

The pretty string representation of the given measure

listSizes

@NotNull
protected java.util.List<T> listSizes(@Nullable
                                                T smallestSize,
                                                @Nullable
                                                T largestSize,
                                                MeasurementSystem... allowedSystems)

Lists all the sizes in this size, from largest to smallest with the given filtering criteria

Parameters:

smallestSize - The smallest size to allow

largestSize - The largest size to allow

allowedSystems - The allowed measurement systems

Returns:

A list, sorted smallest to largest, of the sizes

convertToBestSize

public <U extends Measure<T>> U convertToBestSize()

Converts this to the best size fit to write out with the smallest fraction part in acceptable sizes

Returns:

The measure in the best fitting size

getAmountAs

public RationalNumber getAmountAs(T measure)

Returns the amount of this measure in a different size

Parameters:

measure - The new size

Returns:

The amount in the new size

convertToBestSize

public <U extends Measure<T>> U convertToBestSize(MeasurementSystem... allowedSystems)

Converts this to the best size fit to write out with the smallest fraction part in acceptable sizes

Parameters:

allowedSystems - What measurement systems are allowed to be used

Returns:

The measure in the best fitting size

toStringWithWholePart

@NotNull
public java.lang.String toStringWithWholePart()

Returns a string representation of this measurement, but splits the number portion into both a whole quantity and a fraction

Returns:

The string representation with the numbers as 1 1/2 rather than 3/2

equals

public boolean equals(java.lang.Object o)

Checks to see if this is equal to another measurement, but converts to the same units first. For example, 36 inches equals 3 feet equals 1 yard

Overrides:

equals in class java.lang.Object

Parameters:

o - The other measurement

Returns:

True if the measurements are of the same type and the actual amounts are the same

greaterThan

public boolean greaterThan(Measure<T> other)

Returns this > other

Parameters:

other - The other number. Null is smaller than everything

Returns:

True if this > other or other == null

greaterThanOrEqualTo

public boolean greaterThanOrEqualTo(Measure<T> other)

Returns this >= other

Parameters:

other - The other number. Null is smaller than everything

Returns:

True if this >= other or other == null

lessThan

public boolean lessThan(Measure<T> other)

Returns this < other

Parameters:

other - The other number. Null is smaller than everything

Returns:

True if this < other (returns false if other == null)

lessThanOrEqualTo

public boolean lessThanOrEqualTo(Measure<T> other)

Returns this <= other

Parameters:

other - The other number. Null is smaller than everything

Returns:

True if this <= other (returns false if other == null)

compareTo

public int compareTo(@Nullable
                     Measure<T> other)

Specified by:

compareTo in interface java.lang.Comparable<Measure<T extends MeasureEnum>>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object