org.andromda.cartridges.webservice.metafacades

Class WebServiceParameterLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.cartridges.webservice.metafacades.WebServiceParameterLogic

All Implemented Interfaces:

Serializable, Comparable, WebServiceParameter, ModelElementFacade, ParameterFacade

Direct Known Subclasses:

WebServiceParameterLogicImpl

public abstract class WebServiceParameterLogic
extends MetafacadeBase
implements WebServiceParameter

Represents a parameter modeled on a webservice. MetafacadeLogic for WebServiceParameter

See Also:

WebServiceParameter, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	metaObject The underlying UML object

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

contextRoot

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebServiceParameterLogic(Object metaObjectIn, String context) Create Metafacade implementation instance using the MetafacadeFactory from the context

Method Summary

Methods

Modifier and Type	Method and Description
void	copyTaggedValues(ModelElementFacade element) Copies all tagged values from the given ModelElementFacade to this model element facade.
Object	findTaggedValue(String tagName) Finds the tagged value with the specified 'tagName'.
Collection<Object>	findTaggedValues(String tagName) Returns all the values for the tagged value with the specified name.
String	getBindedFullyQualifiedName(ModelElementFacade bindedElement) Returns the fully qualified name of the model element.
Collection<ConstraintFacade>	getConstraints() Gets all constraints belonging to the model element.
Collection<ConstraintFacade>	getConstraints(String kind) Returns the constraints of the argument kind that have been placed onto this model.
String	getDefaultValue() TODO: Model Documentation for ParameterFacade.defaultValue
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	getEffect() UML2: A representation of the literals of the enumeration 'Parameter Effect Kind': CREATE, READ, UPDATE, DELETE.
EventFacade	getEvent() If this parameter is located on an event, this will represent that event.
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	getGetterName() The name to use for accessors getting this parameter from a bean.
String	getGetterSetterTypeName() Fully Qualified TypeName, determined in part by multiplicity (for UML2).
String	getGetterSetterTypeNameImpl() Fully Qualified implementation class of TypeName, determined in part by multiplicity (for UML2).
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
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	getOperation() If this parameter is located on an operation, this will represent that 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 '/'.
String	getQualifiedName() UML2: Returns the value of the 'Qualified Name' attribute.
String	getRestParamType() TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restParamType
String	getRestPathParam() Customize the REST parameter path in the URL, by default it is /paramname/{paramvalue}/, appended to the /class/method/ URL.
String	getRestPathSegment() TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restPathSegment
PackageFacade	getRootPackage() Gets the root package for the model element.
String	getSetterName() The name to use for accessors getting this parameter in a bean.
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	getTestTypeName() The type name used when calling web service tests.
ClassifierFacade	getType() A Classifier is a classification of instances - it describes a set of instances that have features in common.
int	getUpper() the upper value of the multiplicity (will be -1 for *) -only applicable for UML2
String	getValidationName()
Object	getValidationOwner()
String	getVisibility() The visibility (i.e.
protected abstract String	handleGetRestParamType()
protected abstract String	handleGetRestPathParam()
protected abstract String	handleGetRestPathSegment()
protected abstract String	handleGetTestTypeName()
protected abstract boolean	handleIsAttribute()
protected abstract boolean	handleIsElement()
protected abstract boolean	handleIsNillable()
protected abstract boolean	handleIsRestEncoded()
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	isAttribute() Is the parameter an XML attribute?
boolean	isBindingDependenciesPresent() True if there are target dependencies from this element that are instances of BindingFacade.
boolean	isConstraintsPresent() Indicates if any constraints are present on this model element.
boolean	isDefaultValuePresent() Indicates if the default value is present.
boolean	isDocumentationPresent() Indicates if any documentation is present on this model element.
boolean	isElement() Is the attribute an XML element?
boolean	isException() UML2: Returns the value of the 'Is Exception' attribute.
boolean	isInoutParameter() True if this parameter is an inout parameter.
boolean	isInParameter() True if this parameter is an 'in' parameter.
boolean	isMany() If upper>1 or upper==unlimited.
boolean	isModelElementFacadeMetaType()
boolean	isNillable() Whether or not this webservice parameter is nillable.
boolean	isOrdered() UML2 Only: Is parameter ordered within the Collection type.
boolean	isOutParameter() True if this parameter is an 'out' parameter.
boolean	isParameterFacadeMetaType()
boolean	isReadable() True if this parameter is readable, aka an in-parameter, or this feature is unspecified.
boolean	isRequired() Whether or not this parameter is considered required (i.e must a non-empty value).
boolean	isReservedWord() True if this element name is a reserved word in Java, C#, ANSI or ISO C, C++, JavaScript.
boolean	isRestEncoded() TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restEncoded
boolean	isReturn() Whether or not this parameter represents a return parameter.
boolean	isTemplateParametersPresent() True is there are template parameters on this model element.
boolean	isUnique() If Parameter type isMany (UML2), is the parameter 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.
boolean	isWebServiceParameterMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isWritable() True if this parameter is writable, aka an out-parameter, or this feature is unspecified.
void	resetMetafacadeContext(String context) Reset context only for non-root metafacades
String	toString()
String	translateConstraint(String name, String translation) Searches for the constraint with the specified 'name' on this model element, and if found translates it using the specified 'translation' from a translation library discovered by the framework.
String[]	translateConstraints(String translation) Translates all constraints belonging to this model element with the given 'translation'.
String[]	translateConstraints(String kind, String translation) Translates the constraints of the specified 'kind' belonging to this model element.
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::cartridges::webservice::metafacades::WebServiceParameter::a web service parameter can not be of type collection

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

WebServiceParameterLogic

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

isWebServiceParameterMetaType

public boolean isWebServiceParameterMetaType()

Description copied from interface: WebServiceParameter

Indicates the metafacade type (used for metafacade mappings).

Specified by:

isWebServiceParameterMetaType in interface WebServiceParameter

Returns:

boolean true always

See Also:

WebServiceParameter

handleIsNillable

protected abstract boolean handleIsNillable()

Returns:

boolean

See Also:

WebServiceParameter.isNillable()

isNillable

public final boolean isNillable()

Whether or not this webservice parameter is nillable.

Specified by:

isNillable in interface WebServiceParameter

Returns:

(boolean)handleIsNillable()

handleGetTestTypeName

protected abstract String handleGetTestTypeName()

Returns:

String

See Also:

WebServiceParameter.getTestTypeName()

getTestTypeName

public final String getTestTypeName()

The type name used when calling web service tests.

Specified by:

getTestTypeName in interface WebServiceParameter

Returns:

(String)handleGetTestTypeName()

handleIsAttribute

protected abstract boolean handleIsAttribute()

Returns:

boolean

See Also:

WebServiceParameter.isAttribute()

isAttribute

public final boolean isAttribute()

Is the parameter an XML attribute?

Specified by:

isAttribute in interface WebServiceParameter

Returns:

(boolean)handleIsAttribute()

handleIsElement

protected abstract boolean handleIsElement()

Returns:

boolean

See Also:

WebServiceParameter.isElement()

isElement

public final boolean isElement()

Is the attribute an XML element?

Specified by:

isElement in interface WebServiceParameter

Returns:

(boolean)handleIsElement()

handleGetRestPathParam

protected abstract String handleGetRestPathParam()

Returns:

String

See Also:

WebServiceParameter.getRestPathParam()

getRestPathParam

public final String getRestPathParam()

Customize the REST parameter path in the URL, by default it is /paramname/{paramvalue}/, appended to the /class/method/ URL.

Specified by:

getRestPathParam in interface WebServiceParameter

Returns:

(String)handleGetRestPathParam()

handleGetRestParamType

protected abstract String handleGetRestParamType()

Returns:

String

See Also:

WebServiceParameter.getRestParamType()

getRestParamType

public final String getRestParamType()

TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restParamType

Specified by:

getRestParamType in interface WebServiceParameter

Returns:

(String)handleGetRestParamType()

handleIsRestEncoded

protected abstract boolean handleIsRestEncoded()

Returns:

boolean

See Also:

WebServiceParameter.isRestEncoded()

isRestEncoded

public final boolean isRestEncoded()

TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restEncoded

Specified by:

isRestEncoded in interface WebServiceParameter

Returns:

(boolean)handleIsRestEncoded()

handleGetRestPathSegment

protected abstract String handleGetRestPathSegment()

Returns:

String

See Also:

WebServiceParameter.getRestPathSegment()

getRestPathSegment

public final String getRestPathSegment()

TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restPathSegment

Specified by:

getRestPathSegment in interface WebServiceParameter

Returns:

(String)handleGetRestPathSegment()

isParameterFacadeMetaType

public boolean isParameterFacadeMetaType()

Specified by:

isParameterFacadeMetaType in interface ParameterFacade

Returns:

true

See Also:

ParameterFacade

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)

