wt.iba.value
Class AbstractContextualValue

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.iba.value.AbstractValue
          extended bywt.iba.value.AbstractContextualValue
All Implemented Interfaces:
DisplayIdentification, Evolvable, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable
Direct Known Subclasses:
BooleanValue, FloatValue, IntegerValue, RatioValue, StringValue, TimestampValue, UnitValue, URLValue

public abstract class AbstractContextualValue
extends AbstractValue
implements Externalizable



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
static String CONTEXT
          Label for the attribute.
static String CONTEXT_REFERENCE
          Label for the attribute.
private  ObjectReference contextReference
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
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
AbstractContextualValue()
           
 
Method Summary
private  void contextReferenceValidate(ObjectReference a_ContextReference)
           
 boolean equals(Object obj)
          Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
abstract  AbstractAttributeDefinition getAbstractDefinition()
          Returns the AbstractAttributeDefinition associated with this value.
 ReferenceValue getContext()
          Gets the object for the association that plays role: CONTEXT.
 ObjectReference getContextReference()
          Gets the value of the attribute: CONTEXT_REFERENCE.
abstract  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.
 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(AbstractContextualValue thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setContext(ReferenceValue a_Context)
          Sets the object for the association that plays role: CONTEXT.
 void setContextReference(ObjectReference a_ContextReference)
          Sets the value of the attribute: CONTEXT_REFERENCE.
 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.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
 
Methods inherited from interface wt.fc.NetFactor
getConceptualClassname
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

CONTEXT

public static final String CONTEXT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

CONTEXT_REFERENCE

public static final String CONTEXT_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

contextReference

private ObjectReference contextReference

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

AbstractContextualValue

public AbstractContextualValue()
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 AbstractValue
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 AbstractValue
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(AbstractContextualValue 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 AbstractValue
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 AbstractValue
Parameters:
input -
Throws:
SQLException
DatastoreException

getContext

public ReferenceValue getContext()
Gets the object for the association that plays role: CONTEXT.

Supported API: false

Returns:
ReferenceValue

setContext

public void setContext(ReferenceValue a_Context)
                throws WTPropertyVetoException,
                       WTException
Sets the object for the association that plays role: CONTEXT.

Supported API: false

Parameters:
a_Context -
Throws:
WTPropertyVetoException
WTException

getContextReference

public ObjectReference getContextReference()
Gets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Returns:
ObjectReference

setContextReference

public void setContextReference(ObjectReference a_ContextReference)
                         throws WTPropertyVetoException
Sets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Parameters:
a_ContextReference -
Throws:
WTPropertyVetoException

contextReferenceValidate

private void contextReferenceValidate(ObjectReference a_ContextReference)
                               throws WTPropertyVetoException
Parameters:
a_ContextReference -
Throws:
WTPropertyVetoException

getValueObject

public abstract 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 AbstractValue
Returns:
Object

getAbstractDefinition

public abstract 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 AbstractValue
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 AbstractValue
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 AbstractValue
Returns:
int