JSFEventLogic.java
// license-header java merge-point
//
// Attention: generated code (by MetafacadeLogic.vsl) - do not modify!
//
package org.andromda.cartridges.jsf.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.ConstraintFacade;
import org.andromda.metafacades.uml.DependencyFacade;
import org.andromda.metafacades.uml.FrontEndAction;
import org.andromda.metafacades.uml.FrontEndControllerOperation;
import org.andromda.metafacades.uml.FrontEndEvent;
import org.andromda.metafacades.uml.ModelElementFacade;
import org.andromda.metafacades.uml.ModelFacade;
import org.andromda.metafacades.uml.PackageFacade;
import org.andromda.metafacades.uml.ParameterFacade;
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 front-end JSF even (like the pressing of a button, etc).
* MetafacadeLogic for JSFEvent
*
* @see JSFEvent
*/
public abstract class JSFEventLogic
extends MetafacadeBase
implements JSFEvent
{
/**
* The underlying UML object
* @see Object
*/
protected Object metaObject;
/** Create Metafacade implementation instance using the MetafacadeFactory from the context
* @param metaObjectIn
* @param context
*/
protected JSFEventLogic(Object metaObjectIn, String context)
{
super(metaObjectIn, getContext(context));
this.superFrontEndEvent =
(FrontEndEvent)
MetafacadeFactory.getInstance().createFacadeImpl(
"org.andromda.metafacades.uml.FrontEndEvent",
metaObjectIn,
getContext(context));
this.metaObject = metaObjectIn;
}
/**
* Gets the context for this metafacade logic instance.
* @param context String. Set to JSFEvent if null
* @return context String
*/
private static String getContext(String context)
{
if (context == null)
{
context = "org.andromda.cartridges.jsf.metafacades.JSFEvent";
}
return context;
}
private FrontEndEvent superFrontEndEvent;
private boolean superFrontEndEventInitialized = false;
/**
* Gets the FrontEndEvent parent instance.
* @return this.superFrontEndEvent FrontEndEvent
*/
private FrontEndEvent getSuperFrontEndEvent()
{
if (!this.superFrontEndEventInitialized)
{
((MetafacadeBase)this.superFrontEndEvent).setMetafacadeContext(this.getMetafacadeContext());
this.superFrontEndEventInitialized = true;
}
return this.superFrontEndEvent;
}
/** 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.superFrontEndEventInitialized)
{
((MetafacadeBase)this.superFrontEndEvent).resetMetafacadeContext(context);
}
}
}
/**
* @return boolean true always
* @see JSFEvent
*/
public boolean isJSFEventMetaType()
{
return true;
}
// --------------- attributes ---------------------
/**
* @see org.andromda.cartridges.jsf.metafacades.JSFEvent#getMessageKey()
* @return String
*/
protected abstract String handleGetMessageKey();
private String __messageKey1a;
private boolean __messageKey1aSet = false;
/**
* The resource message key for this trigger.
* @return (String)handleGetMessageKey()
*/
public final String getMessageKey()
{
String messageKey1a = this.__messageKey1a;
if (!this.__messageKey1aSet)
{
// messageKey has no pre constraints
messageKey1a = handleGetMessageKey();
// messageKey has no post constraints
this.__messageKey1a = messageKey1a;
if (isMetafacadePropertyCachingEnabled())
{
this.__messageKey1aSet = true;
}
}
return messageKey1a;
}
/**
* @see org.andromda.cartridges.jsf.metafacades.JSFEvent#getMessageValue()
* @return String
*/
protected abstract String handleGetMessageValue();
private String __messageValue2a;
private boolean __messageValue2aSet = false;
/**
* The resource message value for this trigger, this would be the button label or hyperlink
* name.
* @return (String)handleGetMessageValue()
*/
public final String getMessageValue()
{
String messageValue2a = this.__messageValue2a;
if (!this.__messageValue2aSet)
{
// messageValue has no pre constraints
messageValue2a = handleGetMessageValue();
// messageValue has no post constraints
this.__messageValue2a = messageValue2a;
if (isMetafacadePropertyCachingEnabled())
{
this.__messageValue2aSet = true;
}
}
return messageValue2a;
}
/**
* @see org.andromda.cartridges.jsf.metafacades.JSFEvent#getResetMessageKey()
* @return String
*/
protected abstract String handleGetResetMessageKey();
private String __resetMessageKey3a;
private boolean __resetMessageKey3aSet = false;
/**
* The resource message key for the reset button.
* @return (String)handleGetResetMessageKey()
*/
public final String getResetMessageKey()
{
String resetMessageKey3a = this.__resetMessageKey3a;
if (!this.__resetMessageKey3aSet)
{
// resetMessageKey has no pre constraints
resetMessageKey3a = handleGetResetMessageKey();
// resetMessageKey has no post constraints
this.__resetMessageKey3a = resetMessageKey3a;
if (isMetafacadePropertyCachingEnabled())
{
this.__resetMessageKey3aSet = true;
}
}
return resetMessageKey3a;
}
/**
* @see org.andromda.cartridges.jsf.metafacades.JSFEvent#getResetMessageValue()
* @return String
*/
protected abstract String handleGetResetMessageValue();
private String __resetMessageValue4a;
private boolean __resetMessageValue4aSet = false;
/**
* The default value for the reset button's message.
* @return (String)handleGetResetMessageValue()
*/
public final String getResetMessageValue()
{
String resetMessageValue4a = this.__resetMessageValue4a;
if (!this.__resetMessageValue4aSet)
{
// resetMessageValue has no pre constraints
resetMessageValue4a = handleGetResetMessageValue();
// resetMessageValue has no post constraints
this.__resetMessageValue4a = resetMessageValue4a;
if (isMetafacadePropertyCachingEnabled())
{
this.__resetMessageValue4aSet = true;
}
}
return resetMessageValue4a;
}
/**
* @return true
* @see FrontEndEvent
*/
public boolean isFrontEndEventMetaType()
{
return true;
}
/**
* @return true
* @see org.andromda.metafacades.uml.EventFacade
*/
public boolean isEventFacadeMetaType()
{
return true;
}
/**
* @return true
* @see ModelElementFacade
*/
public boolean isModelElementFacadeMetaType()
{
return true;
}
// ----------- delegates to FrontEndEvent ------------
/**
* The parameters to this event.
* @see org.andromda.metafacades.uml.EventFacade#getParameters()
*/
public Collection<ParameterFacade> getParameters()
{
return this.getSuperFrontEndEvent().getParameters();
}
/**
* If this event is located on an action state, this will represent that state.
* @see org.andromda.metafacades.uml.EventFacade#getState()
*/
public StateFacade getState()
{
return this.getSuperFrontEndEvent().getState();
}
/**
* If this event is located on a transition, this represents that transition.
* @see org.andromda.metafacades.uml.EventFacade#getTransition()
*/
public TransitionFacade getTransition()
{
return this.getSuperFrontEndEvent().getTransition();
}
/**
* The action which triggers the "front-end" event.
* @see FrontEndEvent#getAction()
*/
public FrontEndAction getAction()
{
return this.getSuperFrontEndEvent().getAction();
}
/**
* The call to the controller for this front-end event (if any).
* @see FrontEndEvent#getControllerCall()
*/
public FrontEndControllerOperation getControllerCall()
{
return this.getSuperFrontEndEvent().getControllerCall();
}
/**
* Gets all controller operation calls for the front-end event.
* @see FrontEndEvent#getControllerCalls()
*/
public List<FrontEndControllerOperation> getControllerCalls()
{
return this.getSuperFrontEndEvent().getControllerCalls();
}
/**
* Indicates whether or not this front end event is contained within a FrontEndUseCase.
* @see FrontEndEvent#isContainedInFrontEndUseCase()
*/
public boolean isContainedInFrontEndUseCase()
{
return this.getSuperFrontEndEvent().isContainedInFrontEndUseCase();
}
/**
* Copies all tagged values from the given ModelElementFacade to this model element facade.
* @see ModelElementFacade#copyTaggedValues(ModelElementFacade element)
*/
public void copyTaggedValues(ModelElementFacade element)
{
this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().getBindedFullyQualifiedName(bindedElement);
}
/**
* Gets all constraints belonging to the model element.
* @see ModelElementFacade#getConstraints()
*/
public Collection<ConstraintFacade> getConstraints()
{
return this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().getDocumentation(indent, lineLength, htmlStyle);
}
/**
* The fully qualified name of this model element.
* @see ModelElementFacade#getFullyQualifiedName()
*/
public String getFullyQualifiedName()
{
return this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().getFullyQualifiedNamePath();
}
/**
* Gets the unique identifier of the underlying model element.
* @see ModelElementFacade#getId()
*/
public String getId()
{
return this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().getKeywords();
}
/**
* UML2: Retrieves a localized label for this named element.
* @see ModelElementFacade#getLabel()
*/
public String getLabel()
{
return this.getSuperFrontEndEvent().getLabel();
}
/**
* The language mappings that have been set for this model element.
* @see ModelElementFacade#getLanguageMappings()
*/
public TypeMappings getLanguageMappings()
{
return this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().getModel();
}
/**
* The name of the model element.
* @see ModelElementFacade#getName()
*/
public String getName()
{
return this.getSuperFrontEndEvent().getName();
}
/**
* Gets the package to which this model element belongs.
* @see ModelElementFacade#getPackage()
*/
public ModelElementFacade getPackage()
{
return this.getSuperFrontEndEvent().getPackage();
}
/**
* The name of this model element's package.
* @see ModelElementFacade#getPackageName()
*/
public String getPackageName()
{
return this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().getQualifiedName();
}
/**
* Gets the root package for the model element.
* @see ModelElementFacade#getRootPackage()
*/
public PackageFacade getRootPackage()
{
return this.getSuperFrontEndEvent().getRootPackage();
}
/**
* Gets the dependencies for which this model element is the source.
* @see ModelElementFacade#getSourceDependencies()
*/
public Collection<DependencyFacade> getSourceDependencies()
{
return this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().getStateMachineContext();
}
/**
* The collection of ALL stereotype names for this model element.
* @see ModelElementFacade#getStereotypeNames()
*/
public Collection<String> getStereotypeNames()
{
return this.getSuperFrontEndEvent().getStereotypeNames();
}
/**
* Gets all stereotypes for this model element.
* @see ModelElementFacade#getStereotypes()
*/
public Collection<StereotypeFacade> getStereotypes()
{
return this.getSuperFrontEndEvent().getStereotypes();
}
/**
* Return the TaggedValues associated with this model element, under all stereotypes.
* @see ModelElementFacade#getTaggedValues()
*/
public Collection<TaggedValueFacade> getTaggedValues()
{
return this.getSuperFrontEndEvent().getTaggedValues();
}
/**
* Gets the dependencies for which this model element is the target.
* @see ModelElementFacade#getTargetDependencies()
*/
public Collection<DependencyFacade> getTargetDependencies()
{
return this.getSuperFrontEndEvent().getTargetDependencies();
}
/**
* Get the template parameter for this model element having the parameterName
* @see ModelElementFacade#getTemplateParameter(String parameterName)
*/
public Object getTemplateParameter(String parameterName)
{
return this.getSuperFrontEndEvent().getTemplateParameter(parameterName);
}
/**
* Get the template parameters for this model element
* @see ModelElementFacade#getTemplateParameters()
*/
public Collection<TemplateParameterFacade> getTemplateParameters()
{
return this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().isBindingDependenciesPresent();
}
/**
* Indicates if any constraints are present on this model element.
* @see ModelElementFacade#isConstraintsPresent()
*/
public boolean isConstraintsPresent()
{
return this.getSuperFrontEndEvent().isConstraintsPresent();
}
/**
* Indicates if any documentation is present on this model element.
* @see ModelElementFacade#isDocumentationPresent()
*/
public boolean isDocumentationPresent()
{
return this.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().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.getSuperFrontEndEvent().translateConstraints(kind, translation);
}
/**
* @see org.andromda.core.metafacade.MetafacadeBase#initialize()
*/
@Override
public void initialize()
{
this.getSuperFrontEndEvent().initialize();
}
/**
* @return Object getSuperFrontEndEvent().getValidationOwner()
* @see org.andromda.core.metafacade.MetafacadeBase#getValidationOwner()
*/
@Override
public Object getValidationOwner()
{
Object owner = this.getSuperFrontEndEvent().getValidationOwner();
return owner;
}
/**
* @return String getSuperFrontEndEvent().getValidationName()
* @see org.andromda.core.metafacade.MetafacadeBase#getValidationName()
*/
@Override
public String getValidationName()
{
String name = this.getSuperFrontEndEvent().getValidationName();
return name;
}
/**
* @param validationMessages Collection<ModelValidationMessage>
* @see org.andromda.core.metafacade.MetafacadeBase#validateInvariants(Collection validationMessages)
*/
@Override
public void validateInvariants(Collection<ModelValidationMessage> validationMessages)
{
this.getSuperFrontEndEvent().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();
}
}