org.andromda.metafacades.uml14

Class FrontEndActionLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.ModelElementFacadeLogic

org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

org.andromda.metafacades.uml14.TransitionFacadeLogic

org.andromda.metafacades.uml14.TransitionFacadeLogicImpl

org.andromda.metafacades.uml14.FrontEndForwardLogic

org.andromda.metafacades.uml14.FrontEndForwardLogicImpl

org.andromda.metafacades.uml14.FrontEndActionLogic

All Implemented Interfaces:

Serializable, Comparable, FrontEndAction, FrontEndForward, ModelElementFacade, TransitionFacade

Direct Known Subclasses:

FrontEndActionLogicImpl

public abstract class FrontEndActionLogic
extends FrontEndForwardLogicImpl
implements FrontEndAction

Represents a "front-end" action. An action is some action that is taken when a front-end even occurs. MetafacadeLogic for FrontEndAction

See Also:

FrontEndAction, 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	FrontEndActionLogic(Object metaObjectIn, String context) Create Metafacade implementation instance using the MetafacadeFactory from the context

Method Summary

Methods

Modifier and Type	Method and Description
ParameterFacade	findParameter(String name) Finds the parameter on this action having the given name, if no parameter is found, null is returned instead.
List<FrontEndForward>	getActionForwards() Represents a "front-end" action.
List<FrontEndActionState>	getActionStates() The actions that pass through this action state.
FrontEndController	getController() All actions that defer to at least one operation of this controller.
List<FrontEndForward>	getDecisionTransitions() Represents a "front-end" action.
List<FrontEndControllerOperation>	getDeferredOperations() All those actions that contain at least one front-end action state that is deferring to this operation.
List<FrontEndParameter>	getFormFields() Represents a "front-end" action.
StateVertexFacade	getInput() Represents a "front-end" action.
List<FrontEndParameter>	getParameters() The action to which this parameter belongs (if it belongs to an action), otherwise it returns null.
List<FrontEndView>	getTargetViews() Represents a "front-end" action.
List<FrontEndForward>	getTransitions() The front-end actions directly containing this front-end forward.
protected abstract ParameterFacade	handleFindParameter(String name) Method to be implemented in descendants Finds the parameter on this action having the given name, if no parameter is found, null is returned instead.
protected abstract List	handleGetActionForwards() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetActionStates() 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 List	handleGetDecisionTransitions() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetDeferredOperations() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetFormFields() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetInput() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetParameters() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetTargetViews() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract List	handleGetTransitions() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract boolean	handleIsUseCaseStart()
boolean	isFrontEndActionMetaType()
boolean	isUseCaseStart() Indicates if this action represents the beginning of the front-end use case or not.
void	resetMetafacadeContext(String context) Reset context only for non-root metafacades
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::metafacades::uml::FrontEndAction::parameters must be unique

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

handleGetActionMethodName, handleGetActions, handleGetDecisionTrigger, handleGetForwardParameters, handleGetFrontEndActivityGraph, handleGetName, handleGetOperationCall, handleGetPackageName, handleGetUseCase, handleIsContainedInFrontEndUseCase, handleIsEnteringView, handleIsExitingView

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

getActionMethodName, getActions, getDecisionTrigger, getForwardParameters, getFrontEndActivityGraph, getOperationCall, getUseCase, isContainedInFrontEndUseCase, isEnteringView, isExitingView, isFrontEndForwardMetaType

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

handleGetEffect, handleGetGuard, handleGetSource, handleGetTarget, handleGetTrigger, handleGetValidationOwner, handleIsEnteringActionState, handleIsEnteringDecisionPoint, handleIsEnteringFinalState, handleIsExitingActionState, handleIsExitingDecisionPoint, handleIsExitingInitialState, handleIsTriggerPresent

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

getEffect, getGuard, getSource, getTarget, getTrigger, isEnteringActionState, isEnteringDecisionPoint, isEnteringFinalState, isExitingActionState, isExitingDecisionPoint, isExitingInitialState, isTransitionFacadeMetaType, isTriggerPresent

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, handleGetOwnedElements, handleGetOwner, handleGetPackage, 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, getValidationOwner, 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.FrontEndForward

getActionMethodName, getActions, getDecisionTrigger, getForwardParameters, getFrontEndActivityGraph, getOperationCall, getUseCase, isContainedInFrontEndUseCase, isEnteringView, isExitingView, isFrontEndForwardMetaType

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

getEffect, getGuard, getSource, getTarget, getTrigger, isEnteringActionState, isEnteringDecisionPoint, isEnteringFinalState, isExitingActionState, isExitingDecisionPoint, isExitingInitialState, isTransitionFacadeMetaType, isTriggerPresent

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

FrontEndActionLogic

