DmuModuleDMO (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.DmcObject
- - org.dmd.dms.generated.dmo.DSDefinitionDMO
  - - org.dmd.dmu.shared.generated.dmo.DmuDefinitionDMO
    - - org.dmd.dmu.shared.generated.dmo.DmuModuleDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF
```
public class DmuModuleDMO
extends DmuDefinitionDMO
implements DmcNamedObjectIF, Serializable
```
This is the module definition for the dmu domain-specific language.
Generated from the dmu schema at version unknown
This code was auto-generated by the dmogenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dms.util.DmoFormatter.dumpDMO(DmoFormatter.java:134)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String constructionClassName
- Fields inherited from class org.dmd.dmc.DmcObject
  __objectClass, attributes

Fields
Modifier and Type	Field and Description
`static String`	`constructionClassName`

Constructor Summary

Constructors
Modifier Constructor and Description

DmuModuleDMO()

DmuModuleDMO(DmcTypeModifierMV mods)

protected DmuModuleDMO(String oc)

Constructors
Modifier	Constructor and Description
	`DmuModuleDMO()`
	`DmuModuleDMO(DmcTypeModifierMV mods)`
`protected`	`DmuModuleDMO(String oc)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DmcAttribute<?>`	`addDefFiles(Object value)` Adds another defFiles value.
`DmcAttribute<?>`	`addDefFiles(String value)` Adds another defFiles to the specified value.
`DmcAttribute<?>`	`addDependsOnDmuModule(DmuModuleDMO value)` Adds another dependsOnDmuModule to the specified value.
`DmcAttribute<?>`	`addDependsOnDmuModule(Object value)` Adds another dependsOnDmuModule value.
`DmcAttribute<?>`	`addDescription(Object value)` Adds another description value.
`DmcAttribute<?>`	`addDescription(String value)` Adds another description to the specified value.
`DmcAttribute<?>`	`addLoadSchemaClass(Object value)` Adds another loadSchemaClass value.
`DmcAttribute<?>`	`addLoadSchemaClass(SchemaAndReason value)` Adds another loadSchemaClass to the specified value.
`boolean`	`defFilesContains(String value)`
`DmcAttribute<?>`	`delDefFiles(Object value)` Deletes a defFiles value.
`DmcAttribute<?>`	`delDefFiles(String value)` Deletes a defFiles from the specified value.
`DmcAttribute<?>`	`delDependsOnDmuModule(Object value)` Deletes a dependsOnDmuModule value.
`DmcAttribute<?>`	`delDescription(Object value)` Deletes a description value.
`DmcAttribute<?>`	`delDescription(String value)` Deletes a description from the specified value.
`DmcAttribute<?>`	`delLoadSchemaClass(Object value)` Deletes a loadSchemaClass value.
`DmcAttribute<?>`	`delLoadSchemaClass(SchemaAndReason value)` Deletes a loadSchemaClass from the specified value.
`boolean`	`descriptionContains(String value)`
`boolean`	`equals(Object obj)` This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.
`Iterator<String>`	`getDefFiles()`
`int`	`getDefFilesSize()`
`Iterator<DmuModuleREF>`	`getDependsOnDmuModule()`
`Iterator<DmuModuleREF>`	`getDependsOnDmuModuleREFs()`
`int`	`getDependsOnDmuModuleSize()`
`Iterator<String>`	`getDescription()` The description attribute is used to provide descriptive\n documentation for schema related definitions.
`int`	`getDescriptionSize()`
`Iterator<SchemaAndReason>`	`getLoadSchemaClass()`
`int`	`getLoadSchemaClassSize()`
`DmuModuleDMO`	`getModificationRecorder()`
`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.
`DmuModuleDMO`	`getNew()` Auto-generated derived classes override this to return an empty instance of themselves.
`String`	`getNthDefFiles(int i)`
`String`	`getNthDescription(int i)`
`SchemaAndReason`	`getNthLoadSchemaClass(int i)`
`DefinitionName`	`getObjectName()`
`DmcAttribute<?>`	`getObjectNameAttribute()`
`DmuModuleDMO`	`getSlice(DmcSliceInfo info)` Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
`int`	`hashCode()`
`boolean`	`loadSchemaClassContains(SchemaAndReason value)`
`void`	`remDefFiles()` Removes the defFiles attribute value.
`void`	`remDependsOnDmuModule()` Removes the dependsOnDmuModule attribute value.
`void`	`remDescription()` Removes the description attribute value.
`void`	`remLoadSchemaClass()` Removes the loadSchemaClass attribute value.
`void`	`remName()` Removes the name attribute value.
`void`	`setName(DefinitionName value)` Sets name to the specified value.
`void`	`setName(Object value)` Sets name to the specified value.

Methods inherited from class org.dmd.dmu.shared.generated.dmo.DmuDefinitionDMO
getDefinedInDmuModule, getDefinedInDmuModuleREF, remDefinedInDmuModule, setDefinedInDmuModule, setDefinedInDmuModule

Methods inherited from class org.dmd.dms.generated.dmo.DSDefinitionDMO
addComment, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getDefinedIn, getDescriptionWithNewlines, getDmoFromModule, getDotName, getExample, getFile, getHint, getIdToAttrInfo, getLineNumber, getNvp, getObsolete, getOptimize, getQuestion, getRelationship, getSearchable, getSkip, getSortName, getStringToAttrInfo, getTags, getVersion, getWhy, setDefinedIn, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmc.DmcObject
add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, get, get, get, getAdditionalAttributes, getAttributeInfo, getAttributeInfo, getAttributeIterator, getAttributeNames, getAttributes, getAttributeValidators, getBackref, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getContainer, getDataType, getFullClassName, getLastValue, getModifier, getObjectClass, getObjectValidators, getReferringObjects, getReferringObjectsViaAttribute, getStagingObject, hasAux, hasValue, isModrec, isReferenced, isStaging, modrec, nth, nthNullFromEmptyAttribute, numberOfAttributes, populateSlice, referenceCount, rem, rem, removeAux, removeBackref, resolveReferences, resolveReferences, resolveReferences, resolveReferencesExceptClass, resolveReferencesExceptClass, serializeIt, set, set, setContainer, setLastValue, setModifier, shallowCopy, staging, supportsBackrefTracking, toCompactJSON, toCompactJSON, toJSON, toJSON, toJSON, toOIF, toOIF, toOIFNoPadding, toPersistentOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - constructionClassName
```
public static final String constructionClassName
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DmuModuleDMO
```
public DmuModuleDMO()
```
  - DmuModuleDMO
```
protected DmuModuleDMO(String oc)
```
  - DmuModuleDMO
```
public DmuModuleDMO(DmcTypeModifierMV mods)
```
- Method Detail
  - getNew
```
public DmuModuleDMO getNew()
```
    Description copied from class: DmcObject
    
    Auto-generated derived classes override this to return an empty instance of themselves. This supports cloning.
    
    Overrides:
    
    getNew in class DSDefinitionDMO
    
    Returns:
    
    An instance of the derived class.
  - getSlice
```
public DmuModuleDMO getSlice(DmcSliceInfo info)
```
    Description copied from class: DmcObject
    
    Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes. In the case of named objects, the object name is always part of the slice.
    
    Overrides:
    
    getSlice in class DSDefinitionDMO
    
    Parameters:
    
    info - the slice info
    
    Returns:
    
    An instance of the derived class with the specified slice of attributes.
  - getModificationRecorder
```
public DmuModuleDMO getModificationRecorder()
```
  - getObjectName
```
public DefinitionName getObjectName()
```
    Specified by:
    
    getObjectName in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectName in class DmuDefinitionDMO
    
    Returns:
    
    The name of this object from the name attribute.
  - getObjectNameAttribute
```
public DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectNameAttribute in class DmuDefinitionDMO
    
    Returns:
    
    The name attribute.
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: DmcObject
    
    This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.
    
    Specified by:
    
    equals in interface DmcNamedObjectIF
    
    Overrides:
    
    equals in class DmuDefinitionDMO
    
    Parameters:
    
    obj - The comparison object.
    
    Returns:
    
    true if we equal the specified object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class DmuDefinitionDMO
  - getLoadSchemaClass
```
public Iterator<SchemaAndReason> getLoadSchemaClass()
```
    Returns:
    
    An Iterator of SchemaAndReason objects.
  - getNthLoadSchemaClass
```
public SchemaAndReason getNthLoadSchemaClass(int i)
```
    Parameters:
    
    i - the index
    
    Returns:
    
    The nth SchemaAndReason value.
  - addLoadSchemaClass
```
public DmcAttribute<?> addLoadSchemaClass(SchemaAndReason value)
```
    Adds another loadSchemaClass to the specified value.
    
    Parameters:
    
    value - SchemaAndReason
    
    Returns:
    
    the attribute instance
  - loadSchemaClassContains
```
public boolean loadSchemaClassContains(SchemaAndReason value)
```
    Parameters:
    
    value - SchemaAndReason
    
    Returns:
    
    true if we contain a valued keyed by the specified SchemaAndReason.
  - addLoadSchemaClass
```
public DmcAttribute<?> addLoadSchemaClass(Object value)
                                   throws DmcValueException
```
    Adds another loadSchemaClass value.
    
    Parameters:
    
    value - A value compatible with SchemaAndReason
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if value is not correct
  - getLoadSchemaClassSize
```
public int getLoadSchemaClassSize()
```
    Returns:
    
    the number of values in loadSchemaClass
  - delLoadSchemaClass
```
public DmcAttribute<?> delLoadSchemaClass(Object value)
                                   throws DmcValueException
```
    Deletes a loadSchemaClass value.
    
    Parameters:
    
    value - The SchemaAndReason to be deleted from set of attribute values.
    
    Returns:
    
    the deleted attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - delLoadSchemaClass
```
public DmcAttribute<?> delLoadSchemaClass(SchemaAndReason value)
```
    Deletes a loadSchemaClass from the specified value.
    
    Parameters:
    
    value - SchemaAndReason
    
    Returns:
    
    the deleted attribute instance
  - remLoadSchemaClass
```
public void remLoadSchemaClass()
```
    Removes the loadSchemaClass attribute value.
  - getDescription
```
public Iterator<String> getDescription()
```
    Description copied from class: DSDefinitionDMO
    
    The description attribute is used to provide descriptive\n documentation for schema related definitions. The text provided should conform\n to XHTML concepts since it will be dumped in the context of the generated HTML\n documentation.
    
    Overrides:
    
    getDescription in class DSDefinitionDMO
    
    Returns:
    
    An Iterator of String objects.
  - getNthDescription
```
public String getNthDescription(int i)
```
    Parameters:
    
    i - the index
    
    Returns:
    
    The nth String value.
  - addDescription
```
public DmcAttribute<?> addDescription(String value)
```
    Adds another description to the specified value.
    
    Parameters:
    
    value - String
    
    Returns:
    
    the attribute instance
  - descriptionContains
```
public boolean descriptionContains(String value)
```
    Parameters:
    
    value - String
    
    Returns:
    
    true if we contain a valued keyed by the specified String.
  - addDescription
```
public DmcAttribute<?> addDescription(Object value)
                               throws DmcValueException
```
    Adds another description value.
    
    Overrides:
    
    addDescription in class DSDefinitionDMO
    
    Parameters:
    
    value - A value compatible with String
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if value is not correct
  - getDescriptionSize
```
public int getDescriptionSize()
```
    Returns:
    
    the number of values in description
  - delDescription
```
public DmcAttribute<?> delDescription(Object value)
                               throws DmcValueException
```
    Deletes a description value.
    
    Parameters:
    
    value - The String to be deleted from set of attribute values.
    
    Returns:
    
    the deleted attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - delDescription
```
public DmcAttribute<?> delDescription(String value)
```
    Deletes a description from the specified value.
    
    Parameters:
    
    value - String
    
    Returns:
    
    the deleted attribute instance
  - remDescription
```
public void remDescription()
```
    Removes the description attribute value.
  - getDefFiles
```
public Iterator<String> getDefFiles()
```
    Returns:
    
    An Iterator of String objects.
  - getNthDefFiles
```
public String getNthDefFiles(int i)
```
    Parameters:
    
    i - the index
    
    Returns:
    
    The nth String value.
  - addDefFiles
```
public DmcAttribute<?> addDefFiles(String value)
```
    Adds another defFiles to the specified value.
    
    Parameters:
    
    value - String
    
    Returns:
    
    the attribute instance
  - defFilesContains
```
public boolean defFilesContains(String value)
```
    Parameters:
    
    value - String
    
    Returns:
    
    true if we contain a valued keyed by the specified String.
  - addDefFiles
```
public DmcAttribute<?> addDefFiles(Object value)
                            throws DmcValueException
```
    Adds another defFiles value.
    
    Parameters:
    
    value - A value compatible with String
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if value is not correct
  - getDefFilesSize
```
public int getDefFilesSize()
```
    Returns:
    
    the number of values in defFiles
  - delDefFiles
```
public DmcAttribute<?> delDefFiles(Object value)
                            throws DmcValueException
```
    Deletes a defFiles value.
    
    Parameters:
    
    value - The String to be deleted from set of attribute values.
    
    Returns:
    
    the deleted attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - delDefFiles
```
public DmcAttribute<?> delDefFiles(String value)
```
    Deletes a defFiles from the specified value.
    
    Parameters:
    
    value - String
    
    Returns:
    
    the deleted attribute instance
  - remDefFiles
```
public void remDefFiles()
```
    Removes the defFiles attribute value.
  - getDependsOnDmuModule
```
public Iterator<DmuModuleREF> getDependsOnDmuModule()
```
    Returns:
    
    An Iterator of DmuModuleDMO objects.
  - getDependsOnDmuModuleREFs
```
public Iterator<DmuModuleREF> getDependsOnDmuModuleREFs()
```
    Returns:
    
    An Iterator of DmuModuleREFs without attempting lazy resolution (if it's turned on).
  - addDependsOnDmuModule
```
public DmcAttribute<?> addDependsOnDmuModule(DmuModuleDMO value)
```
    Adds another dependsOnDmuModule to the specified value.
    
    Parameters:
    
    value - DmuModule
    
    Returns:
    
    the attribute instance
  - addDependsOnDmuModule
```
public DmcAttribute<?> addDependsOnDmuModule(Object value)
                                      throws DmcValueException
```
    Adds another dependsOnDmuModule value.
    
    Parameters:
    
    value - A value compatible with DmuModule
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if value is not correct
  - getDependsOnDmuModuleSize
```
public int getDependsOnDmuModuleSize()
```
    Returns:
    
    the number of values in dependsOnDmuModule
  - delDependsOnDmuModule
```
public DmcAttribute<?> delDependsOnDmuModule(Object value)
```
    Deletes a dependsOnDmuModule value.
    
    Parameters:
    
    value - The DmuModule to be deleted from set of attribute values.
    
    Returns:
    
    the deleted attribute instance
  - remDependsOnDmuModule
```
public void remDependsOnDmuModule()
```
    Removes the dependsOnDmuModule attribute value.
  - getName
```
public DefinitionName getName()
```
    Description copied from class: DSDefinitionDMO
    
    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.
    
    Overrides:
    
    getName in class DmuDefinitionDMO
    
    Returns:
    
    the DefinitionName
  - setName
```
public void setName(DefinitionName value)
```
    Sets name to the specified value.
    
    Overrides:
    
    setName in class DmuDefinitionDMO
    
    Parameters:
    
    value - DefinitionName
  - setName
```
public void setName(Object value)
             throws DmcValueException
```
    Sets name to the specified value.
    
    Overrides:
    
    setName in class DmuDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeDefinitionNameSV
    
    Throws:
    
    DmcValueException - if value is not correct
  - remName
```
public void remName()
```
    Removes the name attribute value.
    
    Overrides:
    
    remName in class DmuDefinitionDMO

Class DmuModuleDMO

Field Summary

Fields inherited from class org.dmd.dmc.DmcObject

Constructor Summary

Method Summary

Methods inherited from class org.dmd.dmu.shared.generated.dmo.DmuDefinitionDMO

Methods inherited from class org.dmd.dms.generated.dmo.DSDefinitionDMO

Methods inherited from class org.dmd.dmc.DmcObject

Methods inherited from class java.lang.Object

Field Detail

constructionClassName

Constructor Detail

DmuModuleDMO

DmuModuleDMO

DmuModuleDMO

Method Detail

getNew

getSlice

getModificationRecorder

getObjectName

getObjectNameAttribute

equals

hashCode

getLoadSchemaClass

getNthLoadSchemaClass

addLoadSchemaClass

loadSchemaClassContains

addLoadSchemaClass

getLoadSchemaClassSize

delLoadSchemaClass

delLoadSchemaClass

remLoadSchemaClass

getDescription

getNthDescription

addDescription

descriptionContains

addDescription

getDescriptionSize

delDescription

delDescription

remDescription

getDefFiles

getNthDefFiles

addDefFiles

defFilesContains

addDefFiles

getDefFilesSize

delDefFiles

delDefFiles

remDefFiles

getDependsOnDmuModule

getDependsOnDmuModuleREFs

addDependsOnDmuModule

addDependsOnDmuModule

getDependsOnDmuModuleSize

delDependsOnDmuModule

remDependsOnDmuModule

getName

setName

setName

remName