TdlModuleDMO (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.DmcObject
- - org.dmd.dms.generated.dmo.DSDefinitionDMO
  - - org.dmd.templates.shared.generated.dmo.TdlDefinitionDMO
    - - org.dmd.templates.shared.generated.dmo.TdlModuleDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF
```
public class TdlModuleDMO
extends TdlDefinitionDMO
implements DmcNamedObjectIF, Serializable
```
A TdlModule is used to define a set of Sections that\n define the overall structure of a textual artifact. When run through the dmtdlgen\n utility, a set of classes are generated to represent these different artifact sections.\n
\n By convention, you should place the .dmtdl files along with your other dark-matter \n config files e.g. in the dmconfig folder with your dark-matter schema or with \n your .dmg wrapper generation files. However, there is no restriction on where you\n place your .dmtdl files, but it's recommended that they exist in a separate subfolder.\n
\n When the dmtdlgen utility is run, a folder (named generated) will be created at\n the same level as the dmconfig folder (or whatever you called it). This will contain\n a dmtdl subpackage that will contain the generated code that represents the \n various Sections that you've defined.
Generated from the dmtdl 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

TdlModuleDMO()

TdlModuleDMO(DmcTypeModifierMV mods)

protected TdlModuleDMO(String oc)

Constructors
Modifier	Constructor and Description
	`TdlModuleDMO()`
	`TdlModuleDMO(DmcTypeModifierMV mods)`
`protected`	`TdlModuleDMO(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<?>`	`addDependsOnTdlModule(Object value)` Adds another dependsOnTdlModule value.
`DmcAttribute<?>`	`addDependsOnTdlModule(TdlModuleDMO value)` Adds another dependsOnTdlModule to the specified value.
`DmcAttribute<?>`	`addDescription(Object value)` Adds another description value.
`DmcAttribute<?>`	`addDescription(String value)` Adds another description 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<?>`	`delDependsOnTdlModule(Object value)` Deletes a dependsOnTdlModule value.
`DmcAttribute<?>`	`delDescription(Object value)` Deletes a description value.
`DmcAttribute<?>`	`delDescription(String value)` Deletes a description 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.
`String`	`getCommentFormat()`
`Iterator<String>`	`getDefFiles()`
`int`	`getDefFilesSize()`
`Iterator<TdlModuleREF>`	`getDependsOnTdlModule()`
`Iterator<TdlModuleREF>`	`getDependsOnTdlModuleREFs()`
`int`	`getDependsOnTdlModuleSize()`
`Iterator<String>`	`getDescription()` The description attribute is used to provide descriptive\n documentation for schema related definitions.
`int`	`getDescriptionSize()`
`String`	`getInsertMarker()`
`Integer`	`getMaxFastAddValues()`
`TdlModuleDMO`	`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.
`TdlModuleDMO`	`getNew()` Auto-generated derived classes override this to return an empty instance of themselves.
`String`	`getNthDefFiles(int i)`
`String`	`getNthDescription(int i)`
`DefinitionName`	`getObjectName()`
`DmcAttribute<?>`	`getObjectNameAttribute()`
`String`	`getPackage()`
`TdlModuleDMO`	`getSlice(DmcSliceInfo info)` Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
`String`	`getTemplateFile()`
`String`	`getTemplateFileSuffix()`
`int`	`hashCode()`
`void`	`remCommentFormat()` Removes the commentFormat attribute value.
`void`	`remDefFiles()` Removes the defFiles attribute value.
`void`	`remDependsOnTdlModule()` Removes the dependsOnTdlModule attribute value.
`void`	`remDescription()` Removes the description attribute value.
`void`	`remInsertMarker()` Removes the insertMarker attribute value.
`void`	`remMaxFastAddValues()` Removes the maxFastAddValues attribute value.
`void`	`remName()` Removes the name attribute value.
`void`	`remPackage()` Removes the package attribute value.
`void`	`remTemplateFile()` Removes the templateFile attribute value.
`void`	`remTemplateFileSuffix()` Removes the templateFileSuffix attribute value.
`void`	`setCommentFormat(Object value)` Sets commentFormat to the specified value.
`void`	`setCommentFormat(String value)` Sets commentFormat to the specified value.
`void`	`setInsertMarker(Object value)` Sets insertMarker to the specified value.
`void`	`setInsertMarker(String value)` Sets insertMarker to the specified value.
`void`	`setMaxFastAddValues(Integer value)` Sets maxFastAddValues to the specified value.
`void`	`setMaxFastAddValues(Object value)` Sets maxFastAddValues to the specified value.
`void`	`setName(DefinitionName value)` Sets name to the specified value.
`void`	`setName(Object value)` Sets name to the specified value.
`void`	`setPackage(Object value)` Sets package to the specified value.
`void`	`setPackage(String value)` Sets package to the specified value.
`void`	`setTemplateFile(Object value)` Sets templateFile to the specified value.
`void`	`setTemplateFile(String value)` Sets templateFile to the specified value.
`void`	`setTemplateFileSuffix(Object value)` Sets templateFileSuffix to the specified value.
`void`	`setTemplateFileSuffix(String value)` Sets templateFileSuffix to the specified value.

Methods inherited from class org.dmd.templates.shared.generated.dmo.TdlDefinitionDMO
getDefinedInTdlModule, getDefinedInTdlModuleREF, getDotName, remDefinedInTdlModule, remDotName, setDefinedInTdlModule, setDefinedInTdlModule, setDotName, setDotName

Methods inherited from class org.dmd.dms.generated.dmo.DSDefinitionDMO
addComment, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getDefinedIn, getDescriptionWithNewlines, getDmoFromModule, getExample, getFile, getHint, getIdToAttrInfo, getLineNumber, getNvp, getObsolete, getOptimize, getQuestion, getRelationship, getSearchable, getSkip, getSortName, getStringToAttrInfo, getTags, getVersion, getWhy, setDefinedIn, setDmoFromModule, 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
  - TdlModuleDMO
```
public TdlModuleDMO()
```
  - TdlModuleDMO
```
protected TdlModuleDMO(String oc)
```
  - TdlModuleDMO
```
public TdlModuleDMO(DmcTypeModifierMV mods)
```
- Method Detail
  - getNew
```
public TdlModuleDMO 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 TdlModuleDMO 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 TdlModuleDMO getModificationRecorder()
```
  - getObjectName
```
public DefinitionName getObjectName()
```
    Specified by:
    
    getObjectName in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectName in class TdlDefinitionDMO
    
    Returns:
    
    The name of this object from the name attribute.
  - getObjectNameAttribute
```
public DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectNameAttribute in class TdlDefinitionDMO
    
    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 TdlDefinitionDMO
    
    Parameters:
    
    obj - The comparison object.
    
    Returns:
    
    true if we equal the specified object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class TdlDefinitionDMO
  - 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 TdlDefinitionDMO
    
    Returns:
    
    An Iterator of String objects.
  - getNthDescription
```
public String getNthDescription(int i)
```
    Overrides:
    
    getNthDescription in class TdlDefinitionDMO
    
    Parameters:
    
    i - the index
    
    Returns:
    
    The nth String value.
  - addDescription
```
public DmcAttribute<?> addDescription(String value)
```
    Adds another description to the specified value.
    
    Overrides:
    
    addDescription in class TdlDefinitionDMO
    
    Parameters:
    
    value - String
    
    Returns:
    
    the attribute instance
  - descriptionContains
```
public boolean descriptionContains(String value)
```
    Overrides:
    
    descriptionContains in class TdlDefinitionDMO
    
    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 TdlDefinitionDMO
    
    Parameters:
    
    value - A value compatible with String
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if value is not correct
  - getDescriptionSize
```
public int getDescriptionSize()
```
    Overrides:
    
    getDescriptionSize in class TdlDefinitionDMO
    
    Returns:
    
    the number of values in description
  - delDescription
```
public DmcAttribute<?> delDescription(Object value)
                               throws DmcValueException
```
    Deletes a description value.
    
    Overrides:
    
    delDescription in class TdlDefinitionDMO
    
    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.
    
    Overrides:
    
    delDescription in class TdlDefinitionDMO
    
    Parameters:
    
    value - String
    
    Returns:
    
    the deleted attribute instance
  - remDescription
```
public void remDescription()
```
    Removes the description attribute value.
    
    Overrides:
    
    remDescription in class TdlDefinitionDMO
  - 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.
  - getTemplateFileSuffix
```
public String getTemplateFileSuffix()
```
  - setTemplateFileSuffix
```
public void setTemplateFileSuffix(String value)
```
    Sets templateFileSuffix to the specified value.
    
    Parameters:
    
    value - String
  - setTemplateFileSuffix
```
public void setTemplateFileSuffix(Object value)
                           throws DmcValueException
```
    Sets templateFileSuffix to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if value is not correct
  - remTemplateFileSuffix
```
public void remTemplateFileSuffix()
```
    Removes the templateFileSuffix attribute value.
  - getMaxFastAddValues
```
public Integer getMaxFastAddValues()
```
  - setMaxFastAddValues
```
public void setMaxFastAddValues(Integer value)
```
    Sets maxFastAddValues to the specified value.
    
    Parameters:
    
    value - Integer
  - setMaxFastAddValues
```
public void setMaxFastAddValues(Object value)
                         throws DmcValueException
```
    Sets maxFastAddValues to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if value is not correct
  - remMaxFastAddValues
```
public void remMaxFastAddValues()
```
    Removes the maxFastAddValues attribute value.
  - getInsertMarker
```
public String getInsertMarker()
```
  - setInsertMarker
```
public void setInsertMarker(String value)
```
    Sets insertMarker to the specified value.
    
    Parameters:
    
    value - String
  - setInsertMarker
```
public void setInsertMarker(Object value)
                     throws DmcValueException
```
    Sets insertMarker to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if value is not correct
  - remInsertMarker
```
public void remInsertMarker()
```
    Removes the insertMarker attribute value.
  - getCommentFormat
```
public String getCommentFormat()
```
  - setCommentFormat
```
public void setCommentFormat(String value)
```
    Sets commentFormat to the specified value.
    
    Parameters:
    
    value - String
  - setCommentFormat
```
public void setCommentFormat(Object value)
                      throws DmcValueException
```
    Sets commentFormat to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if value is not correct
  - remCommentFormat
```
public void remCommentFormat()
```
    Removes the commentFormat attribute value.
  - getDependsOnTdlModule
```
public Iterator<TdlModuleREF> getDependsOnTdlModule()
```
    Returns:
    
    An Iterator of TdlModuleDMO objects.
  - getDependsOnTdlModuleREFs
```
public Iterator<TdlModuleREF> getDependsOnTdlModuleREFs()
```
    Returns:
    
    An Iterator of TdlModuleREFs without attempting lazy resolution (if it's turned on).
  - addDependsOnTdlModule
```
public DmcAttribute<?> addDependsOnTdlModule(TdlModuleDMO value)
```
    Adds another dependsOnTdlModule to the specified value.
    
    Parameters:
    
    value - TdlModule
    
    Returns:
    
    the attribute instance
  - addDependsOnTdlModule
```
public DmcAttribute<?> addDependsOnTdlModule(Object value)
                                      throws DmcValueException
```
    Adds another dependsOnTdlModule value.
    
    Parameters:
    
    value - A value compatible with TdlModule
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if value is not correct
  - getDependsOnTdlModuleSize
```
public int getDependsOnTdlModuleSize()
```
    Returns:
    
    the number of values in dependsOnTdlModule
  - delDependsOnTdlModule
```
public DmcAttribute<?> delDependsOnTdlModule(Object value)
```
    Deletes a dependsOnTdlModule value.
    
    Parameters:
    
    value - The TdlModule to be deleted from set of attribute values.
    
    Returns:
    
    the deleted attribute instance
  - remDependsOnTdlModule
```
public void remDependsOnTdlModule()
```
    Removes the dependsOnTdlModule 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 TdlDefinitionDMO
    
    Returns:
    
    the DefinitionName
  - setName
```
public void setName(DefinitionName value)
```
    Sets name to the specified value.
    
    Overrides:
    
    setName in class TdlDefinitionDMO
    
    Parameters:
    
    value - DefinitionName
  - setName
```
public void setName(Object value)
             throws DmcValueException
```
    Sets name to the specified value.
    
    Overrides:
    
    setName in class TdlDefinitionDMO
    
    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 TdlDefinitionDMO
  - getPackage
```
public String getPackage()
```
  - setPackage
```
public void setPackage(String value)
```
    Sets package to the specified value.
    
    Parameters:
    
    value - String
  - setPackage
```
public void setPackage(Object value)
                throws DmcValueException
```
    Sets package to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if value is not correct
  - remPackage
```
public void remPackage()
```
    Removes the package attribute value.
  - getTemplateFile
```
public String getTemplateFile()
```
  - setTemplateFile
```
public void setTemplateFile(String value)
```
    Sets templateFile to the specified value.
    
    Parameters:
    
    value - String
  - setTemplateFile
```
public void setTemplateFile(Object value)
                     throws DmcValueException
```
    Sets templateFile to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if value is not correct
  - remTemplateFile
```
public void remTemplateFile()
```
    Removes the templateFile attribute value.

Class TdlModuleDMO

Field Summary

Fields inherited from class org.dmd.dmc.DmcObject

Constructor Summary

Method Summary

Methods inherited from class org.dmd.templates.shared.generated.dmo.TdlDefinitionDMO

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

TdlModuleDMO

TdlModuleDMO

TdlModuleDMO

Method Detail

getNew

getSlice

getModificationRecorder

getObjectName

getObjectNameAttribute

equals

hashCode

getDescription

getNthDescription

addDescription

descriptionContains

addDescription

getDescriptionSize

delDescription

delDescription

remDescription

getDefFiles

getNthDefFiles

addDefFiles

defFilesContains

addDefFiles

getDefFilesSize

delDefFiles

delDefFiles

remDefFiles

getTemplateFileSuffix

setTemplateFileSuffix

setTemplateFileSuffix

remTemplateFileSuffix

getMaxFastAddValues

setMaxFastAddValues

setMaxFastAddValues

remMaxFastAddValues

getInsertMarker

setInsertMarker

setInsertMarker

remInsertMarker

getCommentFormat

setCommentFormat

setCommentFormat

remCommentFormat

getDependsOnTdlModule

getDependsOnTdlModuleREFs

addDependsOnTdlModule

addDependsOnTdlModule

getDependsOnTdlModuleSize

delDependsOnTdlModule

remDependsOnTdlModule

getName

setName

setName

remName

getPackage

setPackage

setPackage

remPackage

getTemplateFile

setTemplateFile

setTemplateFile

remTemplateFile