wt.iba.definition
Class UnitDefinition

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.iba.definition.AbstractAttributeDefinition
              wt.iba.definition.UnitDefinition

All Implemented Interfaces:

AccessControlled, AttributeDefinition, AttributeHierarchyChild, AttributeHierarchyParent, BusinessInformation, ChildAttributeDefinition, DisplayIdentification, DisplayUnitsHolder, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, ParentAttributeDefinition, Persistable, Serializable, SoftMetaData

public final class UnitDefinition

extends AbstractAttributeDefinition

implements DisplayUnitsHolder, Externalizable

The Unit attribute definition.

Use the newUnitDefinition static factory method(s), not the UnitDefinition 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

private static String	CLASSNAME
static String	constraintClassname A static string which represents a constraint class of the approriate data type.
static long	EXTERNALIZATION_VERSION_UID
private int	hashtableSize
private Hashtable	measurementSystemDisplayUnits
protected static long	OLD_FORMAT_VERSION_UID
static String	QUANTITY_OF_MEASURE Label for the attribute.
static String	QUANTITY_OF_MEASURE_REFERENCE Label for the attribute.
private static String	RESOURCE
(package private) static long	serialVersionUID
private ObjectReference	theQuantityOfMeasureReference
static String	valueClassname A static string references to the java.lang.Class which represents a attribute value class of the approriate data type.

Fields inherited from class wt.iba.definition.AbstractAttributeDefinition

DEFINITION_PARENT

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.iba.definition.AttributeDefinition

COUNTERPART_ID, DISPLAY_NAME

Fields inherited from interface wt.iba.definition.ChildAttributeDefinition

DEFINITION_PARENT_REFERENCE, HIERARCHY_ID, SIBLING_ID

Fields inherited from interface wt.iba.definition.AttributeHierarchyChild

DESCRIPTION, HIERARCHY_DISPLAY_NAME, NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

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.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

