org.dmd.templates.server.generated.dsd

Class TdlModuleDefinitionManager

java.lang.Object

org.dmd.templates.server.generated.dsd.TdlModuleDefinitionManager

All Implemented Interfaces:

DmcNameClashResolverIF, DmcNameResolverIF, DmcNameResolverWithClashSupportIF, TdlModuleDefinitionsIF, TdlModuleGlobalInterface

public class TdlModuleDefinitionManager
extends Object
implements DmcNameClashResolverIF, DmcNameResolverWithClashSupportIF, TdlModuleGlobalInterface, TdlModuleDefinitionsIF

Constructor Summary

Constructors

Constructor and Description
TdlModuleDefinitionManager()

Method Summary

Modifier and Type	Method and Description
void	addContainedElement(ContainedElement def)
void	addDefinition(DSDefinition definition)
void	addDefinition(DSDefinition definition, TdlModule module)
void	addExtensionHook(ExtensionHook def)
void	addSection(Section def)
void	addTdlModule(TdlModule def)
void	addTextualArtifact(TextualArtifact def)
void	deleteContainedElement(ContainedElement def)
void	deleteDefinition(DotName name) Attempts to delete the definition with the specified name.
void	deleteExtensionHook(ExtensionHook def)
void	deleteSection(Section def)
void	deleteTdlModule(TdlModule def)
void	deleteTextualArtifact(TextualArtifact 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<ContainedElement>	getAllContainedElement()
Iterator<ExtensionHook>	getAllExtensionHook()
Iterator<Section>	getAllSection()
Iterator<TdlDefinition>	getAllTdlDefinition()
Iterator<TdlModule>	getAllTdlModule()
Iterator<TextualArtifact>	getAllTextualArtifact()
ContainedElement	getContainedElement(DotName name)
int	getContainedElementCount()
ContainedElement	getContainedElementDefinition(String name)
int	getContainedElementDefinitionCountByName(String name)
Iterator<ContainedElement>	getContainedElementDefinitionsByName(String name)
ExtensionHook	getExtensionHook(DotName name)
int	getExtensionHookCount()
ExtensionHook	getExtensionHookDefinition(String name)
int	getExtensionHookDefinitionCountByName(String name)
Iterator<ExtensionHook>	getExtensionHookDefinitionsByName(String name)
Collection<DmwNamedObjectWrapper>	getIndex(DmcClassInfo ci)
Section	getSection(DotName name)
int	getSectionCount()
Section	getSectionDefinition(String name)
int	getSectionDefinitionCountByName(String name)
Iterator<Section>	getSectionDefinitionsByName(String name)
TdlDefinition	getTdlDefinition(DotName name)
int	getTdlDefinitionCount()
TdlModule	getTdlModule(DotName name)
int	getTdlModuleCount()
TdlModule	getTdlModuleDefinition(String name)
int	getTdlModuleDefinitionCountByName(String name)
Iterator<TdlModule>	getTdlModuleDefinitionsByName(String name)
TextualArtifact	getTextualArtifact(DotName name)
int	getTextualArtifactCount()
TextualArtifact	getTextualArtifactDefinition(String name)
int	getTextualArtifactDefinitionCountByName(String name)
Iterator<TextualArtifact>	getTextualArtifactDefinitionsByName(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

TdlModuleDefinitionManager

public TdlModuleDefinitionManager()

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

getTdlDefinitionCount

public int getTdlDefinitionCount()

Specified by:

getTdlDefinitionCount in interface TdlModuleGlobalInterface

getTdlDefinition

public TdlDefinition getTdlDefinition(DotName name)

Specified by:

getTdlDefinition in interface TdlModuleGlobalInterface

getAllTdlDefinition

public Iterator<TdlDefinition> getAllTdlDefinition()

Specified by:

getAllTdlDefinition in interface TdlModuleGlobalInterface

addContainedElement

public void addContainedElement(ContainedElement def)

Specified by:

addContainedElement in interface TdlModuleGlobalInterface

deleteContainedElement

public void deleteContainedElement(ContainedElement def)

Specified by:

deleteContainedElement in interface TdlModuleGlobalInterface

getContainedElementCount

public int getContainedElementCount()

Specified by:

getContainedElementCount in interface TdlModuleGlobalInterface

getContainedElement

public ContainedElement getContainedElement(DotName name)

Specified by:

getContainedElement in interface TdlModuleGlobalInterface

getAllContainedElement

public Iterator<ContainedElement> getAllContainedElement()

Specified by:

getAllContainedElement in interface TdlModuleGlobalInterface

getContainedElementDefinition

public ContainedElement getContainedElementDefinition(String name)
                                               throws DmcNameClashException,
                                                      DmcValueException

Specified by:

getContainedElementDefinition in interface TdlModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

getContainedElementDefinitionsByName

public Iterator<ContainedElement> getContainedElementDefinitionsByName(String name)
                                                                throws DmcValueException

Specified by:

getContainedElementDefinitionsByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

getContainedElementDefinitionCountByName

public int getContainedElementDefinitionCountByName(String name)
                                             throws DmcValueException

Specified by:

getContainedElementDefinitionCountByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

addExtensionHook

public void addExtensionHook(ExtensionHook def)

Specified by:

addExtensionHook in interface TdlModuleGlobalInterface

deleteExtensionHook

public void deleteExtensionHook(ExtensionHook def)

Specified by:

deleteExtensionHook in interface TdlModuleGlobalInterface

getExtensionHookCount

public int getExtensionHookCount()

Specified by:

getExtensionHookCount in interface TdlModuleGlobalInterface

getExtensionHook

public ExtensionHook getExtensionHook(DotName name)

Specified by:

getExtensionHook in interface TdlModuleGlobalInterface

getAllExtensionHook

public Iterator<ExtensionHook> getAllExtensionHook()

Specified by:

getAllExtensionHook in interface TdlModuleGlobalInterface

getExtensionHookDefinition

public ExtensionHook getExtensionHookDefinition(String name)
                                         throws DmcNameClashException,
                                                DmcValueException

Specified by:

getExtensionHookDefinition in interface TdlModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

getExtensionHookDefinitionsByName

public Iterator<ExtensionHook> getExtensionHookDefinitionsByName(String name)
                                                          throws DmcValueException

Specified by:

getExtensionHookDefinitionsByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

getExtensionHookDefinitionCountByName

public int getExtensionHookDefinitionCountByName(String name)
                                          throws DmcValueException

Specified by:

getExtensionHookDefinitionCountByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

addSection

public void addSection(Section def)

Specified by:

addSection in interface TdlModuleGlobalInterface

deleteSection

public void deleteSection(Section def)

Specified by:

deleteSection in interface TdlModuleGlobalInterface

getSectionCount

public int getSectionCount()

Specified by:

getSectionCount in interface TdlModuleGlobalInterface

getSection

public Section getSection(DotName name)

Specified by:

getSection in interface TdlModuleGlobalInterface

getAllSection

public Iterator<Section> getAllSection()

Specified by:

getAllSection in interface TdlModuleGlobalInterface

getSectionDefinition

public Section getSectionDefinition(String name)
                             throws DmcNameClashException,
                                    DmcValueException

Specified by:

getSectionDefinition in interface TdlModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

getSectionDefinitionsByName

public Iterator<Section> getSectionDefinitionsByName(String name)
                                              throws DmcValueException

Specified by:

getSectionDefinitionsByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

getSectionDefinitionCountByName

public int getSectionDefinitionCountByName(String name)
                                    throws DmcValueException

Specified by:

getSectionDefinitionCountByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

addTdlModule

public void addTdlModule(TdlModule def)

Specified by:

addTdlModule in interface TdlModuleGlobalInterface

deleteTdlModule

public void deleteTdlModule(TdlModule def)

Specified by:

deleteTdlModule in interface TdlModuleGlobalInterface

getTdlModuleCount

public int getTdlModuleCount()

Specified by:

getTdlModuleCount in interface TdlModuleGlobalInterface

getTdlModule

public TdlModule getTdlModule(DotName name)

Specified by:

getTdlModule in interface TdlModuleGlobalInterface

getAllTdlModule

public Iterator<TdlModule> getAllTdlModule()

Specified by:

getAllTdlModule in interface TdlModuleGlobalInterface

getTdlModuleDefinition

public TdlModule getTdlModuleDefinition(String name)
                                 throws DmcNameClashException,
                                        DmcValueException

Specified by:

getTdlModuleDefinition in interface TdlModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

getTdlModuleDefinitionsByName

public Iterator<TdlModule> getTdlModuleDefinitionsByName(String name)
                                                  throws DmcValueException

Specified by:

getTdlModuleDefinitionsByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

getTdlModuleDefinitionCountByName

public int getTdlModuleDefinitionCountByName(String name)
                                      throws DmcValueException

Specified by:

getTdlModuleDefinitionCountByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

addTextualArtifact

public void addTextualArtifact(TextualArtifact def)

Specified by:

addTextualArtifact in interface TdlModuleGlobalInterface

deleteTextualArtifact

public void deleteTextualArtifact(TextualArtifact def)

Specified by:

deleteTextualArtifact in interface TdlModuleGlobalInterface

getTextualArtifactCount

public int getTextualArtifactCount()

Specified by:

getTextualArtifactCount in interface TdlModuleGlobalInterface

getTextualArtifact

public TextualArtifact getTextualArtifact(DotName name)

Specified by:

getTextualArtifact in interface TdlModuleGlobalInterface

getAllTextualArtifact

public Iterator<TextualArtifact> getAllTextualArtifact()

Specified by:

getAllTextualArtifact in interface TdlModuleGlobalInterface

getTextualArtifactDefinition

public TextualArtifact getTextualArtifactDefinition(String name)
                                             throws DmcNameClashException,
                                                    DmcValueException

Specified by:

getTextualArtifactDefinition in interface TdlModuleGlobalInterface

Throws:

DmcNameClashException

DmcValueException

getTextualArtifactDefinitionsByName

public Iterator<TextualArtifact> getTextualArtifactDefinitionsByName(String name)
                                                              throws DmcValueException

Specified by:

getTextualArtifactDefinitionsByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

getTextualArtifactDefinitionCountByName

public int getTextualArtifactDefinitionCountByName(String name)
                                            throws DmcValueException

Specified by:

getTextualArtifactDefinitionCountByName in interface TdlModuleGlobalInterface

Throws:

DmcValueException

addDefinition

public void addDefinition(DSDefinition definition)

addDefinition

public void addDefinition(DSDefinition definition,
                          TdlModule module)

summary

public String summary()