wt.inf.container
Class WTContainerRef

java.lang.Object
  wt.fc.ObjectReference
      wt.fc.CachedObjectReference
          wt.inf.container.WTContainerRef

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

Direct Known Subclasses:

Project2Reference

public class WTContainerRef

extends CachedObjectReference

implements Externalizable

Use the newWTContainerRef static factory method(s), not the WTContainerRef 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
private String	description
static String	DESCRIPTION Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
static String	REFERENCED_CONTAINER Label for the attribute.
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

Fields inherited from interface wt.fc.WTReference

OBJECT

Constructor Summary

WTContainerRef()

Method Summary

String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Deprecated. Replaced by getReferencedContainer
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getName() Gets the value of the attribute: NAME.
WTContainerRef	getParentRef() Supported API: false
WTContainer	getReferencedContainer() Gets the object for the association that plays role: REFERENCED_CONTAINER.
WTContainer	getReferencedContainerReadOnly() Returns a read-only reference to the cached instance of the container.
void	inflate(CachedObjectReference cor) Supported API: false
void	inflate(Persistable obj) Supported API: false
protected void	initialize(Object[] attrs, int start) Supports initialization, following construction of an instance.
protected void	initialize(ObjectIdentifier oid) Supports initialization, following construction of an instance.
protected void	initialize(WTContainer container) Supports initialization, following construction of an instance.
protected void	initialize(WTContainerRef ref) Supports initialization, following construction of an instance.
static WTContainerRef	newWTContainerRef(Object[] attrs, int start) Constructs a reference using a classname and oid.
static WTContainerRef	newWTContainerRef(ObjectIdentifier oid) Supported API: false
static WTContainerRef	newWTContainerRef(WTContainer container) Supported API: true
static WTContainerRef	newWTContainerRef(WTContainerRef ref) Supported API: true
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(WTContainerRef thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

description

private String description

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

name

private String name

REFERENCED_CONTAINER

public static final String REFERENCED_CONTAINER

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

WTContainerRef

public WTContainerRef()

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

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Returns:

String

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

getReferencedContainer

public WTContainer getReferencedContainer()

Gets the object for the association that plays role: REFERENCED_CONTAINER.

Supported API: false

Returns:

WTContainer

newWTContainerRef

public static WTContainerRef newWTContainerRef(WTContainer container)
                                        throws WTException

Supported API: true

Parameters:

container -

Returns:

WTContainerRef

Throws:

WTException

initialize

protected void initialize(WTContainer container)
                   throws WTException

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

Supported API: true

Parameters:

container -

Throws:

WTException

newWTContainerRef

public static WTContainerRef newWTContainerRef(WTContainerRef ref)
                                        throws WTException

Supported API: true

Parameters:

ref -

Returns:

WTContainerRef

Throws:

WTException

initialize

protected void initialize(WTContainerRef ref)
                   throws WTException

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

Supported API: true

Parameters:

ref -

Throws:

WTException

newWTContainerRef

public static WTContainerRef newWTContainerRef(ObjectIdentifier oid)
                                        throws WTException

Supported API: false

Parameters:

oid -

Returns:

WTContainerRef

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

newWTContainerRef

public static WTContainerRef newWTContainerRef(Object[] attrs,
                                               int start)
                                        throws WTException

Constructs a reference using a classname and oid. The element at start must be a String classname, and the element at start + 1 must be a long oid.

Supported API: false

Parameters:

attrs -

start -

Returns:

WTContainerRef

Throws:

WTException

initialize

protected void initialize(Object[] attrs,
                          int start)
                   throws WTException

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

Supported API: false

Parameters:

attrs -

start -

Throws:

WTException

getParentRef

public WTContainerRef getParentRef()

Supported API: false

Returns:

WTContainerRef

getReferencedContainerReadOnly

public WTContainer getReferencedContainerReadOnly()

Returns a read-only reference to the cached instance of the container.

Supported API: true

Returns:

WTContainer

See Also:

wt#fc#CachedObjectReference#getReadOnlyObject()

getContainer

public WTContainer getContainer()

Deprecated. Replaced by getReferencedContainer

Supported API: false

Returns:

WTContainer

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 -