com.rubecula.units
Class UnitsFoundation

java.lang.Object
  com.rubecula.util.Item
      com.rubecula.units.BaseUnit
          com.rubecula.units.UnitsFoundation

All Implemented Interfaces:

Auditable, java.lang.Comparable, Identifiable, Measurable, Nameable, Presentable, java.io.Serializable

Direct Known Subclasses:

Units

public abstract class UnitsFoundation

extends BaseUnit

implements Nameable, Auditable

The public abstract class UnitsFoundation is the base class from which the other Units (Measurable) classes are derived.

Version:

$Revision: 1.3 $ // TODO Ensure compliance.

Author:

Robin Hillyard

See Also:

Serialized Form

Field Summary

protected UnitsName	_Name The name by which this UnitsFoundation will be identified.
private static boolean	debug
(package private) static java.lang.String	UNITS_TEST

Fields inherited from class com.rubecula.util.Item

JQUANTITY_TEST

Constructor Summary

(package private)	UnitsFoundation()
(package private)	UnitsFoundation(UnitsFoundation that)
(package private)	UnitsFoundation(UnitsName name)

Method Summary

java.lang.String	audit() Method to return a detailed (unlabeled) string from an Auditable object for debugging purposes.
void	audit(java.io.PrintStream out, java.lang.String label) Method to output detailed string from an object for debugging purposes.
java.lang.String	audit(java.lang.String label) Method to return a detailed string from an arithmetical object for debugging purposes.
java.lang.String	getIdentifier() Method to get the specific identifier for an object.
boolean	isNumber() Method to determine if this is dimensionless (i.e. unitless).
(package private) void	monitor(java.lang.String method, java.lang.String[] args, java.lang.String result)
(package private) int	normalize()
void	setIdentifier(java.lang.String identifier) Method to set a specific identifier to an object.
void	setName(java.lang.String name)
void	setName(java.lang.String nameAbbrev, boolean force)
void	setName(java.lang.String nameAbbrev, int exponent, boolean force)
void	setName(UnitsName name)
void	setName(UnitsName name, boolean force)
void	setName(UnitsName name, boolean force, int sysIndex)
java.lang.String	toString() This is the default toString method for all Items.
abstract java.lang.String	toString(int sysIndex)

Methods inherited from class com.rubecula.units.BaseUnit

isEqual, isInSystem, isParallel, isParallelInSystem

Methods inherited from class com.rubecula.util.Item

compareTo, Debug, getClassNameShort, getType, IsDebug, present, SetDebug, test, test, Wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rubecula.units.Measurable

flatten, getDimensions, getOffset, getScale, getSystem

Methods inherited from interface com.rubecula.util.Presentable

makePresentableInstance, present

Field Detail

UNITS_TEST

static final java.lang.String UNITS_TEST

See Also:

Constant Field Values

_Name

protected UnitsName _Name

The name by which this UnitsFoundation will be identified.

debug

private static boolean debug

Constructor Detail

UnitsFoundation

UnitsFoundation()

UnitsFoundation

UnitsFoundation(UnitsName name)

UnitsFoundation

UnitsFoundation(UnitsFoundation that)

Method Detail

setIdentifier

public void setIdentifier(java.lang.String identifier)

Method to set a specific identifier to an object.

Specified by:

setIdentifier in interface Nameable

Parameters:

identifier - String: the identifier to associate with the object

getIdentifier

public java.lang.String getIdentifier()

Method to get the specific identifier for an object.

Specified by:

getIdentifier in interface Identifiable

Returns:

String: the identifier.

audit

public java.lang.String audit(java.lang.String label)

Method to return a detailed string from an arithmetical object for debugging purposes.

Specified by:

audit in interface Auditable

Parameters:

label - String: the label to associate with the data

Returns:

the detailed string.

audit

public java.lang.String audit()

Method to return a detailed (unlabeled) string from an Auditable object for debugging purposes.

Specified by:

audit in interface Auditable

Overrides:

audit in class Item

Returns:

the detailed string.

See Also:

Auditable.audit(String)

audit

public void audit(java.io.PrintStream out,
                  java.lang.String label)

Description copied from interface: Auditable

Method to output detailed string from an object for debugging purposes.

Specified by:

audit in interface Auditable

Overrides:

audit in class Item

Parameters:

out - the output stream.

label - the label to attach to the output (may be null).

See Also:

Auditable.audit(String), Item.getClassNameShort(), PrintStream.println(String)

isNumber

public boolean isNumber()

Method to determine if this is dimensionless (i.e. unitless).

Specified by:

isNumber in interface Measurable

Overrides:

isNumber in class BaseUnit

Returns:

true if not in any System.

normalize

final int normalize()

toString

public abstract java.lang.String toString(int sysIndex)

toString

public java.lang.String toString()

Description copied from class: Item

This is the default toString method for all Items. Specific classes will override as appropriate.

Overrides:

toString in class Item

Returns:

a String representing this Item by first converting it to a Presentation and then rendering that with no length constraint.

See Also:

Item.present(), Presentation.toString()

setName

public final void setName(UnitsName name,
                          boolean force,
                          int sysIndex)

setName

public final void setName(UnitsName name,
                          boolean force)

setName

public final void setName(java.lang.String nameAbbrev,
                          int exponent,
                          boolean force)

setName

public final void setName(java.lang.String nameAbbrev,
                          boolean force)

setName

public final void setName(UnitsName name)

setName

public final void setName(java.lang.String name)

monitor

void monitor(java.lang.String method,
             java.lang.String[] args,
             java.lang.String result)