org.andromda.metafacades.uml

Interface ModelElementFacade

All Known Subinterfaces:

ActionFacade, ActionStateFacade, ActivityGraphFacade, ActorFacade, ArgumentFacade, AssociationClassFacade, AssociationEndFacade, AssociationFacade, AttributeFacade, AttributeLinkFacade, BindingFacade, CallActionFacade, CallEventFacade, ClassifierFacade, ConstraintFacade, DependencyFacade, Destination, Entity, EntityAssociation, EntityAssociationEnd, EntityAttribute, EntityQueryOperation, EnumerationFacade, EnumerationLiteralFacade, EventFacade, ExtendFacade, ExtensionPointFacade, FinalStateFacade, FrontEndAction, FrontEndActionState, FrontEndActivityGraph, FrontEndController, FrontEndControllerOperation, FrontEndEvent, FrontEndExceptionHandler, FrontEndFinalState, FrontEndForward, FrontEndPackage, FrontEndParameter, FrontEndPseudostate, FrontEndUseCase, FrontEndView, GeneralizableElementFacade, GeneralizationFacade, GuardFacade, IncludeFacade, InstanceFacade, InteractionFacade, LinkEndFacade, LinkFacade, ManageableEntity, ManageableEntityAssociationEnd, ManageableEntityAttribute, NamespaceFacade, NodeFacade, ObjectFlowStateFacade, OperationFacade, PackageFacade, ParameterFacade, PartitionFacade, PseudostateFacade, Queue, RedefinableTemplateSignatureFacade, Role, Service, ServiceOperation, StateFacade, StateMachineFacade, StateVertexFacade, StereotypeFacade, SubactivityStateFacade, TaggedValueFacade, Topic, TransitionFacade, UseCaseFacade, ValueObject, ValueObjectAssociationEnd

public interface ModelElementFacade

