org.andromda.cartridges.ejb.metafacades

Class EJBOperationFacadeLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.cartridges.ejb.metafacades.EJBOperationFacadeLogic

All Implemented Interfaces:

Serializable, Comparable, EJBOperationFacade, ModelElementFacade, OperationFacade

Direct Known Subclasses:

EJBOperationFacadeLogicImpl

public abstract class EJBOperationFacadeLogic
extends MetafacadeBase
implements EJBOperationFacade

Represents an operation on an EJB. MetafacadeLogic for EJBOperationFacade

See Also:

EJBOperationFacade, 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, logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EJBOperationFacadeLogic(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.
ParameterFacade	findParameter(String name) Finds the parameter on this operation having the given name, if no parameter is found, null is returned instead.
Object	findTaggedValue(String tagName) Finds the tagged value with the specified 'tagName'.
Object	findTaggedValue(String name, boolean follow) Searches the given feature for the specified tag.
Collection<Object>	findTaggedValues(String tagName) Returns all the values for the tagged value with the specified name.
String	getArgumentNames() A comma separated list of all argument names.
Collection<ParameterFacade>	getArguments() Specification of an argument used to pass information into or out of an invocation of a behavioral feature.
String	getArgumentTypeNames() A comma separated list of all types of each argument, in order.
String	getBindedFullyQualifiedName(ModelElementFacade bindedElement) Returns the fully qualified name of the model element.
String	getCall() Constructs the operation call with the operation name
String	getConcurrency() Returns the concurrency modifier for this operation (i.e.
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.
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.
String	getExceptionList() A comma separated list containing all exceptions that this operation throws.
String	getExceptionList(String initialExceptions) Returns a comma separated list of exceptions appended to the comma separated list of fully qualified 'initialException' classes passed in to this method.
Collection<ModelElementFacade>	getExceptions() A collection of all exceptions thrown by this operation.
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 '/'.
String	getGetterSetterReturnTypeName() Return Type with multiplicity taken into account.
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.
int	getLower() the lower value for the multiplicity -only applicable for UML2
String	getMethodBody() Returns the operation method body determined from UML sequence diagrams or other UML sources.
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.
OperationFacade	getOverriddenOperation() The operation this operation overrides, null if this operation is not overriding.
ClassifierFacade	getOwner() Gets the owner of this operation
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 '/'.
Collection<ParameterFacade>	getParameters() Return all parameters for the operation, including the return parameter.
String	getPostconditionName() The name of the operation that handles postcondition constraints.
Collection<ConstraintFacade>	getPostconditions() The postcondition constraints belonging to this operation.
String	getPreconditionCall() The call to the precondition operation.
String	getPreconditionName() The name of the operation that handles precondition constraints.
Collection<ConstraintFacade>	getPreconditions() The precondition constraints belonging to this operation.
String	getPreconditionSignature() The signature of the precondition operation.
String	getQualifiedName() UML2: Returns the value of the 'Qualified Name' attribute.
ParameterFacade	getReturnParameter() (UML2 Only).
ClassifierFacade	getReturnType() The operation return type parameter.
PackageFacade	getRootPackage() Gets the root package for the model element.
String	getSignature() Return the operation signature, including public/protested abstract returnType name plus argument type and name
String	getSignature(boolean withArgumentNames) Returns the signature of the operation and optionally appends the argument names (if withArgumentNames is true), otherwise returns the signature with just the types alone in the signature.
String	getSignature(String argumentModifier) Returns the signature of the operation and optionally appends the given 'argumentModifier' to each argument.
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.
Collection<TaggedValueFacade>	getTaggedValues() Return the TaggedValues associated with this model element, under all stereotypes.
Collection<DependencyFacade>	getTargetDependencies() Gets the dependencies for which this model element is the target.
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
String	getTransactionType() Gets the transaction type for this attribute (i.e.
String	getTypedArgumentList() A comma-separated parameter list (type and name of each parameter) of an operation.
String	getTypedArgumentList(String modifier) A comma-separated parameter list (type and name of each parameter) of an operation with an optional modifier (i.e final) before each parameter.
int	getUpper() the upper value for the multiplicity (will be -1 for *) - only applicable for UML2
String	getValidationName()
Object	getValidationOwner()
String	getVisibility() The visibility (i.e.
protected abstract String	handleGetTransactionType()
protected abstract boolean	handleIsBusinessOperation()
protected abstract boolean	handleIsSelectMethod()
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	isAbstract() True is the operation is abstract.
boolean	isBindingDependenciesPresent() True if there are target dependencies from this element that are instances of BindingFacade.
boolean	isBusinessOperation() True/false on whether or not this operation is an EJB business operation.
boolean	isConstraintsPresent() Indicates if any constraints are present on this model element.
boolean	isDocumentationPresent() Indicates if any documentation is present on this model element.
boolean	isEJBOperationFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isExceptionsPresent() True if the operation has (i.e.
boolean	isLeaf() IsLeaf property in the operation.
boolean	isMany() UML2 only.
boolean	isModelElementFacadeMetaType()
boolean	isOperationFacadeMetaType()
boolean	isOrdered() UML2 only: If isMany (Collection type returned), is the type unique within the collection.
boolean	isOverriding() True if this operation overrides an operation defined in an ancestor class.
boolean	isPostconditionsPresent() Whether any postcondition constraints are present on this operation.
boolean	isPreconditionsPresent() Whether any precondition constraints are present on this operation.
boolean	isQuery() Indicates whether or not this operation is a query operation.
boolean	isReservedWord() True if this element name is a reserved word in Java, C#, ANSI or ISO C, C++, JavaScript.
boolean	isReturnTypePresent() True/false depending on whether or not the operation has a return type or not (i.e.
boolean	isSelectMethod() True/false on whether or not this operation represents a select method.
boolean	isStatic() True is the operation is static (only a single instance can be instantiated).
boolean	isTemplateParametersPresent() True is there are template parameters on this model element.
boolean	isUnique() UML2 only: for Collection return type, is the type unique within the collection.
boolean	isValidIdentifierName() True if this element name is a valid identifier name in Java, C#, ANSI or ISO C, C++, JavaScript.
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)

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

EJBOperationFacadeLogic

protected EJBOperationFacadeLogic(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)

isEJBOperationFacadeMetaType

public boolean isEJBOperationFacadeMetaType()

Description copied from interface: EJBOperationFacade

Indicates the metafacade type (used for metafacade mappings).

Specified by:

isEJBOperationFacadeMetaType in interface EJBOperationFacade

Returns:

boolean true always

See Also:

EJBOperationFacade

handleGetTransactionType

protected abstract String handleGetTransactionType()

Returns:

String

See Also:

EJBOperationFacade.getTransactionType()

getTransactionType

public final String getTransactionType()

Gets the transaction type for this attribute (i.e. REQUIRED, etc)

Specified by:

getTransactionType in interface EJBOperationFacade

Returns:

(String)handleGetTransactionType()

handleIsBusinessOperation

protected abstract boolean handleIsBusinessOperation()

Returns:

boolean

See Also:

EJBOperationFacade.isBusinessOperation()

isBusinessOperation

public final boolean isBusinessOperation()

True/false on whether or not this operation is an EJB business operation.

Specified by:

isBusinessOperation in interface EJBOperationFacade

Returns:

(boolean)handleIsBusinessOperation()

handleIsSelectMethod

protected abstract boolean handleIsSelectMethod()

Returns:

boolean

See Also:

EJBOperationFacade.isSelectMethod()

isSelectMethod

public final boolean isSelectMethod()

True/false on whether or not this operation represents a select method.

Specified by:

isSelectMethod in interface EJBOperationFacade

Returns:

(boolean)handleIsSelectMethod()

isOperationFacadeMetaType

public boolean isOperationFacadeMetaType()

Specified by:

isOperationFacadeMetaType in interface OperationFacade

Returns:

true

See Also:

OperationFacade

isModelElementFacadeMetaType

public boolean isModelElementFacadeMetaType()

Specified by:

isModelElementFacadeMetaType in interface ModelElementFacade

Returns:

true

See Also:

ModelElementFacade

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)

findParameter

public ParameterFacade findParameter(String name)

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

Specified by:

findParameter in interface OperationFacade

See Also:

OperationFacade.findParameter(String name)

findTaggedValue

public Object findTaggedValue(String name,
                     boolean follow)

Searches the given feature for the specified tag. If the follow boolean is set to true then the search will continue from the class operation to the class itself and then up the class hierarchy.

Specified by:

findTaggedValue in interface OperationFacade

See Also:

OperationFacade.findTaggedValue(String name, boolean follow)

getArgumentNames

public String getArgumentNames()

A comma separated list of all argument names.

Specified by:

getArgumentNames in interface OperationFacade

See Also:

OperationFacade.getArgumentNames()

getArgumentTypeNames

public String getArgumentTypeNames()

A comma separated list of all types of each argument, in order.

Specified by:

getArgumentTypeNames in interface OperationFacade

See Also:

OperationFacade.getArgumentTypeNames()

getArguments

public Collection<ParameterFacade> getArguments()

Specification of an argument used to pass information into or out of an invocation of a behavioral feature. Parameters are allowed to be treated as connectable elements. Parameters have support for streaming, exceptions, and parameter sets.

Specified by:

getArguments in interface OperationFacade

See Also:

OperationFacade.getArguments()

getCall

public String getCall()

Constructs the operation call with the operation name

Specified by:

getCall in interface OperationFacade

See Also:

OperationFacade.getCall()

getConcurrency

public String getConcurrency()

Returns the concurrency modifier for this operation (i.e. concurrent, guarded or sequential) of the model element, will attempt a lookup for these values in the language mappings (if any).

Specified by:

getConcurrency in interface OperationFacade

See Also:

OperationFacade.getConcurrency()

getExceptionList

public String getExceptionList()

A comma separated list containing all exceptions that this operation throws. Exceptions are determined through dependencies that have the target element stereotyped as <>.

Specified by:

getExceptionList in interface OperationFacade

See Also:

OperationFacade.getExceptionList()

getExceptionList

public String getExceptionList(String initialExceptions)

Returns a comma separated list of exceptions appended to the comma separated list of fully qualified 'initialException' classes passed in to this method.

Specified by:

getExceptionList in interface OperationFacade

See Also:

OperationFacade.getExceptionList(String initialExceptions)

getExceptions

public Collection<ModelElementFacade> getExceptions()

A collection of all exceptions thrown by this operation.

Specified by:

getExceptions in interface OperationFacade

See Also:

OperationFacade.getExceptions()

getGetterSetterReturnTypeName

public String getGetterSetterReturnTypeName()

Return Type with multiplicity taken into account. UML14 does not allow multiplicity *.

Specified by:

getGetterSetterReturnTypeName in interface OperationFacade

See Also:

OperationFacade.getGetterSetterReturnTypeName()

getLower

public int getLower()

the lower value for the multiplicity -only applicable for UML2

Specified by:

getLower in interface OperationFacade

See Also:

OperationFacade.getLower()

getMethodBody

public String getMethodBody()

Returns the operation method body determined from UML sequence diagrams or other UML sources.

Specified by:

getMethodBody in interface OperationFacade

See Also:

OperationFacade.getMethodBody()

getOverriddenOperation

public OperationFacade getOverriddenOperation()

The operation this operation overrides, null if this operation is not overriding.

Specified by:

getOverriddenOperation in interface OperationFacade

See Also:

OperationFacade.getOverriddenOperation()

getOwner

public ClassifierFacade getOwner()

Gets the owner of this operation

Specified by:

getOwner in interface OperationFacade

See Also:

OperationFacade.getOwner()

getParameters

public Collection<ParameterFacade> getParameters()

Return all parameters for the operation, including the return parameter.

Specified by:

getParameters in interface OperationFacade

See Also:

OperationFacade.getParameters()

getPostconditionName

public String getPostconditionName()

The name of the operation that handles postcondition constraints.

Specified by:

getPostconditionName in interface OperationFacade

See Also:

OperationFacade.getPostconditionName()

getPostconditions

public Collection<ConstraintFacade> getPostconditions()

The postcondition constraints belonging to this operation.

Specified by:

getPostconditions in interface OperationFacade

See Also:

OperationFacade.getPostconditions()

getPreconditionCall

public String getPreconditionCall()

The call to the precondition operation.

Specified by:

getPreconditionCall in interface OperationFacade

See Also:

OperationFacade.getPreconditionCall()

getPreconditionName

public String getPreconditionName()

The name of the operation that handles precondition constraints.

Specified by:

getPreconditionName in interface OperationFacade

See Also:

OperationFacade.getPreconditionName()

getPreconditionSignature

public String getPreconditionSignature()

The signature of the precondition operation.

Specified by:

getPreconditionSignature in interface OperationFacade

See Also:

OperationFacade.getPreconditionSignature()

getPreconditions

public Collection<ConstraintFacade> getPreconditions()

The precondition constraints belonging to this operation.

Specified by:

getPreconditions in interface OperationFacade

See Also:

OperationFacade.getPreconditions()

getReturnParameter

public ParameterFacade getReturnParameter()

(UML2 Only). Get the actual return parameter (which may have stereotypes etc).

Specified by:

getReturnParameter in interface OperationFacade

See Also:

OperationFacade.getReturnParameter()

getReturnType

public ClassifierFacade getReturnType()

The operation return type parameter.

Specified by:

getReturnType in interface OperationFacade

See Also:

OperationFacade.getReturnType()

getSignature

public String getSignature()

Return the operation signature, including public/protested abstract returnType name plus argument type and name

Specified by:

getSignature in interface OperationFacade

See Also:

OperationFacade.getSignature()

getSignature

public String getSignature(boolean withArgumentNames)

Returns the signature of the operation and optionally appends the argument names (if withArgumentNames is true), otherwise returns the signature with just the types alone in the signature.

Specified by:

getSignature in interface OperationFacade

See Also:

OperationFacade.getSignature(boolean withArgumentNames)

getSignature

public String getSignature(String argumentModifier)

Returns the signature of the operation and optionally appends the given 'argumentModifier' to each argument.

Specified by:

getSignature in interface OperationFacade

See Also:

OperationFacade.getSignature(String argumentModifier)

getTypedArgumentList

public String getTypedArgumentList()

A comma-separated parameter list (type and name of each parameter) of an operation.

Specified by:

getTypedArgumentList in interface OperationFacade

See Also:

OperationFacade.getTypedArgumentList()

getTypedArgumentList

public String getTypedArgumentList(String modifier)

A comma-separated parameter list (type and name of each parameter) of an operation with an optional modifier (i.e final) before each parameter.

Specified by:

getTypedArgumentList in interface OperationFacade

See Also:

OperationFacade.getTypedArgumentList(String modifier)

getUpper

public int getUpper()

the upper value for the multiplicity (will be -1 for *) - only applicable for UML2

Specified by:

getUpper in interface OperationFacade

See Also:

OperationFacade.getUpper()

isAbstract

public boolean isAbstract()

True is the operation is abstract.

Specified by:

isAbstract in interface OperationFacade

See Also:

OperationFacade.isAbstract()

isExceptionsPresent

public boolean isExceptionsPresent()

True if the operation has (i.e. throws any exceptions) false otherwise.

Specified by:

isExceptionsPresent in interface OperationFacade

See Also:

OperationFacade.isExceptionsPresent()

isLeaf

public boolean isLeaf()

IsLeaf property in the operation. If true, operation is final, cannot be extended or implemented by a descendant. Default=false.

Specified by:

isLeaf in interface OperationFacade

See Also:

OperationFacade.isLeaf()

isMany

public boolean isMany()

UML2 only. If the return type parameter multiplicity>1 OR the operation multiplicity>1. Default=false.

Specified by:

isMany in interface OperationFacade

See Also:

OperationFacade.isMany()

isOrdered

public boolean isOrdered()

UML2 only: If isMany (Collection type returned), is the type unique within the collection. Unique+Ordered determines CollectionType implementation of return result. Default=false.

Specified by:

isOrdered in interface OperationFacade

See Also:

OperationFacade.isOrdered()

isOverriding

public boolean isOverriding()

True if this operation overrides an operation defined in an ancestor class. An operation overrides when the names of the operations as well as the types of the arguments are equal. The return type may be different and is, as well as any exceptions, ignored.

Specified by:

isOverriding in interface OperationFacade

See Also:

OperationFacade.isOverriding()

isPostconditionsPresent

public boolean isPostconditionsPresent()

Whether any postcondition constraints are present on this operation.

Specified by:

isPostconditionsPresent in interface OperationFacade

See Also:

OperationFacade.isPostconditionsPresent()

isPreconditionsPresent

public boolean isPreconditionsPresent()

Whether any precondition constraints are present on this operation.

Specified by:

isPreconditionsPresent in interface OperationFacade

See Also:

OperationFacade.isPreconditionsPresent()

isQuery

public boolean isQuery()

Indicates whether or not this operation is a query operation.

Specified by:

isQuery in interface OperationFacade

See Also:

OperationFacade.isQuery()

isReturnTypePresent

public boolean isReturnTypePresent()

True/false depending on whether or not the operation has a return type or not (i.e. a return type of something other than void).

Specified by:

isReturnTypePresent in interface OperationFacade

See Also:

OperationFacade.isReturnTypePresent()

isStatic

public boolean isStatic()

True is the operation is static (only a single instance can be instantiated).

Specified by:

isStatic in interface OperationFacade

See Also:

OperationFacade.isStatic()

isUnique

public boolean isUnique()

UML2 only: for Collection return type, is the type unique within the collection. Unique+Ordered determines the returned CollectionType. Default=false.

Specified by:

isUnique in interface OperationFacade

See Also:

OperationFacade.isUnique()

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 getSuperOperationFacade().getValidationOwner()

See Also:

MetafacadeBase.getValidationOwner()

getValidationName

public String getValidationName()

Specified by:

getValidationName in interface ModelElementFacade

Overrides:

getValidationName in class MetafacadeBase

Returns:

String getSuperOperationFacade().getValidationName()

See Also:

MetafacadeBase.getValidationName()

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

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()