wt.content
Class DataFormatIdentity

java.lang.Object
  wt.fc.IdentificationObject
      wt.content.DataFormatIdentity

All Implemented Interfaces:

Externalizable, NetFactor, Serializable

public class DataFormatIdentity

extends IdentificationObject

implements Externalizable

Identification object for a DataFormat This is an implementation object that defines the uniqueness constraint for a DataFormat.

Use the newDataFormatIdentity static factory method(s), not the DataFormatIdentity 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:

DataFormat, Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private String	formatName
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.IdentificationObject

Constructor Summary

DataFormatIdentity()

Method Summary

private void	formatNameValidate(String a_FormatName)
String	getConceptualClassname() Deprecated.
String	getFormatName() Gets the value of the attribute: formatName.
String	getIdentity() Constructs and returns a string representing the object's identity.
protected String	getKeyClassName() Creates a name for the uniqueness constraint.
protected void	initialize(String aFormatName) Supports initialization, following construction of an instance.
static DataFormatIdentity	newDataFormatIdentity(String aFormatName) 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(DataFormatIdentity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected void	setFormatName(String a_FormatName) Sets the value of the attribute: formatName.
protected void	setToObject(Identified obj) Updates the identity of the object passed as argument with the identity held in the object.
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

formatName

private String formatName

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

DataFormatIdentity

public DataFormatIdentity()

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

getFormatName

public String getFormatName()

Gets the value of the attribute: formatName.

Supported API: false

Returns:

String

setFormatName

protected void setFormatName(String a_FormatName)
                      throws WTPropertyVetoException

Sets the value of the attribute: formatName.

Supported API: false

Parameters:

a_FormatName -

Throws:

WTPropertyVetoException

formatNameValidate

private void formatNameValidate(String a_FormatName)
                         throws WTPropertyVetoException

Parameters:

a_FormatName -

Throws:

WTPropertyVetoException

newDataFormatIdentity

public static DataFormatIdentity newDataFormatIdentity(String aFormatName)
                                                throws WTException

Supported API: false

Parameters:

aFormatName -

Returns:

DataFormatIdentity

Throws:

WTException

initialize

protected void initialize(String aFormatName)
                   throws WTException

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

Supported API: false

Parameters:

aFormatName -

Throws:

WTException

getKeyClassName

protected String getKeyClassName()

Creates a name for the uniqueness constraint. The default implementation uses the name of the class, which makes it inappropriate for uniqueness constraints spanning several classes.

Supported API: false

Overrides:

getKeyClassName in class IdentificationObject

Returns:

String

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