public class DSDefinitionModuleDMW extends DmsDefinition
\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.
metanamecore| Modifier | Constructor and Description |
|---|---|
protected |
DSDefinitionModuleDMW() |
protected |
DSDefinitionModuleDMW(ClassDefinition cd) |
protected |
DSDefinitionModuleDMW(DmcObject obj) |
protected |
DSDefinitionModuleDMW(DmcObject obj,
ClassDefinition cd) |
protected |
DSDefinitionModuleDMW(String mn) |
| 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.
|
getDmcObjectaddRelatedToConcept, getRelatedToConcept, getRelatedToConceptSizeequals, getFullDotName, getNameOfModuleWhereThisCameFromaddComment, 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, setWhyaddAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeletedgetDeleted, getModifier, setDeleted, setModifierclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitequalsgetDotName, toOIFprotected DSDefinitionModuleDMW()
protected DSDefinitionModuleDMW(DmcObject obj)
protected DSDefinitionModuleDMW(DmcObject obj, ClassDefinition cd)
protected DSDefinitionModuleDMW(ClassDefinition cd)
protected DSDefinitionModuleDMW(String mn) throws DmcValueException
DmcValueExceptionpublic void setDmcObject(DmcObject obj)
DmcContainersetDmcObject in interface DmcContainerIFsetDmcObject in class DmsDefinitionobj - The core object.public DSDefinitionModuleDMO getDMO()
getDMO in class DmsDefinitionDMWpublic DefinitionName getName()
getName in interface DmcDefinitionIFgetName in class DmsDefinitionDMWpublic void setName(Object value) throws DmcValueException
setName in class DmsDefinitionDMWvalue - A value compatible with DmcTypeDefinitionNameSVDmcValueException - if the value is incorrectpublic String getFileExtension()
public void setFileExtension(Object value) throws DmcValueException
value - A value compatible with DmcTypeStringSVDmcValueException - if the value is incorrectpublic Integer getDmdID()
public void setDmdID(Object value) throws DmcValueException
value - A value compatible with DmcTypeIntegerSVDmcValueException - if the value is incorrectpublic String getModuleClassName()
public void setModuleClassName(Object value) throws DmcValueException
value - A value compatible with DmcTypeStringSVDmcValueException - if the value is incorrectpublic AttributeDefinition getModuleDependenceAttribute()
public void setModuleDependenceAttribute(AttributeDefinition value) throws DmcValueException
value - A value compatible with AttributeDefinitionDmcValueException - if the value is incorrectpublic DSDefinition getBaseDefinition()
public void setBaseDefinition(DSDefinition value) throws DmcValueException
value - A value compatible with DSDefinitionDmcValueException - if the value is incorrectpublic DSDefinitionModuleIterableDMW getRefersToDefsFromDSD()
public DmcAttribute<?> addRefersToDefsFromDSD(DSDefinitionModule value) throws DmcValueException
value - A value compatible with DSDefinitionModuleDmcValueException - if the value is incorrectpublic int getRefersToDefsFromDSDSize()
public AttributeDefinition getDefinedInModuleAttribute()
public void setDefinedInModuleAttribute(AttributeDefinition value) throws DmcValueException
value - A value compatible with AttributeDefinitionDmcValueException - if the value is incorrectpublic AttributeDefinitionIterableDMW getMay()
public DmcAttribute<?> addMay(AttributeDefinition value) throws DmcValueException
value - A value compatible with AttributeDefinitionDmcValueException - if the value is incorrectpublic int getMaySize()
public AttributeDefinitionIterableDMW getMust()
public DmcAttribute<?> addMust(AttributeDefinition value) throws DmcValueException
value - A value compatible with AttributeDefinitionDmcValueException - if the value is incorrectpublic int getMustSize()
public Boolean getSupportDynamicSchemaLoading()
public void setSupportDynamicSchemaLoading(Object value) throws DmcValueException
value - A value compatible with DmcTypeBooleanSVDmcValueException - if the value is incorrectpublic Iterator<String> getRequiredBaseModule()
\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.
public void addRequiredBaseModule(Object value) throws DmcValueException
value - A value compatible with DmcTypeStringMVDmcValueException - if the value is incorrectpublic int getRequiredBaseModuleSize()
public SchemaDefinition getDefinedIn()
getDefinedIn in interface DmcDefinitionIFgetDefinedIn in class DSDefinitionDMWpublic void setDefinedIn(SchemaDefinition value) throws DmcValueException
setDefinedIn in class DSDefinitionDMWvalue - A value compatible with SchemaDefinitionDmcValueException - if the value is incorrectpublic DefinitionName getObjectName()
getObjectName in interface DmcNamedObjectIFgetObjectName in class DmsDefinitionpublic DmcAttribute<?> getObjectNameAttribute()
getObjectNameAttribute in interface DmcNamedObjectIFgetObjectNameAttribute in class DmsDefinitionDMWCopyright © 2023. All rights reserved.