org.dmd.mvw.tools.mvwgenerator.generated.dmw

Class EnumMappingDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW

org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition

org.dmd.mvw.tools.mvwgenerator.generated.dmw.EnumMappingDMW

All Implemented Interfaces:

org.dmd.dmc.DmcContainerIF, org.dmd.dmc.DmcNamedObjectIF

Direct Known Subclasses:

EnumMapping

public abstract class EnumMappingDMW
extends MvwDefinition
implements org.dmd.dmc.DmcNamedObjectIF

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 dmggenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dmg.generators.BaseDMWGenerator.dumpWrapper(BaseDMWGenerator.java:488)

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	EnumMappingDMW()
	EnumMappingDMW(org.dmd.dms.generated.types.DmcTypeModifierMV mods)
	EnumMappingDMW(EnumMappingDMO obj)
protected	EnumMappingDMW(EnumMappingDMO obj, org.dmd.dms.ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addSkipEnumValue(Object value) Adds another skipEnumValue value.
void	addSkipEnumValue(String value) Adds another skipEnumValue value.
EnumMapping	cloneIt()
void	delSkipEnumValue(Object value) Deletes a skipEnumValue value.
void	delSkipEnumValue(String value) Deletes a skipEnumValue value.
boolean	equals(Object obj)
EnumMappingDMO	getDMO()
String	getEmptyText()
String	getEnumName()
EnumMappingGenerator	getMappingGenerator()
org.dmd.dmc.types.CamelCaseName	getMappingName()
EnumMapping	getModificationRecorder()
org.dmd.dmc.types.CamelCaseName	getObjectName()
org.dmd.dmc.DmcAttribute<?>	getObjectNameAttribute()
HashSet<String>	getSkipEnumValueCopy()
boolean	getSkipEnumValueHasValue()
boolean	getSkipEnumValueIsEmpty()
org.dmd.dms.generated.dmw.StringIterableDMW	getSkipEnumValueIterable()
int	getSkipEnumValueSize()
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(EnumMappingGenerator value) Sets the mappingGenerator to the specified value.
void	setMappingGenerator(Object value) Sets the 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 the collection contains the skipEnumValue value.

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition

resolveReferences

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW

addDescription, addDescription, delDescription, delDescription, descriptionContains, getCamelCaseName, getDefinedInModule, getDescriptionCopy, getDescriptionHasValue, getDescriptionIsEmpty, getDescriptionIterable, getDescriptionSize, getFile, getLineNumber, remCamelCaseName, remDefinedInModule, remDescription, remFile, remLineNumber, setCamelCaseName, setCamelCaseName, setDefinedInModule, setDefinedInModule, setFile, setFile, setLineNumber, setLineNumber

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumMappingDMW

public EnumMappingDMW()

EnumMappingDMW

public EnumMappingDMW(org.dmd.dms.generated.types.DmcTypeModifierMV mods)

EnumMappingDMW

public EnumMappingDMW(EnumMappingDMO obj)

EnumMappingDMW

protected EnumMappingDMW(EnumMappingDMO obj,
                         org.dmd.dms.ClassDefinition cd)

Method Detail

getModificationRecorder

public EnumMapping getModificationRecorder()

Specified by:

getModificationRecorder in class MvwDefinitionDMW

cloneIt

public EnumMapping cloneIt()

getDMO

public EnumMappingDMO getDMO()

Overrides:

getDMO in class MvwDefinitionDMW

getObjectName

public org.dmd.dmc.types.CamelCaseName getObjectName()

Specified by:

getObjectName in interface org.dmd.dmc.DmcNamedObjectIF

Overrides:

getObjectName in class MvwDefinitionDMW

hashCode

public int hashCode()

Overrides:

hashCode in class MvwDefinitionDMW

getObjectNameAttribute

public org.dmd.dmc.DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface org.dmd.dmc.DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class MvwDefinitionDMW

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.dmd.dmc.DmcNamedObjectIF

Overrides:

equals in class MvwDefinitionDMW

getEmptyText

public String getEmptyText()

setEmptyText

public void setEmptyText(Object value)
                  throws org.dmd.dmc.DmcValueException

Sets emptyText to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

org.dmd.dmc.DmcValueException

setEmptyText

public void setEmptyText(String value)

Sets emptyText to the specified value.

Parameters:

value - String

remEmptyText

public void remEmptyText()

Removes the emptyText attribute value.

getEnumName

public String getEnumName()

setEnumName

public void setEnumName(Object value)
                 throws org.dmd.dmc.DmcValueException

Sets enumName to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

org.dmd.dmc.DmcValueException

setEnumName

public void setEnumName(String value)

Sets enumName to the specified value.

Parameters:

value - String

remEnumName

public void remEnumName()

Removes the enumName attribute value.

getMappingGenerator

public EnumMappingGenerator getMappingGenerator()

Returns:

A EnumMappingGenerator object.

setMappingGenerator

public void setMappingGenerator(EnumMappingGenerator value)

Sets the mappingGenerator to the specified value.

Parameters:

value - A value compatible with EnumMappingGeneratorREF

setMappingGenerator

public void setMappingGenerator(Object value)
                         throws org.dmd.dmc.DmcValueException

Sets the mappingGenerator to the specified value.

Parameters:

value - A value compatible with EnumMappingGeneratorREF

Throws:

org.dmd.dmc.DmcValueException

remMappingGenerator

public void remMappingGenerator()

Removes the mappingGenerator attribute value.

getMappingName

public org.dmd.dmc.types.CamelCaseName getMappingName()

setMappingName

public void setMappingName(Object value)
                    throws org.dmd.dmc.DmcValueException

Sets mappingName to the specified value.

Parameters:

value - A value compatible with DmcTypeCamelCaseName

Throws:

org.dmd.dmc.DmcValueException

setMappingName

public void setMappingName(org.dmd.dmc.types.CamelCaseName value)

Sets mappingName to the specified value.

Parameters:

value - CamelCaseName

remMappingName

public void remMappingName()

Removes the mappingName attribute value.

getSkipEnumValueSize

public int getSkipEnumValueSize()

Returns:

The number of String items.

getSkipEnumValueIsEmpty

public boolean getSkipEnumValueIsEmpty()

Returns:

true if there are no StringDMO items.

getSkipEnumValueHasValue

public boolean getSkipEnumValueHasValue()

Returns:

true if there are any StringDMO items.

getSkipEnumValueIterable

public org.dmd.dms.generated.dmw.StringIterableDMW getSkipEnumValueIterable()

Returns:

An Iterator of String objects.

addSkipEnumValue

public void addSkipEnumValue(Object value)
                      throws org.dmd.dmc.DmcValueException

Adds another skipEnumValue value.

Parameters:

value - A value compatible with String

Throws:

org.dmd.dmc.DmcValueException

addSkipEnumValue

public void addSkipEnumValue(String value)

Adds another skipEnumValue value.

Parameters:

value - A value compatible with String

skipEnumValueContains

public boolean skipEnumValueContains(String value)

Returns true if the collection contains the skipEnumValue value.

Parameters:

value - A value compatible with String

getSkipEnumValueCopy

public HashSet<String> getSkipEnumValueCopy()

Returns:

A COPY of the collection of String objects.

delSkipEnumValue

public void 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 void delSkipEnumValue(String value)

Deletes a skipEnumValue value.

Parameters:

value - The String to be deleted from set of attribute values.

remSkipEnumValue

public void remSkipEnumValue()

Removes the skipEnumValue attribute value.

getUnsetValue

public String getUnsetValue()

setUnsetValue

public void setUnsetValue(Object value)
                   throws org.dmd.dmc.DmcValueException

Sets unsetValue to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

org.dmd.dmc.DmcValueException

setUnsetValue

public void setUnsetValue(String value)

Sets unsetValue to the specified value.

Parameters:

value - String

remUnsetValue

public void remUnsetValue()

Removes the unsetValue attribute value.

isUseNameAsLabel

public Boolean isUseNameAsLabel()

setUseNameAsLabel

public void setUseNameAsLabel(Object value)
                       throws org.dmd.dmc.DmcValueException

Sets useNameAsLabel to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

org.dmd.dmc.DmcValueException

setUseNameAsLabel

public void setUseNameAsLabel(Boolean value)

Sets useNameAsLabel to the specified value.

Parameters:

value - Boolean

remUseNameAsLabel

public void remUseNameAsLabel()

Removes the useNameAsLabel attribute value.