EnumMappingDMO (dark-matter-mvw 2.1.2 API)

java.lang.Object
- org.dmd.dmc.DmcObject
- - org.dmd.mvw.tools.mvwgenerator.generated.dmo.MvwDefinitionDMO
  - - org.dmd.mvw.tools.mvwgenerator.generated.dmo.EnumMappingDMO

All Implemented Interfaces:

Serializable, org.dmd.dmc.DmcNamedObjectIF
```
public class EnumMappingDMO
extends MvwDefinitionDMO
implements org.dmd.dmc.DmcNamedObjectIF, Serializable
```
The EnumMapping class allows for generation of a set of static data instances\n that represent the values from the specified enumeration (type). Depending on the widget set\n you're using, you will specify different mappingGenerators; these are defined as extensions\n to the standard MVW generation mechanisms. For example, the dark-matter-gxt project defines\n the GXTEnumGenerator generator that will generate code that maps an enum to code that can be used with\n a selector widget.\n
\n Enum values are comprised of an integer, a name, a description and optionally, a label as follows - int name description : label.\n If you specify useNameAsLabel, the uppercase name value of the enum is used to display the value\n of the. If useNameAsLabel is not specified, the label will be used if it has been specified. Otherwise,\n the description is used.
Generated from the mvw schema at version 0.1
This code was auto-generated by the dmogenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dms.util.DmoFormatter.dumpDMO(DmoFormatter.java:134)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String constructionClassName
- Fields inherited from class org.dmd.dmc.DmcObject
  __objectClass, attributes

Fields
Modifier and Type	Field and Description
`static String`	`constructionClassName`

Constructor Summary

Constructors
Modifier Constructor and Description

EnumMappingDMO()

EnumMappingDMO(org.dmd.dms.generated.types.DmcTypeModifierMV mods)

protected EnumMappingDMO(String oc)

Constructors
Modifier	Constructor and Description
	`EnumMappingDMO()`
	`EnumMappingDMO(org.dmd.dms.generated.types.DmcTypeModifierMV mods)`
`protected`	`EnumMappingDMO(String oc)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.dmd.dmc.DmcAttribute<?>`	`addSkipEnumValue(Object value)` Adds another skipEnumValue value.
`org.dmd.dmc.DmcAttribute<?>`	`addSkipEnumValue(String value)` Adds another skipEnumValue to the specified value.
`org.dmd.dmc.DmcAttribute<?>`	`delSkipEnumValue(Object value)` Deletes a skipEnumValue value.
`org.dmd.dmc.DmcAttribute<?>`	`delSkipEnumValue(String value)` Deletes a skipEnumValue from the specified value.
`boolean`	`equals(Object obj)`
`String`	`getEmptyText()`
`String`	`getEnumName()`
`EnumMappingGeneratorREF`	`getMappingGenerator()`
`EnumMappingGeneratorREF`	`getMappingGeneratorREF()` Returns the reference to EnumMappingGenerator without attempting lazy resolution (if turned on).
`org.dmd.dmc.types.CamelCaseName`	`getMappingName()`
`EnumMappingDMO`	`getModificationRecorder()`
`EnumMappingDMO`	`getNew()`
`String`	`getNthSkipEnumValue(int i)`
`org.dmd.dmc.types.CamelCaseName`	`getObjectName()`
`org.dmd.dmc.DmcAttribute<?>`	`getObjectNameAttribute()`
`Iterator<String>`	`getSkipEnumValue()`
`int`	`getSkipEnumValueSize()` Returns the number of values in skipEnumValue
`EnumMappingDMO`	`getSlice(org.dmd.dmc.DmcSliceInfo info)`
`String`	`getUnsetValue()`
`int`	`hashCode()`
`Boolean`	`isUseNameAsLabel()`
`void`	`remEmptyText()` Removes the emptyText attribute value.
`void`	`remEnumName()` Removes the enumName attribute value.
`void`	`remMappingGenerator()` Removes the mappingGenerator attribute value.
`void`	`remMappingName()` Removes the mappingName attribute value.
`void`	`remSkipEnumValue()` Removes the skipEnumValue attribute value.
`void`	`remUnsetValue()` Removes the unsetValue attribute value.
`void`	`remUseNameAsLabel()` Removes the useNameAsLabel attribute value.
`void`	`setEmptyText(Object value)` Sets emptyText to the specified value.
`void`	`setEmptyText(String value)` Sets emptyText to the specified value.
`void`	`setEnumName(Object value)` Sets enumName to the specified value.
`void`	`setEnumName(String value)` Sets enumName to the specified value.
`void`	`setMappingGenerator(EnumMappingGeneratorDMO value)` Sets mappingGenerator to the specified value.
`void`	`setMappingGenerator(Object value)` Sets mappingGenerator to the specified value.
`void`	`setMappingName(org.dmd.dmc.types.CamelCaseName value)` Sets mappingName to the specified value.
`void`	`setMappingName(Object value)` Sets mappingName to the specified value.
`void`	`setUnsetValue(Object value)` Sets unsetValue to the specified value.
`void`	`setUnsetValue(String value)` Sets unsetValue to the specified value.
`void`	`setUseNameAsLabel(Boolean value)` Sets useNameAsLabel to the specified value.
`void`	`setUseNameAsLabel(Object value)` Sets useNameAsLabel to the specified value.
`boolean`	`skipEnumValueContains(String value)` Returns true if we contain a valued keyed by the specified String.

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmo.MvwDefinitionDMO
addDescription, addDescription, delDescription, delDescription, descriptionContains, getCamelCaseName, getDefinedInModule, getDefinedInModuleREF, getDescription, getDescriptionSize, getFile, getLineNumber, getNthDescription, remCamelCaseName, remDefinedInModule, remDescription, remFile, remLineNumber, setCamelCaseName, setCamelCaseName, setDefinedInModule, setDefinedInModule, setFile, setFile, setLineNumber, setLineNumber

