org.dmd.dmc

Class DmcObjectName

java.lang.Object

org.dmd.dmc.DmcObjectName

All Implemented Interfaces:

Serializable, Comparable<DmcObjectName>, DmcMappedAttributeIF

Direct Known Subclasses:

CamelCaseName, DefinitionName, DmcHierarchicObjectName, DmtStringName, IntegerName, LongName, RuleName, StringName, UUIDName

public abstract class DmcObjectName
extends Object
implements DmcMappedAttributeIF, Comparable<DmcObjectName>, Serializable

The DmcObjectName class provides a base type from which all types that represent object names should be derived. The common base allows for wrapping of these types by generated code that makes object naming easier to handle in a consistent way.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DmcObjectName()

Method Summary

Modifier and Type	Method and Description
abstract DmcObjectName	cloneIt()
abstract int	compareTo(DmcObjectName o) Compares the name to another name for order.
abstract void	deserializeIt(DmcInputStreamIF dis) Likewise, they must also be individually deserializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.
abstract boolean	equals(Object obj) Implementors should check to see if the object is of the same type.
abstract Object	getKey() Returns the portion of the name that provides a unique key for storage in maps and sets.
abstract String	getKeyAsString() Returns the key value as a String.
abstract String	getNameClass()
abstract String	getNameString() Return the name of the object as a String.
abstract DmcObjectName	getNew()
abstract String	getPresentationString() Internally, names may not be particularly suited to display in user interfaces.
abstract int	hashCode() Returns the hash code for this name.
abstract void	serializeIt(DmcOutputStreamIF dos) The object name values must be individually serializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.
abstract void	setNameString(String n) Implementing classes must overload this method to initialize their name properly with the String form of their name.
String	toString() Return the name as a string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dmd.dmc.DmcMappedAttributeIF

valuesAreEqual

Constructor Detail

DmcObjectName

public DmcObjectName()

Method Detail

getNameString

public abstract String getNameString()

Return the name of the object as a String. Regardless of how the name is internally represented, it must have a String representation.

Returns:

The name of the object.

getPresentationString

public abstract String getPresentationString()

Internally, names may not be particularly suited to display in user interfaces. This method should be overloaded to provide an informative presentation name.

Returns:

A string.

setNameString

public abstract void setNameString(String n)
                            throws DmcValueException

Implementing classes must overload this method to initialize their name properly with the String form of their name. This can basically be seen as implying that you must have a constructor for your name implementation that takes a String as argument. We need setNameString() so that we can create DmcTypeNamedObjectREF values based on a String.

Parameters:

n - The name value as a String.

Throws:

DmcValueException

equals

public abstract boolean equals(Object obj)

Implementors should check to see if the object is of the same type. If not, return false. If so, use whatever comparison strategy applies to your name.

Overrides:

equals in class Object

Parameters:

obj - The comparison object.

Returns:

True if the names match.

hashCode

public abstract int hashCode()

Returns the hash code for this name.

Overrides:

hashCode in class Object

Returns:

An int hash code.

serializeIt

public abstract void serializeIt(DmcOutputStreamIF dos)
                          throws Exception

The object name values must be individually serializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.

Parameters:

dos - The output stream.

Throws:

Exception

deserializeIt

public abstract void deserializeIt(DmcInputStreamIF dis)
                            throws Exception

Likewise, they must also be individually deserializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.

Parameters:

dis - The input stream.

Throws:

Exception

cloneIt

public abstract DmcObjectName cloneIt()

Returns:

A clone of the object name derivative.

getKey

public abstract Object getKey()

Returns the portion of the name that provides a unique key for storage in maps and sets.

Specified by:

getKey in interface DmcMappedAttributeIF

Returns:

The key value.

getKeyAsString

public abstract String getKeyAsString()

Returns the key value as a String.

Specified by:

getKeyAsString in interface DmcMappedAttributeIF

Returns:

A String.

compareTo

public abstract int compareTo(DmcObjectName o)

Compares the name to another name for order.

Specified by:

compareTo in interface Comparable<DmcObjectName>

getNameClass

public abstract String getNameClass()

Returns:

just the name of the name class e.g. StringName, IntegerName etc.

getNew

public abstract DmcObjectName getNew()

Returns:

a new DmcObjectName derivative.

toString

public String toString()

Return the name as a string.

Overrides:

toString in class Object