org.andromda.cartridges.bpm4struts.metafacades

Class StrutsForwardLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.cartridges.bpm4struts.metafacades.StrutsForwardLogic

All Implemented Interfaces:

Serializable, Comparable, StrutsForward, FrontEndForward, ModelElementFacade, TransitionFacade

Direct Known Subclasses:

StrutsForwardLogicImpl

public abstract class StrutsForwardLogic
extends MetafacadeBase
implements StrutsForward

A Struts forward is any transition between states. Some of these forwards may end up as actual forwards in the Struts deployment descriptor. MetafacadeLogic for StrutsForward

See Also:

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

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	getActionMethodName() The method name used to delegate to this forward.
List<FrontEndAction>	getActions() The front-end actions directly containing this front-end forward.
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.
FrontEndEvent	getDecisionTrigger() The trigger for this front-end forward.
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.
ActionFacade	getEffect() An action is a named element that is the fundamental unit of executable functionality.
String	getForwardName() The name for this forward.
List<FrontEndParameter>	getForwardParameters() Tthe set of parameter used during transport in this forward.
String	getForwardPath() Returns the path targetted by this forward.
FrontEndActivityGraph	getFrontEndActivityGraph() The activity graph which holds this forward if the graph is contained in a FrontEndUseCase.
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 '/'.
GuardFacade	getGuard() A representation of the model object 'Constraint'.
String	getGuardName() If this forward is guarded (such as with decision points) this method return the name of that guard.
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.
FrontEndControllerOperation	getOperationCall() The operation to which is called during execution of this front-end forward.
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.
StateVertexFacade	getSource() A representation of the model object 'Vertex'.
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.
StrutsActivityGraph	getStrutsActivityGraph() A Struts forward is any transition between states.
Map	getSuccessMessages() A map of key=value pairs, one for each success message.
Collection<TaggedValueFacade>	getTaggedValues() Return the TaggedValues associated with this model element, under all stereotypes.
StateVertexFacade	getTarget() A representation of the model object 'Vertex'.
Collection<DependencyFacade>	getTargetDependencies() Gets the dependencies for which this model element is the target.
String	getTargetNameKey() The resource bundle key of the name for the target element.
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
EventFacade	getTrigger() If a trigger is present on this transition, this event represents that trigger.
FrontEndUseCase	getUseCase() The use case in which this forward is contained.
String	getValidationName()
Object	getValidationOwner()
String	getVisibility() The visibility (i.e.
Map	getWarningMessages() A map of key=value pairs, one for each warning message.
protected abstract String	handleGetForwardName()
protected abstract String	handleGetForwardPath()
protected abstract String	handleGetGuardName()
protected abstract Object	handleGetStrutsActivityGraph() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Map	handleGetSuccessMessages()
protected abstract String	handleGetTargetNameKey()
protected abstract Map	handleGetWarningMessages()
protected abstract boolean	handleIsEnteringPage()
protected abstract boolean	handleIsExitingPage()
protected abstract boolean	handleIsSuccessMessagesPresent()
protected abstract boolean	handleIsWarningMessagesPresent()
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()
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	isContainedInFrontEndUseCase() Indicates if this forward is contained in a FrontEndUseCase.
boolean	isDocumentationPresent() Indicates if any documentation is present on this model element.
boolean	isEnteringActionState() TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.enteringActionState
boolean	isEnteringDecisionPoint() TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.enteringDecisionPoint
boolean	isEnteringFinalState() TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.enteringFinalState
boolean	isEnteringPage() True if this action directly targets a JSP page, false otherwise.
boolean	isEnteringView() Indicates if this action directly targets a "front-end" view, false otherwise.
boolean	isExitingActionState() TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.exitingActionState
boolean	isExitingDecisionPoint() TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.exitingDecisionPoint
boolean	isExitingInitialState() TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.exitingInitialState
boolean	isExitingPage() Whether or not this forward (transition) is coming out of a page.
boolean	isExitingView() Indicates if this forward (transition) is coming out of a front-end view.
boolean	isFrontEndForwardMetaType()
boolean	isModelElementFacadeMetaType()
boolean	isReservedWord() True if this element name is a reserved word in Java, C#, ANSI or ISO C, C++, JavaScript.
boolean	isStrutsForwardMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isSuccessMessagesPresent() TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.successMessagesPresent
boolean	isTemplateParametersPresent() True is there are template parameters on this model element.
boolean	isTransitionFacadeMetaType()
boolean	isTriggerPresent() TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.triggerPresent
boolean	isValidIdentifierName() True if this element name is a valid identifier name in Java, C#, ANSI or ISO C, C++, JavaScript.
boolean	isWarningMessagesPresent() TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.warningMessagesPresent
void	resetMetafacadeContext(String context) Reset context only for non-root metafacades
String	toString()
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) Constraint: org::andromda::cartridges::bpm4struts::metafacades::StrutsForward::decision forwards need a controller operation with a non-void return type

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

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

