uk.ac.ucl.cs.uml.jmi.Foundation.ExtensionMechanisms
Interface TaggedValue

All Superinterfaces:
Element, ExtObject, ModelElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject
All Known Implementing Classes:
TaggedValue_Impl

public interface TaggedValue
extends ModelElement

A tagged value allows information to be attached to any model element in conformance with its tag definition. Although a tagged value, being an instance of a kind of ModelElement, automatically inherits the name attribute, the name that is actually used in the tagged value is the name of the associated tag definition. The interpretation of tagged values is intentionally beyond the scope of UML semantics. It must be determined by user or tool conventions that may be specified in a profile in which the tagged value is defined. It is expected that various model analysis tools will define tag definitions to supply information needed for their operations beyond the basis semantics of UML. Such information could include code generation options, model management information, or user-specified semantics. Any tagged value must have one or more reference value links or one or more data values, but not both.


Method Summary
 String getDataValue()
          Specifies the set of values that are part of the tagged value.
 ModelElement getModelElement()
          Not documented in spec!
 Collection getReferenceValue()
          Specifies the model elements that this tagged value references.
 TagDefinition getType()
          Specifies the tag definition that defines the name, meaning, and type of the tagged value.
 void setDataValue(String dataValue)
          Setter for atomic property dataValue)
 void setModelElement(ModelElement modelElement)
          Setter for atomic property modelElement)
 void setType(TagDefinition type)
          Setter for atomic property type)
 
Methods inherited from interface uk.ac.ucl.cs.uml.jmi.Foundation.Core.ModelElement
getAsArgument, getBehavior, getClientDependency, getComment, getConstraint, getContainer, getDefaultElement, getIsSpecification, getName, getNamespace, getPackage, getPresentation, getReferenceTag, getSourceFlow, getStereotype, getSupplierDependency, getTaggedValue, getTargetFlow, getTemplate, getTemplateArgument, getTemplateParameter, getVisibility, setDefaultElement, setIsSpecification, setName, setNamespace, setTemplate, setVisibility
 
Methods inherited from interface uk.ac.ucl.cs.emofocl.jmi.reflect.extended.ExtObject
extAddObjectListener, extDeepCopy, extDeepCopy, extEquals, extRemoveObjectListener, extValueHash, extVisit
 
Methods inherited from interface javax.jmi.reflect.RefObject
refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite
 
Methods inherited from interface javax.jmi.reflect.RefFeatured
refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue
 
Methods inherited from interface javax.jmi.reflect.RefBaseObject
equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints
 

Method Detail

getDataValue

String getDataValue()
                    throws javax.jmi.reflect.JmiException
Specifies the set of values that are part of the tagged value. The type of this value must conform to the type specified in the tagType attribute of the associated tag definition. The number of values that can be specified is defined by the multiplicity attribute of the associated tag definition.

Throws:
javax.jmi.reflect.JmiException

setDataValue

void setDataValue(String dataValue)
                  throws javax.jmi.reflect.JmiException
Setter for atomic property dataValue)

Throws:
javax.jmi.reflect.JmiException

getType

TagDefinition getType()
                      throws javax.jmi.reflect.JmiException
Specifies the tag definition that defines the name, meaning, and type of the tagged value.

Throws:
javax.jmi.reflect.JmiException

setType

void setType(TagDefinition type)
             throws javax.jmi.reflect.JmiException
Setter for atomic property type)

Throws:
javax.jmi.reflect.JmiException

getReferenceValue

Collection getReferenceValue()
                             throws javax.jmi.reflect.JmiException
Specifies the model elements that this tagged value references. These elements are model-level instances of the metaclass or stereotype specified by the tagType attribute of the corresponding tag definition. The number of references is defined by the multiplicity attribute of the associated tag definition.

Throws:
javax.jmi.reflect.JmiException

getModelElement

ModelElement getModelElement()
                             throws javax.jmi.reflect.JmiException
Not documented in spec!

Throws:
javax.jmi.reflect.JmiException

setModelElement

void setModelElement(ModelElement modelElement)
                     throws javax.jmi.reflect.JmiException
Setter for atomic property modelElement)

Throws:
javax.jmi.reflect.JmiException