wt.ixb.mapping
Class UfidMapping

java.lang.Object
  wt.ixb.mapping.UfidMapping

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class UfidMapping

extends Object

implements Persistable, Externalizable

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

static String	BIRTH_UFID Label for the attribute.
private static int	BIRTH_UFID_UPPER_LIMIT
private String	birthUfid
private static String	CLASSNAME
static String	CONTAINER_ID Label for the attribute.
private static int	CONTAINER_ID_UPPER_LIMIT
private String	containerId
static long	EXTERNALIZATION_VERSION_UID
static String	LOCAL_UFID Label for the attribute.
private static int	LOCAL_UFID_UPPER_LIMIT
private String	localUfid
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

UfidMapping()

Method Summary

private void	birthUfidValidate(String a_BirthUfid)
void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	containerIdValidate(String a_ContainerId)
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	getBirthUfid() Gets the value of the attribute: BIRTH_UFID.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
String	getContainerId() Gets the value of the attribute: CONTAINER_ID.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
String	getLocalUfid() Gets the value of the attribute: LOCAL_UFID.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(String localUfid, String birthUfid, String containerId) Supported API: false
private void	localUfidValidate(String a_LocalUfid)
static UfidMapping	newUfidMapping() Default factory for the class.
static UfidMapping	newUfidMapping(String localUfid, String birthUfid, String containerId)
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(UfidMapping thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setBirthUfid(String a_BirthUfid) Sets the value of the attribute: BIRTH_UFID.
void	setContainerId(String a_ContainerId) Sets the value of the attribute: CONTAINER_ID.
void	setLocalUfid(String a_LocalUfid) Sets the value of the attribute: LOCAL_UFID.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
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, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

LOCAL_UFID

public static final String LOCAL_UFID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

LOCAL_UFID_UPPER_LIMIT

private static int LOCAL_UFID_UPPER_LIMIT

localUfid

private String localUfid

BIRTH_UFID

public static final String BIRTH_UFID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

BIRTH_UFID_UPPER_LIMIT

private static int BIRTH_UFID_UPPER_LIMIT

birthUfid

private String birthUfid

CONTAINER_ID

public static final String CONTAINER_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTAINER_ID_UPPER_LIMIT

private static int CONTAINER_ID_UPPER_LIMIT

containerId

private String containerId

thePersistInfo

private PersistInfo thePersistInfo

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

UfidMapping

public UfidMapping()

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(UfidMapping 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

getLocalUfid

public String getLocalUfid()

Gets the value of the attribute: LOCAL_UFID.

Supported API: false

Returns:

String

setLocalUfid

public void setLocalUfid(String a_LocalUfid)
                  throws WTPropertyVetoException

Sets the value of the attribute: LOCAL_UFID.

Supported API: false

Parameters:

a_LocalUfid -

Throws:

WTPropertyVetoException

localUfidValidate

private void localUfidValidate(String a_LocalUfid)
                        throws WTPropertyVetoException

Parameters:

a_LocalUfid -

Throws:

WTPropertyVetoException

getBirthUfid

public String getBirthUfid()

Gets the value of the attribute: BIRTH_UFID.

Supported API: false

Returns:

String

setBirthUfid

public void setBirthUfid(String a_BirthUfid)
                  throws WTPropertyVetoException

Sets the value of the attribute: BIRTH_UFID.

Supported API: false

Parameters:

a_BirthUfid -

Throws:

WTPropertyVetoException

birthUfidValidate

private void birthUfidValidate(String a_BirthUfid)
                        throws WTPropertyVetoException

Parameters:

a_BirthUfid -

Throws:

WTPropertyVetoException

getContainerId

public String getContainerId()

Gets the value of the attribute: CONTAINER_ID.

Supported API: false

Returns:

String

setContainerId

public void setContainerId(String a_ContainerId)
                    throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_ID.

Supported API: false

Parameters:

a_ContainerId -

Throws:

WTPropertyVetoException

containerIdValidate

private void containerIdValidate(String a_ContainerId)
                          throws WTPropertyVetoException

Parameters:

a_ContainerId -

Throws:

WTPropertyVetoException

initialize

protected void initialize(String localUfid,
                          String birthUfid,
                          String containerId)
                   throws WTException,
                          WTPropertyVetoException

Supported API: false

Parameters:

localUfid -

birthUfid -

containerId -

Throws:

WTException

WTPropertyVetoException

newUfidMapping

public static UfidMapping newUfidMapping()
                                  throws WTException

Default factory for the class.

Supported API: false

Returns:

UfidMapping

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: false

Throws:

WTException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

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

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

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

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

Returns:

int

newUfidMapping

public static UfidMapping newUfidMapping(String localUfid,
                                         String birthUfid,
                                         String containerId)
                                  throws WTException

Throws:

WTException