org.dmd.dms.generated.dmw

Class RuleDefinitionDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.DSDefinitionDMW

org.dmd.dms.DSDefinition

org.dmd.dms.generated.dmw.DmsDefinitionDMW

org.dmd.dms.DmsDefinition

org.dmd.dms.generated.dmw.RuleDefinitionDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

RuleDefinition

public class RuleDefinitionDMW
extends DmsDefinition
implements DmcDefinitionIF

The RuleDefinition allows for the definition of rules that can\n be applied to attributes or classes. Rules are not just for validation, they\n can be applied to objects at different times in an object's life cycle e.g. \n the InitRule can initialize a set of attributes to known values.\n

\n RuleDefinitions will result in the generation of ClassDefinitions that define the \n DMOs that will carry the parameters associated with the rule and the expectation\n that you will define an implementation class for the rule that derives from\n an abstract BaseImpl (base implementation) of the rule that provides common\n rule infrastructure and appropriate abstract methods that must be filled in.\n

\n RuleDefinitions and ClassDefinitions share the same dmdID space and the IDs must\n be unique. This is because each RuleDefinition results in the creation of a \n ClassDefinition for the DMO part of the rule that carries the rule parameters.

Author:

Auto Generated Generated from: org.dmd.dms.meta.MetaGenerator.dumpDMWClasses(MetaGenerator.java:1649)

Field Summary

Fields inherited from class org.dmd.dms.DmsDefinition

metaname

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuleDefinitionDMW()
protected	RuleDefinitionDMW(ClassDefinition cd)
protected	RuleDefinitionDMW(DmcObject obj)
protected	RuleDefinitionDMW(DmcObject obj, ClassDefinition cd)
protected	RuleDefinitionDMW(String mn)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addMay(AttributeDefinition value) Adds another may value.
DmcAttribute<?>	addMust(AttributeDefinition value) Adds another must value.
DmcAttribute<?>	addRuleCategory(RuleCategory value) Adds another ruleCategory value.
Dependency	getDependency() A reference to a single Dependency.
Integer	getDmdID() The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.
RuleDefinitionDMO	getDMO()
Boolean	getIsExtensible() Indicates whether or not the ClassDefinition associated with a RuleDefinition has classType EXTENSIBLE\n or not.
AttributeDefinitionIterableDMW	getMay() Indicates the set of attributes that an instance of a class MAY\n have.
int	getMaySize()
AttributeDefinitionIterableDMW	getMust() Indicates the set of attributes that an instance of a class MUST have.
int	getMustSize()
DefinitionName	getName() The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
RuleCategoryIterableDMW	getRuleCategory() The category of a rule.
int	getRuleCategorySize()
void	setDependency(Dependency value) Sets dependency to the specified value.
void	setDmcObject(DmcObject obj) Sets the core object.
void	setDmdID(Object value) Sets dmdID to the specified value.
void	setIsExtensible(Object value) Sets isExtensible to the specified value.
void	setName(Object value) Sets name to the specified value.

Methods inherited from class org.dmd.dms.DmsDefinition

getDmcObject

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

addRelatedToConcept, getRelatedToConcept, getRelatedToConceptSize

Methods inherited from class org.dmd.dms.DSDefinition

equals, getFullDotName, getNameOfModuleWhereThisCameFrom

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

addComment, addDescription, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDescription, getDescriptionSize, getDescriptionWithNewlines, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDefinedIn, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

getDefinedIn, getDotName, toOIF

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

equals

Constructor Detail

RuleDefinitionDMW

protected RuleDefinitionDMW()

RuleDefinitionDMW

protected RuleDefinitionDMW(DmcObject obj)

RuleDefinitionDMW

protected RuleDefinitionDMW(DmcObject obj,
                            ClassDefinition cd)

RuleDefinitionDMW

protected RuleDefinitionDMW(ClassDefinition cd)

RuleDefinitionDMW

protected RuleDefinitionDMW(String mn)
                     throws DmcValueException

Throws:

DmcValueException

Method Detail

setDmcObject

public void setDmcObject(DmcObject obj)

Description copied from class: DmcContainer

Sets the core object.

Specified by:

setDmcObject in interface DmcContainerIF

Overrides:

setDmcObject in class DmsDefinition

Parameters:

obj - The core object.

getDMO

public RuleDefinitionDMO getDMO()

Overrides:

getDMO in class DmsDefinitionDMW

getName

public DefinitionName getName()

The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part. A name starts with a letter followed\n by letters and numbers.

Specified by:

getName in interface DmcDefinitionIF

Overrides:

getName in class DmsDefinitionDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class DmsDefinitionDMW

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if the value is incorrect

getRuleCategory

public RuleCategoryIterableDMW getRuleCategory()

The category of a rule.

Returns:

the RuleCategory

addRuleCategory

public DmcAttribute<?> addRuleCategory(RuleCategory value)
                                throws DmcValueException

Adds another ruleCategory value.

Parameters:

value - A value compatible with RuleCategory

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getRuleCategorySize

public int getRuleCategorySize()

Returns:

the number of ruleCategory values.

getDmdID

public Integer getDmdID()

The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.

Returns:

the Integer

setDmdID

public void setDmdID(Object value)
              throws DmcValueException

Sets dmdID to the specified value.

Parameters:

value - A value compatible with DmcTypeIntegerSV

Throws:

DmcValueException - if the value is incorrect

getMust

public AttributeDefinitionIterableDMW getMust()

Indicates the set of attributes that an instance of a class MUST have.

Returns:

the AttributeDefinition

addMust

public DmcAttribute<?> addMust(AttributeDefinition value)
                        throws DmcValueException

Adds another must value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getMustSize

public int getMustSize()

Returns:

the number of must values.

getMay

public AttributeDefinitionIterableDMW getMay()

Indicates the set of attributes that an instance of a class MAY\n have. When accessed in Java, this is a set of references to AttributeDefinition\n objects.

Returns:

the AttributeDefinition

addMay

public DmcAttribute<?> addMay(AttributeDefinition value)
                       throws DmcValueException

Adds another may value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getMaySize

public int getMaySize()

Returns:

the number of may values.

getIsExtensible

public Boolean getIsExtensible()

Indicates whether or not the ClassDefinition associated with a RuleDefinition has classType EXTENSIBLE\n or not. This mechanism is useful in situations where the exact set of attributes associated with a rule must be flexible.\n The best example is the InitRule where any set of attributes can be specified as value for the rule.

Returns:

the Boolean

setIsExtensible

public void setIsExtensible(Object value)
                     throws DmcValueException

Sets isExtensible to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getDependency

public Dependency getDependency()

A reference to a single Dependency.

Returns:

the Dependency

setDependency

public void setDependency(Dependency value)
                   throws DmcValueException

Sets dependency to the specified value.

Parameters:

value - A value compatible with Dependency

Throws:

DmcValueException - if the value is incorrect

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class DmsDefinition

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class DmsDefinitionDMW

Returns:

The name attribute.