ClassDefinitionDMO (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.DmcObject
- - org.dmd.dms.generated.dmo.DSDefinitionDMO
  - - org.dmd.dms.generated.dmo.DmsDefinitionDMO
    - - org.dmd.dms.generated.dmo.ClassDefinitionDMO

All Implemented Interfaces:

Serializable, DmcDefinitionIF, DmcNamedObjectIF
```
public class ClassDefinitionDMO
extends DmsDefinitionDMO
implements Serializable, DmcDefinitionIF
```
This class provides the basic mechanism to define new classes for a schema.

Author:

Auto Generated Generated from: org.dmd.dms.meta.MetaGenerator.dumpDMOClasses(MetaGenerator.java:1957)

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.dmd.dmc.DmcObject
  __objectClass, attributes

Constructor Summary

Constructors
Constructor and Description

ClassDefinitionDMO()

ClassDefinitionDMO(String oc)

Constructors
Constructor and Description
`ClassDefinitionDMO()`
`ClassDefinitionDMO(String oc)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DmcAttribute<?>`	`addActions(Object value)` Adds another actions value.
`DmcAttribute<?>`	`addAllowedParents(Object value)` Adds another allowedParents value.
`DmcAttribute<?>`	`addComment(Object value)` Adds another comment value.
`DmcAttribute<?>`	`addDerivedClasses(Object value)` Adds another derivedClasses value.
`DmcAttribute<?>`	`addDescription(Object value)` Adds another description value.
`DmcAttribute<?>`	`addDmwWrapperType(Object value)` Adds another dmwWrapperType value.
`DmcAttribute<?>`	`addExample(Object value)` Adds another example value.
`DmcAttribute<?>`	`addExcludeFromContext(Object value)` Adds another excludeFromContext value.
`DmcAttribute<?>`	`addIntendedToExtend(Object value)` Adds another intendedToExtend value.
`DmcAttribute<?>`	`addMay(Object value)` Adds another may value.
`DmcAttribute<?>`	`addMust(Object value)` Adds another must value.
`DmcAttribute<?>`	`addNvp(Object value)` Adds another nvp value.
`DmcAttribute<?>`	`addOptimize(Object value)` Adds another optimize value.
`DmcAttribute<?>`	`addQuestion(Object value)` Adds another question value.
`DmcAttribute<?>`	`addRelatedToConcept(Object value)` Adds another relatedToConcept value.
`DmcAttribute<?>`	`addSkip(Object value)` Adds another skip value.
`DmcAttribute<?>`	`addTags(Object value)` Adds another tags value.
`DmcAttribute<?>`	`addUsesWrapperInterface(Object value)` Adds another usesWrapperInterface value.
`String`	`getAbbrev()` This attribute stores an abbreviated form of the name of an attribute or class.
`Iterator<ActionDefinitionREF>`	`getActions()` Indicates the set of actions that are supported by a class of objects.
`Iterator<ClassDefinitionREF>`	`getAllowedParents()` Indicates the classes of object that may be parents of the\n current class when objects are created in an instance hierarchy.
`ClassTypeEnum`	`getClassType()` This attribute indicates the type of a class definition.
`Iterator<String>`	`getComment()` A comment or note associated with the definition of something.
`Boolean`	`getCreateIndex()` A flag to indicate if you want your data repository to create an index for a named object.
`DataTypeEnum`	`getDataType()` This attribute indicates the persistence characteristics of an attribute or\n class of object.
`SchemaDefinitionREF`	`getDefinedIn()` Indicates the schema in which a type, attribute or class is defined.
`Iterator<ClassDefinitionREF>`	`getDerivedClasses()` Indicates the classes that are known to be derived from a class.
`ClassDefinitionREF`	`getDerivedFrom()` Indicates the abstract or structural class from which this class is derived.
`Iterator<String>`	`getDescription()` The description attribute is used to provide descriptive\n documentation for schema related definitions.
`Iterator<String>`	`getDescriptionWithNewlines()`
`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.
`String`	`getDmeClass()` This attribute indicates just the Dark Matter Extended (DME) class name.
`String`	`getDmeImport()` This attribute indicates the full name of the class that extends a DMW class.\n Dark Matter Extended (DME).
`String`	`getDmoAuxClass()` This attribute indicates just the DMO class name e.g.
`String`	`getDmoAuxClassImport()` This attribute indicates the full name of the MyClassAUXDMO class
`String`	`getDmoClass()` This attribute indicates just the DMO class name e.g.
`String`	`getDmoFromModule()` A bit of a hack to allow for creation of fully qualified dot names\n in the DMODefinitionSet that's used for caching definitions in GWT.
`String`	`getDmoImport()` This attribute indicates the full name of the generated Dark Matter Object (DMO)\n class (including package) that is generated for this class.
`String`	`getDmtClass()` This attribute indicates just the DmcType class name.
`String`	`getDmtImport()` This attribute indicates the full name of the DmcType class used to reference\n a class.
`String`	`getDmtREFImport()` This attribute indicates the full name of the class used to reference\n a class.
`String`	`getDmwAuxClass()` This attribute indicates just the DMO class name e.g.
`String`	`getDmwAuxClassImport()` This attribute indicates the full name of the MyClassAUX class
`String`	`getDmwClass()` This attribute indicates just the DMW class name, eg MyClassDMW
`String`	`getDmwImport()` This attribute indicates the full name of the generated Dark Matter Wrapper (DMW)\n class (including package) that is wrapped by this class.
`String`	`getDmwIteratorClass()` This attribute indicates just the DmcContainerIterator name for a\n class of object.
`String`	`getDmwIteratorImport()` This attribute indicates the full name of the DmcContainerIterator \n derived class that allows us to iterate over a set of object references and get back\n the DMW wrapper object instead of the DMO.
`Iterator<DmwTypeToWrapperType>`	`getDmwWrapperType()` The dmwWrapperType is used to indicate whether or not you want extended wrappers\n when the wrappers are generated for an object in a particular generation context.
`DotName`	`getDotName()` The dotName attribute is used to store dot separated names.
`DSDefinitionModuleREF`	`getDsdModuleDefinition()` The DSDefinitionModule that resulted in the creation of an\n internally generated ClassDefinition.
`Iterator<Example>`	`getExample()` The example attribute is used to provide additional\n examples of how some defined thing is to be used.
`Iterator<String>`	`getExcludeFromContext()` The excludeFromContext attribute is used to indicate that\n a class of object (and all of its derivatives) should be excluded from the wrapper\n generation for the specified context.
`String`	`getFile()` Indicates the file from which a definition was loaded.
`String`	`getHint()` A short description of something that can be dumped as one line summary of something.\n For longer explanations, use the description attribute.
`Map<Integer,DmcAttributeInfo>`	`getIdToAttrInfo()`
`Iterator<ClassDefinitionREF>`	`getIntendedToExtend()` This attribute can be used on AUXILIARY classes to give a hint about their\n intended usage.
`Boolean`	`getInternallyGenerated()` This flag indicates if the associated definition was internally generated.\n This is the case for TypeDefinitions generated for ClassDefinitions and EnumDefinitions\n that allow for references to these objects.
`TypeDefinitionREF`	`getInternalTypeRef()` Indicates the internal type that's generated for all ClassDefinitions.
`Boolean`	`getIsDSDefinition()` Indicates if the class defined by a ClassDefinition and its derivatives are part\n of a domain specific set of definitions.
`AttributeDefinitionREF`	`getIsNamedBy()` Indicates the attribute by which an object of some class is named.\n When this attribute is supplied in a ClassDefinition, the generated DMO class will\n indicate that it implements the DmcNamedObjectIF and its getObjectName() method\n will return the value of the isNamedBy attribute.
`String`	`getJavaClass()` This attribute indicates the full name of the class (including package)\n that should be instantiated when an instance of an object is created via the\n DmdClassDef.newInstance() function.
`Integer`	`getLineNumber()` Indicates the line number of the file from which a definition was loaded.
`Iterator<AttributeDefinitionREF>`	`getMay()` Indicates the set of attributes that an instance of a class MAY\n have.
`Iterator<AttributeDefinitionREF>`	`getMust()` Indicates the set of attributes that an instance of a class MUST have.
`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.
`ClassDefinitionDMO`	`getNew()` Auto-generated derived classes override this to return an empty instance of themselves.
`Iterator<NameValuePair>`	`getNvp()` A set of additional name value pairs that can be associated with an object.
`DefinitionName`	`getObjectName()`
`DmcAttribute<?>`	`getObjectNameAttribute()`
`String`	`getObsolete()` The version at which something became obsolete.
`String`	`getObsoleteVersion()` This indicates the version at which something became obsolete.\n Generally speaking you shouldn't ever delete definitions for products that have\n been released to the field, this may break backwards compatibility.
`Iterator<String>`	`getOptimize()` Depending on what you're modelling, you often come across\n places where you can see an opportunity to optimize, streamline or improve something e.g.
`DSDefinitionModuleREF`	`getPartOfDefinitionModule()` For classes that defined as part of a definition module,\n this indicates the module they belong to.
`Iterator<String>`	`getQuestion()` A question associated with the definition of something.
`Iterator<ConcinnityREF>`	`getRelatedToConcept()` Allows for references to base concepts that relate this\n definition to another definition in the Concinnity domain.
`String`	`getRelationship()` The name of the relationship established via a reference to some other named object.\n
`RuleDefinitionREF`	`getRuleDefinition()` The RuleDefinition that resulted in the creation of an\n internally generated ClassDefinition.
`Boolean`	`getSearchable()` Indicates if something is searchable.
`Iterator<String>`	`getSkip()` A version from which something should be excluded (even though it is included\n in later versions).
`ClassDefinitionDMO`	`getSlice(DmcSliceInfo info)` Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
`DotName`	`getSortName()` The sortName is used in siutations where we need a name\n for storage of a definition that is globally unique but can be sorted on the basis\n of the definition name, not the module name.
`Map<String,DmcAttributeInfo>`	`getStringToAttrInfo()`
`String`	`getSubpackage()` The subpackage beneath extended where generated code will be written.
`Boolean`	`getSupportsBackrefTracking()` Indicates if a class of objects supports back reference tracking or not.
`Iterator<String>`	`getTags()` A collection of tags that can facilitate searching for\n definitions.
`String`	`getUsesInterface()` This is a hack for now to allow for the inclusion of an \n interface on a class; it should be the fully qualified name of the interface.\n The interface shouldn't require any method implementations.
`Iterator<String>`	`getUsesWrapperInterface()` The fully qualified name of a Java interface that should\n be implemented on an extended wrapper class.
`WrapperTypeEnum`	`getUseWrapperType()` Indicates whether you want to use the generated DMW wrapper\n or the extended wrapper you've created yourself.
`String`	`getVersion()` The version at which something was introduced.
`ConcinnityREF`	`getWhy()` An indication of why something was added to a specification or a system.\n This might be a reference to a requirement or feature concept.
`void`	`setAbbrev(Object value)` Sets abbrev to the specified value.
`void`	`setClassType(Object value)` Sets classType to the specified value.
`void`	`setCreateIndex(Object value)` Sets createIndex to the specified value.
`void`	`setDataType(Object value)` Sets dataType to the specified value.
`void`	`setDefinedIn(Object value)` Sets definedIn to the specified value.
`void`	`setDerivedFrom(Object value)` Sets derivedFrom to the specified value.
`void`	`setDmdID(Object value)` Sets dmdID to the specified value.
`void`	`setDmeClass(Object value)` Sets dmeClass to the specified value.
`void`	`setDmeImport(Object value)` Sets dmeImport to the specified value.
`void`	`setDmoAuxClass(Object value)` Sets dmoAuxClass to the specified value.
`void`	`setDmoAuxClassImport(Object value)` Sets dmoAuxClassImport to the specified value.
`void`	`setDmoClass(Object value)` Sets dmoClass to the specified value.
`void`	`setDmoFromModule(Object value)` Sets dmoFromModule to the specified value.
`void`	`setDmoImport(Object value)` Sets dmoImport to the specified value.
`void`	`setDmtClass(Object value)` Sets dmtClass to the specified value.
`void`	`setDmtImport(Object value)` Sets dmtImport to the specified value.
`void`	`setDmtREFImport(Object value)` Sets dmtREFImport to the specified value.
`void`	`setDmwAuxClass(Object value)` Sets dmwAuxClass to the specified value.
`void`	`setDmwAuxClassImport(Object value)` Sets dmwAuxClassImport to the specified value.
`void`	`setDmwClass(Object value)` Sets dmwClass to the specified value.
`void`	`setDmwImport(Object value)` Sets dmwImport to the specified value.
`void`	`setDmwIteratorClass(Object value)` Sets dmwIteratorClass to the specified value.
`void`	`setDmwIteratorImport(Object value)` Sets dmwIteratorImport to the specified value.
`void`	`setDotName(Object value)` Sets dotName to the specified value.
`void`	`setDsdModuleDefinition(Object value)` Sets dsdModuleDefinition to the specified value.
`void`	`setFile(Object value)` Sets file to the specified value.
`void`	`setHint(Object value)` Sets hint to the specified value.
`void`	`setInternallyGenerated(Object value)` Sets internallyGenerated to the specified value.
`void`	`setInternalTypeRef(Object value)` Sets internalTypeRef to the specified value.
`void`	`setIsDSDefinition(Object value)` Sets isDSDefinition to the specified value.
`void`	`setIsNamedBy(Object value)` Sets isNamedBy to the specified value.
`void`	`setJavaClass(Object value)` Sets javaClass to the specified value.
`void`	`setLineNumber(Object value)` Sets lineNumber to the specified value.
`void`	`setName(Object value)` Sets name to the specified value.
`void`	`setObsolete(Object value)` Sets obsolete to the specified value.
`void`	`setObsoleteVersion(Object value)` Sets obsoleteVersion to the specified value.
`void`	`setPartOfDefinitionModule(Object value)` Sets partOfDefinitionModule to the specified value.
`void`	`setRelationship(Object value)` Sets relationship to the specified value.
`void`	`setRuleDefinition(Object value)` Sets ruleDefinition to the specified value.
`void`	`setSearchable(Object value)` Sets searchable to the specified value.
`void`	`setSortName(Object value)` Sets sortName to the specified value.
`void`	`setSubpackage(Object value)` Sets subpackage to the specified value.
`void`	`setSupportsBackrefTracking(Object value)` Sets supportsBackrefTracking to the specified value.
`void`	`setUsesInterface(Object value)` Sets usesInterface to the specified value.
`void`	`setUseWrapperType(Object value)` Sets useWrapperType to the specified value.
`void`	`setVersion(Object value)` Sets version to the specified value.
`void`	`setWhy(Object value)` Sets why to the specified value.

Methods inherited from class org.dmd.dmc.DmcObject
add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, equals, get, get, get, getAdditionalAttributes, getAttributeInfo, getAttributeInfo, getAttributeIterator, getAttributeNames, getAttributes, getAttributeValidators, getBackref, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getContainer, 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, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF
equals

- Constructor Detail
  - ClassDefinitionDMO
```
public ClassDefinitionDMO()
```
  - ClassDefinitionDMO
```
public ClassDefinitionDMO(String oc)
```
- Method Detail
  - getIdToAttrInfo
```
public Map<Integer,DmcAttributeInfo> getIdToAttrInfo()
```
    Overrides:
    
    getIdToAttrInfo in class DmsDefinitionDMO
  - getStringToAttrInfo
```
public Map<String,DmcAttributeInfo> getStringToAttrInfo()
```
    Overrides:
    
    getStringToAttrInfo in class DmsDefinitionDMO
  - getNew
```
public ClassDefinitionDMO 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 DmsDefinitionDMO
    
    Returns:
    
    An instance of the derived class.
  - getSlice
```
public ClassDefinitionDMO 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 DmsDefinitionDMO
    
    Parameters:
    
    info - the slice info
    
    Returns:
    
    An instance of the derived class with the specified slice of attributes.
  - getClassType
```
public ClassTypeEnum getClassType()
```
    This attribute indicates the type of a class definition.
    
    Returns:
    
    the ClassTypeEnum
  - setClassType
```
public void setClassType(Object value)
                  throws DmcValueException
```
    Sets classType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeClassTypeEnumSV
    
    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
  - 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 DmsDefinitionDMO
    
    Returns:
    
    the DefinitionName
  - setName
```
public void setName(Object value)
             throws DmcValueException
```
    Sets name to the specified value.
    
    Overrides:
    
    setName in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeDefinitionNameSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getAbbrev
```
public String getAbbrev()
```
    This attribute stores an abbreviated form of the name of an attribute or class. This\n concept is borrowed from directory technology where shortened name forms are often\n used as part of distinguished names (DNs).
    
    Returns:
    
    the String
  - setAbbrev
```
public void setAbbrev(Object value)
               throws DmcValueException
```
    Sets abbrev to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getActions
```
public Iterator<ActionDefinitionREF> getActions()
```
    Indicates the set of actions that are supported by a class of objects.
    
    Returns:
    
    the ActionDefinition
  - addActions
```
public DmcAttribute<?> addActions(Object value)
                           throws DmcValueException
```
    Adds another actions value.
    
    Parameters:
    
    value - A value compatible with DmcTypeActionDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getAllowedParents
```
public Iterator<ClassDefinitionREF> getAllowedParents()
```
    Indicates the classes of object that may be parents of the\n current class when objects are created in an instance hierarchy.
    
    Returns:
    
    the ClassDefinition
  - addAllowedParents
```
public DmcAttribute<?> addAllowedParents(Object value)
                                  throws DmcValueException
```
    Adds another allowedParents value.
    
    Parameters:
    
    value - A value compatible with DmcTypeClassDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getComment
```
public Iterator<String> getComment()
```
    A comment or note associated with the definition of something. For\n code that's generated from a definition, comments may be added to the code, as opposed to \n descriptions which are meant to assist in generating documentation. In the end, it's up to\n the designer of a DSL to determine how comments are used.
    
    Overrides:
    
    getComment in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addComment
```
public DmcAttribute<?> addComment(Object value)
                           throws DmcValueException
```
    Adds another comment value.
    
    Overrides:
    
    addComment in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getCreateIndex
```
public Boolean getCreateIndex()
```
    A flag to indicate if you want your data repository to create an index for a named object.
    
    Returns:
    
    the Boolean
  - setCreateIndex
```
public void setCreateIndex(Object value)
                    throws DmcValueException
```
    Sets createIndex to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDataType
```
public DataTypeEnum getDataType()
```
    This attribute indicates the persistence characteristics of an attribute or\n class of object. How this information is used is application dependent.
    
    Overrides:
    
    getDataType in class DmcObject
    
    Returns:
    
    the DataTypeEnum
  - setDataType
```
public void setDataType(Object value)
                 throws DmcValueException
```
    Sets dataType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDataTypeEnumSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDefinedIn
```
public SchemaDefinitionREF getDefinedIn()
```
    Indicates the schema in which a type, attribute or class is defined.
    
    Specified by:
    
    getDefinedIn in interface DmcDefinitionIF
    
    Overrides:
    
    getDefinedIn in class DmsDefinitionDMO
    
    Returns:
    
    the SchemaDefinition
  - setDefinedIn
```
public void setDefinedIn(Object value)
                  throws DmcValueException
```
    Sets definedIn to the specified value.
    
    Overrides:
    
    setDefinedIn in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeSchemaDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDerivedClasses
```
public Iterator<ClassDefinitionREF> getDerivedClasses()
```
    Indicates the classes that are known to be derived from a class.
    
    Returns:
    
    the ClassDefinition
  - addDerivedClasses
```
public DmcAttribute<?> addDerivedClasses(Object value)
                                  throws DmcValueException
```
    Adds another derivedClasses value.
    
    Parameters:
    
    value - A value compatible with DmcTypeClassDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDerivedFrom
```
public ClassDefinitionREF getDerivedFrom()
```
    Indicates the abstract or structural class from which this class is derived.
    
    Returns:
    
    the ClassDefinition
  - setDerivedFrom
```
public void setDerivedFrom(Object value)
                    throws DmcValueException
```
    Sets derivedFrom to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeClassDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDescription
```
public Iterator<String> getDescription()
```
    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 DmsDefinitionDMO
    
    Returns:
    
    the String
  - getDescriptionWithNewlines
```
public Iterator<String> getDescriptionWithNewlines()
```
    Overrides:
    
    getDescriptionWithNewlines in class DmsDefinitionDMO
  - addDescription
```
public DmcAttribute<?> addDescription(Object value)
                               throws DmcValueException
```
    Adds another description value.
    
    Overrides:
    
    addDescription in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmeClass
```
public String getDmeClass()
```
    This attribute indicates just the Dark Matter Extended (DME) class name.
    
    Returns:
    
    the String
  - setDmeClass
```
public void setDmeClass(Object value)
                 throws DmcValueException
```
    Sets dmeClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmeImport
```
public String getDmeImport()
```
    This attribute indicates the full name of the class that extends a DMW class.\n Dark Matter Extended (DME).
    
    Returns:
    
    the String
  - setDmeImport
```
public void setDmeImport(Object value)
                  throws DmcValueException
```
    Sets dmeImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmoAuxClass
```
public String getDmoAuxClass()
```
    This attribute indicates just the DMO class name e.g. MyClassAUXDMO
    
    Returns:
    
    the String
  - setDmoAuxClass
```
public void setDmoAuxClass(Object value)
                    throws DmcValueException
```
    Sets dmoAuxClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmoAuxClassImport
```
public String getDmoAuxClassImport()
```
    This attribute indicates the full name of the MyClassAUXDMO class
    
    Returns:
    
    the String
  - setDmoAuxClassImport
```
public void setDmoAuxClassImport(Object value)
                          throws DmcValueException
```
    Sets dmoAuxClassImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmoClass
```
public String getDmoClass()
```
    This attribute indicates just the DMO class name e.g. MyClassDMO
    
    Returns:
    
    the String
  - setDmoClass
```
public void setDmoClass(Object value)
                 throws DmcValueException
```
    Sets dmoClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmoFromModule
```
public String getDmoFromModule()
```
    A bit of a hack to allow for creation of fully qualified dot names\n in the DMODefinitionSet that's used for caching definitions in GWT. On the DMW side, this\n is taken care of by overloading the getNameOfModuleWhereThisCameFrom() to access the \n getDefinedInModule attribute and getting the name of the module.
    
    Overrides:
    
    getDmoFromModule in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setDmoFromModule
```
public void setDmoFromModule(Object value)
                      throws DmcValueException
```
    Sets dmoFromModule to the specified value.
    
    Overrides:
    
    setDmoFromModule in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmoImport
```
public String getDmoImport()
```
    This attribute indicates the full name of the generated Dark Matter Object (DMO)\n class (including package) that is generated for this class. The class will always have DmcObject\n at the top of its derivation hierarchy.
    
    Returns:
    
    the String
  - setDmoImport
```
public void setDmoImport(Object value)
                  throws DmcValueException
```
    Sets dmoImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmtClass
```
public String getDmtClass()
```
    This attribute indicates just the DmcType class name.
    
    Returns:
    
    the String
  - setDmtClass
```
public void setDmtClass(Object value)
                 throws DmcValueException
```
    Sets dmtClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmtImport
```
public String getDmtImport()
```
    This attribute indicates the full name of the DmcType class used to reference\n a class. These types are auto generated and named DmcTypeREF.
    
    Returns:
    
    the String
  - setDmtImport
```
public void setDmtImport(Object value)
                  throws DmcValueException
```
    Sets dmtImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmtREFImport
```
public String getDmtREFImport()
```
    This attribute indicates the full name of the class used to reference\n a class. These types are auto generated and named REF.
    
    Returns:
    
    the String
  - setDmtREFImport
```
public void setDmtREFImport(Object value)
                     throws DmcValueException
```
    Sets dmtREFImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwAuxClass
```
public String getDmwAuxClass()
```
    This attribute indicates just the DMO class name e.g. MyClassAUX
    
    Returns:
    
    the String
  - setDmwAuxClass
```
public void setDmwAuxClass(Object value)
                    throws DmcValueException
```
    Sets dmwAuxClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwAuxClassImport
```
public String getDmwAuxClassImport()
```
    This attribute indicates the full name of the MyClassAUX class
    
    Returns:
    
    the String
  - setDmwAuxClassImport
```
public void setDmwAuxClassImport(Object value)
                          throws DmcValueException
```
    Sets dmwAuxClassImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwClass
```
public String getDmwClass()
```
    This attribute indicates just the DMW class name, eg MyClassDMW
    
    Returns:
    
    the String
  - setDmwClass
```
public void setDmwClass(Object value)
                 throws DmcValueException
```
    Sets dmwClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwImport
```
public String getDmwImport()
```
    This attribute indicates the full name of the generated Dark Matter Wrapper (DMW)\n class (including package) that is wrapped by this class. The class will always be a derived class of\n DmwWrapperBase.
    
    Returns:
    
    the String
  - setDmwImport
```
public void setDmwImport(Object value)
                  throws DmcValueException
```
    Sets dmwImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwIteratorClass
```
public String getDmwIteratorClass()
```
    This attribute indicates just the DmcContainerIterator name for a\n class of object.
    
    Returns:
    
    the String
  - setDmwIteratorClass
```
public void setDmwIteratorClass(Object value)
                         throws DmcValueException
```
    Sets dmwIteratorClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwIteratorImport
```
public String getDmwIteratorImport()
```
    This attribute indicates the full name of the DmcContainerIterator \n derived class that allows us to iterate over a set of object references and get back\n the DMW wrapper object instead of the DMO.
    
    Returns:
    
    the String
  - setDmwIteratorImport
```
public void setDmwIteratorImport(Object value)
                          throws DmcValueException
```
    Sets dmwIteratorImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwWrapperType
```
public Iterator<DmwTypeToWrapperType> getDmwWrapperType()
```
    The dmwWrapperType is used to indicate whether or not you want extended wrappers\n when the wrappers are generated for an object in a particular generation context.
    
    Returns:
    
    the DmwTypeToWrapperType
  - addDmwWrapperType
```
public DmcAttribute<?> addDmwWrapperType(Object value)
                                  throws DmcValueException
```
    Adds another dmwWrapperType value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDmwTypeToWrapperTypeMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDotName
```
public DotName getDotName()
```
    The dotName attribute is used to store dot separated names.
    
    Specified by:
    
    getDotName in interface DmcDefinitionIF
    
    Overrides:
    
    getDotName in class DmsDefinitionDMO
    
    Returns:
    
    the DotName
  - setDotName
```
public void setDotName(Object value)
                throws DmcValueException
```
    Sets dotName to the specified value.
    
    Overrides:
    
    setDotName in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeDotNameSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDsdModuleDefinition
```
public DSDefinitionModuleREF getDsdModuleDefinition()
```
    The DSDefinitionModule that resulted in the creation of an\n internally generated ClassDefinition.
    
    Returns:
    
    the DSDefinitionModule
  - setDsdModuleDefinition
```
public void setDsdModuleDefinition(Object value)
                            throws DmcValueException
```
    Sets dsdModuleDefinition to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDSDefinitionModuleREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getExample
```
public Iterator<Example> getExample()
```
    The example attribute is used to provide additional\n examples of how some defined thing is to be used.
    
    Overrides:
    
    getExample in class DmsDefinitionDMO
    
    Returns:
    
    the Example
  - addExample
```
public DmcAttribute<?> addExample(Object value)
                           throws DmcValueException
```
    Adds another example value.
    
    Overrides:
    
    addExample in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeExampleMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getExcludeFromContext
```
public Iterator<String> getExcludeFromContext()
```
    The excludeFromContext attribute is used to indicate that\n a class of object (and all of its derivatives) should be excluded from the wrapper\n generation for the specified context. An example usage is in the Dark Matter Protocol\n where we don't want to generate wrappers for the message objects in a GXT context.
    
    Returns:
    
    the String
  - addExcludeFromContext
```
public DmcAttribute<?> addExcludeFromContext(Object value)
                                      throws DmcValueException
```
    Adds another excludeFromContext value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getFile
```
public String getFile()
```
    Indicates the file from which a definition was loaded.
    
    Overrides:
    
    getFile in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setFile
```
public void setFile(Object value)
             throws DmcValueException
```
    Sets file to the specified value.
    
    Overrides:
    
    setFile in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getHint
```
public String getHint()
```
    A short description of something that can be dumped as one line summary of something.\n For longer explanations, use the description attribute.
    
    Overrides:
    
    getHint in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setHint
```
public void setHint(Object value)
             throws DmcValueException
```
    Sets hint to the specified value.
    
    Overrides:
    
    setHint in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIntendedToExtend
```
public Iterator<ClassDefinitionREF> getIntendedToExtend()
```
    This attribute can be used on AUXILIARY classes to give a hint about their\n intended usage. For example, if you were extending schema definitions with some or your \n own attributes for some purpose, your auxiliary class could have intendedToExtend ClassDefinition.
    
    Returns:
    
    the ClassDefinition
  - addIntendedToExtend
```
public DmcAttribute<?> addIntendedToExtend(Object value)
                                    throws DmcValueException
```
    Adds another intendedToExtend value.
    
    Parameters:
    
    value - A value compatible with DmcTypeClassDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getInternalTypeRef
```
public TypeDefinitionREF getInternalTypeRef()
```
    Indicates the internal type that's generated for all ClassDefinitions. This\n is set automatically on ClassDefinitions as they are parsed.
    
    Returns:
    
    the TypeDefinition
  - setInternalTypeRef
```
public void setInternalTypeRef(Object value)
                        throws DmcValueException
```
    Sets internalTypeRef to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeTypeDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getInternallyGenerated
```
public Boolean getInternallyGenerated()
```
    This flag indicates if the associated definition was internally generated.\n This is the case for TypeDefinitions generated for ClassDefinitions and EnumDefinitions\n that allow for references to these objects.
    
    Returns:
    
    the Boolean
  - setInternallyGenerated
```
public void setInternallyGenerated(Object value)
                            throws DmcValueException
```
    Sets internallyGenerated to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIsDSDefinition
```
public Boolean getIsDSDefinition()
```
    Indicates if the class defined by a ClassDefinition and its derivatives are part\n of a domain specific set of definitions. For instance, the definitions associated with the meta schema are\n considered a set of domain specific definitions for defining data objects; the dark-matter Model View\n Whatever (MVW) definitions describe a set of domain specific concepts for defining aspects of a GWT\n application.\n
    \n A domain specific definition must be named by name and must have dotName as an attribute because the \n generated class will implement the DmcDefinitionIF which assumes that these attributes exist. This\n interface allows these definitions to be managed as part of a set of definitions.
    
    Returns:
    
    the Boolean
  - setIsDSDefinition
```
public void setIsDSDefinition(Object value)
                       throws DmcValueException
```
    Sets isDSDefinition to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIsNamedBy
```
public AttributeDefinitionREF getIsNamedBy()
```
    Indicates the attribute by which an object of some class is named.\n When this attribute is supplied in a ClassDefinition, the generated DMO class will\n indicate that it implements the DmcNamedObjectIF and its getObjectName() method\n will return the value of the isNamedBy attribute.
    
    Returns:
    
    the AttributeDefinition
  - setIsNamedBy
```
public void setIsNamedBy(Object value)
                  throws DmcValueException
```
    Sets isNamedBy to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeAttributeDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getJavaClass
```
public String getJavaClass()
```
    This attribute indicates the full name of the class (including package)\n that should be instantiated when an instance of an object is created via the\n DmdClassDef.newInstance() function. The class must be a derived class of\n DmdGenericObject.
    
    Returns:
    
    the String
  - setJavaClass
```
public void setJavaClass(Object value)
                  throws DmcValueException
```
    Sets javaClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getLineNumber
```
public Integer getLineNumber()
```
    Indicates the line number of the file from which a definition was loaded.
    
    Overrides:
    
    getLineNumber in class DmsDefinitionDMO
    
    Returns:
    
    the Integer
  - setLineNumber
```
public void setLineNumber(Object value)
                   throws DmcValueException
```
    Sets lineNumber to the specified value.
    
    Overrides:
    
    setLineNumber in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMay
```
public Iterator<AttributeDefinitionREF> 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(Object value)
                       throws DmcValueException
```
    Adds another may value.
    
    Parameters:
    
    value - A value compatible with DmcTypeAttributeDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMust
```
public Iterator<AttributeDefinitionREF> getMust()
```
    Indicates the set of attributes that an instance of a class MUST have.
    
    Returns:
    
    the AttributeDefinition
  - addMust
```
public DmcAttribute<?> addMust(Object value)
                        throws DmcValueException
```
    Adds another must value.
    
    Parameters:
    
    value - A value compatible with DmcTypeAttributeDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getNvp
```
public Iterator<NameValuePair> getNvp()
```
    A set of additional name value pairs that can be associated with an object.
    
    Overrides:
    
    getNvp in class DmsDefinitionDMO
    
    Returns:
    
    the NameValuePair
  - addNvp
```
public DmcAttribute<?> addNvp(Object value)
                       throws DmcValueException
```
    Adds another nvp value.
    
    Overrides:
    
    addNvp in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeNameValuePairMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObsolete
```
public String getObsolete()
```
    The version at which something became obsolete.
    
    Overrides:
    
    getObsolete in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setObsolete
```
public void setObsolete(Object value)
                 throws DmcValueException
```
    Sets obsolete to the specified value.
    
    Overrides:
    
    setObsolete in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObsoleteVersion
```
public String getObsoleteVersion()
```
    This indicates the version at which something became obsolete.\n Generally speaking you shouldn't ever delete definitions for products that have\n been released to the field, this may break backwards compatibility. Instead, you\n should mark them as obsolete.
    
    Returns:
    
    the String
  - setObsoleteVersion
```
public void setObsoleteVersion(Object value)
                        throws DmcValueException
```
    Sets obsoleteVersion to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getOptimize
```
public Iterator<String> getOptimize()
```
    Depending on what you're modelling, you often come across\n places where you can see an opportunity to optimize, streamline or improve something e.g. merging\n concepts together, representing something differently, adding a relationship - whatever.\n However, these ideas often get lost in the shuffle or, if you add them into an overall\n description of something, they don't stand out.\n
    \n Any dark-matter definition can be decorated with optimize notes. These notes provide
    
    Overrides:
    
    getOptimize in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addOptimize
```
public DmcAttribute<?> addOptimize(Object value)
                            throws DmcValueException
```
    Adds another optimize value.
    
    Overrides:
    
    addOptimize in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getPartOfDefinitionModule
```
public DSDefinitionModuleREF getPartOfDefinitionModule()
```
    For classes that defined as part of a definition module,\n this indicates the module they belong to. This allows for generation of a standard\n method to get the name of the module from which they were loaded.
    
    Returns:
    
    the DSDefinitionModule
  - setPartOfDefinitionModule
```
public void setPartOfDefinitionModule(Object value)
                               throws DmcValueException
```
    Sets partOfDefinitionModule to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDSDefinitionModuleREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getQuestion
```
public Iterator<String> getQuestion()
```
    A question associated with the definition of something.
    
    Overrides:
    
    getQuestion in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addQuestion
```
public DmcAttribute<?> addQuestion(Object value)
                            throws DmcValueException
```
    Adds another question value.
    
    Overrides:
    
    addQuestion in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRelatedToConcept
```
public Iterator<ConcinnityREF> getRelatedToConcept()
```
    Allows for references to base concepts that relate this\n definition to another definition in the Concinnity domain. This mechanism is only used\n in the domain of dark-matter schema definitions; other DSLs will allow for direct\n reference to Concinnity concepts.
    
    Overrides:
    
    getRelatedToConcept in class DmsDefinitionDMO
    
    Returns:
    
    the Concinnity
  - addRelatedToConcept
```
public DmcAttribute<?> addRelatedToConcept(Object value)
                                    throws DmcValueException
```
    Adds another relatedToConcept value.
    
    Overrides:
    
    addRelatedToConcept in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeConcinnityREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRelationship
```
public String getRelationship()
```
    The name of the relationship established via a reference to some other named object.\n
    \n This is a minor hack to allow creation of named relationships in graph databases. Eventually, relationships\n will become first class objects to which you can refer.
    
    Overrides:
    
    getRelationship in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setRelationship
```
public void setRelationship(Object value)
                     throws DmcValueException
```
    Sets relationship to the specified value.
    
    Overrides:
    
    setRelationship in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRuleDefinition
```
public RuleDefinitionREF getRuleDefinition()
```
    The RuleDefinition that resulted in the creation of an\n internally generated ClassDefinition.
    
    Returns:
    
    the RuleDefinition
  - setRuleDefinition
```
public void setRuleDefinition(Object value)
                       throws DmcValueException
```
    Sets ruleDefinition to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeRuleDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSearchable
```
public Boolean getSearchable()
```
    Indicates if something is searchable.
    
    Overrides:
    
    getSearchable in class DmsDefinitionDMO
    
    Returns:
    
    the Boolean
  - setSearchable
```
public void setSearchable(Object value)
                   throws DmcValueException
```
    Sets searchable to the specified value.
    
    Overrides:
    
    setSearchable in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSkip
```
public Iterator<String> getSkip()
```
    A version from which something should be excluded (even though it is included\n in later versions). This is an unusual situation, and should be approached with extreme caution!
    
    Overrides:
    
    getSkip in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addSkip
```
public DmcAttribute<?> addSkip(Object value)
                        throws DmcValueException
```
    Adds another skip value.
    
    Overrides:
    
    addSkip in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSortName
```
public DotName getSortName()
```
    The sortName is used in siutations where we need a name\n for storage of a definition that is globally unique but can be sorted on the basis\n of the definition name, not the module name. The dotName for a definition is\n module.definition...type, whereas the sortName would be definition...module.type.\n So, for things like documentation generation, the sortName provides a more \n natural ordering.
    
    Overrides:
    
    getSortName in class DmsDefinitionDMO
    
    Returns:
    
    the DotName
  - setSortName
```
public void setSortName(Object value)
                 throws DmcValueException
```
    Sets sortName to the specified value.
    
    Overrides:
    
    setSortName in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeDotNameSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSubpackage
```
public String getSubpackage()
```
    The subpackage beneath extended where generated code will be written. This\n allows for a hierarchic package structure for the classes generated by the dmg and mvc generator\n utilities. The structure can contain other subpackages etc x.y.z but should not start or end\n with a period.
    
    Returns:
    
    the String
  - setSubpackage
```
public void setSubpackage(Object value)
                   throws DmcValueException
```
    Sets subpackage to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSupportsBackrefTracking
```
public Boolean getSupportsBackrefTracking()
```
    Indicates if a class of objects supports back reference tracking or not. The\n default is that all objects support it, however, in places like the Dark Matter Protocol, we\n don't want to track references in the messages.
    
    Returns:
    
    the Boolean
  - setSupportsBackrefTracking
```
public void setSupportsBackrefTracking(Object value)
                                throws DmcValueException
```
    Sets supportsBackrefTracking to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getTags
```
public Iterator<String> getTags()
```
    A collection of tags that can facilitate searching for\n definitions. The values are limited to a-zA-Z0-9 and the space character.
    
    Overrides:
    
    getTags in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addTags
```
public DmcAttribute<?> addTags(Object value)
                        throws DmcValueException
```
    Adds another tags value.
    
    Overrides:
    
    addTags in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getUseWrapperType
```
public WrapperTypeEnum getUseWrapperType()
```
    Indicates whether you want to use the generated DMW wrapper\n or the extended wrapper you've created yourself.
    
    Returns:
    
    the WrapperTypeEnum
  - setUseWrapperType
```
public void setUseWrapperType(Object value)
                       throws DmcValueException
```
    Sets useWrapperType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeWrapperTypeEnumSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getUsesInterface
```
public String getUsesInterface()
```
    This is a hack for now to allow for the inclusion of an \n interface on a class; it should be the fully qualified name of the interface.\n The interface shouldn't require any method implementations.
    
    Returns:
    
    the String
  - setUsesInterface
```
public void setUsesInterface(Object value)
                      throws DmcValueException
```
    Sets usesInterface to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getUsesWrapperInterface
```
public Iterator<String> getUsesWrapperInterface()
```
    The fully qualified name of a Java interface that should\n be implemented on an extended wrapper class. This is a useful mechanism to specify\n common functionality across a set of classes that, otherwise, may not have anything in\n common i.e. they aren't in the same derivation hierarchy.\n
    \n This results in an implements statement being added to the DmwWrapper derivative.
    
    Returns:
    
    the String
  - addUsesWrapperInterface
```
public DmcAttribute<?> addUsesWrapperInterface(Object value)
                                        throws DmcValueException
```
    Adds another usesWrapperInterface value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getVersion
```
public String getVersion()
```
    The version at which something was introduced. Version names\n are assumed to be lexicographically sortable i.e. the name of a version must have a nautral\n sort order that increases.
    
    Overrides:
    
    getVersion in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setVersion
```
public void setVersion(Object value)
                throws DmcValueException
```
    Sets version to the specified value.
    
    Overrides:
    
    setVersion in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getWhy
```
public ConcinnityREF getWhy()
```
    An indication of why something was added to a specification or a system.\n This might be a reference to a requirement or feature concept. How this is used will depend on context.\n Due to the fact that it is a weak reference, you may also just put in free form text, since it\n will simply be treated as an unresolved reference.
    
    Overrides:
    
    getWhy in class DmsDefinitionDMO
    
    Returns:
    
    the Concinnity
  - setWhy
```
public void setWhy(Object value)
            throws DmcValueException
```
    Sets why to the specified value.
    
    Overrides:
    
    setWhy in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeConcinnityREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObjectName
```
public DefinitionName getObjectName()
```
    Specified by:
    
    getObjectName in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectName in class DmsDefinitionDMO
    
    Returns:
    
    The name of this object from the name attribute.
  - getObjectNameAttribute
```
public DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectNameAttribute in class DmsDefinitionDMO
    
    Returns:
    
    The name attribute.

Class ClassDefinitionDMO

Field Summary

Fields inherited from class org.dmd.dmc.DmcObject

Constructor Summary

Method Summary

Methods inherited from class org.dmd.dmc.DmcObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

Constructor Detail

ClassDefinitionDMO

ClassDefinitionDMO

Method Detail

getIdToAttrInfo

getStringToAttrInfo

getNew

getSlice

getClassType

setClassType

getDmdID

setDmdID

getName

setName

getAbbrev

setAbbrev

getActions

addActions

getAllowedParents

addAllowedParents

getComment

addComment

getCreateIndex

setCreateIndex

getDataType

setDataType

getDefinedIn

setDefinedIn

getDerivedClasses

addDerivedClasses

getDerivedFrom

setDerivedFrom

getDescription

getDescriptionWithNewlines

addDescription

getDmeClass

setDmeClass

getDmeImport

setDmeImport

getDmoAuxClass

setDmoAuxClass

getDmoAuxClassImport

setDmoAuxClassImport

getDmoClass

setDmoClass

getDmoFromModule

setDmoFromModule

getDmoImport

setDmoImport

getDmtClass

setDmtClass

getDmtImport

setDmtImport

getDmtREFImport

setDmtREFImport

getDmwAuxClass

setDmwAuxClass

getDmwAuxClassImport

setDmwAuxClassImport

getDmwClass

setDmwClass

getDmwImport

setDmwImport

getDmwIteratorClass

setDmwIteratorClass

getDmwIteratorImport

setDmwIteratorImport

getDmwWrapperType

addDmwWrapperType

getDotName

setDotName