wt.units.display
Class QuantityOfMeasure

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.units.display.AbstractDisplayUnitsContext
              wt.units.display.QuantityOfMeasure

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DisplayUnitsContext, DisplayUnitsHolder, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

public class QuantityOfMeasure

extends AbstractDisplayUnitsContext

implements DisplayUnitsHolder, Externalizable

Use the newQuantityOfMeasure static factory method(s), not the QuantityOfMeasure 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: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	BASE_UNIT_SYMBOL Label for the attribute.
private static int	BASE_UNIT_SYMBOL_UPPER_LIMIT
private String	baseUnitSymbol
private static String	CLASSNAME
static String	COUNTERPART_ID Label for the attribute; counterpartID is unique (except when null) among all attribute definitions, attribute organizers, classification nodes, and quantities of measure.
private static int	COUNTERPART_ID_UPPER_LIMIT
private String	counterpartID
static long	EXTERNALIZATION_VERSION_UID
private int	hashtableSize
private Hashtable	measurementSystemDisplayUnits
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.units.display.AbstractDisplayUnitsContext

DESCRIPTION, NAME

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

QuantityOfMeasure()

Method Summary

private void	baseUnitSymbolValidate(String a_BaseUnitSymbol)
private void	counterpartIDValidate(String a_CounterpartID)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getBaseUnitSymbol() Gets the value of the attribute: BASE_UNIT_SYMBOL.
String	getConceptualClassname() Deprecated.
String	getCounterpartID() Gets the value of the attribute: COUNTERPART_ID.
AbstractUnitDisplayInfo	getDisplayUnit(DisplayUnitsContext context) Supported API: false
Hashtable	getDisplayUnitsTable() Supported API: false
String	getKey() Supported API: false
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name, String baseUnitSymbol) Supports initialization, following construction of an instance.
static QuantityOfMeasure	newQuantityOfMeasure(String name, String baseUnitSymbol) Supported API: false
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(QuantityOfMeasure thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setBaseUnitSymbol(String a_BaseUnitSymbol) Sets the value of the attribute: BASE_UNIT_SYMBOL.
void	setCounterpartID(String a_CounterpartID) Sets the value of the attribute: COUNTERPART_ID.
void	setDisplayUnit(DisplayUnitsContext context, AbstractUnitDisplayInfo displayUnit) Supported API: false
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 wt.units.display.AbstractDisplayUnitsContext

getDescription, getName, readVersion, setDescription, setName

Methods inherited from class wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

BASE_UNIT_SYMBOL

public static final String BASE_UNIT_SYMBOL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

BASE_UNIT_SYMBOL_UPPER_LIMIT

private static int BASE_UNIT_SYMBOL_UPPER_LIMIT

baseUnitSymbol

private String baseUnitSymbol

measurementSystemDisplayUnits

private Hashtable measurementSystemDisplayUnits

COUNTERPART_ID

public static final String COUNTERPART_ID

Label for the attribute; counterpartID is unique (except when null) among all attribute definitions, attribute organizers, classification nodes, and quantities of measure. It is managed exclusively by CounterPart. Objects created by the CounterPart service will inherit this ID from the CounterPart classification being uploaded. Objects created by some other service will be assigned a unique ID (based on the network address of the server and the database ID of the object) when the object is first downloaded by the CounterPart service. Besides being used by CounterPart in its classification management role, this is the attribute/class/qom ID that is used by PartsLink search.

Supported API: false

See Also:

Constant Field Values

COUNTERPART_ID_UPPER_LIMIT

private static int COUNTERPART_ID_UPPER_LIMIT

counterpartID

private String counterpartID

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

hashtableSize

private final int hashtableSize

See Also:

Constant Field Values

Constructor Detail

QuantityOfMeasure

public QuantityOfMeasure()

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

Overrides:

writeExternal in class AbstractDisplayUnitsContext

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

Overrides:

readExternal in class AbstractDisplayUnitsContext

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(QuantityOfMeasure 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

Overrides:

writeExternal in class AbstractDisplayUnitsContext

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

Overrides:

readExternal in class AbstractDisplayUnitsContext

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

getBaseUnitSymbol

public String getBaseUnitSymbol()

Gets the value of the attribute: BASE_UNIT_SYMBOL.

Supported API: false

Returns:

String

setBaseUnitSymbol

public void setBaseUnitSymbol(String a_BaseUnitSymbol)
                       throws WTPropertyVetoException

Sets the value of the attribute: BASE_UNIT_SYMBOL.

Supported API: false

Parameters:

a_BaseUnitSymbol -

Throws:

WTPropertyVetoException

baseUnitSymbolValidate

private void baseUnitSymbolValidate(String a_BaseUnitSymbol)
                             throws WTPropertyVetoException

Parameters:

a_BaseUnitSymbol -

Throws:

WTPropertyVetoException

getCounterpartID

public String getCounterpartID()

Gets the value of the attribute: COUNTERPART_ID. counterpartID is unique (except when null) among all attribute definitions, attribute organizers, classification nodes, and quantities of measure. It is managed exclusively by CounterPart. Objects created by the CounterPart service will inherit this ID from the CounterPart classification being uploaded. Objects created by some other service will be assigned a unique ID (based on the network address of the server and the database ID of the object) when the object is first downloaded by the CounterPart service. Besides being used by CounterPart in its classification management role, this is the attribute/class/qom ID that is used by PartsLink search.

Supported API: false

Returns:

String

setCounterpartID

public void setCounterpartID(String a_CounterpartID)
                      throws WTPropertyVetoException

Sets the value of the attribute: COUNTERPART_ID. counterpartID is unique (except when null) among all attribute definitions, attribute organizers, classification nodes, and quantities of measure. It is managed exclusively by CounterPart. Objects created by the CounterPart service will inherit this ID from the CounterPart classification being uploaded. Objects created by some other service will be assigned a unique ID (based on the network address of the server and the database ID of the object) when the object is first downloaded by the CounterPart service. Besides being used by CounterPart in its classification management role, this is the attribute/class/qom ID that is used by PartsLink search.

Supported API: false

Parameters:

a_CounterpartID -

Throws:

WTPropertyVetoException

counterpartIDValidate

private void counterpartIDValidate(String a_CounterpartID)
                            throws WTPropertyVetoException

Parameters:

a_CounterpartID -

Throws:

WTPropertyVetoException

newQuantityOfMeasure

public static QuantityOfMeasure newQuantityOfMeasure(String name,
                                                     String baseUnitSymbol)
                                              throws WTException

Supported API: false

Parameters:

name -

baseUnitSymbol -

Returns:

QuantityOfMeasure

Throws:

WTException

initialize

protected void initialize(String name,
                          String baseUnitSymbol)
                   throws WTException

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

Supported API: false

Parameters:

name -

baseUnitSymbol -

Throws:

WTException

getDisplayUnitsTable

public Hashtable getDisplayUnitsTable()

Supported API: false

Returns:

Hashtable

getKey

public String getKey()

Supported API: false

Specified by:

getKey in interface DisplayUnitsContext

Specified by:

getKey in class AbstractDisplayUnitsContext

Returns:

String

getDisplayUnit

public AbstractUnitDisplayInfo getDisplayUnit(DisplayUnitsContext context)

Supported API: false

Specified by:

getDisplayUnit in interface DisplayUnitsHolder

Parameters:

context -

Returns:

AbstractUnitDisplayInfo

setDisplayUnit

public void setDisplayUnit(DisplayUnitsContext context,
                           AbstractUnitDisplayInfo displayUnit)
                    throws UnitFormatException,
                           IncompatibleUnitsException

Supported API: false

Specified by:

setDisplayUnit in interface DisplayUnitsHolder

Parameters:

context -

displayUnit -

Throws:

UnitFormatException

IncompatibleUnitsException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class AbstractDisplayUnitsContext

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class AbstractDisplayUnitsContext

Returns:

int