ClassDefinitionDMW (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.DmcContainer
- - org.dmd.dmw.DmwWrapper
  - - org.dmd.dmw.DmwNamedObjectWrapper
    - - org.dmd.dms.generated.dmw.DSDefinitionDMW
      - org.dmd.dms.DSDefinition
        
        org.dmd.dms.generated.dmw.DmsDefinitionDMW
        
        org.dmd.dms.DmsDefinition
        
        org.dmd.dms.generated.dmw.ClassDefinitionDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

ClassDefinition
```
public class ClassDefinitionDMW
extends DmsDefinition
implements DmcDefinitionIF
```
This class provides the basic mechanism to define new classes for a schema.

Author:

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

Field Summary
- Fields inherited from class org.dmd.dms.DmsDefinition
  metaname
- Fields inherited from class org.dmd.dmc.DmcContainer
  core

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ClassDefinitionDMW()`
`protected`	`ClassDefinitionDMW(ClassDefinition cd)`
`protected`	`ClassDefinitionDMW(DmcObject obj)`
`protected`	`ClassDefinitionDMW(DmcObject obj, ClassDefinition cd)`
`protected`	`ClassDefinitionDMW(String mn)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DmcAttribute<?>`	`addActions(ActionDefinition value)` Adds another actions value.
`DmcAttribute<?>`	`addAllowedParents(ClassDefinition value)` Adds another allowedParents value.
`DmcAttribute<?>`	`addDerivedClasses(ClassDefinition value)` Adds another derivedClasses value.
`void`	`addDescription(Object value)` Adds another description value.
`void`	`addDmwWrapperType(Object value)` Adds another dmwWrapperType value.
`void`	`addExcludeFromContext(Object value)` Adds another excludeFromContext value.
`DmcAttribute<?>`	`addIntendedToExtend(ClassDefinition value)` Adds another intendedToExtend value.
`DmcAttribute<?>`	`addMay(AttributeDefinition value)` Adds another may value.
`DmcAttribute<?>`	`addMust(AttributeDefinition value)` Adds another must value.
`void`	`addUsesWrapperInterface(Object value)` Adds another usesWrapperInterface value.
`String`	`getAbbrev()` This attribute stores an abbreviated form of the name of an attribute or class.
`ActionDefinitionIterableDMW`	`getActions()` Indicates the set of actions that are supported by a class of objects.
`int`	`getActionsSize()`
`ClassDefinitionIterableDMW`	`getAllowedParents()` Indicates the classes of object that may be parents of the\n current class when objects are created in an instance hierarchy.
`int`	`getAllowedParentsSize()`
`ClassTypeEnum`	`getClassType()` This attribute indicates the type of a class definition.
`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.
`ClassDefinitionIterableDMW`	`getDerivedClasses()` Indicates the classes that are known to be derived from a class.
`int`	`getDerivedClassesSize()`
`ClassDefinition`	`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.
`int`	`getDescriptionSize()`
`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).
`ClassDefinitionDMO`	`getDMO()`
`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`	`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.
`int`	`getDmwWrapperTypeSize()`
`DSDefinitionModule`	`getDsdModuleDefinition()` The DSDefinitionModule that resulted in the creation of an\n internally generated ClassDefinition.
`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.
`int`	`getExcludeFromContextSize()`
`ClassDefinitionIterableDMW`	`getIntendedToExtend()` This attribute can be used on AUXILIARY classes to give a hint about their\n intended usage.
`int`	`getIntendedToExtendSize()`
`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.
`TypeDefinition`	`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.
`AttributeDefinition`	`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.
`AttributeDefinitionIterableDMW`	`getMay()` Indicates the set of attributes that an instance of a class MAY\n have.
`int`	`getMaySize()`
`AttributeDefinitionIterableDMW`	`getMust()` Indicates the set of attributes that an instance of a class MUST have.
`int`	`getMustSize()`
`DefinitionName`	`getName()` The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part.
`DefinitionName`	`getObjectName()`
`DmcAttribute<?>`	`getObjectNameAttribute()`
`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.
`DSDefinitionModule`	`getPartOfDefinitionModule()` For classes that defined as part of a definition module,\n this indicates the module they belong to.
`RuleDefinition`	`getRuleDefinition()` The RuleDefinition that resulted in the creation of an\n internally generated ClassDefinition.
`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.
`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.
`int`	`getUsesWrapperInterfaceSize()`
`WrapperTypeEnum`	`getUseWrapperType()` Indicates whether you want to use the generated DMW wrapper\n or the extended wrapper you've created yourself.
`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`	`setDerivedFrom(ClassDefinition value)` Sets derivedFrom to the specified value.
`void`	`setDmcObject(DmcObject obj)` Sets the core object.
`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`	`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`	`setDsdModuleDefinition(DSDefinitionModule value)` Sets dsdModuleDefinition to the specified value.
`void`	`setInternallyGenerated(Object value)` Sets internallyGenerated to the specified value.
`void`	`setInternalTypeRef(TypeDefinition value)` Sets internalTypeRef to the specified value.
`void`	`setIsDSDefinition(Object value)` Sets isDSDefinition to the specified value.
`void`	`setIsNamedBy(AttributeDefinition value)` Sets isNamedBy to the specified value.
`void`	`setJavaClass(Object value)` Sets javaClass to the specified value.
`void`	`setName(Object value)` Sets name to the specified value.
`void`	`setObsoleteVersion(Object value)` Sets obsoleteVersion to the specified value.
`void`	`setPartOfDefinitionModule(DSDefinitionModule value)` Sets partOfDefinitionModule to the specified value.
`void`	`setRuleDefinition(RuleDefinition value)` Sets ruleDefinition 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.