protected FrontEndActionLogic(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 FrontEndForwardLogic

Parameters:

context -

isFrontEndActionMetaType

public boolean isFrontEndActionMetaType()

Specified by:

isFrontEndActionMetaType in interface FrontEndAction

Returns:

boolean true always

See Also:

FrontEndAction

handleIsUseCaseStart

protected abstract boolean handleIsUseCaseStart()

Returns:

boolean

See Also:

FrontEndAction.isUseCaseStart()

isUseCaseStart

public final boolean isUseCaseStart()

Indicates if this action represents the beginning of the front-end use case or not.

Specified by:

isUseCaseStart in interface FrontEndAction

Returns:

(boolean)handleIsUseCaseStart()

handleFindParameter

protected abstract ParameterFacade handleFindParameter(String name)

Method to be implemented in descendants Finds the parameter on this action having the given name, if no parameter is found, null is returned instead.

Parameters:

name -

Returns:

ParameterFacade

findParameter

public ParameterFacade findParameter(String name)

Finds the parameter on this action having the given name, if no parameter is found, null is returned instead.

Specified by:

findParameter in interface FrontEndAction

Parameters:

name - String The name of the parameter to find on the owner action.

Returns:

handleFindParameter(name)

getDecisionTransitions

public final List<FrontEndForward> getDecisionTransitions()

Represents a "front-end" action. An action is some action that is taken when a front-end even occurs.

Specified by:

getDecisionTransitions in interface FrontEndAction

Returns:

(List)handleGetDecisionTransitions()

handleGetDecisionTransitions

protected abstract List handleGetDecisionTransitions()

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

Returns:

List

getActionForwards

public final List<FrontEndForward> getActionForwards()

Represents a "front-end" action. An action is some action that is taken when a front-end even occurs.

Specified by:

getActionForwards in interface FrontEndAction

Returns:

(List)handleGetActionForwards()

handleGetActionForwards

protected abstract List handleGetActionForwards()

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

Returns:

List

getTransitions

public final List<FrontEndForward> getTransitions()

The front-end actions directly containing this front-end forward.

Specified by:

getTransitions in interface FrontEndAction

Returns:

(List)handleGetTransitions()

handleGetTransitions

protected abstract List handleGetTransitions()

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

Returns:

List

getController

public final FrontEndController getController()

All actions that defer to at least one operation of this controller.

Specified by:

getController in interface FrontEndAction

Returns:

(FrontEndController)handleGetController()

handleGetController

protected abstract Object handleGetController()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getParameters

public final List<FrontEndParameter> getParameters()

The action to which this parameter belongs (if it belongs to an action), otherwise it returns null.

Specified by:

getParameters in interface FrontEndAction

Returns:

(List)handleGetParameters()

handleGetParameters

protected abstract List handleGetParameters()

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

Returns:

List

getActionStates

public final List<FrontEndActionState> getActionStates()

The actions that pass through this action state.

Specified by:

getActionStates in interface FrontEndAction

Returns:

(List)handleGetActionStates()

handleGetActionStates

protected abstract List handleGetActionStates()

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

Overrides:

handleGetActionStates in class FrontEndForwardLogicImpl

Returns:

List

See Also:

FrontEndAction.getActionStates()

getFormFields

public final List<FrontEndParameter> getFormFields()

Represents a "front-end" action. An action is some action that is taken when a front-end even occurs.

Specified by:

getFormFields in interface FrontEndAction

Returns:

(List)handleGetFormFields()

handleGetFormFields

protected abstract List handleGetFormFields()

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

Returns:

List

getTargetViews

public final List<FrontEndView> getTargetViews()

Represents a "front-end" action. An action is some action that is taken when a front-end even occurs.

Specified by:

getTargetViews in interface FrontEndAction

Returns:

(List)handleGetTargetViews()

handleGetTargetViews

protected abstract List handleGetTargetViews()

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

Returns:

List

getDeferredOperations

public final List<FrontEndControllerOperation> getDeferredOperations()

All those actions that contain at least one front-end action state that is deferring to this operation.

Specified by:

getDeferredOperations in interface FrontEndAction

Returns:

(List)handleGetDeferredOperations()

handleGetDeferredOperations

protected abstract List handleGetDeferredOperations()

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

Returns:

List

getInput

public final StateVertexFacade getInput()

Represents a "front-end" action. An action is some action that is taken when a front-end even occurs.

Specified by:

getInput in interface FrontEndAction

Returns:

(StateVertexFacade)handleGetInput()

handleGetInput

protected abstract Object handleGetInput()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::metafacades::uml::FrontEndAction::parameters must be unique

Error: Each front-end action parameter must have a unique name.

OCL: context FrontEndAction inv : parameters -> isUnique(name)

Constraint: org::andromda::metafacades::uml::FrontEndAction::each action must carry a trigger

Error: Each action transition coming out of a view must have a trigger (the name is sufficient), it is recommended to add a trigger of type 'signal'.

OCL: context FrontEndAction inv: exitingView implies triggerPresent

Specified by:

validateInvariants in interface ModelElementFacade

Overrides:

validateInvariants in class FrontEndForwardLogic

Parameters:

validationMessages - Collection

See Also:

FrontEndForwardLogic.validateInvariants(Collection validationMessages)