org.dmd.dmu.server.generated.dsd

Class DmuModuleDefinitionManager

java.lang.Object

org.dmd.dmu.server.generated.dsd.DmuModuleDefinitionManager

All Implemented Interfaces:

DmcNameClashResolverIF, DmcNameResolverIF, DmcNameResolverWithClashSupportIF, DmuModuleDefinitionsIF, DmuModuleGlobalInterface

public class DmuModuleDefinitionManager
extends Object
implements DmcNameClashResolverIF, DmcNameResolverWithClashSupportIF, DmuModuleGlobalInterface, DmuModuleDefinitionsIF

Constructor Summary

Constructors

Constructor and Description
DmuModuleDefinitionManager()

Method Summary

Modifier and Type	Method and Description
void	addDefinition(DSDefinition definition)
void	addDefinition(DSDefinition definition, DmuModule module)
void	addDmuModule(DmuModule def)
void	addPayloadExample(PayloadExample def)
void	addPayloadSortInfo(PayloadSortInfo def)
void	deleteDefinition(DotName name) Attempts to delete the definition with the specified name.
void	deleteDmuModule(DmuModule def)
void	deletePayloadExample(PayloadExample def)
void	deletePayloadSortInfo(PayloadSortInfo def)
DSDefinition	findDefinition(DotName name)
DmcObject	findNamedDMO(DmcObjectName name) Finds a DMO based on its name.
DmcNamedObjectIF	findNamedObject(DmcObjectName name) Finds a named object based on its name.
DmcNamedObjectIF	findNamedObject(DmcObjectName name, int attributeID) Finds a named object based on its name and indicates the attribute via which the reference is being made.
DmcNamedObjectIF	findNamedObjectMayClash(DmcObject object, DmcObjectName name, DmcNameClashResolverIF resolver, DmcAttributeInfo ai) Finds a named object based on its name and indicates the attribute via which the reference is being made.
Iterator<DmuDefinition>	getAllDmuDefinition()
Iterator<DmuModule>	getAllDmuModule()
Iterator<PayloadExample>	getAllPayloadExample()
Iterator<PayloadSortInfo>	getAllPayloadSortInfo()
DmuDefinition	getDmuDefinition(DotName name)
int	getDmuDefinitionCount()
DmuModule	getDmuModule(DotName name)
int	getDmuModuleCount()
DmuModule	getDmuModuleDefinition(String name)
int	getDmuModuleDefinitionCountByName(String name)
Iterator<DmuModule>	getDmuModuleDefinitionsByName(String name)
Collection<DmwNamedObjectWrapper>	getIndex(DmcClassInfo ci)
PayloadExample	getPayloadExample(DotName name)
int	getPayloadExampleCount()
PayloadExample	getPayloadExampleDefinition(String name)
int	getPayloadExampleDefinitionCountByName(String name)
Iterator<PayloadExample>	getPayloadExampleDefinitionsByName(String name)
PayloadSortInfo	getPayloadSortInfo(DotName name)
int	getPayloadSortInfoCount()
PayloadSortInfo	getPayloadSortInfoDefinition(String name)
int	getPayloadSortInfoDefinitionCountByName(String name)
Iterator<PayloadSortInfo>	getPayloadSortInfoDefinitionsByName(String name)
DmcNamedObjectIF	resolveClash(DmcObject obj, DmcAttributeInfo ai, DmcNameClashObjectSet<?> ncos) The clash resolver will overload this method to attempt to resolve the name clash.
void	resolveReferences()
String	summary()

Methods inherited from class java.lang.Object

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

Constructor Detail

DmuModuleDefinitionManager

public DmuModuleDefinitionManager()

Method Detail

resolveReferences

public void resolveReferences()
                       throws DmcValueExceptionSet

Throws:

DmcValueExceptionSet

getIndex

public Collection<DmwNamedObjectWrapper> getIndex(DmcClassInfo ci)

findNamedObject

public DmcNamedObjectIF findNamedObject(DmcObjectName name)

Description copied from interface: DmcNameResolverIF

Finds a named object based on its name.

Specified by:

findNamedObject in interface DmcNameResolverIF

Returns:

the named object.

findDefinition

public DSDefinition findDefinition(DotName name)

