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

All Implemented Interfaces:

Serializable, DmcDefinitionIF, DmcNamedObjectIF
```
public class AttributeDefinitionDMO
extends DmsDefinitionDMO
implements Serializable, DmcDefinitionIF
```
This class is used to define attributes to be used\n as part of a class definition.

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

AttributeDefinitionDMO()

AttributeDefinitionDMO(String oc)

Constructors
Constructor and Description
`AttributeDefinitionDMO()`
`AttributeDefinitionDMO(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`	`getAbbrev()` This attribute stores an abbreviated form of the name of an attribute or class.
`Iterator<String>`	`getComment()` A comment or note associated with the definition of something.
`DataTypeEnum`	`getDataType()` This attribute indicates the persistence characteristics of an attribute or\n class of object.
`SchemaDefinitionREF`	`getDefinedIn()` Indicates the schema in which a type, attribute or class is defined.
`Iterator<String>`	`getDescription()` The description attribute is used to provide descriptive\n documentation for schema related definitions.
`Iterator<String>`	`getDescriptionWithNewlines()`
`Boolean`	`getDesignatedFilterAttribute()` The designatedFilterAttribute flag is used to identify the attribute\n designated as the standard wrapper for filters of a particular type.
`Boolean`	`getDesignatedNameAttribute()` The designatedNameAttribute flag is used to identify the attribute\n designated as the standard wrapper for names of a particular type.
`Integer`	`getDmdID()` The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.
`String`	`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.
`String`	`getFile()` Indicates the file from which a definition was loaded.
`String`	`getGenericArgs()` This attribute indicates the generic arguments to be supplied in the\n use of a class in an autogenerated Iterable.
`String`	`getGenericArgsImport()` Indicates the import required to support a genericArgs specification 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()`
`Integer`	`getIndexSize()` The indexSize is used in conjunction with the MULTI valueType to\n indicate that the attribute may have the specified number of values and is integer indexed.\n Indexed attributes may be thought of as having a predetermined number of slots into which\n values may be stored.
`Boolean`	`getInternalUse()` Indicates if an attribute is used and set within the Dark Matter Data\n code generation mechanisms.
`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.
`AttributeDefinitionDMO`	`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.
`Iterator<NameValuePair>`	`getNvp()` A set of additional name value pairs that can be associated with an object.
`DefinitionName`	`getObjectName()`
`DmcAttribute<?>`	`getObjectNameAttribute()`
`String`	`getObsolete()` The version at which something became obsolete.
`String`	`getObsoleteVersion()` This indicates the version at which something became obsolete.\n Generally speaking you shouldn't ever delete definitions for products that have\n been released to the field, this may break backwards compatibility.
`Iterator<String>`	`getOptimize()` Depending on what you're modelling, you often come across\n places where you can see an opportunity to optimize, streamline or improve something e.g.
`Boolean`	`getPreserveNewlines()` Indicates that newline characters should be preserved when an\n attribute is parsed by the DmcUncheckedOIFParser.
`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.
`Boolean`	`getSecure()` This attribute indicates whether or not the attribute should\n be encrypted before being transported over the wire or stored in a file or\n repository
`Iterator<String>`	`getSkip()` A version from which something should be excluded (even though it is included\n in later versions).
`AttributeDefinitionDMO`	`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.
`TypeDefinitionREF`	`getType()` Indicates the type of an attribute.
`ValueTypeEnum`	`getValueType()` This attribute indicates the cardinality and storage mechanism for an\n attribute.
`String`	`getVersion()` The version at which something was introduced.
`Boolean`	`getWeakReference()` A flag to indicate that a reference attribute is weak i.e.
`ConcinnityREF`	`getWhy()` An indication of why something was added to a specification or a system.\n This might be a reference to a requirement or feature concept.
`void`	`setAbbrev(Object value)` Sets abbrev to the specified value.
`void`	`setDataType(Object value)` Sets dataType to the specified value.
`void`	`setDefinedIn(Object value)` Sets definedIn to the specified value.
`void`	`setDesignatedFilterAttribute(Object value)` Sets designatedFilterAttribute to the specified value.
`void`	`setDesignatedNameAttribute(Object value)` Sets designatedNameAttribute to the specified value.
`void`	`setDmdID(Object value)` Sets dmdID to the specified value.
`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`	`setGenericArgs(Object value)` Sets genericArgs to the specified value.
`void`	`setGenericArgsImport(Object value)` Sets genericArgsImport to the specified value.
`void`	`setHint(Object value)` Sets hint to the specified value.
`void`	`setIndexSize(Object value)` Sets indexSize to the specified value.
`void`	`setInternalUse(Object value)` Sets internalUse 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`	`setNullReturnValue(Object value)` Sets nullReturnValue to the specified value.
`void`	`setObsolete(Object value)` Sets obsolete to the specified value.
`void`	`setObsoleteVersion(Object value)` Sets obsoleteVersion to the specified value.
`void`	`setPreserveNewlines(Object value)` Sets preserveNewlines 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`	`setSecure(Object value)` Sets secure to the specified value.
`void`	`setSortName(Object value)` Sets sortName to the specified value.
`void`	`setType(Object value)` Sets type to the specified value.
`void`	`setValueType(Object value)` Sets valueType to the specified value.
`void`	`setVersion(Object value)` Sets version to the specified value.
`void`	`setWeakReference(Object value)` Sets weakReference to the specified value.
`void`	`setWhy(Object value)` Sets why to the specified value.

