org.dmd.dms

Class DSDefinitionModule

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.DSDefinitionDMW

org.dmd.dms.DSDefinition

org.dmd.dms.generated.dmw.DmsDefinitionDMW

org.dmd.dms.DmsDefinition

org.dmd.dms.generated.dmw.DSDefinitionModuleDMW

org.dmd.dms.DSDefinitionModule

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

public class DSDefinitionModule
extends DSDefinitionModuleDMW

The DSDefinitionModule is used to describe the base characteristics of a set of Domain Specific Definitions (DSDs).

Field Summary

Fields inherited from class org.dmd.dms.DmsDefinition

metaname

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Constructor and Description
DSDefinitionModule()
DSDefinitionModule(DmcObject obj)
DSDefinitionModule(DmcObject obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
Iterator<DSDefinitionModule>	getDDMDependencies()
String	getDefinitionManagerImport()
String	getDefinitionManagerName()
String	getDefinitionParserImport()
String	getDefinitionParserName()
String	getDefinitionsInterfaceImport()
String	getDefinitionsInterfaceName()
String	getDMOGlobalInterfaceImport()
void	getDMOImportsForInterface(ImportManager imports, boolean scoped) Populates the ImportManager with the definitions for just this DSD module.
String	getDMOInterfaceMethods(boolean scoped)
String	getDMOInterfaceMethodsImplementations(boolean scoped)
String	getGeneratedDmoPackage()
String	getGeneratedDsdPackage()
String	getGeneratorInterfaceImport()
String	getGeneratorInterfaceName()
String	getGlobalInterfaceImport()
String	getGlobalInterfaceName()
void	getImportsForInterface(ImportManager imports, boolean scoped) Populates the ImportManager with the definitions for just this DSD module.
String	getInterfaceMethods(boolean scoped)
String	getInterfaceMethodsImplementations(boolean scoped)
String	getModuleImport()
String	getScopedInterfaceImport()
void	getScopedInterfaceMembers(MemberManager members, String module)
String	getScopedInterfaceName()

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionModuleDMW

addMay, addMust, addRefersToDefsFromDSD, addRequiredBaseModule, getBaseDefinition, getDefinedIn, getDefinedInModuleAttribute, getDmdID, getDMO, getFileExtension, getMay, getMaySize, getModuleClassName, getModuleDependenceAttribute, getMust, getMustSize, getName, getObjectName, getObjectNameAttribute, getRefersToDefsFromDSD, getRefersToDefsFromDSDSize, getRequiredBaseModule, getRequiredBaseModuleSize, getSupportDynamicSchemaLoading, setBaseDefinition, setDefinedIn, setDefinedInModuleAttribute, setDmcObject, setDmdID, setFileExtension, setModuleClassName, setModuleDependenceAttribute, setName, setSupportDynamicSchemaLoading

Methods inherited from class org.dmd.dms.DmsDefinition

getDmcObject

Methods inherited from class org.dmd.dms.generated.dmw.DmsDefinitionDMW

addRelatedToConcept, getRelatedToConcept, getRelatedToConceptSize

Methods inherited from class org.dmd.dms.DSDefinition

equals, getFullDotName, getNameOfModuleWhereThisCameFrom

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW

addComment, addDescription, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDescription, getDescriptionSize, getDescriptionWithNewlines, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

equals

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

getDotName, toOIF

Constructor Detail

DSDefinitionModule

public DSDefinitionModule()

DSDefinitionModule

public DSDefinitionModule(DmcObject obj)

DSDefinitionModule

public DSDefinitionModule(DmcObject obj,
                          ClassDefinition cd)

Method Detail

getDDMDependencies

public Iterator<DSDefinitionModule> getDDMDependencies()

Returns:

the set of module types on which this module may depend.

getGeneratedDsdPackage

public String getGeneratedDsdPackage()

Returns:

the full package name of the generated.dsd package associated with this module.

getGlobalInterfaceImport

public String getGlobalInterfaceImport()

getGeneratedDmoPackage

public String getGeneratedDmoPackage()

Returns:

the full package name of the generated.dsd package associated with this module.

getDMOGlobalInterfaceImport

public String getDMOGlobalInterfaceImport()

getGlobalInterfaceName

public String getGlobalInterfaceName()

getDefinitionsInterfaceImport

public String getDefinitionsInterfaceImport()

getDefinitionsInterfaceName

public String getDefinitionsInterfaceName()

getGeneratorInterfaceImport

public String getGeneratorInterfaceImport()

getGeneratorInterfaceName

public String getGeneratorInterfaceName()

getScopedInterfaceImport

public String getScopedInterfaceImport()

getScopedInterfaceName

public String getScopedInterfaceName()

getDefinitionManagerImport

public String getDefinitionManagerImport()

getModuleImport

public String getModuleImport()

getDefinitionManagerName

public String getDefinitionManagerName()

getDefinitionParserImport

public String getDefinitionParserImport()

getDefinitionParserName

public String getDefinitionParserName()

getScopedInterfaceMembers

public void getScopedInterfaceMembers(MemberManager members,
                                      String module)

getImportsForInterface

public void getImportsForInterface(ImportManager imports,
                                   boolean scoped)

Populates the ImportManager with the definitions for just this DSD module.

Parameters:

imports - the place to store the imports.

scoped - indicates if the imports are for the scoped interface (which doesn't include the module itself) or for the global interface

getDMOImportsForInterface

public void getDMOImportsForInterface(ImportManager imports,
                                      boolean scoped)

Populates the ImportManager with the definitions for just this DSD module.

Parameters:

imports - the place to store the imports.

scoped - indicates if the imports are for the scoped interface (which doesn't include the module itself) or for the global interface

getInterfaceMethods

public String getInterfaceMethods(boolean scoped)

Parameters:

scoped - flag to indicate if the imports are for the global interface (implemented by global definition managers) or the scoped interface (which is implemented by a module to manage its own definitions)

Returns:

the methods to be implemented on definitions interface for this module.

getDMOInterfaceMethods

public String getDMOInterfaceMethods(boolean scoped)

Parameters:

scoped - flag to indicate if the imports are for the global interface (implemented by global definition managers) or the scoped interface (which is implemented by a module to manage its own definitions)

Returns:

the methods to be implemented on definitions interface for this module.

getInterfaceMethodsImplementations

public String getInterfaceMethodsImplementations(boolean scoped)

Returns:

the implementations of the definitions interface for this module.

getDMOInterfaceMethodsImplementations

public String getDMOInterfaceMethodsImplementations(boolean scoped)

Returns:

the implementations of the definitions interface for this module.