org.dmd.dmc

Class DmcNamedObjectREF<DMO extends DmcNamedObjectIF>

java.lang.Object

org.dmd.dmc.DmcNamedObjectREF<DMO>

All Implemented Interfaces:

Serializable, DmcMappedAttributeIF, DmcNamedObjectIF

Direct Known Subclasses:

DmcNamedObjectNontransportableREF, DmcNamedObjectTransportableREF

public abstract class DmcNamedObjectREF<DMO extends DmcNamedObjectIF>
extends Object
implements Serializable, DmcNamedObjectIF, DmcMappedAttributeIF

The DmcNamedObjectREF is an abstract base class that defines helper class for implementing the concept of references to named objects that can either be resolved or unresolved. The derived classes of this class provide the concept of transportable versus nontransportable object references.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Modifier	backrefModifier

Constructor Summary

Constructors

Constructor and Description
DmcNamedObjectREF() Constructs a new named object reference.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) This method should check the type of the obj param and compare the name of this object with the one passed as argument.
Modifier	getBackrefModifier() If back reference tracking was turned on when this reference was resolved, this will return the handle to back reference modifier that was created on the object being referred to.
Object	getKey() Returns the key associated with this attribute value.
String	getKeyAsString() Returns the key value represented as a string.
abstract DMO	getObject()
int	hashCode()
abstract boolean	isResolved()
void	removeBackref() If back reference tracking is enabled and we have an object and a backref, we remove the back reference.
void	setBackrefModifier(Modifier mod) Sets the modifier that will remove this object reference if the object being referred to is deleted.
abstract void	setName(DmcObjectName n) Sets the name of the object being referred to.
abstract void	setObject(DMO o) Sets the object, thus making this reference "resolved".
String	toString() Override toString() to provide the object name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

getObjectName, getObjectNameAttribute

Methods inherited from interface org.dmd.dmc.DmcMappedAttributeIF

valuesAreEqual

Field Detail

backrefModifier

protected transient Modifier backrefModifier

Constructor Detail

DmcNamedObjectREF

public DmcNamedObjectREF()

Constructs a new named object reference.

Method Detail

setBackrefModifier

public void setBackrefModifier(Modifier mod)

Sets the modifier that will remove this object reference if the object being referred to is deleted. This is used to efficiently remove the back reference when an object is no longer referenced. This mechanism is used by the Dark Matter back reference tracking mechanisms; don't mess with it unless you know what you're doing ;-)

Parameters:

mod - The back reference modifier.

getBackrefModifier

public Modifier getBackrefModifier()

If back reference tracking was turned on when this reference was resolved, this will return the handle to back reference modifier that was created on the object being referred to.

Returns:

The back reference modifier.

removeBackref

public void removeBackref()

If back reference tracking is enabled and we have an object and a backref, we remove the back reference.

setObject

public abstract void setObject(DMO o)

Sets the object, thus making this reference "resolved".

Parameters:

o - the object.

getObject

public abstract DMO getObject()

Returns:

The object if this reference is resolved.

isResolved

public abstract boolean isResolved()

Returns:

True if the reference is resolved and false otherwise.

setName

public abstract void setName(DmcObjectName n)
                      throws DmcValueException

Sets the name of the object being referred to. NOTE: USE WITH CAUTION!!!

Parameters:

n - The name of the object.

Throws:

DmcValueException

toString

public String toString()

Override toString() to provide the object name.

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Description copied from interface: DmcNamedObjectIF

This method should check the type of the obj param and compare the name of this object with the one passed as argument.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class Object

Parameters:

obj - The comparison object.

Returns:

true if the object passed as argument is a DmcNamedObjectREF and has a DmcObjectName that equals our DmcObjectName.

getKey

public Object getKey()

Returns the key associated with this attribute value.

Specified by:

getKey in interface DmcMappedAttributeIF

Returns:

The key value.

getKeyAsString

public String getKeyAsString()

Returns the key value represented as a string. we could just call the toString() method on the Object, but having this forces you implement an appropriate String conversion method for the key.

Specified by:

getKeyAsString in interface DmcMappedAttributeIF

Returns:

A String.