Methods inherited from class org.dmd.dmc.DmcObject
add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, equals, get, get, get, getAdditionalAttributes, getAttributeInfo, getAttributeInfo, getAttributeIterator, getAttributeNames, getAttributes, getAttributeValidators, getBackref, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getContainer, getFullClassName, getLastValue, getModifier, getObjectClass, getObjectValidators, getReferringObjects, getReferringObjectsViaAttribute, getStagingObject, hasAux, hasValue, isModrec, isReferenced, isStaging, modrec, nth, nthNullFromEmptyAttribute, numberOfAttributes, populateSlice, referenceCount, rem, rem, removeAux, removeBackref, resolveReferences, resolveReferences, resolveReferences, resolveReferencesExceptClass, resolveReferencesExceptClass, serializeIt, set, set, setContainer, setLastValue, setModifier, shallowCopy, staging, supportsBackrefTracking, toCompactJSON, toCompactJSON, toJSON, toJSON, toJSON, toOIF, toOIF, toOIFNoPadding, toPersistentOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class java.lang.Object
clone, 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
  - AttributeDefinitionDMO
```
public AttributeDefinitionDMO()
```
  - AttributeDefinitionDMO
```
public AttributeDefinitionDMO(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 AttributeDefinitionDMO 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 AttributeDefinitionDMO 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
  - getType
```
public TypeDefinitionREF getType()
```
    Indicates the type of an attribute. The value is the name of any\n previously defined TypeDefinition, ClassDefinition, EnumDefinition or ComplexTypeDefinition.
    
    Returns:
    
    the TypeDefinition
  - setType
```
public void setType(Object value)
             throws DmcValueException
```
    Sets type to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeTypeDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getAbbrev
```
public String getAbbrev()
```
    This attribute stores an abbreviated form of the name of an attribute or class. This\n concept is borrowed from directory technology where shortened name forms are often\n used as part of distinguished names (DNs).
    
    Returns:
    
    the String
  - setAbbrev
```
public void setAbbrev(Object value)
               throws DmcValueException
```
    Sets abbrev to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - 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
  - getDataType
```
public DataTypeEnum getDataType()
```
    This attribute indicates the persistence characteristics of an attribute or\n class of object. How this information is used is application dependent.
    
    Overrides:
    
    getDataType in class DmcObject
    
    Returns:
    
    the DataTypeEnum
  - setDataType
```
public void setDataType(Object value)
                 throws DmcValueException
```
    Sets dataType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDataTypeEnumSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDefinedIn
```
public SchemaDefinitionREF getDefinedIn()
```
    Indicates the schema in which a type, attribute or class is defined.
    
    Specified by:
    
    getDefinedIn in interface DmcDefinitionIF
    
    Overrides:
    
    getDefinedIn in class DmsDefinitionDMO
    
    Returns:
    
    the SchemaDefinition
  - setDefinedIn
```
public void setDefinedIn(Object value)
                  throws DmcValueException