deleteDefinition

public void deleteDefinition(DotName name)
                      throws ResultException

Attempts to delete the definition with the specified name. If you have enabled back reference tracking via DmcOmni, it will also clean up any existing references from this definition to other definitions.

Parameters:

name - the fully qualified DotName of the definition to be deleted.

Throws:

ResultException - if the definition can't, be found or if there are outstanding references to it.

findNamedObject

public DmcNamedObjectIF findNamedObject(DmcObjectName name,
                                        int attributeID)

Description copied from interface: DmcNameResolverIF

Finds a named object based on its name and indicates the attribute via which the reference is being made. This method is used via the DmcObject and is primarily intended to handle the situation where we must resolve internal type definitions as opposed to class definitions. This is due to the fact that we create internal type definitions for classes that have the same name as the associated classes.

Specified by:

findNamedObject in interface DmcNameResolverIF

Parameters:

name - the name of an object

attributeID - the attribute by which it is named

Returns:

the named object

findNamedDMO

public DmcObject findNamedDMO(DmcObjectName name)

Description copied from interface: DmcNameResolverIF

Finds a DMO based on its name.

Specified by:

findNamedDMO in interface DmcNameResolverIF

Parameters:

name - the name of the object

Returns:

A Dark Matter Object.

findNamedObjectMayClash

public DmcNamedObjectIF findNamedObjectMayClash(DmcObject object,
                                                DmcObjectName name,
                                                DmcNameClashResolverIF resolver,
                                                DmcAttributeInfo ai)
                                         throws DmcValueException

Description copied from interface: DmcNameResolverWithClashSupportIF

Finds a named object based on its name and indicates the attribute via which the reference is being made. This method is used in cases where the name space used by the name resolver allows for clashes and you specify a clash resolver that may be able to resolve the clash based on the context in which the resolution is taking place. This is especially useful in domain specific definition sets, for example dark-matter schema, or Model View Whatever (MVW) specifications where you need to have naming independence so that the specs can be developed without coordination between development groups. If the groups decide to merge or use each other's definitions, we don't want to have name collisions.

Specified by:

findNamedObjectMayClash in interface DmcNameResolverWithClashSupportIF

Parameters:

object - the object that we're resolving

name - the name of the object being referred to

resolver - the entity that may resolve clashes if they occur

ai - the attribute being resolved

Returns:

the named object

Throws:

DmcValueException - if values are incorrect

resolveClash

public DmcNamedObjectIF resolveClash(DmcObject obj,
                                     DmcAttributeInfo ai,
                                     DmcNameClashObjectSet<?> ncos)
                              throws DmcValueException

Description copied from interface: DmcNameClashResolverIF

The clash resolver will overload this method to attempt to resolve the name clash.

Specified by:

resolveClash in interface DmcNameClashResolverIF

Parameters:

obj - the object on which resolveReferences() has been called

ai - the info for the attribute being resolved

ncos - the objects whose names clash

Returns:

the appropriate object

Throws:

DmcValueException - if the appropriate can't be determined

getDmuDefinitionCount

public int getDmuDefinitionCount()

Specified by:

getDmuDefinitionCount in interface DmuModuleGlobalInterface

getDmuDefinition

public DmuDefinition getDmuDefinition(DotName name)

Specified by:

getDmuDefinition in interface DmuModuleGlobalInterface

getAllDmuDefinition

public Iterator<DmuDefinition> getAllDmuDefinition()

Specified by:

getAllDmuDefinition in interface DmuModuleGlobalInterface

addDmuModule

public void addDmuModule(DmuModule def)

Specified by:

addDmuModule in interface DmuModuleGlobalInterface

deleteDmuModule

public void deleteDmuModule(DmuModule def)

Specified by:

deleteDmuModule in interface DmuModuleGlobalInterface

getDmuModuleCount

public int getDmuModuleCount()

Specified by:

getDmuModuleCount in interface DmuModuleGlobalInterface

getDmuModule

public DmuModule getDmuModule(DotName name)

Specified by:

getDmuModule in interface DmuModuleGlobalInterface

getAllDmuModule

public Iterator<DmuModule> getAllDmuModule()

Specified by:

getAllDmuModule in interface DmuModuleGlobalInterface

