StrutsActionStateLogic.java
// license-header java merge-point
//
// Attention: generated code (by MetafacadeLogic.vsl) - do not modify!
//
package org.andromda.cartridges.bpm4struts.metafacades;
import java.util.Collection;
import java.util.List;
import org.andromda.core.common.Introspector;
import org.andromda.core.metafacade.MetafacadeBase;
import org.andromda.core.metafacade.MetafacadeFactory;
import org.andromda.core.metafacade.ModelValidationMessage;
import org.andromda.metafacades.uml.ActionFacade;
import org.andromda.metafacades.uml.ConstraintFacade;
import org.andromda.metafacades.uml.DependencyFacade;
import org.andromda.metafacades.uml.EventFacade;
import org.andromda.metafacades.uml.FrontEndAction;
import org.andromda.metafacades.uml.FrontEndActionState;
import org.andromda.metafacades.uml.FrontEndExceptionHandler;
import org.andromda.metafacades.uml.FrontEndForward;
import org.andromda.metafacades.uml.ModelElementFacade;
import org.andromda.metafacades.uml.ModelFacade;
import org.andromda.metafacades.uml.OperationFacade;
import org.andromda.metafacades.uml.PackageFacade;
import org.andromda.metafacades.uml.PartitionFacade;
import org.andromda.metafacades.uml.StateFacade;
import org.andromda.metafacades.uml.StateMachineFacade;
import org.andromda.metafacades.uml.StereotypeFacade;
import org.andromda.metafacades.uml.TaggedValueFacade;
import org.andromda.metafacades.uml.TemplateParameterFacade;
import org.andromda.metafacades.uml.TransitionFacade;
import org.andromda.metafacades.uml.TypeMappings;
/**
* A plain action state represents an operation on the server called by an action. Optionally an
* action state may defer operations to the controller.
* MetafacadeLogic for StrutsActionState
*
* @see StrutsActionState
*/
public abstract class StrutsActionStateLogic
extends MetafacadeBase
implements StrutsActionState
{
/**
* The underlying UML object
* @see Object
*/
protected Object metaObject;
/** Create Metafacade implementation instance using the MetafacadeFactory from the context
* @param metaObjectIn
* @param context
*/
protected StrutsActionStateLogic(Object metaObjectIn, String context)
{
super(metaObjectIn, getContext(context));
this.superFrontEndActionState =
(FrontEndActionState)
MetafacadeFactory.getInstance().createFacadeImpl(
"org.andromda.metafacades.uml.FrontEndActionState",
metaObjectIn,
getContext(context));
this.metaObject = metaObjectIn;
}
/**
* Gets the context for this metafacade logic instance.
* @param context String. Set to StrutsActionState if null
* @return context String
*/
private static String getContext(String context)
{
if (context == null)
{
context = "org.andromda.cartridges.bpm4struts.metafacades.StrutsActionState";
}
return context;
}
private FrontEndActionState superFrontEndActionState;
private boolean superFrontEndActionStateInitialized = false;
/**
* Gets the FrontEndActionState parent instance.
* @return this.superFrontEndActionState FrontEndActionState
*/
private FrontEndActionState getSuperFrontEndActionState()
{
if (!this.superFrontEndActionStateInitialized)
{
((MetafacadeBase)this.superFrontEndActionState).setMetafacadeContext(this.getMetafacadeContext());
this.superFrontEndActionStateInitialized = true;
}
return this.superFrontEndActionState;
}
/** Reset context only for non-root metafacades
* @param context
* @see org.andromda.core.metafacade.MetafacadeBase#resetMetafacadeContext(String context)
*/
@Override
public void resetMetafacadeContext(String context)
{
if (!this.contextRoot) // reset context only for non-root metafacades
{
context = getContext(context); // to have same value as in original constructor call
setMetafacadeContext (context);
if (this.superFrontEndActionStateInitialized)
{
((MetafacadeBase)this.superFrontEndActionState).resetMetafacadeContext(context);
}
}
}
/**
* @return boolean true always
* @see StrutsActionState
*/
public boolean isStrutsActionStateMetaType()
{
return true;
}
// ------------- associations ------------------
/**
* @return true
* @see FrontEndActionState
*/
public boolean isFrontEndActionStateMetaType()
{
return true;
}
/**
* @return true
* @see org.andromda.metafacades.uml.ActionStateFacade
*/
public boolean isActionStateFacadeMetaType()
{
return true;
}
/**
* @return true
* @see StateFacade
*/
public boolean isStateFacadeMetaType()
{
return true;
}
/**
* @return true
* @see org.andromda.metafacades.uml.StateVertexFacade
*/
public boolean isStateVertexFacadeMetaType()
{
return true;
}
/**
* @return true
* @see ModelElementFacade
*/
public boolean isModelElementFacadeMetaType()
{
return true;
}
// ----------- delegates to FrontEndActionState ------------
/**
* The entry action for this action state (if any).
* @see org.andromda.metafacades.uml.ActionStateFacade#getEntry()
*/
public ActionFacade getEntry()
{
return this.getSuperFrontEndActionState().getEntry();
}
/**
* The method name representing this action state.
* @see FrontEndActionState#getActionMethodName()
*/
public String getActionMethodName()
{
return this.getSuperFrontEndActionState().getActionMethodName();
}
/**
* The actions that pass through this action state.
* @see FrontEndActionState#getContainerActions()
*/
public List<FrontEndAction> getContainerActions()
{
return this.getSuperFrontEndActionState().getContainerActions();
}
/**
* All calls deferred to the controller by this action state.
* @see FrontEndActionState#getControllerCalls()
*/
public List<OperationFacade> getControllerCalls()
{
return this.getSuperFrontEndActionState().getControllerCalls();
}
/**
* All exceptions modelled on this action state.
* @see FrontEndActionState#getExceptions()
*/
public List<FrontEndExceptionHandler> getExceptions()
{
return this.getSuperFrontEndActionState().getExceptions();
}
/**
* The next transition, there can be only one transition going out of an action state, otherwise
* decision points should be used (triggers are not supported at the server-side).
* @see FrontEndActionState#getForward()
*/
public FrontEndForward getForward()
{
return this.getSuperFrontEndActionState().getForward();
}
/**
* All calls deferred to the services by this action state.
* @see FrontEndActionState#getServiceCalls()
*/
public List<OperationFacade> getServiceCalls()
{
return this.getSuperFrontEndActionState().getServiceCalls();
}
/**
* True if this element is contained in a FrontEndUseCase.
* @see FrontEndActionState#isContainedInFrontEndUseCase()
*/
public boolean isContainedInFrontEndUseCase()
{
return this.getSuperFrontEndActionState().isContainedInFrontEndUseCase();
}
/**
* Indicates whether or not this front end action state is server side. Pages, for example, are
* also action states but they return control to the client.
* @see FrontEndActionState#isServerSide()
*/
public boolean isServerSide()
{
return this.getSuperFrontEndActionState().isServerSide();
}
/**
* Copies all tagged values from the given ModelElementFacade to this model element facade.
* @see ModelElementFacade#copyTaggedValues(ModelElementFacade element)
*/
public void copyTaggedValues(ModelElementFacade element)
{
this.getSuperFrontEndActionState().copyTaggedValues(element);
}
/**
* Finds the tagged value with the specified 'tagName'. In case there are more values the first
* one found will be returned.
* @see ModelElementFacade#findTaggedValue(String tagName)
*/
public Object findTaggedValue(String tagName)
{
return this.getSuperFrontEndActionState().findTaggedValue(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.
* @see ModelElementFacade#findTaggedValues(String tagName)
*/
public Collection<Object> findTaggedValues(String tagName)
{
return this.getSuperFrontEndActionState().findTaggedValues(tagName);
}
/**
* 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.
* @see ModelElementFacade#getBindedFullyQualifiedName(ModelElementFacade bindedElement)
*/
public String getBindedFullyQualifiedName(ModelElementFacade bindedElement)
{
return this.getSuperFrontEndActionState().getBindedFullyQualifiedName(bindedElement);
}
/**
* Gets all constraints belonging to the model element.
* @see ModelElementFacade#getConstraints()
*/
public Collection<ConstraintFacade> getConstraints()
{
return this.getSuperFrontEndActionState().getConstraints();
}
/**
* 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.
* @see ModelElementFacade#getConstraints(String kind)
*/
public Collection<ConstraintFacade> getConstraints(String kind)
{
return this.getSuperFrontEndActionState().getConstraints(kind);
}
/**
* 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 <code>getDocumentation(indent, 64)</code>.
* @see ModelElementFacade#getDocumentation(String indent)
*/
public String getDocumentation(String indent)
{
return this.getSuperFrontEndActionState().getDocumentation(indent);
}
/**
* 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 <code>getDocumentation(indent, lineLength, true)</code>.
* @see ModelElementFacade#getDocumentation(String indent, int lineLength)
*/
public String getDocumentation(String indent, int lineLength)
{
return this.getSuperFrontEndActionState().getDocumentation(indent, 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. HTML style determines if HTML Escaping is applied.
* @see ModelElementFacade#getDocumentation(String indent, int lineLength, boolean htmlStyle)
*/
public String getDocumentation(String indent, int lineLength, boolean htmlStyle)
{
return this.getSuperFrontEndActionState().getDocumentation(indent, lineLength, htmlStyle);
}
/**
* The fully qualified name of this model element.
* @see ModelElementFacade#getFullyQualifiedName()
*/
public String getFullyQualifiedName()
{
return this.getSuperFrontEndActionState().getFullyQualifiedName();
}
/**
* 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.
* @see ModelElementFacade#getFullyQualifiedName(boolean modelName)
*/
public String getFullyQualifiedName(boolean modelName)
{
return this.getSuperFrontEndActionState().getFullyQualifiedName(modelName);
}
/**
* Returns the fully qualified name as a path, the returned value always starts with out a slash
* '/'.
* @see ModelElementFacade#getFullyQualifiedNamePath()
*/
public String getFullyQualifiedNamePath()
{
return this.getSuperFrontEndActionState().getFullyQualifiedNamePath();
}
/**
* Gets the unique identifier of the underlying model element.
* @see ModelElementFacade#getId()
*/
public String getId()
{
return this.getSuperFrontEndActionState().getId();
}
/**
* 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.
* @see ModelElementFacade#getKeywords()
*/
public Collection<String> getKeywords()
{
return this.getSuperFrontEndActionState().getKeywords();
}
/**
* UML2: Retrieves a localized label for this named element.
* @see ModelElementFacade#getLabel()
*/
public String getLabel()
{
return this.getSuperFrontEndActionState().getLabel();
}
/**
* The language mappings that have been set for this model element.
* @see ModelElementFacade#getLanguageMappings()
*/
public TypeMappings getLanguageMappings()
{
return this.getSuperFrontEndActionState().getLanguageMappings();
}
/**
* Return the model containing this model element (multiple models may be loaded and processed
* at the same time).
* @see ModelElementFacade#getModel()
*/
public ModelFacade getModel()
{
return this.getSuperFrontEndActionState().getModel();
}
/**
* The name of the model element.
* @see ModelElementFacade#getName()
*/
public String getName()
{
return this.getSuperFrontEndActionState().getName();
}
/**
* Gets the package to which this model element belongs.
* @see ModelElementFacade#getPackage()
*/
public ModelElementFacade getPackage()
{
return this.getSuperFrontEndActionState().getPackage();
}
/**
* The name of this model element's package.
* @see ModelElementFacade#getPackageName()
*/
public String getPackageName()
{
return this.getSuperFrontEndActionState().getPackageName();
}
/**
* Gets the package name (optionally providing the ability to retrieve the model name and not
* the mapped name).
* @see ModelElementFacade#getPackageName(boolean modelName)
*/
public String getPackageName(boolean modelName)
{
return this.getSuperFrontEndActionState().getPackageName(modelName);
}
/**
* Returns the package as a path, the returned value always starts with out a slash '/'.
* @see ModelElementFacade#getPackagePath()
*/
public String getPackagePath()
{
return this.getSuperFrontEndActionState().getPackagePath();
}
/**
* 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.
* @see ModelElementFacade#getQualifiedName()
*/
public String getQualifiedName()
{
return this.getSuperFrontEndActionState().getQualifiedName();
}
/**
* Gets the root package for the model element.
* @see ModelElementFacade#getRootPackage()
*/
public PackageFacade getRootPackage()
{
return this.getSuperFrontEndActionState().getRootPackage();
}
/**
* Gets the dependencies for which this model element is the source.
* @see ModelElementFacade#getSourceDependencies()
*/
public Collection<DependencyFacade> getSourceDependencies()
{
return this.getSuperFrontEndActionState().getSourceDependencies();
}
/**
* If this model element is the context of an activity graph, this represents that activity
* graph.
* @see ModelElementFacade#getStateMachineContext()
*/
public StateMachineFacade getStateMachineContext()
{
return this.getSuperFrontEndActionState().getStateMachineContext();
}
/**
* The collection of ALL stereotype names for this model element.
* @see ModelElementFacade#getStereotypeNames()
*/
public Collection<String> getStereotypeNames()
{
return this.getSuperFrontEndActionState().getStereotypeNames();
}
/**
* Gets all stereotypes for this model element.
* @see ModelElementFacade#getStereotypes()
*/
public Collection<StereotypeFacade> getStereotypes()
{
return this.getSuperFrontEndActionState().getStereotypes();
}
/**
* Return the TaggedValues associated with this model element, under all stereotypes.
* @see ModelElementFacade#getTaggedValues()
*/
public Collection<TaggedValueFacade> getTaggedValues()
{
return this.getSuperFrontEndActionState().getTaggedValues();
}
/**
* Gets the dependencies for which this model element is the target.
* @see ModelElementFacade#getTargetDependencies()
*/
public Collection<DependencyFacade> getTargetDependencies()
{
return this.getSuperFrontEndActionState().getTargetDependencies();
}
/**
* Get the template parameter for this model element having the parameterName
* @see ModelElementFacade#getTemplateParameter(String parameterName)
*/
public Object getTemplateParameter(String parameterName)
{
return this.getSuperFrontEndActionState().getTemplateParameter(parameterName);
}
/**
* Get the template parameters for this model element
* @see ModelElementFacade#getTemplateParameters()
*/
public Collection<TemplateParameterFacade> getTemplateParameters()
{
return this.getSuperFrontEndActionState().getTemplateParameters();
}
/**
* 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).
* @see ModelElementFacade#getVisibility()
*/
public String getVisibility()
{
return this.getSuperFrontEndActionState().getVisibility();
}
/**
* 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.
* @see ModelElementFacade#hasExactStereotype(String stereotypeName)
*/
public boolean hasExactStereotype(String stereotypeName)
{
return this.getSuperFrontEndActionState().hasExactStereotype(stereotypeName);
}
/**
* Does the UML Element contain the named Keyword? Keywords can be separated by space, comma,
* pipe, semicolon, or << >>
* @see ModelElementFacade#hasKeyword(String keywordName)
*/
public boolean hasKeyword(String keywordName)
{
return this.getSuperFrontEndActionState().hasKeyword(keywordName);
}
/**
* 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 <<exception>> and a model element has a
* stereotype called <<applicationException>> which extends <<exception>>, when calling this
* method with 'stereotypeName' defined as 'exception' the method would return true since
* <<applicationException>> inherits from <<exception>>. If you want to check if the model
* element has the exact stereotype, then use the method 'hasExactStereotype' instead.
* @see ModelElementFacade#hasStereotype(String stereotypeName)
*/
public boolean hasStereotype(String stereotypeName)
{
return this.getSuperFrontEndActionState().hasStereotype(stereotypeName);
}
/**
* True if there are target dependencies from this element that are instances of BindingFacade.
* Deprecated in UML2: Use TemplateBinding parameters instead of dependencies.
* @see ModelElementFacade#isBindingDependenciesPresent()
*/
public boolean isBindingDependenciesPresent()
{
return this.getSuperFrontEndActionState().isBindingDependenciesPresent();
}
/**
* Indicates if any constraints are present on this model element.
* @see ModelElementFacade#isConstraintsPresent()
*/
public boolean isConstraintsPresent()
{
return this.getSuperFrontEndActionState().isConstraintsPresent();
}
/**
* Indicates if any documentation is present on this model element.
* @see ModelElementFacade#isDocumentationPresent()
*/
public boolean isDocumentationPresent()
{
return this.getSuperFrontEndActionState().isDocumentationPresent();
}
/**
* True if this element name is a reserved word in Java, C#, ANSI or ISO C, C++, JavaScript.
* @see ModelElementFacade#isReservedWord()
*/
public boolean isReservedWord()
{
return this.getSuperFrontEndActionState().isReservedWord();
}
/**
* True is there are template parameters on this model element. For UML2, applies to Class,
* Operation, Property, and Parameter.
* @see ModelElementFacade#isTemplateParametersPresent()
*/
public boolean isTemplateParametersPresent()
{
return this.getSuperFrontEndActionState().isTemplateParametersPresent();
}
/**
* 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.
* @see ModelElementFacade#isValidIdentifierName()
*/
public boolean isValidIdentifierName()
{
return this.getSuperFrontEndActionState().isValidIdentifierName();
}
/**
* 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.
* @see ModelElementFacade#translateConstraint(String name, String translation)
*/
public String translateConstraint(String name, String translation)
{
return this.getSuperFrontEndActionState().translateConstraint(name, translation);
}
/**
* Translates all constraints belonging to this model element with the given 'translation'.
* @see ModelElementFacade#translateConstraints(String translation)
*/
public String[] translateConstraints(String translation)
{
return this.getSuperFrontEndActionState().translateConstraints(translation);
}
/**
* Translates the constraints of the specified 'kind' belonging to this model element.
* @see ModelElementFacade#translateConstraints(String kind, String translation)
*/
public String[] translateConstraints(String kind, String translation)
{
return this.getSuperFrontEndActionState().translateConstraints(kind, translation);
}
/**
* Events to which is being deferred in this action state.
* @see StateFacade#getDeferrableEvents()
*/
public Collection<EventFacade> getDeferrableEvents()
{
return this.getSuperFrontEndActionState().getDeferrableEvents();
}
/**
* Models a situation during which some (usually implicit) invariant condition holds. The states
* of
* protocol state machines are exposed to the users of their context classifiers. A protocol
* state
* represents an exposed stable situation of its context classifier: when an instance of the
* classifier
* is not processing any operation, users of this instance can always know its state
* configuration.
* @see org.andromda.metafacades.uml.StateVertexFacade#getContainer()
*/
public StateFacade getContainer()
{
return this.getSuperFrontEndActionState().getContainer();
}
/**
* A directed relationship between a source vertex and a target vertex. It may be part of a
* compound
* transition, which takes the state machine from one state configuration to another,
* representing the
* complete response of the state machine to an occurrence of an event of a particular type.
* @see org.andromda.metafacades.uml.StateVertexFacade#getIncomings()
*/
public Collection<TransitionFacade> getIncomings()
{
return this.getSuperFrontEndActionState().getIncomings();
}
/**
* A directed relationship between a source vertex and a target vertex. It may be part of a
* compound
* transition, which takes the state machine from one state configuration to another,
* representing the
* complete response of the state machine to an occurrence of an event of a particular type.
* @see org.andromda.metafacades.uml.StateVertexFacade#getOutgoings()
*/
public Collection<TransitionFacade> getOutgoings()
{
return this.getSuperFrontEndActionState().getOutgoings();
}
/**
* The partition (if any) to which this vertex belongs.
* @see org.andromda.metafacades.uml.StateVertexFacade#getPartition()
*/
public PartitionFacade getPartition()
{
return this.getSuperFrontEndActionState().getPartition();
}
/**
* State machines can be used to express the behavior of part of a system. Behavior is modeled
* as a
* traversal of a graph of state nodes interconnected by one or more joined transition arcs that
* are
* triggered by the dispatching of series of (event) occurrences. During this traversal, the
* state
* machine executes a series of activities associated with various elements of the state
* machine.
* @see org.andromda.metafacades.uml.StateVertexFacade#getStateMachine()
*/
public StateMachineFacade getStateMachine()
{
return this.getSuperFrontEndActionState().getStateMachine();
}
/**
* @see org.andromda.core.metafacade.MetafacadeBase#initialize()
*/
@Override
public void initialize()
{
this.getSuperFrontEndActionState().initialize();
}
/**
* @return Object getSuperFrontEndActionState().getValidationOwner()
* @see org.andromda.core.metafacade.MetafacadeBase#getValidationOwner()
*/
@Override
public Object getValidationOwner()
{
Object owner = this.getSuperFrontEndActionState().getValidationOwner();
return owner;
}
/**
* @return String getSuperFrontEndActionState().getValidationName()
* @see org.andromda.core.metafacade.MetafacadeBase#getValidationName()
*/
@Override
public String getValidationName()
{
String name = this.getSuperFrontEndActionState().getValidationName();
return name;
}
/**
* @param validationMessages Collection<ModelValidationMessage>
* @see org.andromda.core.metafacade.MetafacadeBase#validateInvariants(Collection validationMessages)
*/
@Override
public void validateInvariants(Collection<ModelValidationMessage> validationMessages)
{
this.getSuperFrontEndActionState().validateInvariants(validationMessages);
}
/**
* The property that stores the name of the metafacade.
*/
private static final String NAME_PROPERTY = "name";
private static final String FQNAME_PROPERTY = "fullyQualifiedName";
/**
* @see Object#toString()
*/
@Override
public String toString()
{
final StringBuilder toString = new StringBuilder(this.getClass().getName());
toString.append("[");
try
{
toString.append(Introspector.instance().getProperty(this, FQNAME_PROPERTY));
}
catch (final Throwable tryAgain)
{
try
{
toString.append(Introspector.instance().getProperty(this, NAME_PROPERTY));
}
catch (final Throwable ignore)
{
// - just ignore when the metafacade doesn't have a name or fullyQualifiedName property
}
}
toString.append("]");
return toString.toString();
}
}