DSDefinitionDMW (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

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

DSDefinition
```
public abstract class DSDefinitionDMW
extends DmwNamedObjectWrapper
```
The domain specific definition (DSDefinition) forms the basis for all definitions\n that use dark-matter as their basis. The initial dark-matter mechanisms were focussed only on \n schema for data objects, but, as the project developed, other, domain specific sets of definitions\n were added. Eventually, a pattern emerged in terms of these various sets of definitions and\n some additional higher order concepts were introduced to make the creation of new, domain specific\n definition sets easier and to allow them to build on and use each others' definitions in a \n coherent manner.\n
\n For instance, the Model View Whatever (MVW) framework, builds on the dark-matter schema \n concepts and introduces definitions that align with the Google Web Toolkit (GWT) conceptual model\n of the elements that comprise GWT applications and the various relationships that exist between\n them. The infrastructure needed to parse, manage and use those definitions to generate code\n and documentation are very similar to those used in the base dark-matter schema mechanisms, but\n they had to be hand built for the domain.\n
\n Other kinds of domain specific definitions started to emerge, Google Protocol Buffer (GPB),\n Simple Network Management Protocol (SNMP) etc. Having to build the infrastructure for these \n definitions each time was tedious and, in the spirit of the rest of dark-matter, lent themselves\n to being defined, generated and extended to make the process the easier.\n
\n Likewise, the code generation mechanisms originally employed have evolved and the more generic\n concept of artifact generation, based on definition sets, was introduced to allow for more rapid\n creation of utilities that generate code or documentation or other types of specifications.

Author:

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DSDefinitionDMW()`
`protected`	`DSDefinitionDMW(DmcObject obj)`
`protected`	`DSDefinitionDMW(DmcObject obj, ClassDefinition cd)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addComment(Object value)` Adds another comment value.
`void`	`addDescription(Object value)` Adds another description value.
`void`	`addExample(Object value)` Adds another example value.
`void`	`addNvp(Object value)` Adds another nvp value.
`void`	`addOptimize(Object value)` Adds another optimize value.
`void`	`addQuestion(Object value)` Adds another question value.
`void`	`addSkip(Object value)` Adds another skip value.
`void`	`addTags(Object value)` Adds another tags value.
`Iterator<String>`	`getComment()` A comment or note associated with the definition of something.
`int`	`getCommentSize()`
`SchemaDefinition`	`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.
`int`	`getDescriptionSize()`
`Iterator<String>`	`getDescriptionWithNewlines()`
`DSDefinitionDMO`	`getDMO()`
`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.
`DotName`	`getDotName()` The dotName attribute is used to store dot separated names.
`Iterator<Example>`	`getExample()` The example attribute is used to provide additional\n examples of how some defined thing is to be used.
`int`	`getExampleSize()`
`String`	`getFile()` Indicates the file from which a definition was loaded.
`String`	`getHint()` A short description of something that can be dumped as one line summary of something.\n For longer explanations, use the description attribute.
`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.
`Iterator<NameValuePair>`	`getNvp()` A set of additional name value pairs that can be associated with an object.
`int`	`getNvpSize()`
`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.
`int`	`getOptimizeSize()`
`Iterator<String>`	`getQuestion()` A question associated with the definition of something.
`int`	`getQuestionSize()`
`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).
`int`	`getSkipSize()`
`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.
`Iterator<String>`	`getTags()` A collection of tags that can facilitate searching for\n definitions.
`int`	`getTagsSize()`
`String`	`getVersion()` The version at which something was introduced.
`Concinnity`	`getWhy()` An indication of why something was added to a specification or a system.\n This might be a reference to a requirement or feature concept.
`void`	`setDefinedIn(SchemaDefinition value)` Sets definedIn to the specified value.
`void`	`setDmcObject(DmcObject obj)` Sets the core object.
`void`	`setDmoFromModule(Object value)` Sets dmoFromModule to the specified value.
`void`	`setDotName(Object value)` Sets dotName to the specified value.
`void`	`setFile(Object value)` Sets file to the specified value.
`void`	`setHint(Object value)` Sets hint to the specified value.
`void`	`setLineNumber(Object value)` Sets lineNumber to the specified value.
`void`	`setName(Object value)` Sets name to the specified value.
`void`	`setObsolete(Object value)` Sets obsolete to the specified value.
`void`	`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`	`setVersion(Object value)` Sets version to the specified value.
`void`	`setWhy(Concinnity value)` Sets why to the specified value.

Methods inherited from class org.dmd.dmw.DmwWrapper
addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, 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.DmcNamedObjectIF
equals

- Constructor Detail
  - DSDefinitionDMW
```
protected DSDefinitionDMW()
```
  - DSDefinitionDMW
```
protected DSDefinitionDMW(DmcObject obj)
```
  - DSDefinitionDMW
```
protected DSDefinitionDMW(DmcObject obj,
                          ClassDefinition cd)
