org.andromda.metafacades.uml14

Class FrontEndUseCaseLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.ModelElementFacadeLogic

org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

org.andromda.metafacades.uml14.GeneralizableElementFacadeLogic

org.andromda.metafacades.uml14.GeneralizableElementFacadeLogicImpl

org.andromda.metafacades.uml14.ClassifierFacadeLogic

org.andromda.metafacades.uml14.ClassifierFacadeLogicImpl

org.andromda.metafacades.uml14.NamespaceFacadeLogic

org.andromda.metafacades.uml14.NamespaceFacadeLogicImpl

org.andromda.metafacades.uml14.UseCaseFacadeLogic

org.andromda.metafacades.uml14.UseCaseFacadeLogicImpl

org.andromda.metafacades.uml14.FrontEndUseCaseLogic

All Implemented Interfaces:

Serializable, Comparable, ClassifierFacade, FrontEndUseCase, GeneralizableElementFacade, ModelElementFacade, NamespaceFacade, UseCaseFacade

Direct Known Subclasses:

FrontEndUseCaseLogicImpl

public abstract class FrontEndUseCaseLogic
extends UseCaseFacadeLogicImpl
implements FrontEndUseCase

Represents a use case used in the "front end" of an application. MetafacadeLogic for FrontEndUseCase

See Also:

FrontEndUseCase, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	metaObject The underlying UML object

Fields inherited from class org.andromda.core.metafacade.MetafacadeBase

contextRoot

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FrontEndUseCaseLogic(Object metaObjectIn, String context) Create Metafacade implementation instance using the MetafacadeFactory from the context

Method Summary

Methods

Modifier and Type	Method and Description
List<FrontEndAction>	getActions() Represents a use case used in the "front end" of an application.
FrontEndActivityGraph	getActivityGraph() The use case to which this activity graph belongs.
List<Role>	getAllRoles() Represents a use case used in the "front end" of an application.
List<FrontEndUseCase>	getAllUseCases() Represents a use case used in the "front end" of an application.
FrontEndController	getController() Returns the use-case "controlled" by this controller.
FrontEndView	getInitialView() Represents a use case used in the "front end" of an application.
List<FrontEndFinalState>	getReferencingFinalStates() The use case the final state is "targetting".
List<Role>	getRoles() Represents a use case used in the "front end" of an application.
List<FrontEndView>	getViews() The use-case of which this view is a member.
List<FrontEndParameter>	getViewVariables() Represents a use case used in the "front end" of an application.
protected abstract List	handleGetActions() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetActivityGraph() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetAllRoles() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetAllUseCases() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetController() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetInitialView() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetReferencingFinalStates() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetRoles() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetViews() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetViewVariables() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract boolean	handleIsEntryUseCase()
protected abstract boolean	handleIsSecured()
boolean	isEntryUseCase() True if this use-case is the entry point to the front end.
boolean	isFrontEndUseCaseMetaType()
boolean	isSecured() Indicates if this use case is "secured".
void	resetMetafacadeContext(String context) Reset context only for non-root metafacades
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::metafacades::uml::FrontEndUseCase::each usecase needs one and only one graph

Methods inherited from class org.andromda.metafacades.uml14.UseCaseFacadeLogicImpl

getValidationOwner, handleGetExtends, handleGetExtensionPoints, handleGetFirstActivityGraph, handleGetIncludes, handleGetName

Methods inherited from class org.andromda.metafacades.uml14.UseCaseFacadeLogic

getExtends, getExtensionPoints, getFirstActivityGraph, getIncludes, isUseCaseFacadeMetaType

Methods inherited from class org.andromda.metafacades.uml14.NamespaceFacadeLogicImpl

handleGetOwnedElements

Methods inherited from class org.andromda.metafacades.uml14.NamespaceFacadeLogic

getOwnedElements, isNamespaceFacadeMetaType

Methods inherited from class org.andromda.metafacades.uml14.ClassifierFacadeLogicImpl

