org.dmd.dmc.definitions

Class DMODefinitionSet<DEF extends DSDefinitionDMO>

java.lang.Object

org.dmd.dmc.definitions.DMODefinitionSet<DEF>

Type Parameters:

DEF -

public class DMODefinitionSet<DEF extends DSDefinitionDMO>
extends Object

The DMODefinitionSet class provides a mechanism to store a set of definitions with the possibility that the DefinitionName of some of the definitions may clash.

This is an analog to the DmcDefinitionSet that is used on the server side - this class is intended for use on the client side in GWT applications.

The resulting class stores three different types of maps and, depending on the constructor used to create it, populates those maps in slightly different ways. The subtleties of the population has to do with how definitions are named and references to them resolved.

The nameMap for a given

Constructor Summary

Constructors

Constructor and Description
DMODefinitionSet() Constructs a new global definition set.
DMODefinitionSet(String sn) Constructs a new global definition set.
DMODefinitionSet(String cn, DMODefinitionSet<DSDefinitionDMO> gs) Constructs a new definition set.
DMODefinitionSet(String cn, DMODefinitionSet<DSDefinitionDMO> gs, DMODefinitionSet<?> derivedFrom) Constructs a new definition set.

Method Summary

Modifier and Type	Method and Description
void	add(DEF def) Adds the specified definition.
String	className()
static void	debug(boolean f)
void	delete(DEF def) Deletes the specified definition from all maps.
void	delete(DotName dn) Deletes the specified object from this definition set.
protected void	deleteFromBase(DSDefinitionDMO dsd)
String	getAllDotNames()
DEF	getDefinition(DotName name)
DEF	getDefinition(String name) Attempts to return a definition based on its name.
DEF	getDefinitionByNameAndType(DotName dn) Attempts to return a definition based on the defname.type form of its name.
int	getLongestName()
int	size()
String	summary()
Collection<DEF>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DMODefinitionSet

public DMODefinitionSet()

Constructs a new global definition set. This type of set doesn't have a class name and is used to store a global mapping of definitions of all types.

DMODefinitionSet

public DMODefinitionSet(String sn)

Constructs a new global definition set. This type of set doesn't have a class name and is used to store a global mapping of definitions of all types. This form of the constructor also allows you to give the definition a name that can be useful for debugging purposes.

Parameters:

sn - the set name - so that we can see the name of this set when debugging

DMODefinitionSet

public DMODefinitionSet(String cn,
                        DMODefinitionSet<DSDefinitionDMO> gs)

Constructs a new definition set.

Parameters:

cn - the name of the class of definition being stored in this definition set

gs - the global definition set

DMODefinitionSet

public DMODefinitionSet(String cn,
                        DMODefinitionSet<DSDefinitionDMO> gs,
                        DMODefinitionSet<?> derivedFrom)

Constructs a new definition set.

Parameters:

cn - the name of the class of definition being stored in this definition set

gs - the global definition set

derivedFrom - definition set for class from which we're derived

Method Detail

debug

public static void debug(boolean f)

className

public String className()

add

public void add(DEF def)

Adds the specified definition. If the dotname of the definition already exists, an IllegalState exception is thrown.

Parameters:

def - the definition to be added.

delete

public void delete(DotName dn)
            throws Exception

Deletes the specified object from this definition set.

Parameters:

dn - the fully qualified name of a definition.

Throws:

Exception - if the object deosn't exist or is of the wrong class.

deleteFromBase

protected void deleteFromBase(DSDefinitionDMO dsd)
                       throws Exception

Throws:

Exception

delete

public void delete(DEF def)
            throws Exception

Deletes the specified definition from all maps. If the definition has any references to it (that are not self referential), an exception is thrown.

Parameters:

def - the definition to be deleted.

Throws:

Exception

size

public int size()

Returns:

the number of definitions in this set.

getLongestName

public int getLongestName()

Returns:

the length of the longest DefinitionName

getDefinition

public DEF getDefinition(DotName name)

Parameters:

name - the name of the object you're looking for

Returns:

the definition or null if it doesn't exist.

values

public Collection<DEF> values()

Returns:

the set of definition in this set.

getDefinition

public DEF getDefinition(String name)
                  throws DmcNameClashException,
                         DmcValueException

Attempts to return a definition based on its name.

Parameters:

name - the name of the definition you're looking for

Returns:

the definition or null if it doesn't exist

Throws:

DmcNameClashException - if there's more than one definition with the specified name, we throw an exception

DmcValueException

getDefinitionByNameAndType

public DEF getDefinitionByNameAndType(DotName dn)
                               throws DmcNameClashException

Attempts to return a definition based on the defname.type form of its name. This is useful in situations where name resolution is being done via the findNamedObjectMayClash() mechanisms where we have the name of the object and the attribute via which the reference is being made, which gives us the type information.

Parameters:

dn - the defname.type form of a definition name

Returns:

the definition or null if it doesn't exist

Throws:

DmcNameClashException - DmcNameClashException if there's more than one definition with the specified name, we throw an exception

DmcValueException

getAllDotNames

public String getAllDotNames()

Returns:

all the dot names for which we have a definition in the set

summary

public String summary()