```
    Sets definedIn to the specified value.
    
    Overrides:
    
    setDefinedIn in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeSchemaDefinitionREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - 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
  - getDesignatedFilterAttribute
```
public Boolean getDesignatedFilterAttribute()
```
    The designatedFilterAttribute flag is used to identify the attribute\n designated as the standard wrapper for filters of a particular type. \n One, and only one, attribute definition can be the designatedFilterAttribute for a \n TypeDefinition that is identified as isFilterType.
    
    Returns:
    
    the Boolean
  - setDesignatedFilterAttribute
```
public void setDesignatedFilterAttribute(Object value)
                                  throws DmcValueException
```
    Sets designatedFilterAttribute to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDesignatedNameAttribute
```
public Boolean getDesignatedNameAttribute()
```
    The designatedNameAttribute flag is used to identify the attribute\n designated as the standard wrapper for names of a particular type. One, and only one,\n attribute definition can be the designatedNameAttribute for a TypeDefinition that has\n isNameType true.
    
    Returns:
    
    the Boolean
  - setDesignatedNameAttribute
```
public void setDesignatedNameAttribute(Object value)
                                throws DmcValueException
```
    Sets designatedNameAttribute to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmdID
```
public Integer getDmdID()
```
    The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.
    
    Returns:
    
    the Integer
  - setDmdID
```
public void setDmdID(Object value)
              throws DmcValueException
```
    Sets dmdID to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - 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
  - 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
  - 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
  - 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
  - getGenericArgsImport
```
public String getGenericArgsImport()
```
    Indicates the import required to support a genericArgs specification i.e. if you're\n not specifying something like , an additional import may be required.
    
    Returns:
    
    the String
  - setGenericArgsImport
```
public void setGenericArgsImport(Object value)
                          throws DmcValueException
```
    Sets genericArgsImport 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
  - getIndexSize
```
public Integer getIndexSize()
```
    The indexSize is used in conjunction with the MULTI valueType to\n indicate that the attribute may have the specified number of values and is integer indexed.\n Indexed attributes may be thought of as having a predetermined number of slots into which\n values may be stored. When indexed, an attribute has values added to it using the setMVnth()\n interface, not the usual add() interface. If you attempt to use add() with an indexed attribute,\n an exception will be thrown.
    
    Returns:
    
    the Integer
  - setIndexSize
```
public void setIndexSize(Object value)
                  throws DmcValueException
```
    Sets indexSize to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getInternalUse
```
public Boolean getInternalUse()
```
    Indicates if an attribute is used and set within the Dark Matter Data\n code generation mechanisms. In the documentation generation code, attributes marked as\n internalUse WILL NOT be displayed unless you set the -internalUse flag is indicated.
    
    Returns:
    
    the Boolean
  - setInternalUse
```
public void setInternalUse(Object value)
                    throws DmcValueException
```
    Sets internalUse to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    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
  - 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
  - getNvp
```
public Iterator<NameValuePair> getNvp()
```
    A set of additional name value pairs that can be associated with an object.
    
    Overrides:
    
    getNvp in class DmsDefinitionDMO
    
    Returns:
    
    the NameValuePair
  - addNvp
```
public DmcAttribute<?> addNvp(Object value)
                       throws DmcValueException
```
    Adds another nvp value.
    
    Overrides:
    
    addNvp in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeNameValuePairMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObsolete
```
public String getObsolete()
```
    The version at which something became obsolete.
    
    Overrides:
    
    getObsolete in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - setObsolete
```
public void setObsolete(Object value)
                 throws DmcValueException
```
    Sets obsolete to the specified value.
    
    Overrides:
    
    setObsolete in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObsoleteVersion
```
public String getObsoleteVersion()
```
    This indicates the version at which something became obsolete.\n Generally speaking you shouldn't ever delete definitions for products that have\n been released to the field, this may break backwards compatibility. Instead, you\n should mark them as obsolete.
    
    Returns:
    
    the String
  - setObsoleteVersion
```
public void setObsoleteVersion(Object value)
                        throws DmcValueException
```
    Sets obsoleteVersion to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getOptimize
```
public Iterator<String> getOptimize()
```
    Depending on what you're modelling, you often come across\n places where you can see an opportunity to optimize, streamline or improve something e.g. merging\n concepts together, representing something differently, adding a relationship - whatever.\n However, these ideas often get lost in the shuffle or, if you add them into an overall\n description of something, they don't stand out.\n
    \n Any dark-matter definition can be decorated with optimize notes. These notes provide
    
    Overrides:
    
    getOptimize in class DmsDefinitionDMO
    
    Returns:
    
    the String
  - addOptimize
```
public DmcAttribute<?> addOptimize(Object value)
                            throws DmcValueException