```
- 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 DmwWrapper
    
    Parameters:
    
    obj - The core object.
  - getDMO
```
public DSDefinitionDMO getDMO()
```
  - 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.
    
    Returns:
    
    the DefinitionName
  - setName
```
public void setName(Object value)
             throws DmcValueException
```
    Sets name to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDefinitionNameSV
    
    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.
    
    Returns:
    
    the String
  - getDescriptionWithNewlines
```
public Iterator<String> getDescriptionWithNewlines()
```
  - addDescription
```
public void addDescription(Object value)
                    throws DmcValueException
```
    Adds another description value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDescriptionSize
```
public int getDescriptionSize()
```
    Returns:
    
    the number of description values.
  - 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.
    
    Returns:
    
    the String
  - addComment
```
public void addComment(Object value)
                throws DmcValueException
```
    Adds another comment value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getCommentSize
```
public int getCommentSize()
```
    Returns:
    
    the number of comment values.
  - getQuestion
```
public Iterator<String> getQuestion()
```
    A question associated with the definition of something.
    
    Returns:
    
    the String
  - addQuestion
```
public void addQuestion(Object value)
                 throws DmcValueException
```
    Adds another question value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getQuestionSize
```
public int getQuestionSize()
```
    Returns:
    
    the number of question values.
  - getExample
```
public Iterator<Example> getExample()
```
    The example attribute is used to provide additional\n examples of how some defined thing is to be used.
    
    Returns:
    
    the Example
  - addExample
```
public void addExample(Object value)
                throws DmcValueException
```
    Adds another example value.
    
    Parameters:
    
    value - A value compatible with DmcTypeExampleMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getExampleSize
```
public int getExampleSize()
```
    Returns:
    
    the number of example values.
  - 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.
    
    Returns:
    
    the String
  - setHint
```
public void setHint(Object value)
             throws DmcValueException
```
    Sets hint to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    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.
    
    Returns:
    
    the DotName
  - setSortName
```
public void setSortName(Object value)
                 throws DmcValueException
```
    Sets sortName to the specified value.
    
    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.
    
    Returns:
    
    the String
  - addTags
```
public void addTags(Object value)
             throws DmcValueException
```
    Adds another tags value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getTagsSize
```
public int getTagsSize()
```
    Returns:
    
    the number of tags values.
  - getNvp
```
public Iterator<NameValuePair> getNvp()
```
    A set of additional name value pairs that can be associated with an object.
    
    Returns:
    
    the NameValuePair
  - addNvp
```
public void addNvp(Object value)
            throws DmcValueException
```
    Adds another nvp value.
    
    Parameters:
    
    value - A value compatible with DmcTypeNameValuePairMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getNvpSize
```
public int getNvpSize()
```
    Returns:
    
    the number of nvp values.
  - 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
    
    Returns:
    
    the String
  - addOptimize
```
public void addOptimize(Object value)
                 throws DmcValueException