Methods inherited from class java.lang.Object

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

Field Detail

metaObject

protected Object metaObject

The underlying UML object

See Also:

Object

Constructor Detail

StrutsForwardLogic

protected StrutsForwardLogic(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 MetafacadeBase

Parameters:

context -

See Also:

MetafacadeBase.resetMetafacadeContext(String context)

isStrutsForwardMetaType

public boolean isStrutsForwardMetaType()

Description copied from interface: StrutsForward

Indicates the metafacade type (used for metafacade mappings).

Specified by:

isStrutsForwardMetaType in interface StrutsForward

Returns:

boolean true always

See Also:

StrutsForward

handleGetForwardName

protected abstract String handleGetForwardName()

Returns:

String

See Also:

StrutsForward.getForwardName()

getForwardName

public final String getForwardName()

The name for this forward. This name is always lowercase and words are separated using dots, not unlike the convention for Java package names.

Specified by:

getForwardName in interface StrutsForward

Returns:

(String)handleGetForwardName()

handleGetForwardPath

protected abstract String handleGetForwardPath()

Returns:

String

See Also:

StrutsForward.getForwardPath()

getForwardPath

public final String getForwardPath()

Returns the path targetted by this forward.

Specified by:

getForwardPath in interface StrutsForward

Returns:

(String)handleGetForwardPath()

handleGetGuardName

protected abstract String handleGetGuardName()

Returns:

String

See Also:

StrutsForward.getGuardName()

getGuardName

public final String getGuardName()

If this forward is guarded (such as with decision points) this method return the name of that guard.

Specified by:

getGuardName in interface StrutsForward

Returns:

(String)handleGetGuardName()

handleIsEnteringPage

protected abstract boolean handleIsEnteringPage()

Returns:

boolean

See Also:

StrutsForward.isEnteringPage()

isEnteringPage

public final boolean isEnteringPage()

True if this action directly targets a JSP page, false otherwise.

Specified by:

isEnteringPage in interface StrutsForward

Returns:

(boolean)handleIsEnteringPage()

handleGetTargetNameKey

protected abstract String handleGetTargetNameKey()

Returns:

String

See Also:

StrutsForward.getTargetNameKey()

getTargetNameKey

public final String getTargetNameKey()

The resource bundle key of the name for the target element. This method returns the key for the use-case or jsp page. If targetting anything else this method returns null.

Specified by:

getTargetNameKey in interface StrutsForward

Returns:

(String)handleGetTargetNameKey()

handleIsExitingPage

protected abstract boolean handleIsExitingPage()

Returns:

boolean

See Also:

StrutsForward.isExitingPage()

isExitingPage

public final boolean isExitingPage()

Whether or not this forward (transition) is coming out of a page.

Specified by:

isExitingPage in interface StrutsForward

Returns:

(boolean)handleIsExitingPage()

handleGetSuccessMessages

protected abstract Map handleGetSuccessMessages()

Returns:

Map

See Also:

StrutsForward.getSuccessMessages()

getSuccessMessages

public final Map getSuccessMessages()

A map of key=value pairs, one for each success message.

Specified by:

getSuccessMessages in interface StrutsForward

Returns:

(Map)handleGetSuccessMessages()

handleGetWarningMessages

protected abstract Map handleGetWarningMessages()

Returns:

Map

See Also:

StrutsForward.getWarningMessages()

getWarningMessages

public final Map getWarningMessages()

A map of key=value pairs, one for each warning message.

Specified by:

getWarningMessages in interface StrutsForward

Returns:

(Map)handleGetWarningMessages()

handleIsWarningMessagesPresent

protected abstract boolean handleIsWarningMessagesPresent()

Returns:

boolean

See Also:

StrutsForward.isWarningMessagesPresent()

isWarningMessagesPresent

public final boolean isWarningMessagesPresent()

TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.warningMessagesPresent

Specified by:

isWarningMessagesPresent in interface StrutsForward

Returns:

(boolean)handleIsWarningMessagesPresent()

handleIsSuccessMessagesPresent

protected abstract boolean handleIsSuccessMessagesPresent()

Returns:

boolean

See Also:

StrutsForward.isSuccessMessagesPresent()

isSuccessMessagesPresent

public final boolean isSuccessMessagesPresent()

TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.successMessagesPresent

Specified by:

isSuccessMessagesPresent in interface StrutsForward

Returns:

(boolean)handleIsSuccessMessagesPresent()

getStrutsActivityGraph

public final StrutsActivityGraph getStrutsActivityGraph()

A Struts forward is any transition between states. Some of these forwards may end up as actual forwards in the Struts deployment descriptor.

Specified by:

getStrutsActivityGraph in interface StrutsForward

Returns:

(StrutsActivityGraph)handleGetStrutsActivityGraph()

handleGetStrutsActivityGraph

protected abstract Object handleGetStrutsActivityGraph()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

isFrontEndForwardMetaType

public boolean isFrontEndForwardMetaType()

Specified by:

isFrontEndForwardMetaType in interface FrontEndForward

Returns:

true

See Also:

FrontEndForward

isTransitionFacadeMetaType

public boolean isTransitionFacadeMetaType()

Specified by:

isTransitionFacadeMetaType in interface TransitionFacade

Returns:

true

See Also:

TransitionFacade

isModelElementFacadeMetaType

public boolean isModelElementFacadeMetaType()

Specified by:

isModelElementFacadeMetaType in interface ModelElementFacade

Returns:

true

See Also:

ModelElementFacade

getActionMethodName

public String getActionMethodName()

The method name used to delegate to this forward.

Specified by:

getActionMethodName in interface FrontEndForward

See Also:

FrontEndForward.getActionMethodName()

getActions

public List<FrontEndAction> getActions()

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

Specified by:

getActions in interface FrontEndForward

See Also:

FrontEndForward.getActions()

getDecisionTrigger

public FrontEndEvent getDecisionTrigger()

The trigger for this front-end forward.

Specified by:

getDecisionTrigger in interface FrontEndForward

See Also:

FrontEndForward.getDecisionTrigger()

getForwardParameters

public List<FrontEndParameter> getForwardParameters()

Tthe set of parameter used during transport in this forward.

Specified by:

getForwardParameters in interface FrontEndForward

See Also:

FrontEndForward.getForwardParameters()

getFrontEndActivityGraph

public FrontEndActivityGraph getFrontEndActivityGraph()

The activity graph which holds this forward if the graph is contained in a FrontEndUseCase.

Specified by:

getFrontEndActivityGraph in interface FrontEndForward

See Also:

FrontEndForward.getFrontEndActivityGraph()

getOperationCall

public FrontEndControllerOperation getOperationCall()

The operation to which is called during execution of this front-end forward.

Specified by:

getOperationCall in interface FrontEndForward

See Also:

FrontEndForward.getOperationCall()

getUseCase

public FrontEndUseCase getUseCase()

The use case in which this forward is contained.

Specified by:

getUseCase in interface FrontEndForward

See Also:

FrontEndForward.getUseCase()

isContainedInFrontEndUseCase

public boolean isContainedInFrontEndUseCase()

Indicates if this forward is contained in a FrontEndUseCase.

Specified by:

isContainedInFrontEndUseCase in interface FrontEndForward

See Also:

FrontEndForward.isContainedInFrontEndUseCase()

isEnteringView

public boolean isEnteringView()

Indicates if this action directly targets a "front-end" view, false otherwise.

Specified by:

isEnteringView in interface FrontEndForward

See Also:

FrontEndForward.isEnteringView()

isExitingView

public boolean isExitingView()

Indicates if this forward (transition) is coming out of a front-end view.

Specified by:

isExitingView in interface FrontEndForward

See Also:

FrontEndForward.isExitingView()

copyTaggedValues

public void copyTaggedValues(ModelElementFacade element)

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

Specified by:

copyTaggedValues in interface ModelElementFacade

See Also:

ModelElementFacade.copyTaggedValues(ModelElementFacade element)

findTaggedValue

public 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.

Specified by:

findTaggedValue in interface ModelElementFacade

See Also:

ModelElementFacade.findTaggedValue(String tagName)

findTaggedValues

public 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.

Specified by:

findTaggedValues in interface ModelElementFacade

See Also:

ModelElementFacade.findTaggedValues(String tagName)

getBindedFullyQualifiedName

public String getBindedFullyQualifiedName(ModelElementFacade bindedElement)

Returns the fully qualified name of the model element. The fully qualified name includes complete package qualified name of the underlying model element. The templates parameter will be replaced by the correct one given the binding relation of the parameter to this element.

Specified by:

getBindedFullyQualifiedName in interface ModelElementFacade

See Also:

ModelElementFacade.getBindedFullyQualifiedName(ModelElementFacade bindedElement)

getConstraints

public Collection<ConstraintFacade> getConstraints()

Gets all constraints belonging to the model element.

Specified by:

getConstraints in interface ModelElementFacade

See Also:

ModelElementFacade.getConstraints()

getConstraints

public Collection<ConstraintFacade> getConstraints(String kind)

Returns the constraints of the argument kind that have been placed onto this model. Typical kinds are "inv", "pre" and "post". Other kinds are possible.

Specified by:

getConstraints in interface ModelElementFacade

See Also:

ModelElementFacade.getConstraints(String kind)

getDocumentation

public String getDocumentation(String indent)

Gets the documentation for the model element, The indent argument is prefixed to each line. By default this method wraps lines after 64 characters. This method is equivalent to getDocumentation(indent, 64).

Specified by:

getDocumentation in interface ModelElementFacade

See Also:

ModelElementFacade.getDocumentation(String indent)

getDocumentation

public 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. By default paragraphs are returned as HTML. This method is equivalent to getDocumentation(indent, lineLength, true).

Specified by:

getDocumentation in interface ModelElementFacade

See Also:

ModelElementFacade.getDocumentation(String indent, int lineLength)

getDocumentation

public 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. HTML style determines if HTML Escaping is applied.

Specified by:

getDocumentation in interface ModelElementFacade

See Also:

ModelElementFacade.getDocumentation(String indent, int lineLength, boolean htmlStyle)

getFullyQualifiedName

public String getFullyQualifiedName()

The fully qualified name of this model element.

Specified by:

getFullyQualifiedName in interface ModelElementFacade

See Also:

ModelElementFacade.getFullyQualifiedName()

getFullyQualifiedName

public String getFullyQualifiedName(boolean modelName)

Returns the fully qualified name of the model element. The fully qualified name includes complete package qualified name of the underlying model element. If modelName is true, then the original name of the model element (the name contained within the model) will be the name returned, otherwise a name from a language mapping will be returned.

Specified by:

getFullyQualifiedName in interface ModelElementFacade

See Also:

ModelElementFacade.getFullyQualifiedName(boolean modelName)

getFullyQualifiedNamePath

public String getFullyQualifiedNamePath()

Returns the fully qualified name as a path, the returned value always starts with out a slash '/'.

Specified by:

getFullyQualifiedNamePath in interface ModelElementFacade

See Also:

ModelElementFacade.getFullyQualifiedNamePath()

getId

public String getId()

Gets the unique identifier of the underlying model element.

Specified by:

getId in interface ModelElementFacade

See Also:

ModelElementFacade.getId()

getKeywords

public Collection<String> getKeywords()

UML2: Retrieves the keywords for this element. Used to modify implementation properties which are not represented by other properties, i.e. native, transient, volatile, synchronized, (added annotations) override, deprecated. Can also be used to suppress compiler warnings: (added annotations) unchecked, fallthrough, path, serial, finally, all. Annotations require JDK5 compiler level.

Specified by:

getKeywords in interface ModelElementFacade

See Also:

ModelElementFacade.getKeywords()

getLabel

public String getLabel()

UML2: Retrieves a localized label for this named element.

Specified by:

getLabel in interface ModelElementFacade

See Also:

ModelElementFacade.getLabel()

getLanguageMappings

public TypeMappings getLanguageMappings()

The language mappings that have been set for this model element.

Specified by:

getLanguageMappings in interface ModelElementFacade

See Also:

ModelElementFacade.getLanguageMappings()

getModel

public ModelFacade getModel()

Return the model containing this model element (multiple models may be loaded and processed at the same time).

Specified by:

getModel in interface ModelElementFacade

See Also:

ModelElementFacade.getModel()

getName

public String getName()

The name of the model element.

Specified by:

getName in interface ModelElementFacade

See Also:

ModelElementFacade.getName()

getPackage

public ModelElementFacade getPackage()

Gets the package to which this model element belongs.

Specified by:

getPackage in interface ModelElementFacade

See Also:

ModelElementFacade.getPackage()

getPackageName

public String getPackageName()

The name of this model element's package.

Specified by:

getPackageName in interface ModelElementFacade

See Also:

ModelElementFacade.getPackageName()

getPackageName

public String getPackageName(boolean modelName)

Gets the package name (optionally providing the ability to retrieve the model name and not the mapped name).

Specified by:

getPackageName in interface ModelElementFacade

See Also:

ModelElementFacade.getPackageName(boolean modelName)

getPackagePath

public String getPackagePath()

Returns the package as a path, the returned value always starts with out a slash '/'.

Specified by:

getPackagePath in interface ModelElementFacade

See Also:

ModelElementFacade.getPackagePath()

getQualifiedName

public String getQualifiedName()

UML2: Returns the value of the 'Qualified Name' attribute. A name which allows the NamedElement to be identified within a hierarchy of nested Namespaces. It is constructed from the names of the containing namespaces starting at the root of the hierarchy and ending with the name of the NamedElement itself.

Specified by:

getQualifiedName in interface ModelElementFacade

See Also:

ModelElementFacade.getQualifiedName()

getRootPackage

public PackageFacade getRootPackage()

Gets the root package for the model element.

Specified by:

getRootPackage in interface ModelElementFacade

See Also:

ModelElementFacade.getRootPackage()

getSourceDependencies

public Collection<DependencyFacade> getSourceDependencies()

Gets the dependencies for which this model element is the source.

Specified by:

getSourceDependencies in interface ModelElementFacade

See Also:

ModelElementFacade.getSourceDependencies()

getStateMachineContext

public StateMachineFacade getStateMachineContext()

If this model element is the context of an activity graph, this represents that activity graph.

Specified by:

getStateMachineContext in interface ModelElementFacade

See Also:

ModelElementFacade.getStateMachineContext()

getStereotypeNames

public Collection<String> getStereotypeNames()

The collection of ALL stereotype names for this model element.

Specified by:

getStereotypeNames in interface ModelElementFacade

See Also:

ModelElementFacade.getStereotypeNames()

getStereotypes

public Collection<StereotypeFacade> getStereotypes()

Gets all stereotypes for this model element.

Specified by:

getStereotypes in interface ModelElementFacade

See Also:

ModelElementFacade.getStereotypes()

getTaggedValues

public Collection<TaggedValueFacade> getTaggedValues()

Return the TaggedValues associated with this model element, under all stereotypes.

Specified by:

getTaggedValues in interface ModelElementFacade

See Also:

ModelElementFacade.getTaggedValues()

getTargetDependencies

public Collection<DependencyFacade> getTargetDependencies()

Gets the dependencies for which this model element is the target.

Specified by:

getTargetDependencies in interface ModelElementFacade

See Also:

ModelElementFacade.getTargetDependencies()

getTemplateParameter

public Object getTemplateParameter(String parameterName)

Get the template parameter for this model element having the parameterName

Specified by:

getTemplateParameter in interface ModelElementFacade

See Also:

ModelElementFacade.getTemplateParameter(String parameterName)

getTemplateParameters

public Collection<TemplateParameterFacade> getTemplateParameters()

Get the template parameters for this model element

Specified by:

getTemplateParameters in interface ModelElementFacade

See Also:

ModelElementFacade.getTemplateParameters()

getVisibility

public String getVisibility()

The visibility (i.e. public, private, protected or package) of the model element, will attempt a lookup for these values in the language mappings (if any).

Specified by:

getVisibility in interface ModelElementFacade

See Also:

ModelElementFacade.getVisibility()

hasExactStereotype

public 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.

Specified by:

hasExactStereotype in interface ModelElementFacade

See Also:

ModelElementFacade.hasExactStereotype(String stereotypeName)

hasKeyword

public boolean hasKeyword(String keywordName)

Does the UML Element contain the named Keyword? Keywords can be separated by space, comma, pipe, semicolon, or << >>

Specified by:

hasKeyword in interface ModelElementFacade

See Also:

ModelElementFacade.hasKeyword(String keywordName)

hasStereotype

public boolean hasStereotype(String stereotypeName)

Returns true if the model element has the specified stereotype. If the stereotype itself does not match, then a search will be made up the stereotype inheritance hierarchy, and if one of the stereotype's ancestors has a matching name this method will return true, false otherwise. For example, if we have a certain stereotype called <> and a model element has a stereotype called <> which extends <>, when calling this method with 'stereotypeName' defined as 'exception' the method would return true since <> inherits from <>. If you want to check if the model element has the exact stereotype, then use the method 'hasExactStereotype' instead.

Specified by:

hasStereotype in interface ModelElementFacade

See Also:

ModelElementFacade.hasStereotype(String stereotypeName)

isBindingDependenciesPresent

public boolean isBindingDependenciesPresent()

True if there are target dependencies from this element that are instances of BindingFacade. Deprecated in UML2: Use TemplateBinding parameters instead of dependencies.

Specified by:

isBindingDependenciesPresent in interface ModelElementFacade

See Also:

ModelElementFacade.isBindingDependenciesPresent()

isConstraintsPresent

public boolean isConstraintsPresent()

Indicates if any constraints are present on this model element.

Specified by:

isConstraintsPresent in interface ModelElementFacade

See Also:

ModelElementFacade.isConstraintsPresent()

isDocumentationPresent

public boolean isDocumentationPresent()

Indicates if any documentation is present on this model element.

Specified by:

isDocumentationPresent in interface ModelElementFacade

See Also:

ModelElementFacade.isDocumentationPresent()

isReservedWord

public boolean isReservedWord()

True if this element name is a reserved word in Java, C#, ANSI or ISO C, C++, JavaScript.

Specified by:

isReservedWord in interface ModelElementFacade

See Also:

ModelElementFacade.isReservedWord()

isTemplateParametersPresent

public boolean isTemplateParametersPresent()

True is there are template parameters on this model element. For UML2, applies to Class, Operation, Property, and Parameter.

Specified by:

isTemplateParametersPresent in interface ModelElementFacade

See Also:

ModelElementFacade.isTemplateParametersPresent()

isValidIdentifierName

public boolean isValidIdentifierName()

True if this element name is a valid identifier name in Java, C#, ANSI or ISO C, C++, JavaScript. Contains no spaces, special characters etc. Constraint always applied on Enumerations and Interfaces, optionally applies on other model elements.

Specified by:

isValidIdentifierName in interface ModelElementFacade

See Also:

ModelElementFacade.isValidIdentifierName()

translateConstraint

public 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.

Specified by:

translateConstraint in interface ModelElementFacade

See Also:

ModelElementFacade.translateConstraint(String name, String translation)

translateConstraints

public String[] translateConstraints(String translation)

Translates all constraints belonging to this model element with the given 'translation'.

Specified by:

translateConstraints in interface ModelElementFacade

See Also:

ModelElementFacade.translateConstraints(String translation)

translateConstraints

public String[] translateConstraints(String kind,
                            String translation)

Translates the constraints of the specified 'kind' belonging to this model element.

Specified by:

translateConstraints in interface ModelElementFacade

See Also:

ModelElementFacade.translateConstraints(String kind, String translation)

getEffect

public ActionFacade getEffect()

An action is a named element that is the fundamental unit of executable functionality. The execution of an action represents some transformation or processing in the modeled system, be it a computer system or otherwise. An action represents a single step within an activity, that is, one that is not further decomposed within the activity. An action has pre- and post-conditions.

Specified by:

getEffect in interface TransitionFacade

See Also:

TransitionFacade.getEffect()

getGuard

public GuardFacade getGuard()

A representation of the model object 'Constraint'. A condition or restriction expressed in natural language text or in a machine readable language for the purpose of declaring some of the semantics of an element.

Specified by:

getGuard in interface TransitionFacade

See Also:

TransitionFacade.getGuard()

getSource

public StateVertexFacade getSource()

A representation of the model object 'Vertex'. An abstraction of a node in a state machine graph. In general, it can be the source or destination of any number of transitions.

Specified by:

getSource in interface TransitionFacade

See Also:

TransitionFacade.getSource()

getTarget

public StateVertexFacade getTarget()

A representation of the model object 'Vertex'. An abstraction of a node in a state machine graph. In general, it can be the source or destination of any number of transitions.

Specified by:

getTarget in interface TransitionFacade

See Also:

TransitionFacade.getTarget()

getTrigger

public EventFacade getTrigger()

If a trigger is present on this transition, this event represents that trigger.

Specified by:

getTrigger in interface TransitionFacade

See Also:

TransitionFacade.getTrigger()

isEnteringActionState

public boolean isEnteringActionState()

TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.enteringActionState

Specified by:

isEnteringActionState in interface TransitionFacade

See Also:

TransitionFacade.isEnteringActionState()

isEnteringDecisionPoint

public boolean isEnteringDecisionPoint()

TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.enteringDecisionPoint

Specified by:

isEnteringDecisionPoint in interface TransitionFacade

See Also:

TransitionFacade.isEnteringDecisionPoint()

isEnteringFinalState

public boolean isEnteringFinalState()

TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.enteringFinalState

Specified by:

isEnteringFinalState in interface TransitionFacade

See Also:

TransitionFacade.isEnteringFinalState()

isExitingActionState

public boolean isExitingActionState()

TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.exitingActionState

Specified by:

isExitingActionState in interface TransitionFacade

See Also:

TransitionFacade.isExitingActionState()

isExitingDecisionPoint

public boolean isExitingDecisionPoint()

TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.exitingDecisionPoint

Specified by:

isExitingDecisionPoint in interface TransitionFacade

See Also:

TransitionFacade.isExitingDecisionPoint()

isExitingInitialState

public boolean isExitingInitialState()

TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.exitingInitialState

Specified by:

isExitingInitialState in interface TransitionFacade

See Also:

TransitionFacade.isExitingInitialState()

isTriggerPresent

public boolean isTriggerPresent()

TODO: Model Documentation for org.andromda.metafacades.uml.TransitionFacade.triggerPresent

Specified by:

isTriggerPresent in interface TransitionFacade

See Also:

TransitionFacade.isTriggerPresent()

initialize

public void initialize()

Specified by:

initialize in interface ModelElementFacade

Overrides:

initialize in class MetafacadeBase

See Also:

MetafacadeBase.initialize()

getValidationOwner

public Object getValidationOwner()

Specified by:

getValidationOwner in interface ModelElementFacade

Overrides:

getValidationOwner in class MetafacadeBase

Returns:

Object getSuperFrontEndForward().getValidationOwner()

See Also:

MetafacadeBase.getValidationOwner()

getValidationName

public String getValidationName()

Specified by:

getValidationName in interface ModelElementFacade

Overrides:

getValidationName in class MetafacadeBase

Returns:

String getSuperFrontEndForward().getValidationName()

See Also:

MetafacadeBase.getValidationName()

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::cartridges::bpm4struts::metafacades::StrutsForward::decision forwards need a controller operation with a non-void return type

Error: If a transition is going into a decision point you will need to defer to an operation with a non-void return type. You will need to model this on the transition's trigger.

OCL: context StrutsForward inv: enteringDecisionPoint implies (decisionTrigger->notEmpty() and operationCall->notEmpty() and operationCall.returnTypePresent)

Constraint: org::andromda::cartridges::bpm4struts::metafacades::StrutsForward::decision outcome needs a guard

Error: When a transition exits a decision point it needs a guard with a non-empty name.

OCL: context StrutsForward inv: exitingDecisionPoint implies guardName->notEmpty()

Constraint: org::andromda::cartridges::bpm4struts::metafacades::StrutsForward::validate decision points

Error: Transitions carrying a controller call in their triggers need to target a decision point, this is a diamond shaped figure with 2 or more outgoing transitions.

OCL: context StrutsForward inv: operationCall->notEmpty() and target.oclIsKindOf(org::andromda::metafacades::uml::PseudostateFacade) and (target.choice or target.junction) implies enteringDecisionPoint

Constraint: org::andromda::cartridges::bpm4struts::metafacades::StrutsForward::operation calls must target a decision point

Error: If you defer to an operation call on a transition, than that transition must target a decision point.

OCL: context StrutsForward inv: operationCall->notEmpty() implies (target.oclIsKindOf(org::andromda::metafacades::uml::PseudostateFacade) and target.decisionPoint)

Specified by:

validateInvariants in interface ModelElementFacade

Overrides:

validateInvariants in class MetafacadeBase

Parameters:

validationMessages - Collection

See Also:

MetafacadeBase.validateInvariants(Collection validationMessages)

toString

public String toString()

Overrides:

toString in class MetafacadeBase

See Also:

Object.toString()