Methods inherited from class org.dmd.dms.DmsDefinition
getDmcObject

Methods inherited from class org.dmd.dms.generated.dmw.DmsDefinitionDMW
addRelatedToConcept, getRelatedToConcept, getRelatedToConceptSize

Methods inherited from class org.dmd.dms.DSDefinition
equals, getFullDotName, getNameOfModuleWhereThisCameFrom

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW
addComment, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDefinedIn, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper
addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer
getDeleted, getModifier, setDeleted, setModifier

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

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF
getDefinedIn, getDotName, toOIF

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

- Constructor Detail
  - ClassDefinitionDMW
```
protected ClassDefinitionDMW()
```
  - ClassDefinitionDMW
```
protected ClassDefinitionDMW(DmcObject obj)
```
  - ClassDefinitionDMW
```
protected ClassDefinitionDMW(DmcObject obj,
                             ClassDefinition cd)
```
  - ClassDefinitionDMW
```
protected ClassDefinitionDMW(ClassDefinition cd)
```
  - ClassDefinitionDMW
```
protected ClassDefinitionDMW(String mn)
                      throws DmcValueException
```
    Throws:
    
    DmcValueException
- Method Detail
  - setDmcObject
```
public void setDmcObject(DmcObject obj)
```
    Description copied from class: DmcContainer
    
    Sets the core object.
    
    Specified by:
    
    setDmcObject in interface DmcContainerIF
    
    Overrides:
    
    setDmcObject in class DmsDefinition
    
    Parameters:
    
    obj - The core object.
  - getDMO
```
public ClassDefinitionDMO getDMO()
```
    Overrides:
    
    getDMO in class DmsDefinitionDMW
  - getName
```
public DefinitionName getName()
```
    The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part. A name starts with a letter followed\n by letters and numbers.
    
    Specified by:
    
    getName in interface DmcDefinitionIF
    
    Overrides:
    
    getName in class DmsDefinitionDMW
    
    Returns:
    
    the DefinitionName
  - setName
```
public void setName(Object value)
             throws DmcValueException
```
    Sets name to the specified value.
    
    Overrides:
    
    setName in class DmsDefinitionDMW
    
    Parameters:
    
    value - A value compatible with DmcTypeDefinitionNameSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - 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
  - 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 DSDefinitionDMW
    
    Returns:
    
    the String
  - getDescriptionWithNewlines
```
public Iterator<String> getDescriptionWithNewlines()
```
    Overrides:
    
    getDescriptionWithNewlines in class DSDefinitionDMW
  - addDescription
