org.dmd.dms.generated.dmw

Class DSDefinitionModuleDMW

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

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

DSDefinitionModule

public class DSDefinitionModuleDMW
extends DmsDefinition

The DSDefinitionModule is a definition that defines a collection of definitions\n and provides a basis for the generation of various artifacts that allow for parsing and\n management of that set of definitions.\n

\n The specific of a definition module will result in the generation of a ClassDefinition for\n the specified module type and thus, the dmdID associated with it must be unique across the\n set of classes that comprise the definitions encompassed by the module.\n

\n The ClassDefinition will be named by name and will have the may and must attributes specified\n as part of the DSDefinitionModule.

Author:

Auto Generated Generated from: org.dmd.dms.meta.MetaGenerator.dumpDMWClasses(MetaGenerator.java:1649)

Field Summary

Fields inherited from class org.dmd.dms.DmsDefinition

metaname

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DSDefinitionModuleDMW()
protected	DSDefinitionModuleDMW(ClassDefinition cd)
protected	DSDefinitionModuleDMW(DmcObject obj)
protected	DSDefinitionModuleDMW(DmcObject obj, ClassDefinition cd)
protected	DSDefinitionModuleDMW(String mn)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addMay(AttributeDefinition value) Adds another may value.
DmcAttribute<?>	addMust(AttributeDefinition value) Adds another must value.
DmcAttribute<?>	addRefersToDefsFromDSD(DSDefinitionModule value) Adds another refersToDefsFromDSD value.
void	addRequiredBaseModule(Object value) Adds another requiredBaseModule value.
DSDefinition	getBaseDefinition() A reference to the DSDefinition derived class that is the base class for a \n set of definition classes.
SchemaDefinition	getDefinedIn() Indicates the schema in which a type, attribute or class is defined.
AttributeDefinition	getDefinedInModuleAttribute() The name of the attribute that will be set on all definitions associated with a DSD\n to indicate the module from which a definition was loaded.
Integer	getDmdID() The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.
DSDefinitionModuleDMO	getDMO()
String	getFileExtension() Indicates the extension of files of a particular type.
AttributeDefinitionIterableDMW	getMay() Indicates the set of attributes that an instance of a class MAY\n have.
int	getMaySize()
String	getModuleClassName() The name of the class that will be generated as a result of a DSDefinitionModule definition.
AttributeDefinition	getModuleDependenceAttribute() The name of the attribute in a DSDefinitionModule that\n indicates a dependence on another module of the same type.
AttributeDefinitionIterableDMW	getMust() Indicates the set of attributes that an instance of a class MUST have.
int	getMustSize()
DefinitionName	getName() The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
DSDefinitionModuleIterableDMW	getRefersToDefsFromDSD() A reference to another DSDefinitionModule from which the current\n module makes use of definitions.
int	getRefersToDefsFromDSDSize()
Iterator<String>	getRequiredBaseModule() A set of base module files that should be loaded before\n parsing of any other modules associated with the DSD being defined.
int	getRequiredBaseModuleSize()
Boolean	getSupportDynamicSchemaLoading() If this flag is set to true, the loadSchemaClass attribute\n will be added to the generated domain specific module definition class so that additional schemas\n (usually containg auxiliary classes) can be loaded dynamically.
void	setBaseDefinition(DSDefinition value) Sets baseDefinition to the specified value.
void	setDefinedIn(SchemaDefinition value) Sets definedIn to the specified value.
void	setDefinedInModuleAttribute(AttributeDefinition value) Sets definedInModuleAttribute to the specified value.
void	setDmcObject(DmcObject obj) Sets the core object.
void	setDmdID(Object value) Sets dmdID to the specified value.
void	setFileExtension(Object value) Sets fileExtension to the specified value.
void	setModuleClassName(Object value) Sets moduleClassName to the specified value.
void	setModuleDependenceAttribute(AttributeDefinition value) Sets moduleDependenceAttribute to the specified value.
void	setName(Object value) Sets name to the specified value.
void	setSupportDynamicSchemaLoading(Object value) Sets supportDynamicSchemaLoading to the specified value.

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

