wt.fc
Class ObjectIdentifier

java.lang.Object
  wt.fc.ObjectIdentifier

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, QueryKey, Serializable

public final class ObjectIdentifier

extends Object

implements QueryKey, Evolvable

ObjectIdentifier represents a unique identifier assigned to the object by the PersistenceManager when it saves a Persistable object to a datastore.

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

Field Summary

private String	classname
private static String	CLASSNAME
private static int	CLASSNAME_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
private long	id
static String	ID Label for the attribute; The unique identifier of this ObjectIdentifier.
private static String	ID_SEPARATOR
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
(package private) static long	UNASSIGNED_ID A constant that indicates that an ObjectIdentifier has not been assigned a value for its id attribute.

Constructor Summary

ObjectIdentifier()

ObjectIdentifier(Class aClass, long anIdValue)

ObjectIdentifier(String url)

Method Summary

QuerySpec	appendKeyCriteria(QuerySpec qs) Supported API: false
boolean	equals(Object obj) Compare two ObjectIdentifier objects for equality.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getClassname() Gets the value of the attribute: CLASSNAME.
String	getConceptualClassname() Deprecated.
long	getId() Gets the value of the attribute: ID.
String	getStringValue() Returns a string representation for this ObjectIdentifier.
int	hashCode() Returns a hash code for this ObjectIdentifier.
String	idAsString() Returns a string representation for this ObjectIdentifier.getId.
protected void	initialize() Supported API: false
protected void	initialize(Class aClass, long anIdValue) Supported API: false
protected void	initialize(String url) Supported API: false
boolean	isAssigned() Return true if this ObjectIdentifier has been assigned for a Persistable object.
boolean	isNotAssigned() Return true if this ObjectIdentifier has NOT been assigned to any Persistable object.
static ObjectIdentifier	newObjectIdentifier() Supported API: false
static ObjectIdentifier	newObjectIdentifier(Class aClass, long anIdValue) Supported API: false
static ObjectIdentifier	newObjectIdentifier(String url) 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(ObjectIdentifier thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setClassname(String a_Classname) Sets the value of the attribute: CLASSNAME.
protected void	setId(long a_Id) Sets the value of the attribute: ID.
String	toString() Returns the conceptual (modeled) name for the class.
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 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

ID

public static final String ID

Label for the attribute; The unique identifier of this ObjectIdentifier.

Supported API: false

See Also:

Constant Field Values

id

private long id

UNASSIGNED_ID

static final long UNASSIGNED_ID

A constant that indicates that an ObjectIdentifier has not been assigned a value for its id attribute.

Supported API: false

See Also:

Constant Field Values

ID_SEPARATOR

private static final String ID_SEPARATOR

See Also:

Constant Field Values

CLASSNAME_UPPER_LIMIT

private static int CLASSNAME_UPPER_LIMIT

classname

private String classname

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

ObjectIdentifier

public ObjectIdentifier()

ObjectIdentifier

public ObjectIdentifier(Class aClass,
                        long anIdValue)

ObjectIdentifier

public ObjectIdentifier(String url)
                 throws WTException

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getId

public long getId()

Gets the value of the attribute: ID. The unique identifier of this ObjectIdentifier.

Supported API: false

Returns:

long

setId

protected void setId(long a_Id)

Sets the value of the attribute: ID. The unique identifier of this ObjectIdentifier.

Supported API: false

Parameters:

a_Id -

newObjectIdentifier

public static ObjectIdentifier newObjectIdentifier()
                                            throws WTException

Supported API: false

Returns:

ObjectIdentifier

Throws:

WTException

newObjectIdentifier

public static ObjectIdentifier newObjectIdentifier(Class aClass,
                                                   long anIdValue)
                                            throws WTException

Supported API: false

Parameters:

aClass -

anIdValue -

Returns:

ObjectIdentifier

Throws:

WTException

newObjectIdentifier

public static ObjectIdentifier newObjectIdentifier(String url)
                                            throws WTException

Supported API: false

Parameters:

url -

Returns:

ObjectIdentifier

Throws:

WTException

equals

public boolean equals(Object obj)

Compare two ObjectIdentifier objects for equality.

Supported API: false

Specified by:

equals in interface QueryKey

Parameters:

obj - The reference object to compare.

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this ObjectIdentifier.

Supported API: false

Specified by:

hashCode in interface QueryKey

Returns:

int

getStringValue

public String getStringValue()

Returns a string representation for this ObjectIdentifier. This can be used to pass the ObjectIdentifier as a String value (such as on a URL parameter).

Supported API: false

Returns:

String

idAsString

public String idAsString()

Returns a string representation for this ObjectIdentifier.getId.

Supported API: false

Returns:

String

isAssigned

public boolean isAssigned()

Return true if this ObjectIdentifier has been assigned for a Persistable object.

Supported API: false

Returns:

boolean

isNotAssigned

public boolean isNotAssigned()

Return true if this ObjectIdentifier has NOT been assigned to any Persistable object.

Supported API: false

Returns:

boolean

appendKeyCriteria

public QuerySpec appendKeyCriteria(QuerySpec qs)
                            throws WTException

Supported API: false

Specified by:

appendKeyCriteria in interface QueryKey

Parameters:

qs -

Returns:

QuerySpec

Throws:

WTException

initialize

protected void initialize()

Supported API: false

initialize

protected void initialize(Class aClass,
                          long anIdValue)

Supported API: false

Parameters:

aClass -

anIdValue -

initialize

protected void initialize(String url)
                   throws WTException

Supported API: false

Parameters:

url -

Throws:

WTException

getClassname

public String getClassname()

Gets the value of the attribute: CLASSNAME.

Supported API: false

Specified by:

getClassname in interface QueryKey

Returns:

String

setClassname

public void setClassname(String a_Classname)

Sets the value of the attribute: CLASSNAME.

Supported API: false

Specified by:

setClassname in interface QueryKey

Parameters:

a_Classname -