org.dmd.dmv.shared.generated.dmo

Class RelatedNumbersRuleDataDMO

java.lang.Object

org.dmd.dmc.DmcObject

org.dmd.dms.generated.dmo.RuleDataDMO

org.dmd.dmv.shared.generated.dmo.RelatedNumbersRuleDataDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

public class RelatedNumbersRuleDataDMO
extends RuleDataDMO
implements DmcNamedObjectIF, Serializable

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	RelatedNumbersRuleDataDMO()
	RelatedNumbersRuleDataDMO(DmcTypeModifierMV mods)
protected	RelatedNumbersRuleDataDMO(String oc)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addDescription(Object value) Adds another description value.
DmcAttribute<?>	addDescription(String value) Adds another description to the specified value.
DmcAttribute<?>	delDescription(Object value) Deletes a description value.
DmcAttribute<?>	delDescription(String value) Deletes a description from the specified value.
boolean	descriptionContains(String value)
boolean	equals(Object obj) This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
AttributeDefinitionREF	getLhs()
AttributeDefinitionREF	getLhsREF()
RelatedNumbersRuleDataDMO	getModificationRecorder()
RelatedNumbersRuleDataDMO	getNew() Auto-generated derived classes override this to return an empty instance of themselves.
String	getNthDescription(int i)
NumericRelationEnum	getNumericRelation()
RuleName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
AttributeDefinitionREF	getRhs()
AttributeDefinitionREF	getRhsREF()
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.
RelatedNumbersRuleDataDMO	getSlice(DmcSliceInfo info) Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
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(AttributeDefinitionDMO value) Sets lhs to the specified value.
void	setLhs(Object value) Sets 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(AttributeDefinitionDMO value) Sets rhs to the specified value.
void	setRhs(Object value) Sets 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.dmo.RuleDataDMO

addMsgParam, getApplyToClass, getDefinedIn, getDescriptionWithNewlines, getFile, getIdToAttrInfo, getImmediateHalt, getLineNumber, getMsgKey, getMsgParam, getStringToAttrInfo, setApplyToClass, setDefinedIn, setFile, setImmediateHalt, setLineNumber, setMsgKey

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

RelatedNumbersRuleDataDMO

public RelatedNumbersRuleDataDMO()

RelatedNumbersRuleDataDMO

protected RelatedNumbersRuleDataDMO(String oc)

RelatedNumbersRuleDataDMO

public RelatedNumbersRuleDataDMO(DmcTypeModifierMV mods)

Method Detail

getNew

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

Returns:

An instance of the derived class.

getSlice

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

Parameters:

info - the slice info

Returns:

An instance of the derived class with the specified slice of attributes.

getModificationRecorder

public RelatedNumbersRuleDataDMO getModificationRecorder()

getObjectName

public RuleName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class RuleDataDMO

Returns:

The name of this object from the ruleName attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class RuleDataDMO

Returns:

The ruleName attribute.

equals

public boolean equals(Object obj)

Description copied from class: DmcObject

This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class DmcObject

Parameters:

obj - The comparison object.

Returns:

true if we equal the specified object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDescription

public Iterator<String> getDescription()

Description copied from class: RuleDataDMO

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 RuleDataDMO

Returns:

An Iterator of String objects.

getNthDescription

public String getNthDescription(int i)

Parameters:

i - the index

Returns:

The nth String value.

addDescription

public DmcAttribute<?> addDescription(String value)

Adds another description to the specified value.

Parameters:

value - String

Returns:

the attribute instance

descriptionContains

public boolean descriptionContains(String value)

Parameters:

value - String

Returns:

true if we contain a valued keyed by the specified String.

addDescription

public DmcAttribute<?> addDescription(Object value)
                               throws DmcValueException

Adds another description value.

Overrides:

addDescription in class RuleDataDMO

Parameters:

value - A value compatible with String

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getDescriptionSize

public int getDescriptionSize()

Returns:

the number of values in description

delDescription

public DmcAttribute<?> delDescription(Object value)
                               throws DmcValueException

Deletes a description value.

Parameters:

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

Returns:

the deleted attribute instance

Throws:

DmcValueException - if the value is incorrect

delDescription

public DmcAttribute<?> delDescription(String value)

Deletes a description from the specified value.

Parameters:

value - String

Returns:

the deleted attribute instance

remDescription

public void remDescription()

Removes the description attribute value.

getRuleName

public RuleName getRuleName()

Description copied from class: RuleDataDMO

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 RuleDataDMO

Returns:

the RuleName

setRuleName

public void setRuleName(RuleName value)

Sets ruleName to the specified value.

Parameters:

value - RuleName

setRuleName

public void setRuleName(Object value)
                 throws DmcValueException

Sets ruleName to the specified value.

Overrides:

setRuleName in class RuleDataDMO

Parameters:

value - A value compatible with DmcTypeRuleNameSV

Throws:

DmcValueException - if value is not correct

remRuleName

public void remRuleName()

Removes the ruleName attribute value.

getRuleTitle

public String getRuleTitle()

Description copied from class: RuleDataDMO

The title of a rule.

Overrides:

getRuleTitle in class RuleDataDMO

Returns:

the String

setRuleTitle

public void setRuleTitle(String value)

Sets ruleTitle to the specified value.

Parameters:

value - String

setRuleTitle

public void setRuleTitle(Object value)
                  throws DmcValueException

Sets ruleTitle to the specified value.

Overrides:

setRuleTitle in class RuleDataDMO

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if value is not correct

remRuleTitle

public void remRuleTitle()

Removes the ruleTitle attribute value.

getLhs

public AttributeDefinitionREF getLhs()

Returns:

the AttributeDefinitionREF

getLhsREF

public AttributeDefinitionREF getLhsREF()

Returns:

the reference to AttributeDefinition without attempting lazy resolution (if turned on).

setLhs

public void setLhs(AttributeDefinitionDMO value)

Sets lhs to the specified value.

Parameters:

value - AttributeDefinitionDMO

setLhs

public void setLhs(Object value)
            throws DmcValueException

Sets lhs to the specified value.

Parameters:

value - A value compatible with DmcTypeAttributeDefinitionREFSV

Throws:

DmcValueException - if value is not correct

remLhs

public void remLhs()

Removes the lhs attribute value.

getRhs

public AttributeDefinitionREF getRhs()

Returns:

the AttributeDefinitionREF

getRhsREF

public AttributeDefinitionREF getRhsREF()

Returns:

the reference to AttributeDefinition without attempting lazy resolution (if turned on).

setRhs

public void setRhs(AttributeDefinitionDMO value)

Sets rhs to the specified value.

Parameters:

value - AttributeDefinitionDMO

setRhs

public void setRhs(Object value)
            throws DmcValueException

Sets rhs to the specified value.

Parameters:

value - A value compatible with DmcTypeAttributeDefinitionREFSV

Throws:

DmcValueException - if value is not correct

remRhs

public void remRhs()

Removes the rhs attribute value.

getNumericRelation

public NumericRelationEnum getNumericRelation()

setNumericRelation

public void setNumericRelation(NumericRelationEnum value)

Sets numericRelation to the specified value.

Parameters:

value - NumericRelationEnum

setNumericRelation

public void setNumericRelation(Object value)
                        throws DmcValueException

Sets numericRelation to the specified value.

Parameters:

value - A value compatible with DmcTypeNumericRelationEnumSV

Throws:

DmcValueException - if value is not correct

remNumericRelation

public void remNumericRelation()

Removes the numericRelation attribute value.