Methods inherited from class org.dmd.dmc.DmcObject
add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, 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, notify, notifyAll, wait, wait, wait

- Field Detail
  - constructionClassName
```
public static final String constructionClassName
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EnumMappingDMO
```
public EnumMappingDMO()
```
  - EnumMappingDMO
```
protected EnumMappingDMO(String oc)
```
  - EnumMappingDMO
```
public EnumMappingDMO(org.dmd.dms.generated.types.DmcTypeModifierMV mods)
```
- Method Detail
  - getNew
```
public EnumMappingDMO getNew()
```
    Specified by:
    
    getNew in class org.dmd.dmc.DmcObject
  - getSlice
```
public EnumMappingDMO getSlice(org.dmd.dmc.DmcSliceInfo info)
```
    Specified by:
    
    getSlice in class org.dmd.dmc.DmcObject
  - getModificationRecorder
```
public EnumMappingDMO getModificationRecorder()
```
  - getObjectName
```
public org.dmd.dmc.types.CamelCaseName getObjectName()
```
    Specified by:
    
    getObjectName in interface org.dmd.dmc.DmcNamedObjectIF
    
    Overrides:
    
    getObjectName in class MvwDefinitionDMO
  - getObjectNameAttribute
```
public org.dmd.dmc.DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface org.dmd.dmc.DmcNamedObjectIF
    
    Overrides:
    
    getObjectNameAttribute in class MvwDefinitionDMO
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface org.dmd.dmc.DmcNamedObjectIF
    
    Overrides:
    
    equals in class MvwDefinitionDMO
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class MvwDefinitionDMO
  - isUseNameAsLabel
```
public Boolean isUseNameAsLabel()
```
  - setUseNameAsLabel
```
public void setUseNameAsLabel(Boolean value)
```
    Sets useNameAsLabel to the specified value.
    
    Parameters:
    
    value - Boolean
  - setUseNameAsLabel
```
public void setUseNameAsLabel(Object value)
                       throws org.dmd.dmc.DmcValueException
```
    Sets useNameAsLabel to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeBooleanSV
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - remUseNameAsLabel
```
public void remUseNameAsLabel()
```
    Removes the useNameAsLabel attribute value.
  - getSkipEnumValue
```
public Iterator<String> getSkipEnumValue()
```
    Returns:
    
    An Iterator of String objects.
  - getNthSkipEnumValue
```
public String getNthSkipEnumValue(int i)
```
    Returns:
    
    The nth String value.
  - addSkipEnumValue
```
public org.dmd.dmc.DmcAttribute<?> addSkipEnumValue(String value)
```
    Adds another skipEnumValue to the specified value.
    
    Parameters:
    
    value - String
  - skipEnumValueContains
```
public boolean skipEnumValueContains(String value)
```
    Returns true if we contain a valued keyed by the specified String.
    
    Parameters:
    
    value - String
  - addSkipEnumValue
```
public org.dmd.dmc.DmcAttribute<?> addSkipEnumValue(Object value)
                                             throws org.dmd.dmc.DmcValueException
```
    Adds another skipEnumValue value.
    
    Parameters:
    
    value - A value compatible with String
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - getSkipEnumValueSize
```
public int getSkipEnumValueSize()
```
    Returns the number of values in skipEnumValue
  - delSkipEnumValue