getOwner, getWrapperMappings, handleFindAttribute, handleGetAbstractions, handleGetAllAssociatedClasses, handleGetAllProperties, handleGetAllRequiredConstructorParameters, handleGetArray, handleGetArrayName, handleGetAssociatedClasses, handleGetAssociationEnds, handleGetAttributes, handleGetAttributes, handleGetFullyQualifiedArrayName, handleGetImplementationOperations, handleGetImplementedInterfaceList, handleGetInstanceAttributes, handleGetInstanceOperations, handleGetInterfaceAbstractions, handleGetJavaNewString, handleGetJavaNullString, handleGetNavigableConnectingEnds, handleGetNavigableConnectingEnds, handleGetNonArray, handleGetOperationCallFromAttributes, handleGetOperations, handleGetProperties, handleGetProperties, handleGetRequiredConstructorParameters, handleGetSerialVersionUID, handleGetStaticAttributes, handleGetStaticOperations, handleGetSuperClass, handleGetWrapperName, handleIsAbstract, handleIsArrayType, handleIsAssociationClass, handleIsBlobType, handleIsBooleanType, handleIsCharacterType, handleIsClobType, handleIsCollectionType, handleIsDataType, handleIsDateType, handleIsDoubleType, handleIsEmbeddedValue, handleIsEnumeration, handleIsFileType, handleIsFloatType, handleIsIntegerType, handleIsInterface, handleIsLeaf, handleIsListType, handleIsLongType, handleIsMapType, handleIsPrimitive, handleIsSetType, handleIsStringType, handleIsTimeType, handleIsWrappedPrimitive

Methods inherited from class org.andromda.metafacades.uml14.ClassifierFacadeLogic

findAttribute, getAbstractions, getAllAssociatedClasses, getAllProperties, getAllRequiredConstructorParameters, getArray, getArrayName, getAssociatedClasses, getAssociationEnds, getAttributes, getAttributes, getFullyQualifiedArrayName, getImplementationOperations, getImplementedInterfaceList, getInstanceAttributes, getInstanceOperations, getInterfaceAbstractions, getJavaNewString, getJavaNullString, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getProperties, getProperties, getRequiredConstructorParameters, getSerialVersionUID, getStaticAttributes, getStaticOperations, getSuperClass, getWrapperName, isAbstract, isArrayType, isAssociationClass, isBlobType, isBooleanType, isCharacterType, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

Methods inherited from class org.andromda.metafacades.uml14.GeneralizableElementFacadeLogicImpl

handleFindTaggedValue, handleGetAllGeneralizations, handleGetAllSpecializations, handleGetGeneralization, handleGetGeneralizationLinks, handleGetGeneralizationList, handleGetGeneralizationRoot, handleGetGeneralizations, handleGetSpecializations

Methods inherited from class org.andromda.metafacades.uml14.GeneralizableElementFacadeLogic

findTaggedValue, getAllGeneralizations, getAllSpecializations, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getSpecializations, isGeneralizableElementFacadeMetaType

Methods inherited from class org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

getArraySuffix, getValidationName, handleCopyTaggedValues, handleFindTaggedValue, handleFindTaggedValues, handleGetBindedFullyQualifiedName, handleGetConstraints, handleGetConstraints, handleGetDocumentation, handleGetDocumentation, handleGetDocumentation, handleGetFullyQualifiedName, handleGetFullyQualifiedName, handleGetFullyQualifiedNamePath, handleGetId, handleGetKeywords, handleGetLabel, handleGetLanguageMappings, handleGetModel, handleGetOwner, handleGetPackage, handleGetPackageName, handleGetPackageName, handleGetPackagePath, handleGetQualifiedName, handleGetRootPackage, handleGetSourceDependencies, handleGetStateMachineContext, handleGetStereotypeNames, handleGetStereotypes, handleGetTaggedValues, handleGetTargetDependencies, handleGetTemplateParameter, handleGetTemplateParameters, handleGetVisibility, handleHasExactStereotype, handleHasKeyword, handleHasStereotype, handleIsBindingDependenciesPresent, handleIsConstraintsPresent, handleIsDocumentationPresent, handleIsReservedWord, handleIsTemplateParametersPresent, handleIsValidIdentifierName, handleTranslateConstraint, handleTranslateConstraints, handleTranslateConstraints