DSDefinitionModuleDMW

protected DSDefinitionModuleDMW()

DSDefinitionModuleDMW

protected DSDefinitionModuleDMW(DmcObject obj)

DSDefinitionModuleDMW

protected DSDefinitionModuleDMW(DmcObject obj,
                                ClassDefinition cd)

DSDefinitionModuleDMW

protected DSDefinitionModuleDMW(ClassDefinition cd)

DSDefinitionModuleDMW

protected DSDefinitionModuleDMW(String mn)
                         throws DmcValueException

Throws:

DmcValueException

Method Detail

setDmcObject

public void setDmcObject(DmcObject obj)

Description copied from class: DmcContainer

Sets the core object.

Specified by:

setDmcObject in interface DmcContainerIF

Overrides:

setDmcObject in class DmsDefinition

Parameters:

obj - The core object.

getDMO

public DSDefinitionModuleDMO getDMO()

Overrides:

getDMO in class DmsDefinitionDMW

getName

public DefinitionName getName()

The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part. A name starts with a letter followed\n by letters and numbers.

Specified by:

getName in interface DmcDefinitionIF

Overrides:

getName in class DmsDefinitionDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class DmsDefinitionDMW

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if the value is incorrect

getFileExtension

public String getFileExtension()

Indicates the extension of files of a particular type.

Returns:

the String

setFileExtension

public void setFileExtension(Object value)
                      throws DmcValueException

Sets fileExtension to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getDmdID

public Integer getDmdID()

The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.

Returns:

the Integer

setDmdID

public void setDmdID(Object value)
              throws DmcValueException

Sets dmdID to the specified value.

Parameters:

value - A value compatible with DmcTypeIntegerSV

Throws:

DmcValueException - if the value is incorrect

getModuleClassName

public String getModuleClassName()

The name of the class that will be generated as a result of a DSDefinitionModule definition.

Returns:

the String

setModuleClassName

public void setModuleClassName(Object value)
                        throws DmcValueException

Sets moduleClassName to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getModuleDependenceAttribute

public AttributeDefinition getModuleDependenceAttribute()

The name of the attribute in a DSDefinitionModule that\n indicates a dependence on another module of the same type. For example, in\n dark-matter schemas, the SchemaDefinition uses the dependsOn attribute to\n refer to oher schemas.

Returns:

the AttributeDefinition

setModuleDependenceAttribute

public void setModuleDependenceAttribute(AttributeDefinition value)
                                  throws DmcValueException

Sets moduleDependenceAttribute to the specified value.

Parameters:

value - A value compatible with AttributeDefinition

Throws:

DmcValueException - if the value is incorrect

getBaseDefinition

public DSDefinition getBaseDefinition()

A reference to the DSDefinition derived class that is the base class for a \n set of definition classes.

Returns:

the DSDefinition

setBaseDefinition

public void setBaseDefinition(DSDefinition value)
                       throws DmcValueException

Sets baseDefinition to the specified value.

Parameters:

value - A value compatible with DSDefinition

Throws:

DmcValueException - if the value is incorrect

getRefersToDefsFromDSD

public DSDefinitionModuleIterableDMW getRefersToDefsFromDSD()

A reference to another DSDefinitionModule from which the current\n module makes use of definitions. For instance, the Model View Whatever DSD includes references\n to schema related definitions. As a result of specifying this, the module\n class that's generated for the DSDefinitionModule will include the moduleDependenceAttribute\n of the module from which definitions are used. Likewise, the generated parser\n will be primed with the schema of the required definition module.

Returns:

the DSDefinitionModule

addRefersToDefsFromDSD

public DmcAttribute<?> addRefersToDefsFromDSD(DSDefinitionModule value)
                                       throws DmcValueException

