org.dmd.dmc.types

Class DmcTypeNamedObjectREF<HELPER extends DmcNamedObjectREF,NAMETYPE extends DmcObjectName>

java.lang.Object

org.dmd.dmc.DmcAttribute<HELPER>

org.dmd.dmc.types.DmcTypeNamedObjectREF<HELPER,NAMETYPE>

All Implemented Interfaces:

Serializable, Cloneable, Comparable<String>

Direct Known Subclasses:

DmcTypeABConceptXREF, DmcTypeAConceptBaseREF, DmcTypeAConceptXREF, DmcTypeActifactGeneratorREF, DmcTypeActionDefinitionREF, DmcTypeAllowedAttributesRuleDataREF, DmcTypeAttributeDefinitionREF, DmcTypeBaseObjREF, DmcTypeBConceptBaseREF, DmcTypeBConceptXREF, DmcTypeCardinalityRuleDataREF, DmcTypeCConceptBaseREF, DmcTypeCConceptXREF, DmcTypeCheckAttributesBasedOnValueRuleDataREF, DmcTypeClassDefinitionREF, DmcTypeComplexTypeDefinitionREF, DmcTypeConceptREF, DmcTypeConcinnityDefinitionREF, DmcTypeConcinnityModuleREF, DmcTypeConcinnityREF, DmcTypeContainedElementREF, DmcTypeDependencyImplementationREF, DmcTypeDependencyREF, DmcTypeDmsDefinitionREF, DmcTypeDmuDefinitionREF, DmcTypeDmuModuleREF, DmcTypeDotNamedObjectREF, DmcTypeDSDefinitionModuleREF, DmcTypeDSDefinitionREF, DmcTypeEnumDefinitionREF, DmcTypeExtendedReferenceTypeDefinitionREF, DmcTypeExtensionHookREF, DmcTypeGenerationContextREF, DmcTypeHierarchicObjectREF, DmcTypeInitRuleDataREF, DmcTypeIntegerNamedObjectREF, DmcTypeLDAPHierarchicObjectREF, DmcTypeMethodGeneratorREF, DmcTypeModuleAREF, DmcTypeModuleBREF, DmcTypeModuleCREF, DmcTypeNamedObjectRuleDataREF, DmcTypeNumericRangeRuleDataREF, DmcTypeObjWithRefsDerivedAREF, DmcTypeObjWithRefsDerivedBREF, DmcTypeObjWithRefsREF, DmcTypeOneOfTheseAttributesRequiredRuleDataREF, DmcTypeOnlyOneOfTheseAttributesAllowedRuleDataREF, DmcTypePartCheckerRuleDataREF, DmcTypePatternMatchRuleDataREF, DmcTypePayloadExampleREF, DmcTypePayloadSortInfoREF, DmcTypeReferencedAttributeTypeRuleDataREF, DmcTypeRelatedNumbersRuleDataREF, DmcTypeRestrictReferencesRuleDataREF, DmcTypeRuleCategoryREF, DmcTypeRuleDataREF, DmcTypeRuleDefinitionREF, DmcTypeRunContextREF, DmcTypeSchemaDefinitionREF, DmcTypeSectionREF, DmcTypeSliceDefinitionREF, DmcTypeSomeRelation, DmcTypeStringSetRuleDataREF, DmcTypeTdlDefinitionREF, DmcTypeTdlModuleREF, DmcTypeTemplateREF, DmcTypeTestBasicNamedObjectExtendedREF, DmcTypeTestBasicNamedObjectFixedREF, DmcTypeTestDerivedDiffSubpackageREF, DmcTypeTestDerivedSubpackageREF, DmcTypeTestMultiLevelSubpackageREF, DmcTypeTestOneLevelSubpackageExtendedREF, DmcTypeTestOneLevelSubpackageREF, DmcTypeTextualArtifactREF, DmcTypeTypeDefinitionREF, DmcTypeUCOAllowedAttributesRuleDataREF, DmcTypeUUIDNamedObjectREF, DmcTypeValueLengthRuleDataREF, DmcTypeWrapperGeneratorREF

