org.eclipse.gmt.modisco.omg.kdm.core
Interface KDMEntity

All Superinterfaces:
Element, ModelElement
All Known Subinterfaces:
AbstractBuildElement, AbstractCodeElement, AbstractConceptualElement, AbstractContentElement, AbstractDataElement, AbstractEventElement, AbstractInventoryElement, AbstractPlatformElement, AbstractStructureElement, AbstractUIElement, ActionElement, AllContent, ArchitectureView, ArrayType, BagType, BehaviorUnit, BinaryFile, BitstringType, BitType, BlockUnit, BooleanType, BuildComponent, BuildDescription, BuildElement, BuildProduct, BuildResource, BuildStep, CallableUnit, Catalog, CatchUnit, CharType, ChoiceContent, ChoiceType, ClassUnit, CodeAssembly, CodeElement, CodeItem, ColumnSet, CompilationUnit, ComplexContentType, Component, CompositeType, ComputationalObject, ConceptualContainer, ConceptualElement, ConceptualRole, ConditionalDirective, Configuration, ContentAttribute, ContentElement, ContentItem, ContentReference, ContentRestriction, ControlElement, DataAction, DataContainer, DataElement, DataEvent, DataManager, DataResource, DataSegment, Datatype, DateType, DecimalType, DefinedType, DeployedComponent, DeployedResource, DeployedSoftwareSystem, DerivedType, Directory, EnumeratedType, Event, EventAction, EventElement, EventResource, ExceptionUnit, ExecutableFile, ExecutionResource, ExtendedDataElement, ExternalActor, FactUnit, FileResource, FinallyUnit, FloatType, GroupContent, Image, IncludeDirective, Index, IndexElement, IndexUnit, InitialState, IntegerType, InterfaceUnit, InventoryContainer, InventoryElement, InventoryItem, ItemUnit, LanguageUnit, Layer, Library, LockResource, Machine, MacroDirective, MacroUnit, MarshalledResource, MemberUnit, MessagingResource, MethodUnit, MixedContent, Module, Namespace, NamingResource, OctetstringType, OctetType, OnEntry, OnExit, OrdinalType, Package, ParameterUnit, PlatformAction, PlatformElement, PlatformEvent, PointerType, PreprocessorDirective, PrimitiveType, Process, Project, RangeType, RecordFile, RecordType, ReferenceKey, RelationalSchema, RelationalTable, RelationalView, Report, ResourceDescription, ResourceType, RuleUnit, RuntimeResource, ScaledType, ScenarioUnit, Screen, SeqContent, SequenceType, SetType, SharedUnit, Signature, SimpleContentType, SoftwareSystem, SourceFile, State, StorableUnit, StreamResource, StringType, StructureElement, Subsystem, Supplier, SymbolicLink, SynonymUnit, TemplateParameter, TemplateType, TemplateUnit, TermUnit, Thread, TimeType, Tool, Transition, TryUnit, TypeUnit, UIAction, UIDisplay, UIElement, UIEvent, UIField, UIResource, UniqueKey, Value, ValueElement, ValueList, VoidType, XMLSchema

public interface KDMEntity
extends ModelElement

A representation of the model object 'KDM Entity'. A KDM entity is a named model element that represents an artifact of existing software systems. In the meta-model, KDMEntity is a subclass of ModelElement. Each KDM package defines specific KDM entities that are direct or indirect subclasses of KDMEntity. A KDMEntity can be either an atomic element, a container for some KDMEntities, or a group of some KDMEntities. Container and group introduce implicit relationships between entities and are used to represent hierarchies of entities. A container is a KDMEntity that owns other entities. A group is a KDMEntity with which other entities are associated. A KDMEntity can be owned by at most one container, and can be associated with zero or many groups.

The following features are supported:

See Also:
CorePackage.getKDMEntity()
Generated:
Model:
abstract="true"

Method Summary
 AggregatedRelationship createAggregation(KDMEntity otherEntity)
          This operation creates an aggregated relationship such that the current entity is the from-endpoint of the aggregated relation and the "otherEntity" is the to-endpoint.
 void deleteAggregation(AggregatedRelationship aggregation)
          This operation deletes the given aggregated relationship.
  getGroup()
          Returns the value of the 'Group' reference list.
  getGroupedElement()
          Returns the value of the 'Grouped Element' reference list.
  getInAggregated()
          Returns the value of the 'In Aggregated' reference list.
  getInbound()
          Returns the value of the 'Inbound' reference list.
 KDMModel getModel()
          Returns the value of the 'Model' reference.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
  getOutAggregated()
          Returns the value of the 'Out Aggregated' reference list.
  getOutbound()
          Returns the value of the 'Outbound' reference list.
  getOwnedElement()
          Returns the value of the 'Owned Element' containment reference list.
  getOwnedRelation()
          Returns the value of the 'Owned Relation' containment reference list.
 KDMEntity getOwner()
          Returns the value of the 'Owner' container reference.
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 
Methods inherited from interface org.eclipse.gmt.modisco.omg.kdm.core.ModelElement
getStereotype, getTaggedValue
 
Methods inherited from interface org.eclipse.gmt.modisco.omg.kdm.core.Element
getAnnotation, getAttribute
 

Method Detail

getName

java.lang.String getName()
Returns the value of the 'Name' attribute. An identifier for the KDM entity.

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), CorePackage.getKDMEntity_Name()
Generated:
Model:
dataType="org.eclipse.gmt.modisco.omg.kdm.core.String"

