org.dmd.dmc

Interface DmcMappedAttributeIF

All Known Subinterfaces:

DmcHierarchicObjectNameIF, DmcObjectNameIF

All Known Implementing Classes:

ABConceptXREF, AConceptBaseREF, AConceptXREF, ActifactGeneratorREF, ActionDefinitionREF, AllowedAttributesRuleDataREF, AttributeDefinitionREF, BaseObjREF, BConceptBaseREF, BConceptXREF, CamelCaseName, CardinalityRuleDataREF, CConceptBaseREF, CConceptXREF, CheckAttributesBasedOnValueRuleDataREF, ClassDefinitionREF, ClassInfoRef, ComplexTypeDefinitionREF, ConceptREF, ConcinnityDefinitionREF, ConcinnityModuleREF, ConcinnityREF, ContainedElementREF, DefinitionName, DependencyImplementationREF, DependencyREF, DmcHierarchicObjectName, DmcNamedObjectNontransportableREF, DmcNamedObjectREF, DmcNamedObjectTransportableREF, DmcObjectName, DmsDefinitionREF, DmtStringName, DmuDefinitionREF, DmuModuleREF, DotName, DotNamedObjectREF, DSDefinitionModuleREF, DSDefinitionREF, EnumDefinitionREF, ExtendedReferenceTypeDefinitionREF, ExtensionHookREF, FullyQualifiedName, GenerationContextREF, HierarchicObjectREF, InitRuleDataREF, IntegerName, IntegerNamedObjectREF, IntegerToBoolean, IntegerToString, IntegerToUUIDLite, KeyedType, LabelledIntegerDataPoint, LDAPHierarchicObjectREF, LongName, MethodGeneratorREF, ModuleAREF, ModuleBREF, ModuleCREF, NameContainer, NamedObjectRuleDataREF, NumericRangeRuleDataREF, ObjWithRefsDerivedAREF, ObjWithRefsDerivedBREF, ObjWithRefsREF, OneOfTheseAttributesRequiredRuleDataREF, OnlyOneOfTheseAttributesAllowedRuleDataREF, PartCheckerRuleDataREF, PatternMatchRuleDataREF, PayloadExampleREF, PayloadSortInfoREF, ReferencedAttributeTypeRuleDataREF, RelatedNumbersRuleDataREF, RestrictReferencesRuleDataREF, RuleCategoryREF, RuleDataREF, RuleDefinitionREF, RuleName, RunContextREF, SchemaDefinitionREF, SectionREF, SliceDefinitionREF, SomeRelation, StringName, StringSetRuleDataREF, StringToString, TdlDefinitionREF, TdlModuleREF, TemplateREF, TestBasicNamedObjectExtendedREF, TestBasicNamedObjectFixedREF, TestDerivedDiffSubpackageREF, TestDerivedSubpackageREF, TestMultiLevelSubpackageREF, TestOneLevelSubpackageExtendedREF, TestOneLevelSubpackageREF, TextualArtifactREF, TimeDoubleDataPoint, TypeDefinitionREF, UCOAllowedAttributesRuleDataREF, UUIDName, UUIDNamedObjectREF, ValueLengthRuleDataREF, WrapperGeneratorREF

public interface DmcMappedAttributeIF

The DmcMappedAttributeIF interface defines attribute values that have an associated key value that allows them to be stored in a Map. Basically, the value has its key embedded in it and this key can be accessed for the purposes of putting the value in a map or retrieving it.

Method Summary

Modifier and Type	Method and Description
Object	getKey() Returns the key associated with this attribute value.
String	getKeyAsString() Returns the key value represented as a string.
boolean	valuesAreEqual(DmcMappedAttributeIF obj) This method is used by the Modifier mechanism to determine whether or not a change has occurred as a result of applying the modifier.

Method Detail

getKey

Object getKey()

Returns the key associated with this attribute value.

Returns:

The key value.

getKeyAsString

String getKeyAsString()

Returns the key value represented as a string. we could just call the toString() method on the Object, but having this forces you implement an appropriate String conversion method for the key.

Returns:

A String.

valuesAreEqual

boolean valuesAreEqual(DmcMappedAttributeIF obj)

This method is used by the Modifier mechanism to determine whether or not a change has occurred as a result of applying the modifier. Having this method forces you to implement a value comparison function, as opposed to relying on you to remember to overload the equals method on your values. When the value is put in the map, we get back the existing value if the key already existed. The add() method will then call this function to determine if a change really took place; if this method returns false, we report the change (by passing back the new value), otherwise we return null from the add().

You should ensure that you compare both the key and the value in your comparison.

Parameters:

obj - Another mapped attribute.

Returns:

true if the value of this attribute matches the value of the object passed in and false otherwise.