org.andromda.metafacades.uml

Interface ModelFacade

public interface ModelFacade

Captures a view of a physical system. It is an abstraction of the physical system, with a certain purpose. This purpose determines what is to be included in the model and what is irrelevant. Thus the model completely describes those aspects of the physical system that are relevant to the purpose of the model, at the appropriate level of detail. May be a UML2 model or package. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
ActivityGraphFacade	findActivityGraphByName(String name) Finds the ActivityGraph with the Name.
ActivityGraphFacade	findActivityGraphByNameAndStereotype(String name, String stereotypeName) Finds the ActivityGraph with the Name and Stereotype.
ClassifierFacade	findClassWithTaggedValueOrHyperlink(String tag, String value) Return the Class belonging to this model with the tagged value or hyperlink.
Collection<FinalStateFacade>	findFinalStatesWithNameOrHyperlink(UseCaseFacade useCase) Finds the FinalState with the Name or Hyperlink.
UseCaseFacade	findUseCaseByName(String name) Finds the UseCase with the Name.
UseCaseFacade	findUseCaseWithNameAndStereotype(String name, String stereotypeName) Finds the UseGraph with the Name and Stereotype.
UseCaseFacade	findUseCaseWithTaggedValueOrHyperlink(String tag, String value) Return the UseCase belonging to this model with the tagged value or hyperlink.
Collection<ActionStateFacade>	getAllActionStates() Return all ActionStates belonging to this model.
Collection<ActionStateFacade>	getAllActionStatesWithStereotype(ActivityGraphFacade activityGraph, String stereotypeName) Finds all ActionStates with the Stereotype.
Collection<ActorFacade>	getAllActors() Return all Actors belonging to this model.
Collection<ClassifierFacade>	getAllClasses() Return all Classes and Datatypes belonging to this model.
Collection<ObjectFlowStateFacade>	getAllObjectFlowStates() All object flow states in this model.
Collection<TransitionFacade>	getAllTransitions() All transitions present in the activity graphs contained by this model.
Collection<UseCaseFacade>	getAllUseCases() Return all UseCases belonging to this model.
PackageFacade	getRootPackage() Return the root package belonging to this model.
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.
void	initialize() Provides any required initialization of the metafacade.
boolean	isModelFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
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

isModelFacadeMetaType

boolean isModelFacadeMetaType()

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.

findActivityGraphByName

ActivityGraphFacade findActivityGraphByName(String name)

Finds the ActivityGraph with the Name.

Parameters:

name - String

Returns:

ActivityGraphFacade

findActivityGraphByNameAndStereotype

ActivityGraphFacade findActivityGraphByNameAndStereotype(String name,
                                                       String stereotypeName)

Finds the ActivityGraph with the Name and Stereotype.

Parameters:

name - String

stereotypeName - String

Returns:

ActivityGraphFacade

findClassWithTaggedValueOrHyperlink

ClassifierFacade findClassWithTaggedValueOrHyperlink(String tag,
                                                   String value)

Return the Class belonging to this model with the tagged value or hyperlink.

Parameters:

tag - String

value - String

Returns:

ClassifierFacade

findFinalStatesWithNameOrHyperlink

Collection<FinalStateFacade> findFinalStatesWithNameOrHyperlink(UseCaseFacade useCase)

Finds the FinalState with the Name or Hyperlink.

Parameters:

useCase - UseCaseFacade

Returns:

Collection

findUseCaseByName

UseCaseFacade findUseCaseByName(String name)

Finds the UseCase with the Name.

Parameters:

name - String

Returns:

UseCaseFacade

findUseCaseWithNameAndStereotype

UseCaseFacade findUseCaseWithNameAndStereotype(String name,
                                             String stereotypeName)

Finds the UseGraph with the Name and Stereotype.

Parameters:

name - String

stereotypeName - String

Returns:

UseCaseFacade

findUseCaseWithTaggedValueOrHyperlink

UseCaseFacade findUseCaseWithTaggedValueOrHyperlink(String tag,
                                                  String value)

Return the UseCase belonging to this model with the tagged value or hyperlink.

Parameters:

tag - String

value - String

Returns:

UseCaseFacade

getAllActionStates

Collection<ActionStateFacade> getAllActionStates()

Return all ActionStates belonging to this model.

Returns:

Collection

getAllActionStatesWithStereotype

Collection<ActionStateFacade> getAllActionStatesWithStereotype(ActivityGraphFacade activityGraph,
                                                             String stereotypeName)

Finds all ActionStates with the Stereotype.

Parameters:

activityGraph - ActivityGraphFacade

stereotypeName - String

Returns:

Collection

getAllActors

Collection<ActorFacade> getAllActors()

Return all Actors belonging to this model.

Returns:

Collection

getAllClasses

Collection<ClassifierFacade> getAllClasses()

Return all Classes and Datatypes belonging to this model.

Returns:

Collection

getAllObjectFlowStates

Collection<ObjectFlowStateFacade> getAllObjectFlowStates()

All object flow states in this model.

Returns:

Collection

getAllTransitions

Collection<TransitionFacade> getAllTransitions()

All transitions present in the activity graphs contained by this model.

Returns:

Collection

getAllUseCases

Collection<UseCaseFacade> getAllUseCases()

Return all UseCases belonging to this model.

Returns:

Collection

getRootPackage

PackageFacade getRootPackage()

Return the root package belonging to this model. In UML2, the top level element may be either a package or a model.

Returns:

PackageFacade