UnitDefinition()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
AttributeDefinitionReference	getAttributeDefinitionReference() Get the AttributeDefinitionReference out of this definition.
String	getConceptualClassname() Deprecated.
String	getConstraintClassname() Get the classname of the associated attribute constraint.
AbstractUnitDisplayInfo	getDisplayUnit(DisplayUnitsContext context) Supported API: false
Hashtable	getDisplayUnitsTable() Supported API: false
AttributeHierarchyParent	getParent() Supported API: false
QuantityOfMeasure	getQuantityOfMeasure() Gets the object for the association that plays role: QUANTITY_OF_MEASURE.
ObjectReference	getQuantityOfMeasureReference() Gets the value of the attribute: QUANTITY_OF_MEASURE_REFERENCE.
String	getValueClassname() Get the classname of the associated attribute value.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name, String description, ObjectReference parentReference, String displayName, ObjectReference quantityOfMeausreRef) Supports initialization, following construction of an instance.
protected void	initialize(String name, String description, ObjectReference parentReference, String displayName, String hierarchyDisplayName, ObjectReference quantityOfMeausreRef) Supports initialization, following construction of an instance.
boolean	isValidChild(AttributeHierarchyChild hierChild) Supported API: false
static UnitDefinition	newUnitDefinition(String name, String description, ObjectReference parentReference, String displayName, ObjectReference quantityOfMeausreRef) Supported API: false
static UnitDefinition	newUnitDefinition(String name, String description, ObjectReference parentReference, String displayName, String hierarchyDisplayName, ObjectReference quantityOfMeausreRef) 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(UnitDefinition thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDisplayUnit(DisplayUnitsContext context, AbstractUnitDisplayInfo displayUnit) Supported API: false
void	setQuantityOfMeasure(QuantityOfMeasure a_QuantityOfMeasure) Sets the object for the association that plays role: QUANTITY_OF_MEASURE.
void	setQuantityOfMeasureReference(ObjectReference a_QuantityOfMeasureReference) Sets the value of the attribute: QUANTITY_OF_MEASURE_REFERENCE.
private void	theQuantityOfMeasureReferenceValidate(ObjectReference a_QuantityOfMeasureReference)
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.iba.definition.AbstractAttributeDefinition

getCounterpartID, getDefinitionParent, getDefinitionParentReference, getDescription, getDisplayName, getHierarchyDisplayName, getHierarchyID, getName, getSiblingID, readVersion, setCounterpartID, setDefinitionParent, setDefinitionParentReference, setDescription, setDisplayName, setHierarchyDisplayName, setHierarchyID, setName, setSiblingID

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.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

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

measurementSystemDisplayUnits

private Hashtable measurementSystemDisplayUnits

valueClassname

public static final String valueClassname

A static string references to the java.lang.Class which represents a attribute value class of the approriate data type. One of the purposes of this reference is to search the approtriate data type attribute value table when a query kicks off from the attribute definition.

Supported API: false

See Also:

Constant Field Values

constraintClassname

public static final String constraintClassname

A static string which represents a constraint class of the approriate data type. One of the purposes of this reference is to search the approtriate constraint subclass when a query kicks off from the attribute definition.

Supported API: false

See Also:

Constant Field Values

QUANTITY_OF_MEASURE

public static final String QUANTITY_OF_MEASURE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

QUANTITY_OF_MEASURE_REFERENCE

public static final String QUANTITY_OF_MEASURE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theQuantityOfMeasureReference

private ObjectReference theQuantityOfMeasureReference

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

UnitDefinition

public UnitDefinition()

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 AbstractAttributeDefinition

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 AbstractAttributeDefinition

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 AbstractAttributeDefinition

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

getQuantityOfMeasure

public QuantityOfMeasure getQuantityOfMeasure()

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

Supported API: false

Returns:

QuantityOfMeasure

setQuantityOfMeasure

public void setQuantityOfMeasure(QuantityOfMeasure a_QuantityOfMeasure)
                          throws WTPropertyVetoException,
                                 WTException

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

Supported API: false

Parameters:

a_QuantityOfMeasure -

Throws:

WTPropertyVetoException

WTException

getQuantityOfMeasureReference

public ObjectReference getQuantityOfMeasureReference()

Gets the value of the attribute: QUANTITY_OF_MEASURE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setQuantityOfMeasureReference

public void setQuantityOfMeasureReference(ObjectReference a_QuantityOfMeasureReference)
                                   throws WTPropertyVetoException

Sets the value of the attribute: QUANTITY_OF_MEASURE_REFERENCE.

Supported API: false

Parameters:

a_QuantityOfMeasureReference -

Throws:

WTPropertyVetoException

theQuantityOfMeasureReferenceValidate

private void theQuantityOfMeasureReferenceValidate(ObjectReference a_QuantityOfMeasureReference)
                                            throws WTPropertyVetoException

Parameters:

a_QuantityOfMeasureReference -

Throws:

WTPropertyVetoException

newUnitDefinition

public static UnitDefinition newUnitDefinition(String name,
                                               String description,
                                               ObjectReference parentReference,
                                               String displayName,
                                               ObjectReference quantityOfMeausreRef)
                                        throws WTException

Supported API: false

Parameters:

name -

description -

parentReference -

displayName -

quantityOfMeausreRef -

Returns:

UnitDefinition

Throws:

WTException

initialize

protected void initialize(String name,
                          String description,
                          ObjectReference parentReference,
                          String displayName,
                          ObjectReference quantityOfMeausreRef)
                   throws WTException

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

Supported API: false

Parameters:

name -

description -

parentReference -

displayName -

quantityOfMeausreRef -

Throws:

WTException

newUnitDefinition

public static UnitDefinition newUnitDefinition(String name,
                                               String description,
                                               ObjectReference parentReference,
                                               String displayName,
                                               String hierarchyDisplayName,
                                               ObjectReference quantityOfMeausreRef)
                                        throws WTException

Supported API: false

Parameters:

name -

description -

parentReference -

displayName -

hierarchyDisplayName -

quantityOfMeausreRef -

Returns:

UnitDefinition

Throws:

WTException

initialize

protected void initialize(String name,
                          String description,
                          ObjectReference parentReference,
                          String displayName,
                          String hierarchyDisplayName,
                          ObjectReference quantityOfMeausreRef)
                   throws WTException

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

Supported API: false

Parameters:

name -

description -

parentReference -

displayName -

hierarchyDisplayName -

quantityOfMeausreRef -

Throws:

WTException

getDisplayUnitsTable

public Hashtable getDisplayUnitsTable()

Supported API: false

Returns:

Hashtable

isValidChild

public boolean isValidChild(AttributeHierarchyChild hierChild)

Supported API: false

Specified by:

isValidChild in interface AttributeHierarchyParent

Specified by:

isValidChild in class AbstractAttributeDefinition

Parameters:

hierChild -

Returns:

boolean

getParent

public AttributeHierarchyParent getParent()

Supported API: false

Specified by:

getParent in interface AttributeHierarchyChild

Specified by:

getParent in class AbstractAttributeDefinition

Returns:

AttributeHierarchyParent

getValueClassname

public String getValueClassname()

Get the classname of the associated attribute value.

Supported API: false

Specified by:

getValueClassname in class AbstractAttributeDefinition

Returns:

String

getConstraintClassname

public String getConstraintClassname()

Get the classname of the associated attribute constraint.

Supported API: false

Specified by:

getConstraintClassname in class AbstractAttributeDefinition

Returns:

String

getAttributeDefinitionReference

public AttributeDefinitionReference getAttributeDefinitionReference()
                                                             throws WTException

Get the AttributeDefinitionReference out of this definition.

Supported API: false

Specified by:

getAttributeDefinitionReference in class AbstractAttributeDefinition

Returns:

AttributeDefinitionReference

Throws:

WTException

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 AbstractAttributeDefinition

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 AbstractAttributeDefinition

Returns:

int