wt.vc.views
Class ViewReference

java.lang.Object
  wt.fc.ObjectReference
      wt.fc.CachedObjectReference
          wt.vc.views.ViewReference

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

public final class ViewReference

extends CachedObjectReference

implements Externalizable

The ViewReference is an ObjectReference particular to Views. When getting the view object from the reference, it uses the ViewService rather than hitting the database directly.

Use the newViewReference static factory method(s), not the ViewReference 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; Non-persistent attribute that is filled in by the inflate in the query results thru the cached object.
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

ViewReference()

Method Summary

String	getConceptualClassname() Deprecated.
String	getIdentity() Return the nice string of the referenced object's identity.
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(ObjectIdentifier objId) Supports initialization, following construction of an instance.
protected void	initialize(View obj) Supports initialization, following construction of an instance.
protected void	initialize(ViewReference viewReference) Supports initialization, following construction of an instance.
static ViewReference	newViewReference() Supported API: true
static ViewReference	newViewReference(ObjectIdentifier objId) Supported API: true
static ViewReference	newViewReference(View obj) Supported API: true
static ViewReference	newViewReference(ViewReference viewReference) 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(ViewReference thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	refresh() Override refresh to set the view object using the cache, not the db.
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, 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

NAME

public static final String NAME

Label for the attribute; Non-persistent attribute that is filled in by the inflate in the query results thru the cached object.

Supported API: false

See Also:

Constant Field Values

name

private String name

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

ViewReference

public ViewReference()

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(ViewReference 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. Non-persistent attribute that is filled in by the inflate in the query results thru the cached object.

Supported API: false

Returns:

String

newViewReference

public static ViewReference newViewReference()
                                      throws WTException

Supported API: true

Returns:

ViewReference

Throws:

WTException

newViewReference

public static ViewReference newViewReference(View obj)
                                      throws WTException

Supported API: true

Parameters:

obj -

Returns:

ViewReference

Throws:

WTException

initialize

protected void initialize(View obj)
                   throws WTException

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

Supported API: true

Parameters:

obj -

Throws:

WTException

newViewReference

public static ViewReference newViewReference(ViewReference viewReference)
                                      throws WTException

Supported API: true

Parameters:

viewReference -

Returns:

ViewReference

Throws:

WTException

initialize

protected void initialize(ViewReference viewReference)
                   throws WTException

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

Supported API: true

Parameters:

viewReference -

Throws:

WTException

newViewReference

public static ViewReference newViewReference(ObjectIdentifier objId)
                                      throws WTException

Supported API: true

Parameters:

objId -

Returns:

ViewReference

Throws:

WTException

initialize

protected void initialize(ObjectIdentifier objId)
                   throws WTException

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

Supported API: true

Overrides:

initialize in class ObjectReference

Parameters:

objId -

Throws:

WTException

getIdentity

public String getIdentity()

Return the nice string of the referenced object's identity.

Supported API: true

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 -

refresh

public void refresh()
             throws WTException

Override refresh to set the view object using the cache, not the db.

Specified by:

refresh in interface WTReference

Overrides:

refresh in class CachedObjectReference

Throws:

WTException