org.dmd.dmv.server.generated.dmw

Class RelatedNumbersRuleDataDMW

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

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

public class RelatedNumbersRuleDataDMW
extends RuleData
implements DmcNamedObjectIF

The RelatedNumbersRule ensures that a particular numeric\n relationship exists between two single-valued, numeric values on an object.\n An example usage might be:\n

\n RelatedNumbersRuleData\n ruleName       
 dmvHeightGirth\n ruleTitle       Your height must exceed your girth.\n
 applyToClass    Person\n lhs             height\n rhs             girth\n
 numericRelation GT\n description     If your girth exceeds your height,
 you're in trouble!\n 

\n The rule will only test the relationship if both attributes exist; if not,\n that's okay - the rule will pass.\n

\n It's a good rule of thumb to indicate the relationship you expect in the\n title of the rule since this is what will be returned in the case that \n the relationship check fails.\n

\n NOTE: this rule works by implicitly converting the values of the attributes\n to type Double in order to be able to compare apples to apples. However,\n if you are dealing with large numeric values you may run into issues.

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
	RelatedNumbersRuleDataDMW()
	RelatedNumbersRuleDataDMW(DmcTypeModifierMV mods)
	RelatedNumbersRuleDataDMW(RelatedNumbersRuleDataDMO obj)
protected	RelatedNumbersRuleDataDMW(RelatedNumbersRuleDataDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addDescription(Object value) Adds another description value.
void	addDescription(String value) Adds another description value.
RelatedNumbersRuleDataDMW	cloneIt()
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.
ArrayList<String>	getDescriptionCopy()
boolean	getDescriptionHasValue()
boolean	getDescriptionIsEmpty()
StringIterableDMW	getDescriptionIterable()
int	getDescriptionSize()
RelatedNumbersRuleDataDMO	getDMO()
AttributeDefinition	getLhs()
RelatedNumbersRuleDataDMW	getModificationRecorder()
NumericRelationEnum	getNumericRelation()
RuleName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
AttributeDefinition	getRhs()
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	remDescription() Removes the description attribute value.
void	remLhs() Removes the lhs attribute value.
void	remNumericRelation() Removes the numericRelation attribute value.
void	remRhs() Removes the rhs attribute value.
void	remRuleName() Removes the ruleName attribute value.
void	remRuleTitle() Removes the ruleTitle attribute value.
void	setLhs(AttributeDefinition value) Sets the lhs to the specified value.
void	setLhs(Object value) Sets the lhs to the specified value.
void	setNumericRelation(NumericRelationEnum value) Sets numericRelation to the specified value.
void	setNumericRelation(Object value) Sets numericRelation to the specified value.
void	setRhs(AttributeDefinition value) Sets the rhs to the specified value.
void	setRhs(Object value) Sets the rhs 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

RelatedNumbersRuleDataDMW

public RelatedNumbersRuleDataDMW()

RelatedNumbersRuleDataDMW

public RelatedNumbersRuleDataDMW(DmcTypeModifierMV mods)

RelatedNumbersRuleDataDMW

public RelatedNumbersRuleDataDMW(RelatedNumbersRuleDataDMO obj)

RelatedNumbersRuleDataDMW

protected RelatedNumbersRuleDataDMW(RelatedNumbersRuleDataDMO obj,
                                    ClassDefinition cd)

Method Detail

getModificationRecorder

public RelatedNumbersRuleDataDMW getModificationRecorder()

cloneIt

public RelatedNumbersRuleDataDMW cloneIt()

getDMO

public RelatedNumbersRuleDataDMO 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.

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.

getLhs

public AttributeDefinition getLhs()

Returns:

A AttributeDefinition object.

setLhs

public void setLhs(AttributeDefinition value)

Sets the lhs to the specified value.

Parameters:

value - A value compatible with AttributeDefinitionREF

setLhs

public void setLhs(Object value)
            throws DmcValueException

Sets the lhs to the specified value.

Parameters:

value - A value compatible with AttributeDefinitionREF

Throws:

DmcValueException - is the value is incorrect

remLhs

public void remLhs()

Removes the lhs attribute value.

getNumericRelation

public NumericRelationEnum getNumericRelation()

setNumericRelation

public void setNumericRelation(Object value)
                        throws DmcValueException

Sets numericRelation to the specified value.

Parameters:

value - A value compatible with DmcTypeNumericRelationEnum

Throws:

DmcValueException

setNumericRelation

public void setNumericRelation(NumericRelationEnum value)

Sets numericRelation to the specified value.

Parameters:

value - NumericRelationEnum

remNumericRelation

public void remNumericRelation()

Removes the numericRelation attribute value.

getRhs

public AttributeDefinition getRhs()

Returns:

A AttributeDefinition object.

setRhs

public void setRhs(AttributeDefinition value)

Sets the rhs to the specified value.

Parameters:

value - A value compatible with AttributeDefinitionREF

setRhs

public void setRhs(Object value)
            throws DmcValueException

Sets the rhs to the specified value.

Parameters:

value - A value compatible with AttributeDefinitionREF

Throws:

DmcValueException - is the value is incorrect

remRhs

public void remRhs()

Removes the rhs 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.