org.dmd.dmv.server.generated.dmw

Class StringSetRuleDataDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.RuleDataDMW

org.dmd.dms.RuleData

org.dmd.dmv.server.generated.dmw.StringSetRuleDataDMW

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

public class StringSetRuleDataDMW
extends RuleData
implements DmcNamedObjectIF

The StringSetRule lets you specify a set of strings that are allowed as values for an attribute.\n

\n StringSetRule\n ruleName    fishRule\n
 ruleTitle      The fish must be one of red fish, blue fish or green fish.\n
 applyToAttribute fish\n allowedString red fish\n allowedString blue fish\n
 allowedString green fish\n 

Generated from the dmv 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
	StringSetRuleDataDMW()
	StringSetRuleDataDMW(DmcTypeModifierMV mods)
	StringSetRuleDataDMW(StringSetRuleDataDMO obj)
protected	StringSetRuleDataDMW(StringSetRuleDataDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addAllowedString(Object value) Adds another allowedString value.
void	addAllowedString(String value) Adds another allowedString value.
void	addDescription(Object value) Adds another description value.
void	addDescription(String value) Adds another description value.
boolean	allowedStringContains(String value)
StringSetRuleDataDMW	cloneIt()
void	delAllowedString(Object value) Deletes a allowedString value.
void	delAllowedString(String value) Deletes a allowedString value.
void	delDescription(Object value) Deletes a description value.
void	delDescription(String value) Deletes a description value.
boolean	descriptionContains(String value)
boolean	equals(Object obj) This method should check the type of the obj param and compare the name of this object with the one passed as argument.
HashSet<String>	getAllowedStringCopy()
boolean	getAllowedStringHasValue()
boolean	getAllowedStringIsEmpty()
StringIterableDMW	getAllowedStringIterable()
int	getAllowedStringSize()
AttributeDefinition	getApplyToAttribute()
ArrayList<String>	getDescriptionCopy()
boolean	getDescriptionHasValue()
boolean	getDescriptionIsEmpty()
StringIterableDMW	getDescriptionIterable()
int	getDescriptionSize()
StringSetRuleDataDMO	getDMO()
StringSetRuleDataDMW	getModificationRecorder()
RuleName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
RuleName	getRuleName() The ruleName attribute is used to store a single camelCase format name for a rule.\n The name starts with a single letter and can be followed by a mix of letters and numbers.
String	getRuleTitle() The title of a rule.
int	hashCode()
void	remAllowedString() Removes the allowedString attribute value.
void	remApplyToAttribute() Removes the applyToAttribute attribute value.
void	remDescription() Removes the description attribute value.
void	remRuleName() Removes the ruleName attribute value.
void	remRuleTitle() Removes the ruleTitle attribute value.
void	setApplyToAttribute(AttributeDefinition value) Sets the applyToAttribute to the specified value.
void	setApplyToAttribute(Object value) Sets the applyToAttribute to the specified value.
void	setRuleName(Object value) Sets ruleName to the specified value.
void	setRuleName(RuleName value) Sets ruleName to the specified value.
void	setRuleTitle(Object value) Sets ruleTitle to the specified value.
void	setRuleTitle(String value) Sets ruleTitle to the specified value.

Methods inherited from class org.dmd.dms.generated.dmw.RuleDataDMW

addMsgParam, getApplyToClass, getDefinedIn, getDescription, getDescriptionWithNewlines, getFile, getImmediateHalt, getLineNumber, getMsgKey, getMsgParam, getMsgParamSize, setApplyToClass, setDefinedIn, setDmcObject, setFile, setImmediateHalt, setLineNumber, setMsgKey

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, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSetRuleDataDMW

public StringSetRuleDataDMW()

StringSetRuleDataDMW

public StringSetRuleDataDMW(DmcTypeModifierMV mods)

StringSetRuleDataDMW

public StringSetRuleDataDMW(StringSetRuleDataDMO obj)

StringSetRuleDataDMW

protected StringSetRuleDataDMW(StringSetRuleDataDMO obj,
                               ClassDefinition cd)

Method Detail

getModificationRecorder

public StringSetRuleDataDMW getModificationRecorder()

cloneIt

public StringSetRuleDataDMW cloneIt()

getDMO

public StringSetRuleDataDMO getDMO()

Overrides:

getDMO in class RuleDataDMW

getObjectName

public RuleName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class RuleDataDMW

Returns:

The name of this object from the ruleName attribute.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class RuleDataDMW

Returns:

The ruleName attribute.

equals

public boolean equals(Object obj)

Description copied from interface: DmcNamedObjectIF

This method should check the type of the obj param and compare the name of this object with the one passed as argument.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class DmwWrapper

Parameters:

obj - The comparison object.

Returns:

True if the names match.

getAllowedStringSize

public int getAllowedStringSize()

Returns:

The number of String items.

getAllowedStringIsEmpty

public boolean getAllowedStringIsEmpty()

Returns:

true if there are no StringDMO items.

getAllowedStringHasValue

public boolean getAllowedStringHasValue()

Returns:

true if there are any StringDMO items.

getAllowedStringIterable

public StringIterableDMW getAllowedStringIterable()

Returns:

An Iterator of String objects.

addAllowedString

public void addAllowedString(Object value)
                      throws DmcValueException

Adds another allowedString value.

Parameters:

value - A value compatible with String

Throws:

DmcValueException - if value is incorrect

addAllowedString

public void addAllowedString(String value)

Adds another allowedString value.

Parameters:

value - A value compatible with String

allowedStringContains

public boolean allowedStringContains(String value)

Parameters:

value - A value compatible with String

Returns:

true if the collection contains the allowedString value.

getAllowedStringCopy

public HashSet<String> getAllowedStringCopy()

Returns:

A COPY of the collection of String objects.

delAllowedString

public void delAllowedString(Object value)
                      throws DmcValueException

Deletes a allowedString value.

Parameters:

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

Throws:

DmcValueException - if value is incorrect

delAllowedString

public void delAllowedString(String value)

Deletes a allowedString value.

Parameters:

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

remAllowedString

public void remAllowedString()

Removes the allowedString attribute value.

getApplyToAttribute

public AttributeDefinition getApplyToAttribute()

Returns:

A AttributeDefinition object.

setApplyToAttribute

public void setApplyToAttribute(AttributeDefinition value)

Sets the applyToAttribute to the specified value.

Parameters:

value - A value compatible with AttributeDefinitionREF

setApplyToAttribute

public void setApplyToAttribute(Object value)
                         throws DmcValueException

Sets the applyToAttribute to the specified value.

Parameters:

value - A value compatible with AttributeDefinitionREF

Throws:

DmcValueException - is the value is incorrect

remApplyToAttribute

public void remApplyToAttribute()

Removes the applyToAttribute attribute value.

getDescriptionSize

public int getDescriptionSize()

Overrides:

getDescriptionSize in class RuleDataDMW

Returns:

The number of String items.

getDescriptionIsEmpty

public boolean getDescriptionIsEmpty()

Returns:

true if there are no StringDMO items.

getDescriptionHasValue

public boolean getDescriptionHasValue()

Returns:

true if there are any StringDMO items.

getDescriptionIterable

public StringIterableDMW getDescriptionIterable()

Returns:

An Iterator of String objects.

addDescription

public void addDescription(Object value)
                    throws DmcValueException

Adds another description value.

Overrides:

addDescription in class RuleDataDMW

Parameters:

value - A value compatible with String

Throws:

DmcValueException - if value is incorrect

addDescription

public void addDescription(String value)

Adds another description value.

Parameters:

value - A value compatible with String

descriptionContains

public boolean descriptionContains(String value)

Parameters:

value - A value compatible with String

Returns:

true if the collection contains the description value.

getDescriptionCopy

public ArrayList<String> getDescriptionCopy()

Returns:

A COPY of the collection of String objects.

delDescription

public void delDescription(Object value)
                    throws DmcValueException

Deletes a description value.

Parameters:

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

Throws:

DmcValueException - if value is incorrect

delDescription

public void delDescription(String value)

Deletes a description value.

Parameters:

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

remDescription

public void remDescription()

Removes the description attribute value.

getRuleName

public RuleName getRuleName()

Description copied from class: RuleDataDMW

The ruleName attribute is used to store a single camelCase format name for a rule.\n The name starts with a single letter and can be followed by a mix of letters and numbers. No spaces or \n other characters are allowed.

Overrides:

getRuleName in class RuleDataDMW

Returns:

the RuleName

setRuleName

public void setRuleName(Object value)
                 throws DmcValueException

Sets ruleName to the specified value.

Overrides:

setRuleName in class RuleDataDMW

Parameters:

value - A value compatible with DmcTypeRuleName

Throws:

DmcValueException - if the value is incorrect

setRuleName

public void setRuleName(RuleName value)

Sets ruleName to the specified value.

Parameters:

value - RuleName

remRuleName

public void remRuleName()

Removes the ruleName attribute value.

getRuleTitle

public String getRuleTitle()

Description copied from class: RuleDataDMW

The title of a rule.

Overrides:

getRuleTitle in class RuleDataDMW

Returns:

the String

setRuleTitle

public void setRuleTitle(Object value)
                  throws DmcValueException

Sets ruleTitle to the specified value.

Overrides:

setRuleTitle in class RuleDataDMW

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException - if the value is incorrect

setRuleTitle

public void setRuleTitle(String value)

Sets ruleTitle to the specified value.

Parameters:

value - String

remRuleTitle

public void remRuleTitle()

Removes the ruleTitle attribute value.