```
public void addDescription(Object value)
                    throws DmcValueException
```
    Adds another description value.
    
    Overrides:
    
    addDescription in class DSDefinitionDMW
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDescriptionSize
```
public int getDescriptionSize()
```
    Overrides:
    
    getDescriptionSize in class DSDefinitionDMW
    
    Returns:
    
    the number of description values.
  - getDerivedFrom
```
public ClassDefinition getDerivedFrom()
```
    Indicates the abstract or structural class from which this class is derived.
    
    Returns:
    
    the ClassDefinition
  - setDerivedFrom
```
public void setDerivedFrom(ClassDefinition value)
                    throws DmcValueException
```
    Sets derivedFrom to the specified value.
    
    Parameters:
    
    value - A value compatible with ClassDefinition
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMust
```
public AttributeDefinitionIterableDMW getMust()
```
    Indicates the set of attributes that an instance of a class MUST have.
    
    Returns:
    
    the AttributeDefinition
  - addMust
```
public DmcAttribute<?> addMust(AttributeDefinition value)
                        throws DmcValueException
```
    Adds another must value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinition
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMustSize
```
public int getMustSize()
```
    Returns:
    
    the number of must values.
  - getMay
```
public AttributeDefinitionIterableDMW getMay()
```
    Indicates the set of attributes that an instance of a class MAY\n have. When accessed in Java, this is a set of references to AttributeDefinition\n objects.
    
    Returns:
    
    the AttributeDefinition
  - addMay
```
public DmcAttribute<?> addMay(AttributeDefinition value)
                       throws DmcValueException
```
    Adds another may value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinition
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getMaySize
```
public int getMaySize()
```
    Returns:
    
    the number of may values.
  - getIsNamedBy
```
public AttributeDefinition 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(AttributeDefinition value)
                  throws DmcValueException
```
    Sets isNamedBy to the specified value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinition
    
    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
  - getIntendedToExtend
```
public ClassDefinitionIterableDMW 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(ClassDefinition value)
                                    throws DmcValueException
```
    Adds another intendedToExtend value.
    
    Parameters:
    
    value - A value compatible with ClassDefinition
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIntendedToExtendSize
```
public int getIntendedToExtendSize()
```
    Returns:
    
    the number of intendedToExtend values.
  - 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 void addUsesWrapperInterface(Object value)
                             throws DmcValueException
```
    Adds another usesWrapperInterface value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getUsesWrapperInterfaceSize
```
public int getUsesWrapperInterfaceSize()
```
    Returns:
    
    the number of usesWrapperInterface values.
  - 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
  - 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 void addDmwWrapperType(Object value)
                       throws DmcValueException
```
    Adds another dmwWrapperType value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDmwTypeToWrapperTypeMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwWrapperTypeSize
```
public int getDmwWrapperTypeSize()
```
    Returns:
    
    the number of dmwWrapperType values.
  - getAllowedParents
```
public ClassDefinitionIterableDMW 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(ClassDefinition value)
                                  throws DmcValueException
```
    Adds another allowedParents value.
    
    Parameters:
    
    value - A value compatible with ClassDefinition
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getAllowedParentsSize
```
public int getAllowedParentsSize()
```
    Returns:
    
    the number of allowedParents values.
  - 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
  - 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.
    
    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
  - 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
  - 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 void addExcludeFromContext(Object value)
                           throws DmcValueException
```
    Adds another excludeFromContext value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getExcludeFromContextSize
```
public int getExcludeFromContextSize()
```
    Returns:
    
    the number of excludeFromContext values.
  - 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
  - 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
  - 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
  - getPartOfDefinitionModule
```
public DSDefinitionModule 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(DSDefinitionModule value)
                               throws DmcValueException
```
    Sets partOfDefinitionModule to the specified value.
    
    Parameters:
    
    value - A value compatible with DSDefinitionModule
    
    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
  - 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
  - getRuleDefinition
```
public RuleDefinition getRuleDefinition()
```
    The RuleDefinition that resulted in the creation of an\n internally generated ClassDefinition.
    
    Returns:
    
    the RuleDefinition
  - setRuleDefinition
```
public void setRuleDefinition(RuleDefinition value)
                       throws DmcValueException
