org.dmd.dmv.shared.generated.dmo

Class ReferencedAttributeTypeRuleDataDMO

java.lang.Object

org.dmd.dmc.DmcObject

org.dmd.dms.generated.dmo.RuleDataDMO

org.dmd.dmv.shared.generated.dmo.ReferencedAttributeTypeRuleDataDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

public class ReferencedAttributeTypeRuleDataDMO
extends RuleDataDMO
implements DmcNamedObjectIF, Serializable

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 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
	ReferencedAttributeTypeRuleDataDMO()
	ReferencedAttributeTypeRuleDataDMO(DmcTypeModifierMV mods)
protected	ReferencedAttributeTypeRuleDataDMO(String oc)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addAllowedType(Object value) Adds another allowedType value.
DmcAttribute<?>	addAllowedType(TypeDefinitionDMO value) Adds another allowedType to the specified value.
DmcAttribute<?>	addDescription(Object value) Adds another description value.
DmcAttribute<?>	addDescription(String value) Adds another description to the specified value.
DmcAttribute<?>	delAllowedType(Object value) Deletes a allowedType 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<TypeDefinitionREF>	getAllowedType()
Iterator<TypeDefinitionREF>	getAllowedTypeREFs()
int	getAllowedTypeSize()
ValueTypeEnum	getAllowedValueType()
AttributeDefinitionREF	getApplyToAttribute()
AttributeDefinitionREF	getApplyToAttributeREF()
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
ReferencedAttributeTypeRuleDataDMO	getModificationRecorder()
ReferencedAttributeTypeRuleDataDMO	getNew() Auto-generated derived classes override this to return an empty instance of themselves.
String	getNthDescription(int i)
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.
ReferencedAttributeTypeRuleDataDMO	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	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(AttributeDefinitionDMO value) Sets applyToAttribute to the specified value.
void	setApplyToAttribute(Object value) Sets 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.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

ReferencedAttributeTypeRuleDataDMO

public ReferencedAttributeTypeRuleDataDMO()

ReferencedAttributeTypeRuleDataDMO

protected ReferencedAttributeTypeRuleDataDMO(String oc)

ReferencedAttributeTypeRuleDataDMO

public ReferencedAttributeTypeRuleDataDMO(DmcTypeModifierMV mods)

Method Detail

getNew

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

getAllowedType

public Iterator<TypeDefinitionREF> getAllowedType()

Returns:

An Iterator of TypeDefinitionDMO objects.

getAllowedTypeREFs

public Iterator<TypeDefinitionREF> getAllowedTypeREFs()

Returns:

An Iterator of TypeDefinitionREFs without attempting lazy resolution (if it's turned on).

addAllowedType

public DmcAttribute<?> addAllowedType(TypeDefinitionDMO value)

Adds another allowedType to the specified value.

Parameters:

value - TypeDefinition

Returns:

the attribute instance

addAllowedType

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

Adds another allowedType value.

Parameters:

value - A value compatible with TypeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getAllowedTypeSize

public int getAllowedTypeSize()

Returns:

the number of values in allowedType

delAllowedType

public DmcAttribute<?> delAllowedType(Object value)

Deletes a allowedType value.

Parameters:

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

Returns:

the deleted attribute instance

remAllowedType

public void remAllowedType()

Removes the allowedType attribute value.

getAllowedValueType

public ValueTypeEnum getAllowedValueType()

setAllowedValueType

public void setAllowedValueType(ValueTypeEnum value)

Sets allowedValueType to the specified value.

Parameters:

value - ValueTypeEnum

setAllowedValueType

public void setAllowedValueType(Object value)
                         throws DmcValueException

Sets allowedValueType to the specified value.

Parameters:

value - A value compatible with DmcTypeValueTypeEnumSV

Throws:

DmcValueException - if value is not correct

remAllowedValueType

public void remAllowedValueType()

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

getApplyToAttribute

public AttributeDefinitionREF getApplyToAttribute()

Returns:

the AttributeDefinitionREF

getApplyToAttributeREF

public AttributeDefinitionREF getApplyToAttributeREF()

Returns:

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

setApplyToAttribute

public void setApplyToAttribute(AttributeDefinitionDMO value)

Sets applyToAttribute to the specified value.

Parameters:

value - AttributeDefinitionDMO

setApplyToAttribute

public void setApplyToAttribute(Object value)
                         throws DmcValueException

Sets applyToAttribute to the specified value.

Parameters:

value - A value compatible with DmcTypeAttributeDefinitionREFSV

Throws:

DmcValueException - if value is not correct

remApplyToAttribute

public void remApplyToAttribute()

Removes the applyToAttribute attribute value.