public abstract class DmcTypeNamedObjectREF<HELPER extends DmcNamedObjectREF,NAMETYPE extends DmcObjectName>
extends DmcAttribute<HELPER>
implements Serializable

The DmcTypeNamedObjectREF is a base type from which all references to named objects are derived. This stuff is a bit complicated and this class overrides most of the basic functionality of the DmcAttribute to make this happen. This is because unlike basic attribute types, types derived from this one allow you to set the contents of the attribute to be a DmcObjectName, or a DmcObject that implements the DmcNamedObjectIF interface.

The values of this kind of attribute are derived from DmcNamedObjectREF which allows you to store just the name of an object, or the name of the object and the object itself. This provides the concept of resolved/unresolved object references. For instance, if you parse a bunch of objects from a file and they contain object reference attributes, they will appear as just the names of other objects. Later, you can attempt to resolve these references (or not). Depending on the context in which you're using your data, this mechanism gives you the option of lazily resolving (or perhaps retrieving) the objects to which this type of attribute refers.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dmd.dmc.DmcAttribute

attrInfo, ID

Constructor Summary

Constructors

Constructor and Description
DmcTypeNamedObjectREF() Constructs a new object reference attribute.
DmcTypeNamedObjectREF(DmcAttributeInfo ai)

Method Summary

Modifier and Type	Method and Description
boolean	doLazyResolution(DmcObject referrer) This method is called from derived classes if the lazy resolution mechanism has been turned on via the DmcOmni.
protected abstract String	getDMOClassName()
protected abstract HELPER	getNewHelper()
protected abstract NAMETYPE	getNewName()
protected abstract boolean	isDMO(Object value) Checks if the object is an instance of the appropriate type.
void	removeBackReferences() This method will remove back references that are associated with this reference attribute.
void	resolveReferences(DmcNameResolverIF rx) Attempts to resolve references with the specified name resolver.
protected boolean	weAreResolved()

Methods inherited from class org.dmd.dmc.DmcAttribute

add, addModsMV, addModsSV, cloneIt, cloneValue, compareTo, contains, containsKey, del, deserializeIt, deserializeValue, formatValue, formatValueAsCompactJSON, formatValueAsJSON, getAttributeInfo, getByKey, getID, getMV, getMVnth, getMVSize, getName, getNew, getSV, hasValue, modifierFormat, serializeIt, serializeValue, set, setAttributeInfo, setMVnth, toOIF, toOIF, typeCheck, valueChangedMV, valueChangedSV

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DmcTypeNamedObjectREF

public DmcTypeNamedObjectREF()

Constructs a new object reference attribute.

DmcTypeNamedObjectREF

public DmcTypeNamedObjectREF(DmcAttributeInfo ai)

Method Detail

getNewHelper

protected abstract HELPER getNewHelper()

Returns:

A new DmcNamedObjectREF derivative instance.

getNewName

protected abstract NAMETYPE getNewName()

isDMO

protected abstract boolean isDMO(Object value)

Checks if the object is an instance of the appropriate type.

Parameters:

value - The value to be tested.

Returns:

True if the object is the appropriate type.

getDMOClassName

protected abstract String getDMOClassName()

resolveReferences

public void resolveReferences(DmcNameResolverIF rx)
                       throws DmcValueException

Attempts to resolve references with the specified name resolver.

Parameters:

rx - The resolver.

Throws:

DmcValueException - if value problems

removeBackReferences

public void removeBackReferences()

This method will remove back references that are associated with this reference attribute. This is used when removing a reference attribute from an object.

doLazyResolution

public boolean doLazyResolution(DmcObject referrer)

This method is called from derived classes if the lazy resolution mechanism has been turned on via the DmcOmni.

We try to find the object(s) referred to in the reference. If so, we set the object on the reference (thus making it resolved).

We also check to see if backref tracking has been turned on in DmcOmni. If so, we create the backref modifier and add it to the object we're referring to.

If the reference(s) can't be resolved we return a flag that indicates that the attribute should remove itself from the object (since there's nothing of value in it).

Parameters:

referrer - The object doing the referring.

Returns:

true if this attribute needs to be removed from the object.

weAreResolved

protected boolean weAreResolved()