Adds another refersToDefsFromDSD value.

Parameters:

value - A value compatible with DSDefinitionModule

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getRefersToDefsFromDSDSize

public int getRefersToDefsFromDSDSize()

Returns:

the number of refersToDefsFromDSD values.

getDefinedInModuleAttribute

public AttributeDefinition getDefinedInModuleAttribute()

The name of the attribute that will be set on all definitions associated with a DSD\n to indicate the module from which a definition was loaded.

Returns:

the AttributeDefinition

setDefinedInModuleAttribute

public void setDefinedInModuleAttribute(AttributeDefinition value)
                                 throws DmcValueException

Sets definedInModuleAttribute to the specified value.

Parameters:

value - A value compatible with AttributeDefinition

Throws:

DmcValueException - if the value is incorrect

getMay

public AttributeDefinitionIterableDMW getMay()

Indicates the set of attributes that an instance of a class MAY\n have. When accessed in Java, this is a set of references to AttributeDefinition\n objects.

Returns:

the AttributeDefinition

addMay

public DmcAttribute<?> addMay(AttributeDefinition value)
                       throws DmcValueException

Adds another may value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getMaySize

public int getMaySize()

Returns:

the number of may values.

getMust

public AttributeDefinitionIterableDMW getMust()

Indicates the set of attributes that an instance of a class MUST have.

Returns:

the AttributeDefinition

addMust

public DmcAttribute<?> addMust(AttributeDefinition value)
                        throws DmcValueException

Adds another must value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getMustSize

public int getMustSize()

Returns:

the number of must values.

getSupportDynamicSchemaLoading

public Boolean getSupportDynamicSchemaLoading()

If this flag is set to true, the loadSchemaClass attribute\n will be added to the generated domain specific module definition class so that additional schemas\n (usually containg auxiliary classes) can be loaded dynamically. This allows the generated\n module parser to handle auxiliary information on the domain specific definitions.

Returns:

the Boolean

setSupportDynamicSchemaLoading

public void setSupportDynamicSchemaLoading(Object value)
                                    throws DmcValueException

Sets supportDynamicSchemaLoading to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getRequiredBaseModule

public Iterator<String> getRequiredBaseModule()

A set of base module files that should be loaded before\n parsing of any other modules associated with the DSD being defined. For example,\n the dmdgpb (augmented Googoe Protocol Buffer specifications) DSD always requires\n that the gpbbase.gpb file is loaded because it defines the base types of the fields\n that comprise messages. By specifying gpbbase.gpb as a requiredBaseModule, the\n generated parsing coordinator will ensure that this module is loaded on start-up.\n

\n You should specify just the name of the module file to be loaded, not the file extension.\n The file extension is assumed to be fileExtension associated with the DSD.

Returns:

the String

addRequiredBaseModule

public void addRequiredBaseModule(Object value)
                           throws DmcValueException

Adds another requiredBaseModule value.

Parameters:

value - A value compatible with DmcTypeStringMV

Throws:

DmcValueException - if the value is incorrect

getRequiredBaseModuleSize

public int getRequiredBaseModuleSize()

Returns:

the number of requiredBaseModule values.

getDefinedIn

public SchemaDefinition getDefinedIn()

Indicates the schema in which a type, attribute or class is defined.

Specified by:

getDefinedIn in interface DmcDefinitionIF

Overrides:

getDefinedIn in class DSDefinitionDMW

Returns:

the SchemaDefinition

setDefinedIn

public void setDefinedIn(SchemaDefinition value)
                  throws DmcValueException

Sets definedIn to the specified value.

Overrides:

setDefinedIn in class DSDefinitionDMW

Parameters:

value - A value compatible with SchemaDefinition

Throws:

DmcValueException - if the value is incorrect

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class DmsDefinition

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class DmsDefinitionDMW

Returns:

The name attribute.