Methods inherited from class org.andromda.metafacades.uml14.ModelElementFacadeLogic

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, toString, translateConstraint, translateConstraints, translateConstraints

Methods inherited from class org.andromda.core.metafacade.MetafacadeBase

compareTo, equals, getConfiguredProperty, getDebug, getMetafacadeContext, getMetaObject, hashCode, initialize, isConfiguredProperty, isMetafacadePropertyCachingEnabled, setMetafacadeContext, setProperty, shieldedElement, shieldedElements, THIS, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.andromda.metafacades.uml.UseCaseFacade

getExtends, getExtensionPoints, getFirstActivityGraph, getIncludes, isUseCaseFacadeMetaType

Methods inherited from interface org.andromda.metafacades.uml.NamespaceFacade

getOwnedElements, isNamespaceFacadeMetaType

Methods inherited from interface org.andromda.metafacades.uml.ClassifierFacade

findAttribute, getAbstractions, getAllAssociatedClasses, getAllProperties, getAllRequiredConstructorParameters, getArray, getArrayName, getAssociatedClasses, getAssociationEnds, getAttributes, getAttributes, getFullyQualifiedArrayName, getImplementationOperations, getImplementedInterfaceList, getInstanceAttributes, getInstanceOperations, getInterfaceAbstractions, getJavaNewString, getJavaNullString, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getProperties, getProperties, getRequiredConstructorParameters, getSerialVersionUID, getStaticAttributes, getStaticOperations, getSuperClass, getWrapperName, isAbstract, isArrayType, isAssociationClass, isBlobType, isBooleanType, isCharacterType, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

Methods inherited from interface org.andromda.metafacades.uml.GeneralizableElementFacade

findTaggedValue, getAllGeneralizations, getAllSpecializations, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getSpecializations, isGeneralizableElementFacadeMetaType

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints

Field Detail

metaObject

protected Object metaObject

The underlying UML object

See Also:

Object

Constructor Detail

FrontEndUseCaseLogic

protected FrontEndUseCaseLogic(Object metaObjectIn,
                    String context)

Create Metafacade implementation instance using the MetafacadeFactory from the context

Parameters:

metaObjectIn -

context -

Method Detail

resetMetafacadeContext

public void resetMetafacadeContext(String context)

Reset context only for non-root metafacades

Overrides:

resetMetafacadeContext in class UseCaseFacadeLogic

Parameters:

context -

isFrontEndUseCaseMetaType

public boolean isFrontEndUseCaseMetaType()

Specified by:

isFrontEndUseCaseMetaType in interface FrontEndUseCase

Returns:

boolean true always

See Also:

FrontEndUseCase

handleIsEntryUseCase

protected abstract boolean handleIsEntryUseCase()

Returns:

boolean

See Also:

FrontEndUseCase.isEntryUseCase()

isEntryUseCase

public final boolean isEntryUseCase()

True if this use-case is the entry point to the front end.

Specified by:

isEntryUseCase in interface FrontEndUseCase

Returns:

(boolean)handleIsEntryUseCase()

handleIsSecured

protected abstract boolean handleIsSecured()

Returns:

boolean

See Also:

FrontEndUseCase.isSecured()

isSecured

public final boolean isSecured()

Indicates if this use case is "secured". This is true when there is at least one role associated to it.

Specified by:

isSecured in interface FrontEndUseCase

Returns:

(boolean)handleIsSecured()

getReferencingFinalStates

public final List<FrontEndFinalState> getReferencingFinalStates()

The use case the final state is "targetting".

Specified by:

getReferencingFinalStates in interface FrontEndUseCase

Returns:

(List)handleGetReferencingFinalStates()

