wt.content
Class DataFormatReference

java.lang.Object
  wt.fc.ObjectReference
      wt.fc.CachedObjectReference
          wt.content.DataFormatReference

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

public class DataFormatReference

extends CachedObjectReference

implements Externalizable

DataFormatReference is what is stored with a ContentItem of a FormatContentHolder to indicate how the item should be displayed to the user as well as how ApplicationData objects should be downloaded (i.e. with what MIME type)

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

Nested Class Summary

Nested classes inherited from class wt.fc.CachedObjectReference

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	FORMAT_NAME Label for the attribute; The displayed FormatName for the corresponding DataFormat object.
private String	formatName
static String	OBJECT Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.CachedObjectReference

INFLATED

Fields inherited from class wt.fc.ObjectReference

KEY, object, OBJECT_ID

Constructor Summary

DataFormatReference()

Method Summary

private void	formatNameValidate(String a_FormatName)
String	getConceptualClassname() Deprecated.
DataFormat	getDataFormat() Supported API: false
DataFormatReference	getDataFormatReference() Supported API: false
String	getFormatName() Gets the value of the attribute: FORMAT_NAME.
String	getIdentity() Supported API: false
void	inflate(CachedObjectReference cor) Supported API: false
void	inflate(Persistable obj) Supported API: false
protected void	initialize(DataFormat formatObj) Supports initialization, following construction of an instance.
protected void	initialize(DataFormatReference ref) Supports initialization, following construction of an instance.
protected void	initialize(ObjectIdentifier oid) Supports initialization, following construction of an instance.
protected void	initialize(String formatName) Supports initialization, following construction of an instance.
static DataFormatReference	newDataFormatReference(DataFormat formatObj) Constructor based on a DataFormat object.
static DataFormatReference	newDataFormatReference(DataFormatReference ref) Constructor based on FormatName.
static DataFormatReference	newDataFormatReference(ObjectIdentifier oid) Constructor based on an oid of a DataFormat.
static DataFormatReference	newDataFormatReference(String formatName) Constructor based on FormatName.
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(DataFormatReference thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setFormatName(String a_FormatName) Sets the value of the attribute: FORMAT_NAME.
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.fc.CachedObjectReference

deflate, getObject, getReadOnlyObject, inflate, isInflated, isObjectInflated, readVersion, refresh, reset, setInflated, setObjectNull

Methods inherited from class wt.fc.ObjectReference

equals, getClassInfo, getKey, getObjectId, getReferencedClass, getReferencedClass, hashCode, hasPersistence, initialize, initialize, initialize, newObjectReference, newObjectReference, newObjectReference, newObjectReference, readVersion, references, setKey, setObject, setObjectId, toString

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

FORMAT_NAME

public static final String FORMAT_NAME

Label for the attribute; The displayed FormatName for the corresponding DataFormat object.

Supported API: false

See Also:

Constant Field Values

formatName

private String formatName

OBJECT

public static final String OBJECT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

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

DataFormatReference

public DataFormatReference()

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 CachedObjectReference

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 CachedObjectReference

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 CachedObjectReference

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

Overrides:

getConceptualClassname in class ObjectReference

Returns:

String

getFormatName

public String getFormatName()

Gets the value of the attribute: FORMAT_NAME. The displayed FormatName for the corresponding DataFormat object.

Supported API: false

Returns:

String

setFormatName

public void setFormatName(String a_FormatName)
                   throws WTPropertyVetoException

Sets the value of the attribute: FORMAT_NAME. The displayed FormatName for the corresponding DataFormat object.

Supported API: false

Parameters:

a_FormatName -

Throws:

WTPropertyVetoException

formatNameValidate

private void formatNameValidate(String a_FormatName)
                         throws WTPropertyVetoException

Parameters:

a_FormatName -

Throws:

WTPropertyVetoException

newDataFormatReference

public static DataFormatReference newDataFormatReference(DataFormat formatObj)
                                                  throws WTException

Constructor based on a DataFormat object. Should really only be used in the ContentService.

Supported API: false

Parameters:

formatObj -

Returns:

DataFormatReference

Throws:

WTException

initialize

protected void initialize(DataFormat formatObj)
                   throws WTException

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

Supported API: false

Parameters:

formatObj -

Throws:

WTException

newDataFormatReference

public static DataFormatReference newDataFormatReference(String formatName)
                                                  throws WTException

Constructor based on FormatName. The FormatName is what gets displayed to users. This is what can be used to set the format in the client.

Supported API: false

Parameters:

formatName -

Returns:

DataFormatReference

Throws:

WTException

initialize

protected void initialize(String formatName)
                   throws WTException

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

Supported API: false

Parameters:

formatName -

Throws:

WTException

newDataFormatReference

public static DataFormatReference newDataFormatReference(DataFormatReference ref)
                                                  throws WTException

Constructor based on FormatName. The FormatName is what gets displayed to users. This is what can be used to set the format in the client.

Supported API: false

Parameters:

ref -

Returns:

DataFormatReference

Throws:

WTException

initialize

protected void initialize(DataFormatReference ref)
                   throws WTException

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

Supported API: false

Parameters:

ref -

Throws:

WTException

newDataFormatReference

public static DataFormatReference newDataFormatReference(ObjectIdentifier oid)
                                                  throws WTException

Constructor based on an oid of a DataFormat.

Supported API: false

Parameters:

oid -

Returns:

DataFormatReference

Throws:

WTException

initialize

protected void initialize(ObjectIdentifier oid)
                   throws WTException

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

Supported API: false

Overrides:

initialize in class ObjectReference

Parameters:

oid -

Throws:

WTException

getIdentity

public String getIdentity()

Supported API: false

Returns:

String

getDataFormat

public DataFormat getDataFormat()
                         throws WTException

Supported API: false

Returns:

DataFormat

Throws:

WTException

getDataFormatReference

public DataFormatReference getDataFormatReference()
                                           throws WTException

Supported API: false

Returns:

DataFormatReference

Throws:

WTException

inflate

public void inflate(Persistable obj)

Supported API: false

Specified by:

inflate in class CachedObjectReference

Parameters:

obj -

inflate

public void inflate(CachedObjectReference cor)

Supported API: false

Specified by:

inflate in class CachedObjectReference

Parameters:

cor -