getDmuModuleDefinition

public DmuModule getDmuModuleDefinition(String name)
                                 throws DmcNameClashException,
                                        DmcValueException

Specified by:

getDmuModuleDefinition in interface DmuModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

getDmuModuleDefinitionsByName

public Iterator<DmuModule> getDmuModuleDefinitionsByName(String name)
                                                  throws DmcValueException

Specified by:

getDmuModuleDefinitionsByName in interface DmuModuleGlobalInterface

Throws:

DmcValueException

getDmuModuleDefinitionCountByName

public int getDmuModuleDefinitionCountByName(String name)
                                      throws DmcValueException

Specified by:

getDmuModuleDefinitionCountByName in interface DmuModuleGlobalInterface

Throws:

DmcValueException

addPayloadExample

public void addPayloadExample(PayloadExample def)

Specified by:

addPayloadExample in interface DmuModuleGlobalInterface

deletePayloadExample

public void deletePayloadExample(PayloadExample def)

Specified by:

deletePayloadExample in interface DmuModuleGlobalInterface

getPayloadExampleCount

public int getPayloadExampleCount()

Specified by:

getPayloadExampleCount in interface DmuModuleGlobalInterface

getPayloadExample

public PayloadExample getPayloadExample(DotName name)

Specified by:

getPayloadExample in interface DmuModuleGlobalInterface

getAllPayloadExample

public Iterator<PayloadExample> getAllPayloadExample()

Specified by:

getAllPayloadExample in interface DmuModuleGlobalInterface

getPayloadExampleDefinition

public PayloadExample getPayloadExampleDefinition(String name)
                                           throws DmcNameClashException,
                                                  DmcValueException

Specified by:

getPayloadExampleDefinition in interface DmuModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

getPayloadExampleDefinitionsByName

public Iterator<PayloadExample> getPayloadExampleDefinitionsByName(String name)
                                                            throws DmcValueException

Specified by:

getPayloadExampleDefinitionsByName in interface DmuModuleGlobalInterface

Throws:

DmcValueException

getPayloadExampleDefinitionCountByName

public int getPayloadExampleDefinitionCountByName(String name)
                                           throws DmcValueException

Specified by:

getPayloadExampleDefinitionCountByName in interface DmuModuleGlobalInterface

Throws:

DmcValueException

addPayloadSortInfo

public void addPayloadSortInfo(PayloadSortInfo def)

Specified by:

addPayloadSortInfo in interface DmuModuleGlobalInterface

deletePayloadSortInfo

public void deletePayloadSortInfo(PayloadSortInfo def)

Specified by:

deletePayloadSortInfo in interface DmuModuleGlobalInterface

getPayloadSortInfoCount

public int getPayloadSortInfoCount()

Specified by:

getPayloadSortInfoCount in interface DmuModuleGlobalInterface

getPayloadSortInfo

public PayloadSortInfo getPayloadSortInfo(DotName name)

Specified by:

getPayloadSortInfo in interface DmuModuleGlobalInterface

getAllPayloadSortInfo

public Iterator<PayloadSortInfo> getAllPayloadSortInfo()

Specified by:

getAllPayloadSortInfo in interface DmuModuleGlobalInterface

getPayloadSortInfoDefinition

public PayloadSortInfo getPayloadSortInfoDefinition(String name)
                                             throws DmcNameClashException,
                                                    DmcValueException

Specified by:

getPayloadSortInfoDefinition in interface DmuModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

getPayloadSortInfoDefinitionsByName

public Iterator<PayloadSortInfo> getPayloadSortInfoDefinitionsByName(String name)
                                                              throws DmcValueException

Specified by:

getPayloadSortInfoDefinitionsByName in interface DmuModuleGlobalInterface

Throws:

DmcValueException

getPayloadSortInfoDefinitionCountByName

public int getPayloadSortInfoDefinitionCountByName(String name)
                                            throws DmcValueException

Specified by:

getPayloadSortInfoDefinitionCountByName in interface DmuModuleGlobalInterface

Throws:

DmcValueException

addDefinition

public void addDefinition(DSDefinition definition)

addDefinition

public void addDefinition(DSDefinition definition,
                          DmuModule module)

summary

public String summary()