com.rubecula.units
Class UnitsName

java.lang.Object
  com.rubecula.units.UnitsName

public class UnitsName

extends java.lang.Object

The class UnitsName is used to identify units.

Version:

$Revision: 1.4 $ // TODO Ensure Compliance.

Author:

Robin Hillyard

Field Summary

private java.lang.String	_Abbrevtn
private boolean	_Derived
private Rational	_Dimension
private int	_Exponent
private java.lang.String	_Name
private static char	$C_ABBREV_DELIM
private static java.lang.String	$Delimiters
private static java.lang.String[]	$DimPrefix
private static java.lang.String[]	$PrefixesSI1
private static java.lang.String[]	$PrefixesSI3

Constructor Summary

(package private)	UnitsName()
	UnitsName(java.lang.String nameAbbrev)
(package private)	UnitsName(java.lang.String nameAbbrev, boolean derived)
(package private)	UnitsName(java.lang.String nameAbbrev, int exponent)
(package private)	UnitsName(java.lang.String nameAbbrev, int exponent, boolean derived)
	UnitsName(java.lang.String name, java.lang.String abbreviation)
(package private)	UnitsName(java.lang.String name, java.lang.String abbreviation, boolean derived)
(package private)	UnitsName(java.lang.String name, java.lang.String abbreviation, int exponent)
(package private)	UnitsName(java.lang.String name, java.lang.String abbreviation, int exponent, boolean derived)
(package private)	UnitsName(java.lang.String name, java.lang.String abbreviation, int exponent, Rational dimension)
(package private)	UnitsName(java.lang.String name, java.lang.String abbreviation, int exponent, Rational dimension, boolean derived)
(package private)	UnitsName(UnitsName that)

Method Summary

(package private) UnitsName	add(UnitsName that)
(package private) void	audit()
(package private) void	audit(java.lang.String tag)
(package private) static int	complexity(java.lang.String x)
(package private) static java.lang.String	ExpString(Rational x)
java.lang.String	getName()
(package private) UnitsName	getPrefix()
(package private) UnitsName	invert()
(package private) static java.lang.String	InvertString(java.lang.String x)
(package private) boolean	isDerived()
private static int	LookupPrefix(java.lang.String s)
static void	main(java.lang.String[] args)
boolean	matches(java.lang.String name) Method to see if a name matches either the full name or the abbreviation.
(package private) UnitsName	multiply(int x)
(package private) UnitsName	multiply(Rational x)
(package private) int	normalize()
private void	show(java.lang.String name)
(package private) UnitsName	subtract(UnitsName that)
java.lang.String	toString()
(package private) java.lang.String	toString(boolean useAbbrev)

Methods inherited from class java.lang.Object

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

Field Detail

$C_ABBREV_DELIM

private static final char $C_ABBREV_DELIM

See Also:

Constant Field Values

_Name

private java.lang.String _Name

_Abbrevtn

private java.lang.String _Abbrevtn

_Exponent

private int _Exponent

_Dimension

private Rational _Dimension

_Derived

private boolean _Derived

$PrefixesSI3

private static final java.lang.String[] $PrefixesSI3

$PrefixesSI1

private static final java.lang.String[] $PrefixesSI1

$DimPrefix

private static final java.lang.String[] $DimPrefix

$Delimiters

private static final java.lang.String $Delimiters

See Also:

Constant Field Values

Constructor Detail

UnitsName

UnitsName()

UnitsName

UnitsName(java.lang.String name,
          java.lang.String abbreviation,
          int exponent,
          Rational dimension,
          boolean derived)

UnitsName

UnitsName(java.lang.String name,
          java.lang.String abbreviation,
          int exponent,
          Rational dimension)

UnitsName

UnitsName(java.lang.String name,
          java.lang.String abbreviation,
          int exponent,
          boolean derived)

UnitsName

UnitsName(java.lang.String name,
          java.lang.String abbreviation,
          int exponent)

UnitsName

UnitsName(java.lang.String name,
          java.lang.String abbreviation,
          boolean derived)

UnitsName

public UnitsName(java.lang.String name,
                 java.lang.String abbreviation)

UnitsName

UnitsName(java.lang.String nameAbbrev,
          int exponent,
          boolean derived)

UnitsName

UnitsName(java.lang.String nameAbbrev,
          int exponent)

UnitsName

UnitsName(java.lang.String nameAbbrev,
          boolean derived)

UnitsName

public UnitsName(java.lang.String nameAbbrev)

UnitsName

UnitsName(UnitsName that)

Method Detail

audit

final void audit(java.lang.String tag)

audit

final void audit()

toString

final java.lang.String toString(boolean useAbbrev)

toString

public java.lang.String toString()

matches

public boolean matches(java.lang.String name)

Method to see if a name matches either the full name or the abbreviation. Note that this is not yet complete - there are other ways of matching.

Parameters:

name - the string to be matched

Returns:

true if this UnitsName "matches" name

add

final UnitsName add(UnitsName that)
             throws UnitsException

Throws:

UnitsException

subtract

final UnitsName subtract(UnitsName that)
                  throws UnitsException

Throws:

UnitsException

normalize

final int normalize()

InvertString

static java.lang.String InvertString(java.lang.String x)

ExpString

static java.lang.String ExpString(Rational x)

complexity

static final int complexity(java.lang.String x)

invert

final UnitsName invert()
                throws UnitsException

Throws:

UnitsException

isDerived

final boolean isDerived()

multiply

final UnitsName multiply(Rational x)
                  throws UnitsException

Throws:

UnitsException

multiply

final UnitsName multiply(int x)
                  throws UnitsException

Throws:

UnitsException

getPrefix

final UnitsName getPrefix()

LookupPrefix

private static int LookupPrefix(java.lang.String s)
                         throws UnitsException

Throws:

UnitsException

show

private void show(java.lang.String name)

main

public static void main(java.lang.String[] args)

getName

public java.lang.String getName()

Returns:

Returns the name.