wt.iba.value
Class RatioValue

java.lang.Object
  wt.fc.WTObject
      wt.iba.value.AbstractValue
          wt.iba.value.AbstractContextualValue
              wt.iba.value.RatioValue

All Implemented Interfaces:

DisplayIdentification, Evolvable, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public final class RatioValue

extends AbstractContextualValue

implements Externalizable

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

Nested Class Summary

(package private) static class

RatioValue.RatioNumber Simple Number implementation that maintains an internal ratio storage and corresponding toString().

Field Summary

private static String	CLASSNAME
static String	DEFINITION_REFERENCE Label for the attribute.
private RatioDefinitionReference	definitionReference
private double	denominator
static String	DENOMINATOR Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private double	value
static String	VALUE Label for the attribute.

Fields inherited from class wt.iba.value.AbstractContextualValue

CONTEXT, CONTEXT_REFERENCE

Fields inherited from class wt.iba.value.AbstractValue

IBAHOLDER_REFERENCE

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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

RatioValue()

Method Summary

private void	definitionReferenceValidate(RatioDefinitionReference a_DefinitionReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
AbstractAttributeDefinition	getAbstractDefinition() Returns the AbstractAttributeDefinition associated with this value.
String	getConceptualClassname() Deprecated.
RatioDefinitionReference	getDefinitionReference() Gets the object for the association that plays role: DEFINITION_REFERENCE.
double	getDenominator() Gets the value of the attribute: DENOMINATOR.
double	getValue() Gets the value of the attribute: VALUE.
Object	getValueObject() Returns a single Object representing the value of the attribute as accurately as possible.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(RatioDefinition attributeDefinition, IBAHolder holder, double value, double denominator) Supports initialization, following construction of an instance.
protected void	initialize(RatioDefinition attributeDefinition, IBAHolder holder, ReferenceValue referenceValue, double value, double denominator) Supports initialization, following construction of an instance.
static RatioValue	newRatioValue() Supported API: false
static RatioValue	newRatioValue(RatioDefinition attributeDefinition, IBAHolder holder, double value, double denominator) Supported API: false
static RatioValue	newRatioValue(RatioDefinition attributeDefinition, IBAHolder holder, ReferenceValue referenceValue, double value, double denominator) 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(RatioValue thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDefinitionReference(RatioDefinitionReference a_DefinitionReference) Sets the object for the association that plays role: DEFINITION_REFERENCE.
void	setDenominator(double a_Denominator) Sets the value of the attribute: DENOMINATOR.
void	setValue(double a_Value) Sets the value of the attribute: VALUE.
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.value.AbstractContextualValue

getContext, getContextReference, readVersion, setContext, setContextReference

Methods inherited from class wt.iba.value.AbstractValue

getIBAHolderReference, readVersion, setIBAHolderReference

Methods inherited from class wt.fc.WTObject

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

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

VALUE

public static final String VALUE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

value

private double value

DENOMINATOR

public static final String DENOMINATOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

denominator

private double denominator

DEFINITION_REFERENCE

public static final String DEFINITION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

definitionReference

private RatioDefinitionReference definitionReference

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

RatioValue

public RatioValue()

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 AbstractContextualValue

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 AbstractContextualValue

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 AbstractContextualValue

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

getValue

public double getValue()

Gets the value of the attribute: VALUE.

Supported API: false

Returns:

double

setValue

public void setValue(double a_Value)
              throws WTPropertyVetoException

Sets the value of the attribute: VALUE.

Supported API: false

Parameters:

a_Value -

Throws:

WTPropertyVetoException

getDenominator

public double getDenominator()

Gets the value of the attribute: DENOMINATOR.

Supported API: false

Returns:

double

setDenominator

public void setDenominator(double a_Denominator)
                    throws WTPropertyVetoException

Sets the value of the attribute: DENOMINATOR.

Supported API: false

Parameters:

a_Denominator -

Throws:

WTPropertyVetoException

getDefinitionReference

public RatioDefinitionReference getDefinitionReference()

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

Supported API: false

Returns:

RatioDefinitionReference

setDefinitionReference

public void setDefinitionReference(RatioDefinitionReference a_DefinitionReference)
                            throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

definitionReferenceValidate

private void definitionReferenceValidate(RatioDefinitionReference a_DefinitionReference)
                                  throws WTPropertyVetoException

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

newRatioValue

public static RatioValue newRatioValue(RatioDefinition attributeDefinition,
                                       IBAHolder holder,
                                       double value,
                                       double denominator)
                                throws WTException

Supported API: false

Parameters:

attributeDefinition -

holder -

value -

denominator -

Returns:

RatioValue

Throws:

WTException

initialize

protected void initialize(RatioDefinition attributeDefinition,
                          IBAHolder holder,
                          double value,
                          double denominator)
                   throws WTException

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

Supported API: false

Parameters:

attributeDefinition -

holder -

value -

denominator -

Throws:

WTException

newRatioValue

public static RatioValue newRatioValue(RatioDefinition attributeDefinition,
                                       IBAHolder holder,
                                       ReferenceValue referenceValue,
                                       double value,
                                       double denominator)
                                throws WTException

Supported API: false

Parameters:

attributeDefinition -

holder -

referenceValue -

value -

denominator -

Returns:

RatioValue

Throws:

WTException

initialize

protected void initialize(RatioDefinition attributeDefinition,
                          IBAHolder holder,
                          ReferenceValue referenceValue,
                          double value,
                          double denominator)
                   throws WTException

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

Supported API: false

Parameters:

attributeDefinition -

holder -

referenceValue -

value -

denominator -

Throws:

WTException

newRatioValue

public static RatioValue newRatioValue()
                                throws WTException

Supported API: false

Returns:

RatioValue

Throws:

WTException

getValueObject

public Object getValueObject()

Returns a single Object representing the value of the attribute as accurately as possible. Where possible the returned object's toString() method supplies an accurate (and localized where necessary/appropriate) string representation. This method is intended to provide easy, polymorphic read access to the IBA value itself. In other words, this does not include the value's context, constraints, and so forth, just the value itself.

Supported API: false

Specified by:

getValueObject in class AbstractContextualValue

Returns:

Object

getAbstractDefinition

public AbstractAttributeDefinition getAbstractDefinition()

Returns the AbstractAttributeDefinition associated with this value. This method is intended to provide easy, polymorphic read access to IBA definitions.

Supported API: false

Specified by:

getAbstractDefinition in class AbstractContextualValue

Returns:

AbstractAttributeDefinition

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 AbstractContextualValue

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 AbstractContextualValue

Returns:

int