```
public org.dmd.dmc.DmcAttribute<?> delSkipEnumValue(Object value)
                                             throws org.dmd.dmc.DmcValueException
```
    Deletes a skipEnumValue value.
    
    Parameters:
    
    value - The String to be deleted from set of attribute values.
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - delSkipEnumValue
```
public org.dmd.dmc.DmcAttribute<?> delSkipEnumValue(String value)
```
    Deletes a skipEnumValue from the specified value.
    
    Parameters:
    
    value - String
  - remSkipEnumValue
```
public void remSkipEnumValue()
```
    Removes the skipEnumValue attribute value.
  - getEmptyText
```
public String getEmptyText()
```
  - setEmptyText
```
public void setEmptyText(String value)
```
    Sets emptyText to the specified value.
    
    Parameters:
    
    value - String
  - setEmptyText
```
public void setEmptyText(Object value)
                  throws org.dmd.dmc.DmcValueException
```
    Sets emptyText to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - remEmptyText
```
public void remEmptyText()
```
    Removes the emptyText attribute value.
  - getMappingName
```
public org.dmd.dmc.types.CamelCaseName getMappingName()
```
  - setMappingName
```
public void setMappingName(org.dmd.dmc.types.CamelCaseName value)
```
    Sets mappingName to the specified value.
    
    Parameters:
    
    value - CamelCaseName
  - setMappingName
```
public void setMappingName(Object value)
                    throws org.dmd.dmc.DmcValueException
```
    Sets mappingName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeCamelCaseNameSV
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - remMappingName
```
public void remMappingName()
```
    Removes the mappingName attribute value.
  - getEnumName
```
public String getEnumName()
```
  - setEnumName
```
public void setEnumName(String value)
```
    Sets enumName to the specified value.
    
    Parameters:
    
    value - String
  - setEnumName
```
public void setEnumName(Object value)
                 throws org.dmd.dmc.DmcValueException
```
    Sets enumName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - remEnumName
```
public void remEnumName()
```
    Removes the enumName attribute value.
  - getUnsetValue
```
public String getUnsetValue()
```
  - setUnsetValue
```
public void setUnsetValue(String value)
```
    Sets unsetValue to the specified value.
    
    Parameters:
    
    value - String
  - setUnsetValue
```
public void setUnsetValue(Object value)
                   throws org.dmd.dmc.DmcValueException
```
    Sets unsetValue to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeStringSV
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - remUnsetValue
```
public void remUnsetValue()
```
    Removes the unsetValue attribute value.
  - getMappingGenerator
```
public EnumMappingGeneratorREF getMappingGenerator()
```
  - getMappingGeneratorREF
```
public EnumMappingGeneratorREF getMappingGeneratorREF()
```
    Returns the reference to EnumMappingGenerator without attempting lazy resolution (if turned on).
  - setMappingGenerator
```
public void setMappingGenerator(EnumMappingGeneratorDMO value)
```
    Sets mappingGenerator to the specified value.
    
    Parameters:
    
    value - EnumMappingGeneratorDMO
  - setMappingGenerator
```
public void setMappingGenerator(Object value)
                         throws org.dmd.dmc.DmcValueException
```
    Sets mappingGenerator to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeEnumMappingGeneratorREFSV
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - remMappingGenerator
```
public void remMappingGenerator()
```
    Removes the mappingGenerator attribute value.

Class EnumMappingDMO

Field Summary

Fields inherited from class org.dmd.dmc.DmcObject

Constructor Summary

Method Summary

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmo.MvwDefinitionDMO

Methods inherited from class org.dmd.dmc.DmcObject

Methods inherited from class java.lang.Object

Field Detail

constructionClassName

Constructor Detail

EnumMappingDMO

EnumMappingDMO

EnumMappingDMO

Method Detail

getNew

getSlice

getModificationRecorder

getObjectName

getObjectNameAttribute

equals

hashCode

isUseNameAsLabel

setUseNameAsLabel

setUseNameAsLabel

remUseNameAsLabel

getSkipEnumValue

getNthSkipEnumValue

addSkipEnumValue

skipEnumValueContains

addSkipEnumValue

getSkipEnumValueSize

delSkipEnumValue

delSkipEnumValue

remSkipEnumValue

getEmptyText

setEmptyText

setEmptyText

remEmptyText

getMappingName

setMappingName

setMappingName

remMappingName

getEnumName

setEnumName

setEnumName

remEnumName

getUnsetValue

setUnsetValue

setUnsetValue

remUnsetValue

getMappingGenerator

getMappingGeneratorREF

setMappingGenerator

setMappingGenerator

remMappingGenerator