wt.part
Class Quantity

java.lang.Object
  wt.part.Quantity

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public final class Quantity

extends Object

implements ObjectMappable, Externalizable

This structured attribute class represents the concept of quantity as an amount and a QuantityUnit (unit of measure).

Use the newQuantity static factory method(s), not the Quantity constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private double	amount
static String	AMOUNT Label for the attribute; The amount attributes represents the amount portion of the Quantity.
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private QuantityUnit	unit
static String	UNIT Label for the attribute.
private static int	UNIT_UPPER_LIMIT

Constructor Summary

Quantity()

Method Summary

boolean	equals(Object obj) Returns true if the amount and QuantityUnit are equivalent.
double	getAmount() Gets the value of the attribute: AMOUNT.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
QuantityUnit	getUnit() Gets the object for the association that plays role: UNIT.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(double an_Amount, QuantityUnit a_Unit) Supports initialization, following construction of an instance.
static Quantity	newQuantity() Default factory for Quantity.
static Quantity	newQuantity(double an_Amount, QuantityUnit a_Unit) Quantity factory, allowing construction with a specified amount and unit.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(Quantity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAmount(double a_Amount) Sets the value of the attribute: AMOUNT.
void	setUnit(QuantityUnit a_Unit) Sets the object for the association that plays role: UNIT.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

AMOUNT

public static final String AMOUNT

Label for the attribute; The amount attributes represents the amount portion of the Quantity.

Supported API: true

See Also:

Constant Field Values

amount

private double amount

UNIT

public static final String UNIT

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

UNIT_UPPER_LIMIT

private static int UNIT_UPPER_LIMIT

unit

private QuantityUnit unit

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

Quantity

public Quantity()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Quantity thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getAmount

public double getAmount()

Gets the value of the attribute: AMOUNT. The amount attributes represents the amount portion of the Quantity.

Supported API: true

Returns:

double

setAmount

public void setAmount(double a_Amount)

Sets the value of the attribute: AMOUNT. The amount attributes represents the amount portion of the Quantity.

Supported API: true

Parameters:

a_Amount -

getUnit

public QuantityUnit getUnit()

Gets the object for the association that plays role: UNIT.

Supported API: true

Returns:

QuantityUnit

setUnit

public void setUnit(QuantityUnit a_Unit)

Sets the object for the association that plays role: UNIT.

Supported API: true

Parameters:

a_Unit -

newQuantity

public static Quantity newQuantity(double an_Amount,
                                   QuantityUnit a_Unit)
                            throws WTException

Quantity factory, allowing construction with a specified amount and unit.

Supported API: true

Parameters:

an_Amount -

a_Unit -

Returns:

Quantity

Throws:

WTException

initialize

protected void initialize(double an_Amount,
                          QuantityUnit a_Unit)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

an_Amount -

a_Unit -

Throws:

WTException

newQuantity

public static Quantity newQuantity()
                            throws WTException

Default factory for Quantity. Defaults the amount to 1 and the unit to "ea".

Supported API: true

Returns:

Quantity

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Throws:

WTException

equals

public boolean equals(Object obj)

Returns true if the amount and QuantityUnit are equivalent. Does not convert from one unit to another.

Supported API: true

Parameters:

obj - The Quantity object to compare against.

Returns:

boolean