wt.identity
Class DisplayIdentificationStandardDelegate

java.lang.Object
  wt.identity.DisplayIdentificationStandardDelegate

All Implemented Interfaces:

DisplayIdentification, DisplayIdentificationDelegate, Externalizable, Serializable

Direct Known Subclasses:

DisplayIdentificationAnnotationSetDelegate, DisplayIdentificationCADNameContextDelegate, DisplayIdentificationChangeItemDelegate, DisplayIdentificationEffConfigurationItemDelegate, DisplayIdentificationEffGroupDelegate, DisplayIdentificationEPMDocumentMasterDelegate, DisplayIdentificationEPMWorkspaceDelegate, DisplayIdentificationFolderDelegate, DisplayIdentificationIteratedDelegate, DisplayIdentificationObjectDelegate, DisplayIdentificationPersistableDelegate, DisplayIdentificationProductInstanceDelegate, DisplayIdentificationShortcutDelegate, DisplayIdentificationWTDocumentDependencyLinkDelegate, DisplayIdentificationWTDocumentMasterDelegate, DisplayIdentificationWTPartMasterDelegate, DisplayIdentificationWTProductConfigurationDelegate, DisplayIdentificationWTProductInstance2Delegate, DisplayIdentificationWTProductInstanceMasterDelegate, SecuredIdentificationDelegate

public abstract class DisplayIdentificationStandardDelegate

extends Object

implements DisplayIdentificationDelegate, Externalizable

This is a standard delegate implementation for providing display identification information for objects. It utilizes only basic windchill util mechanisms and is unaware of any Windchill plug'n play. It's goal is a very light-weight delegate. The class provides a basic pattern for delegate initialization which classes that implement this one can utilize.

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private Object	identifier
private String	messageKey
protected static long	OLD_FORMAT_VERSION_UID
private Object	originalType
private static String	RESOURCE
private String	resourceBundle
(package private) static long	serialVersionUID
private Object	type
protected static boolean	VERBOSE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

DisplayIdentificationStandardDelegate()

Method Summary

LocalizableMessage	getDisplayIdentifier() Returns a localizable message describing the identifier for the object.
DisplayIdentity	getDisplayIdentity() Supported API: false
LocalizableMessage	getDisplayType() Returns a localizable message describing the object's type.
protected Object	getIdentifier() Gets the value of the attribute: identifier.
String	getMessageKey() Gets the value of the attribute: messageKey.
protected Object	getOriginalType() Gets the value of the attribute: originalType.
String	getResourceBundle() Gets the value of the attribute: resourceBundle.
protected Object	getType() Gets the value of the attribute: type.
void	initialize(Object object) Initialize the object so it holds all the required information about the supplied object.
protected abstract void	initializeIdentifier(Object object) Initialize the identifier attribute of this property object.
protected abstract void	initializeType(Object object) Initialize the type attribute of this property object.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
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(DisplayIdentificationStandardDelegate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected void	setIdentifier(Object a_Identifier) Sets the value of the attribute: identifier.
protected void	setOriginalType(Object a_OriginalType) Sets the value of the attribute: originalType.
protected void	setType(Object a_Type) Sets the value of the attribute: type.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

resourceBundle

private String resourceBundle

messageKey

private String messageKey

identifier

private Object identifier

type

private Object type

originalType

private Object originalType

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

VERBOSE

protected static final boolean VERBOSE

Constructor Detail

DisplayIdentificationStandardDelegate

public DisplayIdentificationStandardDelegate()

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

getResourceBundle

public String getResourceBundle()

Gets the value of the attribute: resourceBundle.

Supported API: false

Returns:

String

getMessageKey

public String getMessageKey()

Gets the value of the attribute: messageKey.

Supported API: false

Returns:

String

getIdentifier

protected Object getIdentifier()

Gets the value of the attribute: identifier.

Supported API: false

Returns:

Object

setIdentifier

protected void setIdentifier(Object a_Identifier)

Sets the value of the attribute: identifier.

Supported API: false

Parameters:

a_Identifier -

getType

protected Object getType()

Gets the value of the attribute: type.

Supported API: false

Returns:

Object

setType

protected void setType(Object a_Type)

Sets the value of the attribute: type.

Supported API: false

Parameters:

a_Type -

getOriginalType

protected Object getOriginalType()

Gets the value of the attribute: originalType.

Supported API: false

Returns:

Object

setOriginalType

protected void setOriginalType(Object a_OriginalType)

Sets the value of the attribute: originalType.

Supported API: false

Parameters:

a_OriginalType -

initialize

public void initialize(Object object)

Initialize the object so it holds all the required information about the supplied object. Invokes the initializeType method followed by the initializeIdentifier method. If this method is over-ridden by implementors of this classthe children should invoke super.initialize(object), then do whatever processing they require.

Supported API: false

Specified by:

initialize in interface DisplayIdentificationDelegate

Parameters:

object -

initializeIdentifier

protected abstract void initializeIdentifier(Object object)

Initialize the identifier attribute of this property object.

Supported API: true

Parameters:

object -

initializeType

protected abstract void initializeType(Object object)

Initialize the type attribute of this property object.

Supported API: true

Parameters:

object -

getDisplayType

public LocalizableMessage getDisplayType()

Returns a localizable message describing the object's type.

Supported API: false

Specified by:

getDisplayType in interface DisplayIdentification

Returns:

LocalizableMessage

getDisplayIdentifier

public LocalizableMessage getDisplayIdentifier()

Returns a localizable message describing the identifier for the object.

Supported API: false

Specified by:

getDisplayIdentifier in interface DisplayIdentification

Returns:

LocalizableMessage

getDisplayIdentity

public DisplayIdentity getDisplayIdentity()

Supported API: false

Specified by:

getDisplayIdentity in interface DisplayIdentification

Returns:

DisplayIdentity