handleGetReferencingFinalStates

protected abstract List handleGetReferencingFinalStates()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

List

getAllRoles

public final List<Role> getAllRoles()

Represents a use case used in the "front end" of an application.

Specified by:

getAllRoles in interface FrontEndUseCase

Returns:

(List)handleGetAllRoles()

handleGetAllRoles

protected abstract List handleGetAllRoles()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

List

getRoles

public final List<Role> getRoles()

Represents a use case used in the "front end" of an application.

Specified by:

getRoles in interface FrontEndUseCase

Returns:

(List)handleGetRoles()

handleGetRoles

protected abstract List handleGetRoles()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

List

getController

public final FrontEndController getController()

Returns the use-case "controlled" by this controller.

Specified by:

getController in interface FrontEndUseCase

Returns:

(FrontEndController)handleGetController()

handleGetController

protected abstract Object handleGetController()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getViews

public final List<FrontEndView> getViews()

The use-case of which this view is a member.

Specified by:

getViews in interface FrontEndUseCase

Returns:

(List)handleGetViews()

handleGetViews

protected abstract List handleGetViews()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

List

getActions

public final List<FrontEndAction> getActions()

Represents a use case used in the "front end" of an application.

Specified by:

getActions in interface FrontEndUseCase

Returns:

(List)handleGetActions()

handleGetActions

protected abstract List handleGetActions()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

List

getAllUseCases

public final List<FrontEndUseCase> getAllUseCases()

Represents a use case used in the "front end" of an application.

Specified by:

getAllUseCases in interface FrontEndUseCase

Returns:

(List)handleGetAllUseCases()

handleGetAllUseCases

protected abstract List handleGetAllUseCases()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

List

getInitialView

public final FrontEndView getInitialView()

Represents a use case used in the "front end" of an application.

Specified by:

getInitialView in interface FrontEndUseCase

Returns:

(FrontEndView)handleGetInitialView()

handleGetInitialView

protected abstract Object handleGetInitialView()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getActivityGraph

public final FrontEndActivityGraph getActivityGraph()

The use case to which this activity graph belongs.

Specified by:

getActivityGraph in interface FrontEndUseCase

Returns:

(FrontEndActivityGraph)handleGetActivityGraph()

handleGetActivityGraph

protected abstract Object handleGetActivityGraph()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getViewVariables

public final List<FrontEndParameter> getViewVariables()

Represents a use case used in the "front end" of an application.

Specified by:

getViewVariables in interface FrontEndUseCase

Returns:

(List)handleGetViewVariables()

handleGetViewVariables

protected abstract List handleGetViewVariables()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

List

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::metafacades::uml::FrontEndUseCase::each usecase needs one and only one graph

Error: Each use-case needs one and only one activity graph.

OCL: context FrontEndUseCase inv: activityGraph->notEmpty()

Constraint: org::andromda::metafacades::uml::FrontEndUseCase::one and only one usecase must be a FrontEndApplication

Error: One and only one use-case must be marked as the application entry use-case. Currently this is done by adding the FrontEndApplication stereotype to it.

OCL: context FrontEndUseCase inv: allUseCases->one(entryUseCase = true)

Constraint: org::andromda::metafacades::uml::FrontEndUseCase::non-empty unique usecase name

Error: Each use-case must have a non-empty name that is unique among all use-cases.

OCL: context FrontEndUseCase inv: name->notEmpty() and model.allUseCases->isUnique(name)

Constraint: org::andromda::metafacades::uml::FrontEndUseCase::each front-end use-case needs to be in a package

Error: Each front-end use-case is required to be modeled in a package, doing otherwise will result in uncompileable code due to filename collisions.

OCL: context FrontEndUseCase inv: packageName->notEmpty()

Specified by:

validateInvariants in interface ModelElementFacade

Overrides:

validateInvariants in class UseCaseFacadeLogic

Parameters:

validationMessages - Collection

See Also:

UseCaseFacadeLogic.validateInvariants(Collection validationMessages)