getDefaultValue

public String getDefaultValue()

TODO: Model Documentation for ParameterFacade.defaultValue

Specified by:

getDefaultValue in interface ParameterFacade

See Also:

ParameterFacade.getDefaultValue()

getEffect

public String getEffect()

UML2: A representation of the literals of the enumeration 'Parameter Effect Kind': CREATE, READ, UPDATE, DELETE. The datatype ParameterEffectKind is an enumeration that indicates the effect of a behavior on values passed in or out of its parameters.

Specified by:

getEffect in interface ParameterFacade

See Also:

ParameterFacade.getEffect()

getEvent

public EventFacade getEvent()

If this parameter is located on an event, this will represent that event.

Specified by:

getEvent in interface ParameterFacade

See Also:

ParameterFacade.getEvent()

getGetterName

public String getGetterName()

The name to use for accessors getting this parameter from a bean.

Specified by:

getGetterName in interface ParameterFacade

See Also:

ParameterFacade.getGetterName()

getGetterSetterTypeName

public String getGetterSetterTypeName()

Fully Qualified TypeName, determined in part by multiplicity (for UML2). For UML14, same as getterName.

Specified by:

getGetterSetterTypeName in interface ParameterFacade

See Also:

ParameterFacade.getGetterSetterTypeName()

getGetterSetterTypeNameImpl

