wt.folder
Class CabinetReference

java.lang.Object
  wt.fc.ObjectReference
      wt.fc.CachedObjectReference
          wt.folder.CabinetReference

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

public final class CabinetReference

extends CachedObjectReference

implements Externalizable

Provides a means to reference a Cabinet. This reference is persistently stored in objects to associate themselves to the Cabinet they reside in.

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

Nested Class Summary

Nested classes inherited from class wt.fc.CachedObjectReference

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute; The name of the cabinet for this reference.
static String	OBJECT Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
static String	PERSONAL_CABINET Label for the attribute; A boolean set to true if the cabinet is a personal cabinet and set to false if the cabinet is a shared cabinet.
private boolean	personalCabinet
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

CabinetReference()

Method Summary

String	getConceptualClassname() Deprecated.
String	getIdentity() Return the object's identity in string form.
String	getName() Gets the value of the attribute: NAME.
void	inflate(CachedObjectReference cor) Supported API: false
void	inflate(Persistable obj) Supported API: false
protected void	initialize(Cabinet cabinet) Supports initialization, following construction of an instance.
protected void	initialize(CabinetReference reference) Supports initialization, following construction of an instance.
protected void	initialize(ObjectIdentifier cabinet_oid) Supports initialization, following construction of an instance.
boolean	isPersonalCabinet() Gets the value of the attribute: PERSONAL_CABINET.
static CabinetReference	newCabinetReference() Default no-arg factory to construct a CabinetReference.
static CabinetReference	newCabinetReference(Cabinet cabinet) Factory to construct a CabinetReference for the supplied Cabinet.
static CabinetReference	newCabinetReference(CabinetReference reference) Factory to construct a CabinetReference for the supplied CabinetReference.
static CabinetReference	newCabinetReference(ObjectIdentifier cabinet_oid) Supported API: false
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(CabinetReference thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
String	toString() Returns a String representation of the object being referenced.
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

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

NAME

public static final String NAME

Label for the attribute; The name of the cabinet for this reference. This is a dynamically calculated from the referenced cabinet.

Supported API: false

See Also:

Constant Field Values

name

private String name

PERSONAL_CABINET

public static final String PERSONAL_CABINET

Label for the attribute; A boolean set to true if the cabinet is a personal cabinet and set to false if the cabinet is a shared cabinet.

Supported API: false

See Also:

Constant Field Values

personalCabinet

private boolean personalCabinet

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

CabinetReference

public CabinetReference()

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

getName

public String getName()

Gets the value of the attribute: NAME. The name of the cabinet for this reference. This is a dynamically calculated from the referenced cabinet.

Supported API: false

Returns:

String

isPersonalCabinet

public boolean isPersonalCabinet()

Gets the value of the attribute: PERSONAL_CABINET. A boolean set to true if the cabinet is a personal cabinet and set to false if the cabinet is a shared cabinet.

Supported API: false

Returns:

boolean

newCabinetReference

public static CabinetReference newCabinetReference()
                                            throws WTException

Default no-arg factory to construct a CabinetReference.

Supported API: false

Returns:

CabinetReference

Throws:

WTException

newCabinetReference

public static CabinetReference newCabinetReference(ObjectIdentifier cabinet_oid)
                                            throws WTException

Supported API: false

Parameters:

cabinet_oid -

Returns:

CabinetReference

Throws:

WTException

initialize

protected void initialize(ObjectIdentifier cabinet_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:

cabinet_oid -

Throws:

WTException

newCabinetReference

public static CabinetReference newCabinetReference(Cabinet cabinet)
                                            throws WTException

Factory to construct a CabinetReference for the supplied Cabinet.

Supported API: false

Parameters:

cabinet -

Returns:

CabinetReference

Throws:

WTException

initialize

protected void initialize(Cabinet cabinet)
                   throws WTException

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

Supported API: false

Parameters:

cabinet -

Throws:

WTException

newCabinetReference

public static CabinetReference newCabinetReference(CabinetReference reference)
                                            throws WTException

Factory to construct a CabinetReference for the supplied CabinetReference.

Supported API: false

Parameters:

reference -

Returns:

CabinetReference

Throws:

WTException

initialize

protected void initialize(CabinetReference reference)
                   throws WTException

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

Supported API: false

Parameters:

reference -

Throws:

WTException

getIdentity

public String getIdentity()

Return the object's identity in string form.

Supported API: false

Returns:

String

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 -

toString

public String toString()

Description copied from class: ObjectReference

Returns a String representation of the object being referenced.

Supported API: false

Overrides:

toString in class ObjectReference

Returns:

String