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

All Implemented Interfaces:

Serializable, DmcDefinitionIF, DmcNamedObjectIF
```
public class TypeDefinitionDMO
extends DmsDefinitionDMO
implements Serializable, 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.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

TypeDefinitionDMO()

TypeDefinitionDMO(String oc)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DmcAttribute<?>`	`addComment(Object value)` Adds another comment value.
`DmcAttribute<?>`	`addDescription(Object value)` Adds another description value.
`DmcAttribute<?>`	`addExample(Object value)` Adds another example 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.
`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>`	`getComment()` A comment or note associated with the definition of something.
`SchemaDefinitionREF`	`getDefinedIn()` Indicates the schema in which a type, attribute or class is defined.
`Iterator<String>`	`getDescription()` The description attribute is used to provide descriptive\n documentation for schema related definitions.
`Iterator<String>`	`getDescriptionWithNewlines()`
`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`	`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.
`DotName`	`getDotName()` The dotName attribute is used to store dot separated names.
`String`	`getEnumName()` The original name of an enum as referred to in the internally generated type for enums.
`Iterator<Example>`	`getExample()` The example attribute is used to provide additional\n examples of how some defined thing is to be used.
`String`	`getFile()` Indicates the file from which a definition was loaded.
`AttributeDefinitionREF`	`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.
`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()`
`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.
`Integer`	`getLineNumber()` Indicates the line number of the file from which a definition was loaded.
`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.
`AttributeDefinitionREF`	`getNameAttributeDef()` The nameAttributeDef is a reference to the attribute that is locked\n to a TypeDefinition.
`TypeDefinitionDMO`	`getNew()` Auto-generated derived classes override this to return an empty instance of themselves.
`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.
`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.
`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.
`ClassDefinitionREF`	`getOriginalClass()` Refers to the class that an internally generated type represents.
`String`	`getPrimitiveType()` The primitiveType indicates the underlying type of a DmcType.
`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
`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).
`TypeDefinitionDMO`	`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()`
`Iterator<String>`	`getTags()` A collection of tags that can facilitate searching for\n definitions.
`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`	`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.
`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`	`setDefinedIn(Object value)` Sets definedIn to the specified value.
`void`	`setDmoFromModule(Object value)` Sets dmoFromModule 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`	`setEnumName(Object value)` Sets enumName to the specified value.
`void`	`setFile(Object value)` Sets file to the specified value.
`void`	`setFilterAttributeDef(Object 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`	`setHint(Object value)` Sets hint 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`	`setLineNumber(Object value)` Sets lineNumber to the specified value.
`void`	`setName(Object value)` Sets name to the specified value.
`void`	`setNameAttributeDef(Object 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`	`setObsolete(Object value)` Sets obsolete to the specified value.
`void`	`setOriginalClass(Object value)` Sets originalClass to the specified value.
`void`	`setPrimitiveType(Object value)` Sets primitiveType to the specified value.
`void`	`setRelationship(Object value)` Sets relationship 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`	`setTypeClassName(Object value)` Sets typeClassName to the specified value.
`void`	`setVersion(Object value)` Sets version to the specified value.
`void`	`setWhy(Object value)` Sets why to the specified value.
`void`	`setWrapperClassName(Object value)` Sets wrapperClassName 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, getDataType, getFullClassName, getLastValue, getModifier, getObjectClass, getObjectValidators, getReferringObjects, getReferringObjectsViaAttribute, getStagingObject, hasAux, hasValue, isModrec, isReferenced, isStaging, modrec, nth, nthNullFromEmptyAttribute, numberOfAttributes, populateSlice, referenceCount, rem, rem, removeAux, removeBackref, resolveReferences, resolveReferences, resolveReferences, resolveReferencesExceptClass, resolveReferencesExceptClass, serializeIt, set, set, setContainer, setLastValue, setModifier, shallowCopy, staging, supportsBackrefTracking, toCompactJSON, toCompactJSON, toJSON, toJSON, toJSON, toOIF, toOIF, toOIFNoPadding, toPersistentOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class java.lang.Object
clone, equals, 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
  - TypeDefinitionDMO
```
public TypeDefinitionDMO()
```
  - TypeDefinitionDMO
```
public TypeDefinitionDMO(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 TypeDefinitionDMO 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 TypeDefinitionDMO 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.
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - getFilterAttributeDef
```
public AttributeDefinitionREF 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(Object value)
                           throws DmcValueException
```
    Sets filterAttributeDef to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeAttributeDefinitionREFSV
    
    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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - getNameAttributeDef
```
public AttributeDefinitionREF 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(Object value)
                         throws DmcValueException
```
    Sets nameAttributeDef to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeAttributeDefinitionREFSV
    
    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
  - 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
  - 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
  - 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
  - getOriginalClass
```
public ClassDefinitionREF getOriginalClass()
```
    Refers to the class that an internally generated type represents.
    
    Returns:
    
    the ClassDefinition
  - setOriginalClass
```
public void setOriginalClass(Object value)
                      throws DmcValueException
```
    Sets originalClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeClassDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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 TypeDefinitionDMO

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

TypeDefinitionDMO

TypeDefinitionDMO

Method Detail

getIdToAttrInfo

getStringToAttrInfo

getNew

getSlice

getName

setName

getTypeClassName

setTypeClassName

getAltType

setAltType

getAltTypeImport

setAltTypeImport

getComment

addComment

getDefinedIn

setDefinedIn

getDescription

getDescriptionWithNewlines

addDescription

getDmoFromModule

setDmoFromModule

getDmwIteratorClass

setDmwIteratorClass

getDmwIteratorImport

setDmwIteratorImport

getDotName

setDotName

getEnumName

setEnumName

getExample

addExample

getFile

setFile

getFilterAttributeDef

setFilterAttributeDef

getGenericArgs

setGenericArgs

getHelperClassName

setHelperClassName

getHint

setHint

getInternallyGenerated

setInternallyGenerated

getIsEnumType

setIsEnumType

getIsExtendedRefType

setIsExtendedRefType

getIsFilterType

setIsFilterType

getIsHierarchicName

setIsHierarchicName

getIsNameType

setIsNameType

getIsRefType

setIsRefType

getKeyClass

setKeyClass

getKeyImport

setKeyImport

getLineNumber

setLineNumber

getNameAttributeDef

setNameAttributeDef

getNullReturnValue

setNullReturnValue

getNumericOrBoolean

setNumericOrBoolean