```
    Sets ruleDefinition to the specified value.
    
    Parameters:
    
    value - A value compatible with RuleDefinition
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDsdModuleDefinition
```
public DSDefinitionModule getDsdModuleDefinition()
```
    The DSDefinitionModule that resulted in the creation of an\n internally generated ClassDefinition.
    
    Returns:
    
    the DSDefinitionModule
  - setDsdModuleDefinition
```
public void setDsdModuleDefinition(DSDefinitionModule value)
                            throws DmcValueException
```
    Sets dsdModuleDefinition to the specified value.
    
    Parameters:
    
    value - A value compatible with DSDefinitionModule
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDerivedClasses
```
public ClassDefinitionIterableDMW getDerivedClasses()
```
    Indicates the classes that are known to be derived from a class.
    
    Returns:
    
    the ClassDefinition
  - addDerivedClasses
```
public DmcAttribute<?> addDerivedClasses(ClassDefinition value)
                                  throws DmcValueException
```
    Adds another derivedClasses value.
    
    Parameters:
    
    value - A value compatible with ClassDefinition
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDerivedClassesSize
```
public int getDerivedClassesSize()
```
    Returns:
    
    the number of derivedClasses values.
  - getActions
```
public ActionDefinitionIterableDMW getActions()
```
    Indicates the set of actions that are supported by a class of objects.
    
    Returns:
    
    the ActionDefinition
  - addActions
```
public DmcAttribute<?> addActions(ActionDefinition value)
                           throws DmcValueException
```
    Adds another actions value.
    
    Parameters:
    
    value - A value compatible with ActionDefinition
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getActionsSize
```
public int getActionsSize()
```
    Returns:
    
    the number of actions values.
  - getInternalTypeRef
```
public TypeDefinition 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(TypeDefinition value)
                        throws DmcValueException
```
    Sets internalTypeRef to the specified value.
    
    Parameters:
    
    value - A value compatible with TypeDefinition
    
    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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - getObjectName
```
public DefinitionName getObjectName()
```
    Specified by:
    
    getObjectName in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectName in class DmsDefinition
    
    Returns:
    
    The name of this object from the name attribute.
  - getObjectNameAttribute
```
public DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectNameAttribute in class DmsDefinitionDMW
    
    Returns:
    
    The name attribute.

Class ClassDefinitionDMW

Field Summary

Fields inherited from class org.dmd.dms.DmsDefinition

Fields inherited from class org.dmd.dmc.DmcContainer

Constructor Summary

Method Summary

Methods inherited from class org.dmd.dms.DmsDefinition

Methods inherited from class org.dmd.dms.generated.dmw.DmsDefinitionDMW

Methods inherited from class org.dmd.dms.DSDefinition

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW

Methods inherited from class org.dmd.dmw.DmwWrapper

Methods inherited from class org.dmd.dmc.DmcContainer

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

ClassDefinitionDMW

ClassDefinitionDMW

ClassDefinitionDMW

ClassDefinitionDMW

ClassDefinitionDMW

Method Detail

setDmcObject

getDMO

getName

setName

getClassType

setClassType

getDmdID

setDmdID

getDescription

getDescriptionWithNewlines

addDescription

getDescriptionSize

getDerivedFrom

setDerivedFrom

getMust

addMust

getMustSize

getMay

addMay

getMaySize

getIsNamedBy

setIsNamedBy

getJavaClass

setJavaClass

getIntendedToExtend

addIntendedToExtend

getIntendedToExtendSize

getUsesInterface

setUsesInterface

getUsesWrapperInterface

addUsesWrapperInterface

getUsesWrapperInterfaceSize

getUseWrapperType

setUseWrapperType

getDmwWrapperType

addDmwWrapperType

getDmwWrapperTypeSize

getAllowedParents

addAllowedParents

getAllowedParentsSize

getSubpackage

setSubpackage

getDataType

setDataType

getSupportsBackrefTracking

setSupportsBackrefTracking

getExcludeFromContext

addExcludeFromContext

getExcludeFromContextSize

getAbbrev

setAbbrev

getObsoleteVersion

setObsoleteVersion

getIsDSDefinition

setIsDSDefinition

getPartOfDefinitionModule

setPartOfDefinitionModule

getCreateIndex