wt.viewmarkup
Class DerivedImageIdentity

java.lang.Object
  wt.fc.IdentificationObject
      wt.viewmarkup.DerivedImageIdentity

All Implemented Interfaces:

Externalizable, NetFactor, Serializable

public class DerivedImageIdentity

extends IdentificationObject

implements Externalizable

The uniqueness constraints on DerivedImage: name, type, create timestamp, Representable.

Use the newDerivedImageIdentity static factory method(s), not the DerivedImageIdentity 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
private Timestamp	createTimestamp
static long	EXTERNALIZATION_VERSION_UID
private String	name
protected static long	OLD_FORMAT_VERSION_UID
private ObjectReference	representable
private static String	RESOURCE
(package private) static long	serialVersionUID
private RepresentationType	type

Fields inherited from class wt.fc.IdentificationObject

Constructor Summary

DerivedImageIdentity()

Method Summary

String	getConceptualClassname() Deprecated.
Timestamp	getCreateTimestamp() Gets the value of the attribute: createTimestamp.
String	getIdentity() Constructs and returns a string representing the object's identity.
protected SemanticKey	getKey(Identified obj) This method overrides the superclass's implementation and ignores any Project set in the MethodContext when looking up SemanticKeys.
protected String	getKeyClassName() Gets the name of the class containing the uniqueness constraint Supported API: false
String	getName() Gets the value of the attribute: name; The name attribute of the DerivedImage.
ObjectReference	getRepresentable() Gets the value of the attribute: representable.
RepresentationType	getType() Gets the value of the attribute: type.
protected void	initialize(String name, RepresentationType type, ObjectReference representable, Timestamp createTimestamp) Supports initialization, following construction of an instance.
private void	nameValidate(String a_Name)
static DerivedImageIdentity	newDerivedImageIdentity(String name, RepresentationType type, ObjectReference representable, Timestamp createTimestamp) Supported API: false
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(DerivedImageIdentity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	representableValidate(ObjectReference a_Representable)
void	setCreateTimestamp(Timestamp a_CreateTimestamp) Sets the value of the attribute: createTimestamp.
void	setName(String a_Name) Sets the value of the attribute: name; The name attribute of the DerivedImage.
void	setRepresentable(ObjectReference a_Representable) Sets the value of the attribute: representable.
protected void	setToObject(Identified obj) Updates the identity of the object passed as argument with the identity held in the object.
void	setType(RepresentationType 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 wt.fc.IdentificationObject

changeIdentity, checkIdentity, createKey, getClassInfo, getSemanticKey, initialize, readVersion, setAdditionalKeyAttributes, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

name

private String name

type

private RepresentationType type

createTimestamp

private Timestamp createTimestamp

representable

private ObjectReference representable

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

DerivedImageIdentity

public DerivedImageIdentity()

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 IdentificationObject

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 IdentificationObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getName

public String getName()

Gets the value of the attribute: name; The name attribute of the DerivedImage.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: name; The name attribute of the DerivedImage.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getType

public RepresentationType getType()

Gets the value of the attribute: type.

Supported API: false

Returns:

RepresentationType

setType

public void setType(RepresentationType a_Type)
             throws WTPropertyVetoException

Sets the value of the attribute: type.

Supported API: false

Parameters:

a_Type -

Throws:

WTPropertyVetoException

getCreateTimestamp

public Timestamp getCreateTimestamp()

Gets the value of the attribute: createTimestamp.

Supported API: false

Returns:

Timestamp

setCreateTimestamp

public void setCreateTimestamp(Timestamp a_CreateTimestamp)
                        throws WTPropertyVetoException

Sets the value of the attribute: createTimestamp.

Supported API: false

Parameters:

a_CreateTimestamp -

Throws:

WTPropertyVetoException

getRepresentable

public ObjectReference getRepresentable()

Gets the value of the attribute: representable.

Supported API: false

Returns:

ObjectReference

setRepresentable

public void setRepresentable(ObjectReference a_Representable)
                      throws WTPropertyVetoException

Sets the value of the attribute: representable.

Supported API: false

Parameters:

a_Representable -

Throws:

WTPropertyVetoException

representableValidate

private void representableValidate(ObjectReference a_Representable)
                            throws WTPropertyVetoException

Parameters:

a_Representable -

Throws:

WTPropertyVetoException

getKeyClassName

protected String getKeyClassName()

Gets the name of the class containing the uniqueness constraint

Supported API: false

Overrides:

getKeyClassName in class IdentificationObject

Returns:

String

newDerivedImageIdentity

public static DerivedImageIdentity newDerivedImageIdentity(String name,
                                                           RepresentationType type,
                                                           ObjectReference representable,
                                                           Timestamp createTimestamp)
                                                    throws WTException

Supported API: false

Parameters:

name -

type -

representable -

createTimestamp -

Returns:

DerivedImageIdentity

Throws:

WTException

initialize

protected void initialize(String name,
                          RepresentationType type,
                          ObjectReference representable,
                          Timestamp createTimestamp)
                   throws WTException

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

Supported API: false

Parameters:

name -

type -

representable -

createTimestamp -

Throws:

WTException

getIdentity

public String getIdentity()

Constructs and returns a string representing the object's identity. This is an abstract method that must be implemented by classes extending the IdentifiactionObject class. A straightforward way of build a string representation of the identity is to concatenate the attributes that constitute the identity, using an appropriate separator.

Supported API: false

Specified by:

getIdentity in class IdentificationObject

Returns:

String

setToObject

protected void setToObject(Identified obj)
                    throws WTException

Updates the identity of the object passed as argument with the identity held in the object.

Supported API: false

Specified by:

setToObject in class IdentificationObject

Parameters:

obj -

Throws:

WTException

getKey

protected SemanticKey getKey(Identified obj)
                      throws WTException

This method overrides the superclass's implementation and ignores any Project set in the MethodContext when looking up SemanticKeys.

Supported API: false

Returns:

String

Throws:

WTException