```
    Adds another optimize value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getOptimizeSize
```
public int getOptimizeSize()
```
    Returns:
    
    the number of optimize values.
  - 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.
    
    Returns:
    
    the String
  - setVersion
```
public void setVersion(Object value)
                throws DmcValueException
```
    Sets version to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    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!
    
    Returns:
    
    the String
  - addSkip
```
public void addSkip(Object value)
             throws DmcValueException
```
    Adds another skip value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSkipSize
```
public int getSkipSize()
```
    Returns:
    
    the number of skip values.
  - getObsolete
```
public String getObsolete()
```
    The version at which something became obsolete.
    
    Returns:
    
    the String
  - setObsolete
```
public void setObsolete(Object value)
                 throws DmcValueException
```
    Sets obsolete to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getWhy
```
public Concinnity 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.
    
    Returns:
    
    the Concinnity
  - setWhy
```
public void setWhy(Concinnity value)
            throws DmcValueException
```
    Sets why to the specified value.
    
    Parameters:
    
    value - A value compatible with Concinnity
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSearchable
```
public Boolean getSearchable()
```
    Indicates if something is searchable.
    
    Returns:
    
    the Boolean
  - setSearchable
```
public void setSearchable(Object value)
                   throws DmcValueException
```
    Sets searchable to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    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.
    
    Returns:
    
    the String
  - setRelationship
```
public void setRelationship(Object value)
                     throws DmcValueException
```
    Sets relationship to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDefinedIn
```
public SchemaDefinition getDefinedIn()
```
    Indicates the schema in which a type, attribute or class is defined.
    
    Returns:
    
    the SchemaDefinition
  - setDefinedIn
```
public void setDefinedIn(SchemaDefinition value)
                  throws DmcValueException
```
    Sets definedIn to the specified value.
    
    Parameters:
    
    value - A value compatible with SchemaDefinition
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getFile
```
public String getFile()
```
    Indicates the file from which a definition was loaded.
    
    Returns:
    
    the String
  - setFile
```
public void setFile(Object value)
             throws DmcValueException
```
    Sets file 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.
    
    Returns:
    
    the Integer
  - setLineNumber
```
public void setLineNumber(Object value)
                   throws DmcValueException
```
    Sets lineNumber to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDotName
```
public DotName getDotName()
```
    The dotName attribute is used to store dot separated names.
    
    Returns:
    
    the DotName
  - setDotName
```
public void setDotName(Object value)
                throws DmcValueException
```
    Sets dotName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDotNameSV
    
    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.
    
    Returns:
    
    the String
  - setDmoFromModule
```
public void setDmoFromModule(Object value)
                      throws DmcValueException
```
    Sets dmoFromModule to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObjectName
```
public DefinitionName getObjectName()
```
    Returns:
    
    The name of this object from the name attribute.
  - getObjectNameAttribute
```
public DmcAttribute<?> getObjectNameAttribute()
```
    Returns:
    
    The name attribute.

Class DSDefinitionDMW

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

Constructor Summary

Method Summary

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.DmcNamedObjectIF

Constructor Detail

DSDefinitionDMW

DSDefinitionDMW

DSDefinitionDMW

Method Detail

setDmcObject

getDMO

getName

setName

getDescription

getDescriptionWithNewlines

addDescription

getDescriptionSize

getComment

addComment

getCommentSize

getQuestion

addQuestion

getQuestionSize

getExample

addExample

getExampleSize

getHint

setHint

getSortName

setSortName

getTags

addTags

getTagsSize

getNvp

addNvp

getNvpSize

getOptimize

addOptimize

getOptimizeSize

getVersion

setVersion

getSkip

addSkip

getSkipSize

getObsolete

setObsolete

getWhy

setWhy

getSearchable

setSearchable

getRelationship

setRelationship

getDefinedIn

setDefinedIn

getFile

setFile

getLineNumber

setLineNumber

getDotName

setDotName

getDmoFromModule

setDmoFromModule

getObjectName

getObjectNameAttribute