Represents a model element. It may be an Element or NamedElement. A named element is an element in a model that may have a name. An element is a constituent of a model. As such, it has the capability of owning other elements. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyTaggedValues(ModelElementFacade element) Copies all tagged values from the given ModelElementFacade to this model element facade.
Object	findTaggedValue(String tagName) Finds the tagged value with the specified 'tagName'.
Collection<Object>	findTaggedValues(String tagName) Returns all the values for the tagged value with the specified name.
String	getBindedFullyQualifiedName(ModelElementFacade bindedElement) Returns the fully qualified name of the model element.
Collection<ConstraintFacade>	getConstraints() Gets all constraints belonging to the model element.
Collection<ConstraintFacade>	getConstraints(String kind) Returns the constraints of the argument kind that have been placed onto this model.
String	getDocumentation(String indent) Gets the documentation for the model element, The indent argument is prefixed to each line.
String	getDocumentation(String indent, int lineLength) This method returns the documentation for this model element, with the lines wrapped after the specified number of characters, values of less than 1 will indicate no line wrapping is required.
String	getDocumentation(String indent, int lineLength, boolean htmlStyle) This method returns the documentation for this model element, with the lines wrapped after the specified number of characters, values of less than 1 will indicate no line wrapping is required.
String	getFullyQualifiedName() The fully qualified name of this model element.
String	getFullyQualifiedName(boolean modelName) Returns the fully qualified name of the model element.
String	getFullyQualifiedNamePath() Returns the fully qualified name as a path, the returned value always starts with out a slash '/'.
String	getId() Gets the unique identifier of the underlying model element.
Collection<String>	getKeywords() UML2: Retrieves the keywords for this element.
String	getLabel() UML2: Retrieves a localized label for this named element.
TypeMappings	getLanguageMappings() The language mappings that have been set for this model element.
ModelFacade	getModel() Return the model containing this model element (multiple models may be loaded and processed at the same time).
String	getName() The name of the model element.
ModelElementFacade	getPackage() Gets the package to which this model element belongs.
String	getPackageName() The name of this model element's package.
String	getPackageName(boolean modelName) Gets the package name (optionally providing the ability to retrieve the model name and not the mapped name).
String	getPackagePath() Returns the package as a path, the returned value always starts with out a slash '/'.
String	getQualifiedName() UML2: Returns the value of the 'Qualified Name' attribute.
PackageFacade	getRootPackage() Gets the root package for the model element.
Collection<DependencyFacade>	getSourceDependencies() Gets the dependencies for which this model element is the source.
StateMachineFacade	getStateMachineContext() If this model element is the context of an activity graph, this represents that activity graph.
Collection<String>	getStereotypeNames() The collection of ALL stereotype names for this model element.
Collection<StereotypeFacade>	getStereotypes() Gets all stereotypes for this model element.
Collection<TaggedValueFacade>	getTaggedValues() Return the TaggedValues associated with this model element, under all stereotypes.
Collection<DependencyFacade>	getTargetDependencies() Gets the dependencies for which this model element is the target.
Object	getTemplateParameter(String parameterName) Get the template parameter for this model element having the parameterName
Collection<TemplateParameterFacade>	getTemplateParameters() Get the template parameters for this model element
String	getValidationName() Gets the name of the metafacade used within validation messages.
Object	getValidationOwner() Gets the metafacade that acts as the owner of this metafacade.
String	getVisibility() The visibility (i.e.
boolean	hasExactStereotype(String stereotypeName) Returns true if the model element has the exact stereotype (meaning no stereotype inheritance is taken into account when searching for the stereotype), false otherwise.
boolean	hasKeyword(String keywordName) Does the UML Element contain the named Keyword? Keywords can be separated by space, comma, pipe, semicolon, or << >>
boolean	hasStereotype(String stereotypeName) Returns true if the model element has the specified stereotype.
void	initialize() Provides any required initialization of the metafacade.
boolean	isBindingDependenciesPresent() True if there are target dependencies from this element that are instances of BindingFacade.
boolean	isConstraintsPresent() Indicates if any constraints are present on this model element.
boolean	isDocumentationPresent() Indicates if any documentation is present on this model element.
boolean	isModelElementFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isReservedWord() True if this element name is a reserved word in Java, C#, ANSI or ISO C, C++, JavaScript.
boolean	isTemplateParametersPresent() True is there are template parameters on this model element.
boolean	isValidIdentifierName() True if this element name is a valid identifier name in Java, C#, ANSI or ISO C, C++, JavaScript.
String	translateConstraint(String name, String translation) Searches for the constraint with the specified 'name' on this model element, and if found translates it using the specified 'translation' from a translation library discovered by the framework.
String[]	translateConstraints(String translation) Translates all constraints belonging to this model element with the given 'translation'.
String[]	translateConstraints(String kind, String translation) Translates the constraints of the specified 'kind' belonging to this model element.
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Performs validation of any invariants found on this model element and stores the messages within the validationMessages collection.

Method Detail

isModelElementFacadeMetaType

boolean isModelElementFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

initialize

void initialize()

Provides any required initialization of the metafacade.

getValidationOwner

Object getValidationOwner()

Gets the metafacade that acts as the owner of this metafacade. (for example: an operation is an owner of its parameters, etc). This is used by AndroMDA's validation framework to provide more context as to where the error has occurred.

Returns:

Object the Validation Owner

getValidationName

String getValidationName()

Gets the name of the metafacade used within validation messages. This provides the full name of the metafacade.

Returns:

String the Validation Name

validateInvariants

void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Performs validation of any invariants found on this model element and stores the messages within the validationMessages collection.

Parameters:

validationMessages - the collection of messages to which additional validation messages will be added if invariants are broken.

copyTaggedValues

void copyTaggedValues(ModelElementFacade element)

Copies all tagged values from the given ModelElementFacade to this model element facade.

Parameters:

element - ModelElementFacade

findTaggedValue

Object findTaggedValue(String tagName)

Finds the tagged value with the specified 'tagName'. In case there are more values the first one found will be returned.

Parameters:

tagName - String

Returns:

Object

findTaggedValues

Collection<Object> findTaggedValues(String tagName)

Returns all the values for the tagged value with the specified name. The returned collection will contains only String instances, or will be empty. Never null.

Parameters:

tagName - String

Returns:

Collection