Package ome.model.units

Class Conversion

java.lang.Object

ome.model.units.Conversion

Direct Known Subclasses:

Conversion.Add, Conversion.Int, Conversion.Mul, Conversion.Pow, Conversion.Rat, Conversion.Sym

public abstract class Conversion
extends java.lang.Object

Base-functor like object which can be used for preparing complex equations for converting from one unit to another. Primarily these classes and static methods are used via code-generation. Sympy-generated strings are placed directly into code. If the proper imports are in place, then a top-level Conversion (usually of type Conversion.Add or Conversion.Mul is returned from the evaluation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Conversion.Add	Sums all Conversion instances via BigDecimal.add(BigDecimal).
static class	Conversion.Int	Simply is a representation of a possibly large integer.
static class	Conversion.Mul	Multiplies all Conversion instances via BigDecimal.multiply(BigDecimal).
static class	Conversion.Pow	Exponentiates two Conversion instances via BigDecimal.pow(int).
static class	Conversion.Rat	Divides two Conversion instances via BigDecimal.divide(BigDecimal, MathContext).
static class	Conversion.Sym	Simply represents the variable of the source unit so that Conversion.Sym.convert(double) just returns the value passed in.

Field Summary

Fields

Modifier and Type	Field	Description
protected Conversion[]	conversions	Conversions, if any, which are passed into the constructor of this instance.

Constructor Summary

Constructors

Constructor	Description
Conversion(Conversion... conversions)	Primary constructor for a Conversion object.

Method Summary

Modifier and Type	Method	Description
static Conversion	Add(Conversion... conversions)	Static helper for creating Conversion.Add instances.
abstract java.math.BigDecimal	convert(double original)	Primary operator for Conversion instances.
static Conversion	Int(long i)	Static helper for creating Conversion.Int instances.
static Conversion	Int(java.lang.String i)	Static helper for creating Conversion.Int instances.
static Conversion	Mul(Conversion... conversions)	Static helper for creating Conversion.Mul instances.
static Conversion	Pow(long num, int den)	Static helper for creating Conversion.Pow instances.
static Conversion	Rat(long num, long den)	Static helper for creating Conversion.Rat instances.
static Conversion	Rat(Conversion... conversions)	Static helper for creating Conversion.Rat instances.
static Conversion	Sym(java.lang.String sym)	Static helper for creating Conversion.Sym instances.

Methods inherited from class java.lang.Object

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

Field Detail

conversions

protected final Conversion[] conversions

Conversions, if any, which are passed into the constructor of this instance. If none are passed, then the implementation has a short-cut form, e.g. taking an Integer rather than an Conversion.Int.

Constructor Detail

Conversion

public Conversion(Conversion... conversions)

Primary constructor for a Conversion object. No processing happens during constructor. Instead, the convert(double) method will handle descending through the recursive structure.

Parameters:

conversions - can be empty.

Method Detail

Add

public static Conversion Add(Conversion... conversions)

Static helper for creating Conversion.Add instances.

Int

public static Conversion Int(long i)

Static helper for creating Conversion.Int instances.

Int

public static Conversion Int(java.lang.String i)

Static helper for creating Conversion.Int instances.

Mul

public static Conversion Mul(Conversion... conversions)

Static helper for creating Conversion.Mul instances.

Pow

public static Conversion Pow(long num,
                             int den)

Static helper for creating Conversion.Pow instances.

Rat

public static Conversion Rat(long num,
                             long den)

Static helper for creating Conversion.Rat instances.

Rat

public static Conversion Rat(Conversion... conversions)

Static helper for creating Conversion.Rat instances.

Sym

public static Conversion Sym(java.lang.String sym)

Static helper for creating Conversion.Sym instances.

convert

public abstract java.math.BigDecimal convert(double original)

Primary operator for Conversion instances.

Parameters:

original - A unit value which is to be processed through the tree-like representation of this equation. Only Conversion.Sym objects will actually use the "original" value.

Returns:

a BigDecimal result from the calculation. If this value maps to Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY, then a BigResult exception should be thrown before returning to clients.