public String getGetterSetterTypeNameImpl()

Fully Qualified implementation class of TypeName, determined in part by multiplicity (for UML2). If upper multiplicity =1, same as getterSetterTypeName.

Specified by:

getGetterSetterTypeNameImpl in interface ParameterFacade

See Also:

ParameterFacade.getGetterSetterTypeNameImpl()

getLower

public int getLower()

the lower value for the multiplicity -only applicable for UML2

Specified by:

getLower in interface ParameterFacade

See Also:

ParameterFacade.getLower()

getOperation

public OperationFacade getOperation()

If this parameter is located on an operation, this will represent that operation.

Specified by:

getOperation in interface ParameterFacade

See Also:

ParameterFacade.getOperation()

getSetterName

public String getSetterName()

The name to use for accessors getting this parameter in a bean.

Specified by:

getSetterName in interface ParameterFacade

See Also:

ParameterFacade.getSetterName()

getType

public ClassifierFacade getType()

A Classifier is a classification of instances - it describes a set of instances that have features in common. Can specify a generalization hierarchy by referencing its general classifiers. It may be a Class, DataType, PrimitiveType, Association, Collaboration, UseCase, etc. Can specify a generalization hierarchy by referencing its general classifiers. Has the capability to own collaboration uses. These collaboration uses link a collaboration with the classifier to give a description of the workings of the classifier. Classifier is defined to be a kind of templateable element so that a classifier can be parameterized. It is also defined to be a kind of parameterable element so that a classifier can be a formal template parameter.

Specified by:

getType in interface ParameterFacade

See Also:

ParameterFacade.getType()

getUpper

public int getUpper()

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

Specified by:

getUpper in interface ParameterFacade

See Also:

ParameterFacade.getUpper()

isDefaultValuePresent

public boolean isDefaultValuePresent()

Indicates if the default value is present.

Specified by:

isDefaultValuePresent in interface ParameterFacade

See Also:

ParameterFacade.isDefaultValuePresent()

isException

public boolean isException()

UML2: Returns the value of the 'Is Exception' attribute. The default value is "false". Tells whether an output parameter may emit a value to the exclusion of the other outputs.

Specified by:

isException in interface ParameterFacade

See Also:

ParameterFacade.isException()

isInParameter

public boolean isInParameter()

True if this parameter is an 'in' parameter.

Specified by:

isInParameter in interface ParameterFacade

See Also:

ParameterFacade.isInParameter()

isInoutParameter

public boolean isInoutParameter()

True if this parameter is an inout parameter.

Specified by:

isInoutParameter in interface ParameterFacade

See Also:

ParameterFacade.isInoutParameter()

isMany

public boolean isMany()

If upper>1 or upper==unlimited. Only applies to UML2. For UML14, always false.

Specified by:

isMany in interface ParameterFacade

See Also:

ParameterFacade.isMany()

isOrdered

public boolean isOrdered()

UML2 Only: Is parameter ordered within the Collection type. Ordered+Unique determines the implementation Collection Type. For UML14, always false.

Specified by:

isOrdered in interface ParameterFacade

See Also:

ParameterFacade.isOrdered()

isOutParameter

public boolean isOutParameter()

True if this parameter is an 'out' parameter.

Specified by:

isOutParameter in interface ParameterFacade

See Also:

ParameterFacade.isOutParameter()

isReadable

public boolean isReadable()

True if this parameter is readable, aka an in-parameter, or this feature is unspecified.

Specified by:

isReadable in interface ParameterFacade

See Also:

ParameterFacade.isReadable()

isRequired

public boolean isRequired()

Whether or not this parameter is considered required (i.e must a non-empty value).

Specified by:

isRequired in interface ParameterFacade

See Also:

ParameterFacade.isRequired()

isReturn

public boolean isReturn()

Whether or not this parameter represents a return parameter.

Specified by:

isReturn in interface ParameterFacade

See Also:

ParameterFacade.isReturn()

isUnique

public boolean isUnique()

If Parameter type isMany (UML2), is the parameter unique within the Collection. Unique+Sorted determines pareter implementation type. For UML14, always false.

Specified by:

isUnique in interface ParameterFacade

See Also:

ParameterFacade.isUnique()

isWritable

public boolean isWritable()

True if this parameter is writable, aka an out-parameter, or this feature is unspecified.

Specified by:

isWritable in interface ParameterFacade

See Also:

ParameterFacade.isWritable()

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

See Also:

MetafacadeBase.getValidationOwner()

getValidationName

public String getValidationName()

Specified by:

getValidationName in interface ModelElementFacade

Overrides:

getValidationName in class MetafacadeBase

Returns:

String getSuperParameterFacade().getValidationName()

See Also:

MetafacadeBase.getValidationName()

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::cartridges::webservice::metafacades::WebServiceParameter::a web service parameter can not be of type collection

Error: A web service parameter can NOT be a collection type You'll need to model an array instead.

OCL: context WebServiceParameter inv : return = false implies type.collectionType = false

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