setName

void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()
Generated:

createAggregation

AggregatedRelationship createAggregation(KDMEntity otherEntity)
This operation creates an aggregated relationship such that the current entity is the from-endpoint of the aggregated relation and the "otherEntity" is the to-endpoint. The new aggregated relationship is owned by the model to which owns the current entity (either directly or indirectly through container ownership).

Generated:
Model:
otherEntityRequired="true"

deleteAggregation

void deleteAggregation(AggregatedRelationship aggregation)
This operation deletes the given aggregated relationship.

Generated:
Model:
aggregationRequired="true"

getInbound

 getInbound()
Returns the value of the 'Inbound' reference list. The list contents are of type KDMRelationship. the set of relationships such that the current KDMEntity is the to-endpoint of these relations.

Returns:
the value of the 'Inbound' reference list.
See Also:
CorePackage.getKDMEntity_Inbound()
Generated:
Model:
changeable="false" derived="true"

getOutbound

 getOutbound()
Returns the value of the 'Outbound' reference list. The list contents are of type KDMRelationship. the set of relationships such that the current KDMEntity is the from-endpoint of these relationships.

Returns:
the value of the 'Outbound' reference list.
See Also:
CorePackage.getKDMEntity_Outbound()
Generated:
Model:
changeable="false" derived="true"

getOwnedRelation

 getOwnedRelation()
Returns the value of the 'Owned Relation' containment reference list. The list contents are of type KDMRelationship. the set of relationships such that the current KDMEntity owns these relationships.

Returns:
the value of the 'Owned Relation' containment reference list.
See Also:
CorePackage.getKDMEntity_OwnedRelation()
Generated:
Model:
containment="true" changeable="false" derived="true"

getInAggregated

 getInAggregated()
Returns the value of the 'In Aggregated' reference list. The list contents are of type AggregatedRelationship. It is bidirectional and its opposite is 'To'. the set of AggregatedRelationship for which the target is the current KDM Entity.

Returns:
the value of the 'In Aggregated' reference list.
See Also:
CorePackage.getKDMEntity_InAggregated(), AggregatedRelationship.getTo()
Generated:
Model:
opposite="to" changeable="false" derived="true"

getOutAggregated

 getOutAggregated()
Returns the value of the 'Out Aggregated' reference list. The list contents are of type AggregatedRelationship. It is bidirectional and its opposite is 'From'. the set of AggregatedRelationship for which the origin is the current KDM Entity.

Returns:
the value of the 'Out Aggregated' reference list.
See Also:
CorePackage.getKDMEntity_OutAggregated(), AggregatedRelationship.getFrom()
Generated:
Model:
opposite="from" changeable="false" derived="true"

getOwner

KDMEntity getOwner()
Returns the value of the 'Owner' container reference. It is bidirectional and its opposite is 'Owned Element'. KDM entity that owns the current element. This property determines a meta-level interface to KDM entities. This property is a derived union. Some KDM entities define a concrete set of owned elements that are subtypes of KDMEntity. In KDM this is represented by the CMOF "derived union" mechanism. Concrete properties subset the "union" properties of the parent classes, defined in the Core package. The owner of a KDM entity is defined as the container for which the given entity is an owned entity.

Returns:
the value of the 'Owner' container reference.
See Also:
CorePackage.getKDMEntity_Owner(), getOwnedElement()
Generated:
Model:
opposite="ownedElement" transient="false" changeable="false" derived="true"

getOwnedElement

 getOwnedElement()
Returns the value of the 'Owned Element' containment reference list. The list contents are of type KDMEntity. It is bidirectional and its opposite is 'Owner'. the set of KDM entities that are owned by the current KDM Entity. Only KDM containers can own other entities.

Returns:
the value of the 'Owned Element' containment reference list.
See Also:
CorePackage.getKDMEntity_OwnedElement(), getOwner()
Generated:
Model:
opposite="owner" containment="true" changeable="false" derived="true"

getGroup

 getGroup()
Returns the value of the 'Group' reference list. The list contents are of type KDMEntity. Set of KDM entities with which the current element is associated. This property determines a meta-level interface to KDM entities. This property is a derived union. Some KDM entities define a concrete set of grouped elements that are the subtypes of KDMEntity. In KDM this is represented by the CMOF "derived union" mechanism. Concrete properties subset the "union" properties of the parent classes, defined in the Core package. The group of a KDM entity is defined as the group for which the given entity is a grouped entity. Each KDM entity can be associated with multiple groups.

Returns:
the value of the 'Group' reference list.
See Also:
CorePackage.getKDMEntity_Group()
Generated:
Model:
changeable="false" derived="true"

getGroupedElement

 getGroupedElement()
Returns the value of the 'Grouped Element' reference list. The list contents are of type KDMEntity. the set of KDM entities that are "grouped" by the current KDM entity. Only KDM groups can have group associations to other entities.

Returns:
the value of the 'Grouped Element' reference list.
See Also:
CorePackage.getKDMEntity_GroupedElement()
Generated:
Model:
changeable="false" derived="true"

getModel

KDMModel getModel()
Returns the value of the 'Model' reference. It is bidirectional and its opposite is 'Owned Element'. the KDM model that owns the current KDM Entity

Returns:
the value of the 'Model' reference.
See Also:
CorePackage.getKDMEntity_Model(), KDMModel.getOwnedElement()
Generated:
Model:
opposite="ownedElement" changeable="false" derived="true"