org.dmd.dmv.server.generated.dmw

Class ReferencedAttributeTypeRuleDataDMW

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

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

public class ReferencedAttributeTypeRuleDataDMW
extends RuleData
implements DmcNamedObjectIF

The ReferencedAttributeTypeRule allows you to restrict the type of\n an attribute referred to by an AttributeDefinition reference. Some examples include:\n

\n ReferencedAttributeTypeRuleData\n ruleName         
 dmvNRRApplyToAttribute\n ruleTitle         The applyToAttribute attribute
 in a NumericRangeRuleData instance must refer to an Integer, Long, Float
 or Double attribute\n applyToAttribute  applyToAttribute\n applyToClass   
   NumericRangeRuleData\n allowedType       Integer\n allowedType      
 Long\n allowedType       Float\n allowedType       Double\n 

\n In this case, we're restricting the applyToAttribute to be a numeric type, either Integer, Long Float or Double.\n

\n You can also restrict the valueType of an attribute reference, for instance:\n

\n
 ReferencedAttributeTypeRuleData\n ruleName          dmvLhs\n ruleTitle    
     The lhs attribute must be a single valued Integer, Long, Float or
 Double\n applyToAttribute  lhs\n applyToClass     
 RelatedNumbersRuleData\n allowedType       Integer\n allowedType      
 Long\n allowedType       Float\n allowedType       Double\n
 allowedValueType  SINGLE\n 

\n Here, we're indicating that the lhs (left hand side) attribute must be single valued.

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

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addAllowedType(TypeDefinition value) Adds another allowedType value.
void	addDescription(Object value) Adds another description value.
void	addDescription(String value) Adds another description value.
ReferencedAttributeTypeRuleDataDMW	cloneIt()
void	delAllowedType(TypeDefinition value) Deletes a allowedType 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.
ArrayList<TypeDefinition>	getAllowedTypeCopy()
boolean	getAllowedTypeHasValue()
boolean	getAllowedTypeIsEmpty()
TypeDefinitionIterableDMW	getAllowedTypeIterable()
int	getAllowedTypeSize()
ValueTypeEnum	getAllowedValueType()
AttributeDefinition	getApplyToAttribute()
ArrayList<String>	getDescriptionCopy()
boolean	getDescriptionHasValue()
boolean	getDescriptionIsEmpty()
StringIterableDMW	getDescriptionIterable()
int	getDescriptionSize()
ReferencedAttributeTypeRuleDataDMO	getDMO()
ReferencedAttributeTypeRuleDataDMW	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	remAllowedType() Removes the allowedType attribute value.
void	remAllowedValueType() Removes the allowedValueType 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	setAllowedValueType(Object value) Sets allowedValueType to the specified value.
void	setAllowedValueType(ValueTypeEnum value) Sets allowedValueType to the specified 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

ReferencedAttributeTypeRuleDataDMW

public ReferencedAttributeTypeRuleDataDMW()

ReferencedAttributeTypeRuleDataDMW

public ReferencedAttributeTypeRuleDataDMW(DmcTypeModifierMV mods)

ReferencedAttributeTypeRuleDataDMW

public ReferencedAttributeTypeRuleDataDMW(ReferencedAttributeTypeRuleDataDMO obj)

ReferencedAttributeTypeRuleDataDMW

protected ReferencedAttributeTypeRuleDataDMW(ReferencedAttributeTypeRuleDataDMO obj,
                                             ClassDefinition cd)

Method Detail

getModificationRecorder

public ReferencedAttributeTypeRuleDataDMW getModificationRecorder()

cloneIt

public ReferencedAttributeTypeRuleDataDMW cloneIt()

getDMO

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

getAllowedTypeSize

public int getAllowedTypeSize()

Returns:

The number of TypeDefinition items.

getAllowedTypeIsEmpty

public boolean getAllowedTypeIsEmpty()

Returns:

true if there are no TypeDefinitionDMO items.

getAllowedTypeHasValue

public boolean getAllowedTypeHasValue()

Returns:

true if there are any TypeDefinitionDMO items.

getAllowedTypeIterable

public TypeDefinitionIterableDMW getAllowedTypeIterable()

Returns:

An Iterator of TypeDefinitionDMO objects.

addAllowedType

public DmcAttribute<?> addAllowedType(TypeDefinition value)

Adds another allowedType value.

Parameters:

value - A value compatible with TypeDefinition

Returns:

the attribute instance

delAllowedType

public void delAllowedType(TypeDefinition value)

Deletes a allowedType value.

Parameters:

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

getAllowedTypeCopy

public ArrayList<TypeDefinition> getAllowedTypeCopy()

Returns:

A COPY of the collection of TypeDefinition objects.

remAllowedType

public void remAllowedType()

Removes the allowedType attribute value.

getAllowedValueType

public ValueTypeEnum getAllowedValueType()

setAllowedValueType

public void setAllowedValueType(Object value)
                         throws DmcValueException

Sets allowedValueType to the specified value.

Parameters:

value - A value compatible with DmcTypeValueTypeEnum

Throws:

DmcValueException

setAllowedValueType

public void setAllowedValueType(ValueTypeEnum value)

Sets allowedValueType to the specified value.

Parameters:

value - ValueTypeEnum

remAllowedValueType

public void remAllowedValueType()

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