org.dmd.dmu.shared.generated.dsd

Class DmuModuleDefinitionDMOCache

java.lang.Object

org.dmd.dmu.shared.generated.dsd.DmuModuleDefinitionDMOCache

All Implemented Interfaces:

DmcNameClashResolverIF, DmcNameResolverIF, DmcNameResolverWithClashSupportIF, DmuModuleGlobalInterface

public class DmuModuleDefinitionDMOCache
extends Object
implements DmcNameClashResolverIF, DmcNameResolverWithClashSupportIF, DmuModuleGlobalInterface

Constructor Summary

Constructors

Constructor and Description
DmuModuleDefinitionDMOCache()

Method Summary

Modifier and Type	Method and Description
void	addDefinition(DSDefinitionDMO definition)
void	addDmuModule(DmuModuleDMO def)
void	addPayloadExample(PayloadExampleDMO def)
void	addPayloadSortInfo(PayloadSortInfoDMO def)
void	deleteDefinition(DotName name)
DSDefinitionDMO	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<DmuDefinitionDMO>	getAllDmuDefinition()
Iterator<DmuModuleDMO>	getAllDmuModule()
Iterator<PayloadExampleDMO>	getAllPayloadExample()
Iterator<PayloadSortInfoDMO>	getAllPayloadSortInfo()
DmuDefinitionDMO	getDmuDefinition(DotName name)
int	getDmuDefinitionCount()
DmuModuleDMO	getDmuModule(DotName name)
int	getDmuModuleCount()
DmuModuleDMO	getDmuModuleDefinition(String name)
PayloadExampleDMO	getPayloadExample(DotName name)
int	getPayloadExampleCount()
PayloadExampleDMO	getPayloadExampleDefinition(String name)
PayloadSortInfoDMO	getPayloadSortInfo(DotName name)
int	getPayloadSortInfoCount()
PayloadSortInfoDMO	getPayloadSortInfoDefinition(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()
DmvRuleManager	ruleManager()
String	summary()

Methods inherited from class java.lang.Object

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

Constructor Detail

DmuModuleDefinitionDMOCache

public DmuModuleDefinitionDMOCache()

Method Detail

ruleManager

public DmvRuleManager ruleManager()

resolveReferences

public void resolveReferences()
                       throws DmcValueExceptionSet

Throws:

DmcValueExceptionSet

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 DSDefinitionDMO findDefinition(DotName name)

deleteDefinition

public void deleteDefinition(DotName name)
                      throws Exception

Throws:

Exception

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 DmuDefinitionDMO getDmuDefinition(DotName name)

Specified by:

getDmuDefinition in interface DmuModuleGlobalInterface

getAllDmuDefinition

public Iterator<DmuDefinitionDMO> getAllDmuDefinition()

Specified by:

getAllDmuDefinition in interface DmuModuleGlobalInterface

addDmuModule

public void addDmuModule(DmuModuleDMO def)

Specified by:

addDmuModule in interface DmuModuleGlobalInterface

getDmuModuleCount

public int getDmuModuleCount()

Specified by:

getDmuModuleCount in interface DmuModuleGlobalInterface

getDmuModule

public DmuModuleDMO getDmuModule(DotName name)

Specified by:

getDmuModule in interface DmuModuleGlobalInterface

getAllDmuModule

public Iterator<DmuModuleDMO> getAllDmuModule()

Specified by:

getAllDmuModule in interface DmuModuleGlobalInterface

getDmuModuleDefinition

public DmuModuleDMO getDmuModuleDefinition(String name)
                                    throws DmcNameClashException,
                                           DmcValueException

Specified by:

getDmuModuleDefinition in interface DmuModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

addPayloadExample

public void addPayloadExample(PayloadExampleDMO def)

Specified by:

addPayloadExample in interface DmuModuleGlobalInterface

getPayloadExampleCount

public int getPayloadExampleCount()

Specified by:

getPayloadExampleCount in interface DmuModuleGlobalInterface

getPayloadExample

public PayloadExampleDMO getPayloadExample(DotName name)

Specified by:

getPayloadExample in interface DmuModuleGlobalInterface

getAllPayloadExample

public Iterator<PayloadExampleDMO> getAllPayloadExample()

Specified by:

getAllPayloadExample in interface DmuModuleGlobalInterface

getPayloadExampleDefinition

public PayloadExampleDMO getPayloadExampleDefinition(String name)
                                              throws DmcNameClashException,
                                                     DmcValueException

Specified by:

getPayloadExampleDefinition in interface DmuModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

addPayloadSortInfo

public void addPayloadSortInfo(PayloadSortInfoDMO def)

Specified by:

addPayloadSortInfo in interface DmuModuleGlobalInterface

getPayloadSortInfoCount

public int getPayloadSortInfoCount()

Specified by:

getPayloadSortInfoCount in interface DmuModuleGlobalInterface

getPayloadSortInfo

public PayloadSortInfoDMO getPayloadSortInfo(DotName name)

Specified by:

getPayloadSortInfo in interface DmuModuleGlobalInterface

getAllPayloadSortInfo

public Iterator<PayloadSortInfoDMO> getAllPayloadSortInfo()

Specified by:

getAllPayloadSortInfo in interface DmuModuleGlobalInterface

getPayloadSortInfoDefinition

public PayloadSortInfoDMO getPayloadSortInfoDefinition(String name)
                                                throws DmcNameClashException,
                                                       DmcValueException

Specified by:

getPayloadSortInfoDefinition in interface DmuModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

addDefinition

public void addDefinition(DSDefinitionDMO definition)

summary

public String summary()