```
    Adds another optimize value.
    
    Overrides:
    
    addOptimize in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getPreserveNewlines
```
public Boolean getPreserveNewlines()
```
    Indicates that newline characters should be preserved when an\n attribute is parsed by the DmcUncheckedOIFParser. This is useful for certain attributes\n when newlines are required to properly format the contents of the attribute at\n a later time. For example, the description attribute is later dumped as part of \n HTML documentation and, if the newlines are stripped, it won't be properly formatted.
    
    Returns:
    
    the Boolean
  - setPreserveNewlines
```
public void setPreserveNewlines(Object value)
                         throws DmcValueException
```
    Sets preserveNewlines to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    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
  - getSecure
```
public Boolean getSecure()
```
    This attribute indicates whether or not the attribute should\n be encrypted before being transported over the wire or stored in a file or\n repository
    
    Returns:
    
    the Boolean
  - setSecure
```
public void setSecure(Object value)
               throws DmcValueException
```
    Sets secure to the specified value.
    
    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
  - getValueType
```
public ValueTypeEnum getValueType()
```
    This attribute indicates the cardinality and storage mechanism for an\n attribute.
    
    Returns:
    
    the ValueTypeEnum
  - setValueType
```
public void setValueType(Object value)
                  throws DmcValueException
```
    Sets valueType to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeValueTypeEnumSV
    
    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
  - getWeakReference
```
public Boolean getWeakReference()
```
    A flag to indicate that a reference attribute is weak i.e. \n if the object can't be resolved, no exception is thrown.
    
    Returns:
    
    the Boolean
  - setWeakReference
```
public void setWeakReference(Object value)
                      throws DmcValueException
```
    Sets weakReference to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getWhy
```
public ConcinnityREF getWhy()
```
    An indication of why something was added to a specification or a system.\n This might be a reference to a requirement or feature concept. How this is used will depend on context.\n Due to the fact that it is a weak reference, you may also just put in free form text, since it\n will simply be treated as an unresolved reference.
    
    Overrides:
    
    getWhy in class DmsDefinitionDMO
    
    Returns:
    
    the Concinnity
  - setWhy
```
public void setWhy(Object value)
            throws DmcValueException
```
    Sets why to the specified value.
    
    Overrides:
    
    setWhy in class DmsDefinitionDMO
    
    Parameters:
    
    value - A value compatible with DmcTypeConcinnityREFSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getObjectName
```
public DefinitionName getObjectName()
```
    Specified by:
    
    getObjectName in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectName in class DmsDefinitionDMO
    
    Returns:
    
    The name of this object from the name attribute.
  - getObjectNameAttribute
```
public DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface DmcNamedObjectIF
    
    Overrides:
    
    getObjectNameAttribute in class DmsDefinitionDMO
    
    Returns:
    
    The name attribute.

Class AttributeDefinitionDMO

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

AttributeDefinitionDMO

AttributeDefinitionDMO

Method Detail

getIdToAttrInfo

getStringToAttrInfo

getNew

getSlice

getName

setName

getType

setType

getAbbrev

setAbbrev

getComment

addComment

getDataType

setDataType

getDefinedIn

setDefinedIn

getDescription

getDescriptionWithNewlines

addDescription

getDesignatedFilterAttribute

setDesignatedFilterAttribute

getDesignatedNameAttribute

setDesignatedNameAttribute

getDmdID

setDmdID

getDmoFromModule

setDmoFromModule

getDotName

setDotName

getExample

addExample

getFile

setFile

getGenericArgs

setGenericArgs

getGenericArgsImport

setGenericArgsImport

getHint

setHint

getIndexSize

setIndexSize

getInternalUse

setInternalUse

getLineNumber

setLineNumber

getNullReturnValue

setNullReturnValue

getNvp

addNvp

getObsolete

setObsolete

getObsoleteVersion

setObsoleteVersion

getOptimize

addOptimize

getPreserveNewlines

setPreserveNewlines

getQuestion

addQuestion

getRelatedToConcept

addRelatedToConcept

getRelationship

setRelationship

getSearchable

setSearchable

getSecure

setSecure