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

All Implemented Interfaces:

Serializable, DmcNamedObjectIF
```
public class SchemaDefinitionDMO
extends DmsDefinitionDMO
implements Serializable
```
This class is used to define a schema as a discrete, nameable entity.

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

SchemaDefinitionDMO()

SchemaDefinitionDMO(String oc)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DmcAttribute<?>`	`addActionDefList(Object value)` Adds another actionDefList value.
`DmcAttribute<?>`	`addAttributeDefList(Object value)` Adds another attributeDefList value.
`DmcAttribute<?>`	`addClassDefList(Object value)` Adds another classDefList value.
`DmcAttribute<?>`	`addComment(Object value)` Adds another comment value.
`DmcAttribute<?>`	`addComplexTypeDefList(Object value)` Adds another complexTypeDefList value.
`DmcAttribute<?>`	`addDefFiles(Object value)` Adds another defFiles value.
`DmcAttribute<?>`	`addDependsOn(Object value)` Adds another dependsOn value.
`DmcAttribute<?>`	`addDependsOnRef(Object value)` Adds another dependsOnRef value.
`DmcAttribute<?>`	`addDescription(Object value)` Adds another description value.
`DmcAttribute<?>`	`addDmwTypeToPackage(Object value)` Adds another dmwTypeToPackage value.
`DmcAttribute<?>`	`addDsdModuleList(Object value)` Adds another dsdModuleList value.
`DmcAttribute<?>`	`addEnumDefList(Object value)` Adds another enumDefList value.
`DmcAttribute<?>`	`addExample(Object value)` Adds another example value.
`DmcAttribute<?>`	`addExtendedReferenceTypeDefList(Object value)` Adds another extendedReferenceTypeDefList value.
`DmcAttribute<?>`	`addInternalTypeDefList(Object value)` Adds another internalTypeDefList 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<?>`	`addRuleCategoryList(Object value)` Adds another ruleCategoryList value.
`DmcAttribute<?>`	`addRuleDataList(Object value)` Adds another ruleDataList value.
`DmcAttribute<?>`	`addRuleDefinitionList(Object value)` Adds another ruleDefinitionList value.
`DmcAttribute<?>`	`addSchemaExtension(Object value)` Adds another schemaExtension value.
`DmcAttribute<?>`	`addSkip(Object value)` Adds another skip value.
`DmcAttribute<?>`	`addSliceDefList(Object value)` Adds another sliceDefList value.
`DmcAttribute<?>`	`addTags(Object value)` Adds another tags value.
`DmcAttribute<?>`	`addTypeDefList(Object value)` Adds another typeDefList value.
`Iterator<ActionDefinitionREF>`	`getActionDefList()` A list of action definition references.
`Iterator<AttributeDefinitionREF>`	`getAttributeDefList()` A list of attribute definition references.
`Iterator<ClassDefinitionREF>`	`getClassDefList()` A list of class definition references.
`Iterator<String>`	`getComment()` A comment or note associated with the definition of something.
`Iterator<ComplexTypeDefinitionREF>`	`getComplexTypeDefList()` A list of complex type definition references.
`Boolean`	`getCreateAttributeFactory()` When specified as true on a SchemaDefinition, the DMO generation\n utility will create a free standing AttributeFactory for the schema.
`Iterator<String>`	`getDefFiles()` A list of files that contain the class, attribute and type definitions\n that comprise a schema.
`SchemaDefinitionREF`	`getDefinedIn()` Indicates the schema in which a type, attribute or class is defined.
`Iterator<String>`	`getDependsOn()` A list of schema names.
`Iterator<SchemaDefinitionREF>`	`getDependsOnRef()` A list of schema references that are based on the contents of the dependsOn\n attribute.
`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`	`getDmwPackage()` Indicates the package where server related Dark Matter Wrapper classes \n were generated for this schema.
`Iterator<StringToString>`	`getDmwTypeToPackage()` The dmwTypeToPackage attribute is used to indicate alternative generation\n packages for the Dark Matter Wrapper (DMW) code generation mechanisms.
`DotName`	`getDotName()` The dotName attribute is used to store dot separated names.
`Iterator<DSDefinitionModuleREF>`	`getDsdModuleList()` The set of DSDefinitionModules defined in a schema.
`Iterator<EnumDefinitionREF>`	`getEnumDefList()` A list of EnumDefinitions.
`Iterator<Example>`	`getExample()` The example attribute is used to provide additional\n examples of how some defined thing is to be used.
`Iterator<ExtendedReferenceTypeDefinitionREF>`	`getExtendedReferenceTypeDefList()` A list of extended reference type definition references.
`String`	`getFile()` Indicates the file from which a definition was loaded.
`String`	`getGeneratedFileHeader()` The name of file that coresides with the schema.dms file that\n contains a common header to be applied to all generated code.
`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()`
`Iterator<TypeDefinitionREF>`	`getInternalTypeDefList()` A list of type definitions that were generated internally to represent\n enums and object references.
`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.
`SchemaDefinitionDMO`	`getNew()` Auto-generated derived classes override this to return an empty instance of themselves.
`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.
`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
`Iterator<RuleCategoryREF>`	`getRuleCategoryList()` The RuleCategories defined in a schema.
`Iterator<RuleDataREF>`	`getRuleDataList()` The RuleData defined in a schema.
`Iterator<RuleDefinitionREF>`	`getRuleDefinitionList()` The RuleDefinitions defined in a schema.
`Integer`	`getSchemaBaseID()` The base identifier value for a schema.
`Iterator<String>`	`getSchemaExtension()` The fully qualified name of a class that extends the schema management\n capabilities of the SchemaManager.
`Integer`	`getSchemaIDRange()` The maximum number of attribute definitions in a particular schema.
`String`	`getSchemaPackage()` Indicates the package that a schema will be part of when its code\n is generated using DMO generator tool.
`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).
`SchemaDefinitionDMO`	`getSlice(DmcSliceInfo info)` Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
`Iterator<SliceDefinitionREF>`	`getSliceDefList()` A list of slice definition references.
`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.
`Iterator<TypeDefinitionREF>`	`getTypeDefList()` A list of type definition references.
`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.
`void`	`setCreateAttributeFactory(Object value)` Sets createAttributeFactory 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`	`setDmwPackage(Object value)` Sets dmwPackage 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`	`setGeneratedFileHeader(Object value)` Sets generatedFileHeader 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`	`setSchemaBaseID(Object value)` Sets schemaBaseID to the specified value.
`void`	`setSchemaIDRange(Object value)` Sets schemaIDRange to the specified value.
`void`	`setSchemaPackage(Object value)` Sets schemaPackage 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(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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Constructor Detail
  - SchemaDefinitionDMO
```
public SchemaDefinitionDMO()
```
  - SchemaDefinitionDMO
```
public SchemaDefinitionDMO(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 SchemaDefinitionDMO 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 SchemaDefinitionDMO 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.
    
    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
  - getSchemaBaseID
```
public Integer getSchemaBaseID()
```
    The base identifier value for a schema. This value is added to each dmdID value\n associated with the AttributeDefinitions defined by the schema. This allows for easy rebasing of\n identifier values if required.
    
    Returns:
    
    the Integer
  - setSchemaBaseID
```
public void setSchemaBaseID(Object value)
                     throws DmcValueException
```
    Sets schemaBaseID to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSchemaIDRange
```
public Integer getSchemaIDRange()
```
    The maximum number of attribute definitions in a particular schema. This will provide\n immediate feedback if you exceed the given ID range for your schema.
    
    Returns:
    
    the Integer
  - setSchemaIDRange
```
public void setSchemaIDRange(Object value)
                      throws DmcValueException
```
    Sets schemaIDRange to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeIntegerSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSchemaPackage
```
public String getSchemaPackage()
```
    Indicates the package that a schema will be part of when its code\n is generated using DMO generator tool.
    
    Returns:
    
    the String
  - setSchemaPackage
```
public void setSchemaPackage(Object value)
                      throws DmcValueException
```
    Sets schemaPackage to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getActionDefList
```
public Iterator<ActionDefinitionREF> getActionDefList()
```
    A list of action definition references.
    
    Returns:
    
    the ActionDefinition
  - addActionDefList
```
public DmcAttribute<?> addActionDefList(Object value)
                                 throws DmcValueException
```
    Adds another actionDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeActionDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getAttributeDefList
```
public Iterator<AttributeDefinitionREF> getAttributeDefList()
```
    A list of attribute definition references.
    
    Returns:
    
    the AttributeDefinition
  - addAttributeDefList
```
public DmcAttribute<?> addAttributeDefList(Object value)
                                    throws DmcValueException
```
    Adds another attributeDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeAttributeDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getClassDefList
```
public Iterator<ClassDefinitionREF> getClassDefList()
```
    A list of class definition references.
    
    Returns:
    
    the ClassDefinition
  - addClassDefList
```
public DmcAttribute<?> addClassDefList(Object value)
                                throws DmcValueException
```
    Adds another classDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeClassDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    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
  - getComplexTypeDefList
```
public Iterator<ComplexTypeDefinitionREF> getComplexTypeDefList()
```
    A list of complex type definition references.
    
    Returns:
    
    the ComplexTypeDefinition
  - addComplexTypeDefList
```
public DmcAttribute<?> addComplexTypeDefList(Object value)
                                      throws DmcValueException
```
    Adds another complexTypeDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeComplexTypeDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getCreateAttributeFactory
```
public Boolean getCreateAttributeFactory()
```
    When specified as true on a SchemaDefinition, the DMO generation\n utility will create a free standing AttributeFactory for the schema. This allows for\n the creation of attributes taht can then be embedded in complex objects and properly\n serialized/deserialized.
    
    Returns:
    
    the Boolean
  - setCreateAttributeFactory
```
public void setCreateAttributeFactory(Object value)
                               throws DmcValueException
```
    Sets createAttributeFactory to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDefFiles
```
public Iterator<String> getDefFiles()
```
    A list of files that contain the class, attribute and type definitions\n that comprise a schema.
    
    Returns:
    
    the String
  - addDefFiles
```
public DmcAttribute<?> addDefFiles(Object value)
                            throws DmcValueException
```
    Adds another defFiles value.
    
    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.
    
    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
  - getDependsOn
```
public Iterator<String> getDependsOn()
```
    A list of schema names.
    
    Returns:
    
    the String
  - addDependsOn
```
public DmcAttribute<?> addDependsOn(Object value)
                             throws DmcValueException
```
    Adds another dependsOn value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDependsOnRef
```
public Iterator<SchemaDefinitionREF> getDependsOnRef()
```
    A list of schema references that are based on the contents of the dependsOn\n attribute.
    
    Returns:
    
    the SchemaDefinition
  - addDependsOnRef
```
public DmcAttribute<?> addDependsOnRef(Object value)
                                throws DmcValueException
```
    Adds another dependsOnRef value.
    
    Parameters:
    
    value - A value compatible with DmcTypeSchemaDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    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
  - getDmwPackage
```
public String getDmwPackage()
```
    Indicates the package where server related Dark Matter Wrapper classes \n were generated for this schema. This is used when we're generating derived wrapper\n classes.
    
    Returns:
    
    the String
  - setDmwPackage
```
public void setDmwPackage(Object value)
                   throws DmcValueException
```
    Sets dmwPackage to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDmwTypeToPackage
```
public Iterator<StringToString> getDmwTypeToPackage()
```
    The dmwTypeToPackage attribute is used to indicate alternative generation\n packages for the Dark Matter Wrapper (DMW) code generation mechanisms. For instance, if we \n want to generate GXT wrappers for use with Sencha's GXT model classes, we could specify\n dmwTypeToPackage gxt com.example.client. Each of schemas that's loaded for generation would\n have to have this same attribute specified so that, if there were derived classes across\n schemas, the appropriate wrapper derivations could be determined. See the ClassDefintion.adjustClass()\n method to see how this is used.
    
    Returns:
    
    the StringToString
  - addDmwTypeToPackage
```
public DmcAttribute<?> addDmwTypeToPackage(Object value)
                                    throws DmcValueException
```
    Adds another dmwTypeToPackage value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringToStringMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getDotName
```
public DotName getDotName()
```
    The dotName attribute is used to store dot separated names.
    
    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
  - getDsdModuleList
```
public Iterator<DSDefinitionModuleREF> getDsdModuleList()
```
    The set of DSDefinitionModules defined in a schema.
    
    Returns:
    
    the DSDefinitionModule
  - addDsdModuleList
```
public DmcAttribute<?> addDsdModuleList(Object value)
                                 throws DmcValueException
```
    Adds another dsdModuleList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeDSDefinitionModuleREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getEnumDefList
```
public Iterator<EnumDefinitionREF> getEnumDefList()
```
    A list of EnumDefinitions.
    
    Returns:
    
    the EnumDefinition
  - addEnumDefList
```
public DmcAttribute<?> addEnumDefList(Object value)
                               throws DmcValueException
```
    Adds another enumDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeEnumDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    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
  - getExtendedReferenceTypeDefList
```
public Iterator<ExtendedReferenceTypeDefinitionREF> getExtendedReferenceTypeDefList()
```
    A list of extended reference type definition references.
    
    Returns:
    
    the ExtendedReferenceTypeDefinition
  - addExtendedReferenceTypeDefList
```
public DmcAttribute<?> addExtendedReferenceTypeDefList(Object value)
                                                throws DmcValueException
```
    Adds another extendedReferenceTypeDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeExtendedReferenceTypeDefinitionREFMV
    
    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
  - getGeneratedFileHeader
```
public String getGeneratedFileHeader()
```
    The name of file that coresides with the schema.dms file that\n contains a common header to be applied to all generated code. For instance, you\n might want a common licensing comment at the top of your generated files.
    
    Returns:
    
    the String
  - setGeneratedFileHeader
```
public void setGeneratedFileHeader(Object value)
                            throws DmcValueException
```
    Sets generatedFileHeader 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
  - getInternalTypeDefList
```
public Iterator<TypeDefinitionREF> getInternalTypeDefList()
```
    A list of type definitions that were generated internally to represent\n enums and object references.
    
    Returns:
    
    the TypeDefinition
  - addInternalTypeDefList
```
public DmcAttribute<?> addInternalTypeDefList(Object value)
                                       throws DmcValueException
```
    Adds another internalTypeDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeTypeDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    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
  - 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
  - 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
  - getRuleCategoryList
```
public Iterator<RuleCategoryREF> getRuleCategoryList()
```
    The RuleCategories defined in a schema.
    
    Returns:
    
    the RuleCategory
  - addRuleCategoryList
```
public DmcAttribute<?> addRuleCategoryList(Object value)
                                    throws DmcValueException
```
    Adds another ruleCategoryList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeRuleCategoryREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRuleDataList
```
public Iterator<RuleDataREF> getRuleDataList()
```
    The RuleData defined in a schema.
    
    Returns:
    
    the RuleData
  - addRuleDataList
```
public DmcAttribute<?> addRuleDataList(Object value)
                                throws DmcValueException
```
    Adds another ruleDataList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeRuleDataREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getRuleDefinitionList
```
public Iterator<RuleDefinitionREF> getRuleDefinitionList()
```
    The RuleDefinitions defined in a schema.
    
    Returns:
    
    the RuleDefinition
  - addRuleDefinitionList
```
public DmcAttribute<?> addRuleDefinitionList(Object value)
                                      throws DmcValueException
```
    Adds another ruleDefinitionList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeRuleDefinitionREFMV
    
    Returns:
    
    the attribute instance
    
    Throws:
    
    DmcValueException - if the value is incorrect
  - getSchemaExtension
```
public Iterator<String> getSchemaExtension()
```
    The fully qualified name of a class that extends the schema management\n capabilities of the SchemaManager. the class must have a zero arg constructor and implement\n the SchemaExtensionIF.
    
    Returns:
    
    the String
  - addSchemaExtension
```
public DmcAttribute<?> addSchemaExtension(Object value)
                                   throws DmcValueException
```
    Adds another schemaExtension value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringMV
    
    Returns:
    
    the attribute instance
    
    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
  - getSliceDefList
```
public Iterator<SliceDefinitionREF> getSliceDefList()
```
    A list of slice definition references.
    
    Returns:
    
    the SliceDefinition
  - addSliceDefList
```
public DmcAttribute<?> addSliceDefList(Object value)
                                throws DmcValueException
```
    Adds another sliceDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeSliceDefinitionREFMV
    
    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
  - getTypeDefList
```
public Iterator<TypeDefinitionREF> getTypeDefList()
```
    A list of type definition references.
    
    Returns:
    
    the TypeDefinition
  - addTypeDefList
```
public DmcAttribute<?> addTypeDefList(Object value)
                               throws DmcValueException
```
    Adds another typeDefList value.
    
    Parameters:
    
    value - A value compatible with DmcTypeTypeDefinitionREFMV
    
    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
  - 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 SchemaDefinitionDMO

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

Constructor Detail

SchemaDefinitionDMO

SchemaDefinitionDMO

Method Detail

getIdToAttrInfo

getStringToAttrInfo

getNew

getSlice

getName

setName

getSchemaBaseID

setSchemaBaseID

getSchemaIDRange

setSchemaIDRange

getSchemaPackage

setSchemaPackage

getActionDefList

addActionDefList

getAttributeDefList

addAttributeDefList

getClassDefList

addClassDefList

getComment

addComment

getComplexTypeDefList

addComplexTypeDefList

getCreateAttributeFactory

setCreateAttributeFactory

getDefFiles

addDefFiles

getDefinedIn

setDefinedIn

getDependsOn

addDependsOn

getDependsOnRef

addDependsOnRef

getDescription

getDescriptionWithNewlines

addDescription

getDmoFromModule

setDmoFromModule

getDmwPackage

setDmwPackage

getDmwTypeToPackage

addDmwTypeToPackage

getDotName

setDotName

getDsdModuleList

addDsdModuleList

getEnumDefList

addEnumDefList

getExample

addExample

getExtendedReferenceTypeDefList

addExtendedReferenceTypeDefList

getFile

setFile

getGeneratedFileHeader

setGeneratedFileHeader

getHint

setHint

getInternalTypeDefList

addInternalTypeDefList

getLineNumber

setLineNumber

getNvp

addNvp

getObsolete

setObsolete

getOptimize

addOptimize

getQuestion