TypeDefinitionDMW (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.TypeDefinitionDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

TypeDefinition
```
public class TypeDefinitionDMW
extends DmsDefinition
implements DmcDefinitionIF
```
The TypeDefinition is used to define the types of attributes that can be used\n as the basis for attribute values. The name of the type definition should be the same as the\n actual Java class that is used to store the value of an attribute e.g. the name of the type\n used to store strings is String. The typeClassName is the fully qualified name of the class\n derived from DmcAttribute that stores this type of value; they are always, by convention,\n named DmcTypeXXX.\n
\n TypeDefinitions are automatically generated internally for ClassDefinitions, \n ComplexTypeDefinitions, ExtendedReferenceTypeDefinitions and\n EnumDefinitions so that these objects can be referred to via the type attribute of AttributeDefinitions.\n These definitions are marked as internallyGenerated .\n
\n The simplest TypeDefinition would look something like:\n
```
\n TypeDefinition\n name           String\n typeClassName 
 org.dmd.dmc.types.DmcTypeString\n description    Provides support for
 String values.\n 
```
\n This form would be used for attribute types whose base type originates in java.lang.\n The dark-matter base types include: Boolean, Byte, Double, Float, Integer, Long, Short and String.\n
\n TypeDefinitions also support the concept of specifying a nullReturnValue \n for the entire type i.e. whenever an attribute of the specified type is accessed, it will return\n that value when the attribute doesn't exist in the object. An example of this is the Boolean type:\n
```
\n TypeDefinition\n name  
          Boolean\n typeClassName   org.dmd.dmc.types.DmcTypeBoolean\n
 nullReturnValue false\n description     Provides support for Boolean
 values. This type makes use of the\n                 nullReturnValue flag
 so that, even if there is no\n                 value for an attribute of
 this type, a value of false will\n                 be returned.\n 
```
\n
\n The next most common form of TypeDefinition adds the primitiveType \n attribute. This is required for code generation so that we can import the appropriate type for\n use in the various getter/setter methods. An example would be the Date type.\n
```
\n TypeDefinition\n name           Date\n typeClassName 
 org.dmd.dmc.types.DmcTypeDate\n primitiveType  java.util.Date\n
 description    Provides support for Date values.\n 
```
\n Another common form of TypeDefinition is the definition of a name type. Object\n naming is a fundamental aspect of DMOs, with all object names being based on the DmcObjectName.\n Flagging a type as being a name type also implies the definition of a designated naming attribute\n associated with the type. This mechanism allows for the transport of names that are self\n describing in terms of their implementation type. This feature supports the NameContainer\n type that allows any name to be transported in things like dark-matter protocol GetRequest.\n An example of a naming type would be:\n
```
\n
 TypeDefinition\n name           CamelCaseName\n typeClassName 
 org.dmd.dmc.types.DmcTypeCamelCaseName\n primitiveType 
 org.dmd.dmc.types.CamelCaseName\n isNameType     true\n description    The
 CamelCaseName is a string based name that must start with\n               
 an alpha character which is followed by a mix of alphanumerics.\n 
```
\n And its associated designated naming attribute would be:\n
```
\n
 AttributeDefinition\n name                     camelCaseName\n dmdID      
              116\n type                     CamelCaseName\n
 designatedNameAttribute  true\n description              The camelCaseName
 attribute is used to store a single camelCase\n                         
 format name for something. The name starts with a single letter\n         
                 and can be followed by a mix of letters and numbers. No
 spaces or \n                          other characters are allowed.\n
 
```
\n The last form of type definition is one that includes some additional information to provide\n a convenient, alternate interface for the generation of member functions associated with\n a container type; this concept is pretty much limited to the meta-schema, so it is unlikely\n that non-contributors to dark-matter will make use of this concept. However, here is an example:\n
```
\n TypeDefinition\n name     
      NameContainer\n typeClassName 
 org.dmd.dmc.types.DmcTypeNameContainer\n primitiveType 
 org.dmd.dmc.types.NameContainer\n altType        DmcObjectName\n
 altTypeImport  org.dmd.dmc.DmcObjectName\n description    The
 NameContainer type allows for the storage of object names of different
 types...\n 
```
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`	`TypeDefinitionDMW()`
`protected`	`TypeDefinitionDMW(ClassDefinition cd)`
`protected`	`TypeDefinitionDMW(DmcObject obj)`
`protected`	`TypeDefinitionDMW(DmcObject obj, ClassDefinition cd)`
`protected`	`TypeDefinitionDMW(String mn)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDescription(Object value)` Adds another description value.
`String`	`getAltType()` The altType indicates an alternate type for a value.
`String`	`getAltTypeImport()` An additional import (if required) by the altType attribute value.
`Iterator<String>`	`getDescription()` The description attribute is used to provide descriptive\n documentation for schema related definitions.
`int`	`getDescriptionSize()`
`Iterator<String>`	`getDescriptionWithNewlines()`
`TypeDefinitionDMO`	`getDMO()`
`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.
`String`	`getEnumName()` The original name of an enum as referred to in the internally generated type for enums.
`AttributeDefinition`	`getFilterAttributeDef()` The filterAttributeDef is a reference to the attribute that is locked\n to a TypeDefinition that is flagged as filterType.
`String`	`getGenericArgs()` This attribute indicates the generic arguments to be supplied in the\n use of a class in an autogenerated Iterable.
`String`	`getHelperClassName()` This attribute indicates the full name of the generated helper class for \n object references i.e.
`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.
`Boolean`	`getIsEnumType()` This flag is set to true for type definitions that define enumerations.
`Boolean`	`getIsExtendedRefType()` This flag is used to indicate taht an internally generated type\n is an extended reference type.
`Boolean`	`getIsFilterType()` Indicates that a type is derived from DmcFilter.
`Boolean`	`getIsHierarchicName()` Indicates if a name type is for hierarchic objects.
`Boolean`	`getIsNameType()` This attribute indicates if a defined type is used for naming purposes.\n This allows us to automatically add attributes of this type to the AttributeFactories.
`Boolean`	`getIsRefType()` This flag is set to true for type definitions that refer to other\n objects.
`String`	`getKeyClass()` This attribute indicates the class of the key used for types that support\n storage in a MAP.
`String`	`getKeyImport()` Indicates the import for a keyClass.
`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.
`AttributeDefinition`	`getNameAttributeDef()` The nameAttributeDef is a reference to the attribute that is locked\n to a TypeDefinition.
`String`	`getNullReturnValue()` This attribute is used in TypeDefinitions to indicate the value that should be returned when\n an attribute of the specified type doesn't exist in the object.
`Boolean`	`getNumericOrBoolean()` When we perform toJSON() operations, we need to know whether to quote\n values.
`DefinitionName`	`getObjectName()`
`DmcAttribute<?>`	`getObjectNameAttribute()`
`ClassDefinition`	`getOriginalClass()` Refers to the class that an internally generated type represents.
`String`	`getPrimitiveType()` The primitiveType indicates the underlying type of a DmcType.
`String`	`getTypeClassName()` This is the fully qualified name of the class derived from DmcAttribute that provides management\n of a particular type of attribute value.
`String`	`getWrapperClassName()` This is the fully qualified name of the wrapper class derived from DmcWrapperBase that\n wraps a DMO.
`void`	`setAltType(Object value)` Sets altType to the specified value.
`void`	`setAltTypeImport(Object value)` Sets altTypeImport to the specified value.
`void`	`setDmcObject(DmcObject obj)` Sets the core object.
`void`	`setDmwIteratorClass(Object value)` Sets dmwIteratorClass to the specified value.
`void`	`setDmwIteratorImport(Object value)` Sets dmwIteratorImport to the specified value.
`void`	`setEnumName(Object value)` Sets enumName to the specified value.
`void`	`setFilterAttributeDef(AttributeDefinition value)` Sets filterAttributeDef to the specified value.
`void`	`setGenericArgs(Object value)` Sets genericArgs to the specified value.
`void`	`setHelperClassName(Object value)` Sets helperClassName to the specified value.
`void`	`setInternallyGenerated(Object value)` Sets internallyGenerated to the specified value.
`void`	`setIsEnumType(Object value)` Sets isEnumType to the specified value.
`void`	`setIsExtendedRefType(Object value)` Sets isExtendedRefType to the specified value.
`void`	`setIsFilterType(Object value)` Sets isFilterType to the specified value.
`void`	`setIsHierarchicName(Object value)` Sets isHierarchicName to the specified value.
`void`	`setIsNameType(Object value)` Sets isNameType to the specified value.
`void`	`setIsRefType(Object value)` Sets isRefType to the specified value.
`void`	`setKeyClass(Object value)` Sets keyClass to the specified value.
`void`	`setKeyImport(Object value)` Sets keyImport to the specified value.
`void`	`setName(Object value)` Sets name to the specified value.
`void`	`setNameAttributeDef(AttributeDefinition value)` Sets nameAttributeDef to the specified value.
`void`	`setNullReturnValue(Object value)` Sets nullReturnValue to the specified value.
`void`	`setNumericOrBoolean(Object value)` Sets numericOrBoolean to the specified value.
`void`	`setOriginalClass(ClassDefinition value)` Sets originalClass to the specified value.
`void`	`setPrimitiveType(Object value)` Sets primitiveType to the specified value.
`void`	`setTypeClassName(Object value)` Sets typeClassName to the specified value.
`void`	`setWrapperClassName(Object value)` Sets wrapperClassName 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, equals, 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
  - TypeDefinitionDMW
```
protected TypeDefinitionDMW()
```
  - TypeDefinitionDMW
```
protected TypeDefinitionDMW(DmcObject obj)
```
  - TypeDefinitionDMW
```
protected TypeDefinitionDMW(DmcObject obj,
                            ClassDefinition cd)
```
  - TypeDefinitionDMW
```
protected TypeDefinitionDMW(ClassDefinition cd)
```
  - TypeDefinitionDMW
```
protected TypeDefinitionDMW(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 TypeDefinitionDMO 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
  - getTypeClassName
```
public String getTypeClassName()
```
    This is the fully qualified name of the class derived from DmcAttribute that provides management\n of a particular type of attribute value. For instance, the type class that handles String attributes \n is org.dmd.dmc.types.DmcTypeString
    
    Returns:
    
    the String
  - setTypeClassName
```
public void setTypeClassName(Object value)
                      throws DmcValueException
```
    Sets typeClassName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    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.
  - getPrimitiveType
```
public String getPrimitiveType()
```
    The primitiveType indicates the underlying type of a DmcType.
    
    Returns:
    
    the String
  - setPrimitiveType
```
public void setPrimitiveType(Object value)
                      throws DmcValueException
```
    Sets primitiveType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getNullReturnValue
```
public String getNullReturnValue()
```
    This attribute is used in TypeDefinitions to indicate the value that should be returned when\n an attribute of the specified type doesn't exist in the object. For example, Boolean values are defined\n to return false when they aren't actually set on an object. This just gives a convenient mechanism to\n provide a default value for non-existent attribute values.
    
    Returns:
    
    the String
  - setNullReturnValue
```
public void setNullReturnValue(Object value)
                        throws DmcValueException
```
    Sets nullReturnValue to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getAltType
```
public String getAltType()
```
    The altType indicates an alternate type for a value. For instance\n when dealing with NameContainers, the value interface is obviously NameContainer, but\n the secret sauce of NameContainers is that they also take any DmcObjectName derivative.\n Specifying the altType on the NameContainer TypeDefinition allows for generation of \n the DmcObjectName interface as well.
    
    Returns:
    
    the String
  - setAltType
```
public void setAltType(Object value)
                throws DmcValueException
```
    Sets altType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getAltTypeImport
```
public String getAltTypeImport()
```
    An additional import (if required) by the altType attribute value.
    
    Returns:
    
    the String
  - setAltTypeImport
```
public void setAltTypeImport(Object value)
                      throws DmcValueException
```
    Sets altTypeImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getKeyClass
```
public String getKeyClass()
```
    This attribute indicates the class of the key used for types that support\n storage in a MAP.
    
    Returns:
    
    the String
  - setKeyClass
```
public void setKeyClass(Object value)
                 throws DmcValueException
```
    Sets keyClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getKeyImport
```
public String getKeyImport()
```
    Indicates the import for a keyClass. this is required if the keyClass\n is NOT a primitive java type e.g. Integer, String etc.
    
    Returns:
    
    the String
  - setKeyImport
```
public void setKeyImport(Object value)
                  throws DmcValueException
```
    Sets keyImport to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getWrapperClassName
```
public String getWrapperClassName()
```
    This is the fully qualified name of the wrapper class derived from DmcWrapperBase that\n wraps a DMO. This is used when generating object reference classes associated with ClassDefinitions\n This actually aligns to the javaClass of the ClassDefinition for which we're generating the reference\n classes.
    
    Returns:
    
    the String
  - setWrapperClassName
```
public void setWrapperClassName(Object value)
                         throws DmcValueException
```
    Sets wrapperClassName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    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
  - getHelperClassName
```
public String getHelperClassName()
```
    This attribute indicates the full name of the generated helper class for \n object references i.e. if you had a ClassDefinition X, the framework generates a \n types/XREF class which is subsequently used by the DmcTypeXREF class to store references\n to objects of the defined class.
    
    Returns:
    
    the String
  - setHelperClassName
```
public void setHelperClassName(Object value)
                        throws DmcValueException
```
    Sets helperClassName 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
  - getIsEnumType
```
public Boolean getIsEnumType()
```
    This flag is set to true for type definitions that define enumerations.
    
    Returns:
    
    the Boolean
  - setIsEnumType
```
public void setIsEnumType(Object value)
                   throws DmcValueException
```
    Sets isEnumType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIsNameType
```
public Boolean getIsNameType()
```
    This attribute indicates if a defined type is used for naming purposes.\n This allows us to automatically add attributes of this type to the AttributeFactories.
    
    Returns:
    
    the Boolean
  - setIsNameType
```
public void setIsNameType(Object value)
                   throws DmcValueException
```
    Sets isNameType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIsHierarchicName
```
public Boolean getIsHierarchicName()
```
    Indicates if a name type is for hierarchic objects.
    
    Returns:
    
    the Boolean
  - setIsHierarchicName
```
public void setIsHierarchicName(Object value)
                         throws DmcValueException
```
    Sets isHierarchicName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIsFilterType
```
public Boolean getIsFilterType()
```
    Indicates that a type is derived from DmcFilter.
    
    Returns:
    
    the Boolean
  - setIsFilterType
```
public void setIsFilterType(Object value)
                     throws DmcValueException
```
    Sets isFilterType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIsExtendedRefType
```
public Boolean getIsExtendedRefType()
```
    This flag is used to indicate taht an internally generated type\n is an extended reference type.
    
    Returns:
    
    the Boolean
  - setIsExtendedRefType
```
public void setIsExtendedRefType(Object value)
                          throws DmcValueException
```
    Sets isExtendedRefType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getIsRefType
```
public Boolean getIsRefType()
```
    This flag is set to true for type definitions that refer to other\n objects.
    
    Returns:
    
    the Boolean
  - setIsRefType
```
public void setIsRefType(Object value)
                  throws DmcValueException
```
    Sets isRefType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getEnumName
```
public String getEnumName()
```
    The original name of an enum as referred to in the internally generated type for enums.
    
    Returns:
    
    the String
  - setEnumName
```
public void setEnumName(Object value)
                 throws DmcValueException
```
    Sets enumName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getOriginalClass
```
public ClassDefinition getOriginalClass()
```
    Refers to the class that an internally generated type represents.
    
    Returns:
    
    the ClassDefinition
  - setOriginalClass
```
public void setOriginalClass(ClassDefinition value)
                      throws DmcValueException
```
    Sets originalClass to the specified value.
    
    Parameters:
    
    value - A value compatible with ClassDefinition
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getNameAttributeDef
```
public AttributeDefinition getNameAttributeDef()
```
    The nameAttributeDef is a reference to the attribute that is locked\n to a TypeDefinition. This mechanism is used to create the correct type of DmcType[NAMETYPE]*\n derivative for a value of type DmcObjectName.
    
    Returns:
    
    the AttributeDefinition
  - setNameAttributeDef
```
public void setNameAttributeDef(AttributeDefinition value)
                         throws DmcValueException
```
    Sets nameAttributeDef to the specified value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinition
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getFilterAttributeDef
```
public AttributeDefinition getFilterAttributeDef()
```
    The filterAttributeDef is a reference to the attribute that is locked\n to a TypeDefinition that is flagged as filterType. This mechanism is used to create the\n correct type of DmcType[FILTERTYPE]SV derivative for a value of type DmcFilter.
    
    Returns:
    
    the AttributeDefinition
  - setFilterAttributeDef
```
public void setFilterAttributeDef(AttributeDefinition value)
                           throws DmcValueException
```
    Sets filterAttributeDef to the specified value.
    
    Parameters:
    
    value - A value compatible with AttributeDefinition
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getNumericOrBoolean
```
public Boolean getNumericOrBoolean()
```
    When we perform toJSON() operations, we need to know whether to quote\n values. If the type of a property is numeric or boolean, we omit the quotes. This\n value is set to true on TypeDefinitions generated as part of the MetaSchemaAG -\n Boolean, Integer, Long, Short, Float and Double.
    
    Returns:
    
    the Boolean
  - setNumericOrBoolean
```
public void setNumericOrBoolean(Object value)
                         throws DmcValueException
```
    Sets numericOrBoolean to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getGenericArgs
```
public String getGenericArgs()
```
    This attribute indicates the generic arguments to be supplied in the\n use of a class in an autogenerated Iterable.
    
    Returns:
    
    the String
  - setGenericArgs
```
public void setGenericArgs(Object value)
                    throws DmcValueException
```
    Sets genericArgs 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 TypeDefinitionDMW

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

TypeDefinitionDMW

TypeDefinitionDMW

TypeDefinitionDMW

TypeDefinitionDMW

TypeDefinitionDMW

Method Detail

setDmcObject

getDMO

getName

setName

getTypeClassName

setTypeClassName

getDescription

getDescriptionWithNewlines

addDescription

getDescriptionSize

getPrimitiveType

setPrimitiveType

getNullReturnValue

setNullReturnValue

getAltType

setAltType

getAltTypeImport

setAltTypeImport

getKeyClass

setKeyClass

getKeyImport

setKeyImport

getWrapperClassName

setWrapperClassName

getInternallyGenerated

setInternallyGenerated

getHelperClassName

setHelperClassName

getDmwIteratorImport

setDmwIteratorImport

getDmwIteratorClass

setDmwIteratorClass

getIsEnumType

setIsEnumType

getIsNameType

setIsNameType

getIsHierarchicName

setIsHierarchicName

getIsFilterType

setIsFilterType

getIsExtendedRefType

setIsExtendedRefType

getIsRefType

setIsRefType

getEnumName

setEnumName

getOriginalClass

setOriginalClass

getNameAttributeDef

setNameAttributeDef

getFilterAttributeDef

setFilterAttributeDef

getNumericOrBoolean

setNumericOrBoolean

getGenericArgs

setGenericArgs

getObjectName

getObjectNameAttribute