org.andromda.metafacades.uml14

Class ParameterFacadeLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.ModelElementFacadeLogic

org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

org.andromda.metafacades.uml14.ParameterFacadeLogic

All Implemented Interfaces:

Serializable, Comparable, ModelElementFacade, ParameterFacade

Direct Known Subclasses:

ParameterFacadeLogicImpl

public abstract class ParameterFacadeLogic
extends ModelElementFacadeLogicImpl
implements ParameterFacade

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. MetafacadeLogic for ParameterFacade

See Also:

ParameterFacade, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.omg.uml.foundation.core.Parameter	metaObject The underlying UML object

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

contextRoot

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParameterFacadeLogic(org.omg.uml.foundation.core.Parameter metaObjectIn, String context) Create Metafacade implementation instance using the MetafacadeFactory from the context

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValue() TODO: Model Documentation for ParameterFacade.defaultValue
String	getEffect() UML2: A representation of the literals of the enumeration 'Parameter Effect Kind': CREATE, READ, UPDATE, DELETE.
EventFacade	getEvent() The parameters to this event.
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).
int	getLower() the lower value for the multiplicity -only applicable for UML2
OperationFacade	getOperation() Return all parameters for the operation, including the return parameter.
String	getSetterName() The name to use for accessors getting this parameter in a bean.
ClassifierFacade	getType() Specification of an argument used to pass information into or out of an invocation of a behavioral feature.
int	getUpper() the upper value of the multiplicity (will be -1 for *) -only applicable for UML2
protected abstract String	handleGetDefaultValue()
protected abstract String	handleGetEffect()
protected abstract Object	handleGetEvent() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetGetterName()
protected abstract String	handleGetGetterSetterTypeName()
protected abstract String	handleGetGetterSetterTypeNameImpl()
protected abstract int	handleGetLower()
protected abstract Object	handleGetOperation() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetSetterName()
protected abstract Object	handleGetType() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract int	handleGetUpper()
protected abstract boolean	handleIsDefaultValuePresent()
protected abstract boolean	handleIsException()
protected abstract boolean	handleIsInoutParameter()
protected abstract boolean	handleIsInParameter()
protected abstract boolean	handleIsMany()
protected abstract boolean	handleIsOrdered()
protected abstract boolean	handleIsOutParameter()
protected abstract boolean	handleIsReadable()
protected abstract boolean	handleIsRequired()
protected abstract boolean	handleIsReturn()
protected abstract boolean	handleIsUnique()
protected abstract boolean	handleIsWritable()
boolean	isDefaultValuePresent() Indicates if the default value is present.
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	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	isReturn() Whether or not this parameter represents a return parameter.
boolean	isUnique() If Parameter type isMany (UML2), is the parameter unique within the Collection.
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
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::metafacades::uml::ParameterFacade::parameter needs a type

Methods inherited from class org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

getArraySuffix, getValidationName, handleCopyTaggedValues, handleFindTaggedValue, handleFindTaggedValues, handleGetBindedFullyQualifiedName, handleGetConstraints, handleGetConstraints, handleGetDocumentation, handleGetDocumentation, handleGetDocumentation, handleGetFullyQualifiedName, handleGetFullyQualifiedName, handleGetFullyQualifiedNamePath, handleGetId, handleGetKeywords, handleGetLabel, handleGetLanguageMappings, handleGetModel, handleGetName, handleGetOwnedElements, handleGetOwner, handleGetPackage, handleGetPackageName, handleGetPackageName, handleGetPackagePath, handleGetQualifiedName, handleGetRootPackage, handleGetSourceDependencies, handleGetStateMachineContext, handleGetStereotypeNames, handleGetStereotypes, handleGetTaggedValues, handleGetTargetDependencies, handleGetTemplateParameter, handleGetTemplateParameters, handleGetVisibility, handleHasExactStereotype, handleHasKeyword, handleHasStereotype, handleIsBindingDependenciesPresent, handleIsConstraintsPresent, handleIsDocumentationPresent, handleIsReservedWord, handleIsTemplateParametersPresent, handleIsValidIdentifierName, handleTranslateConstraint, handleTranslateConstraints, handleTranslateConstraints

Methods inherited from class org.andromda.metafacades.uml14.ModelElementFacadeLogic

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, toString, translateConstraint, translateConstraints, translateConstraints

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints

Field Detail

metaObject

protected org.omg.uml.foundation.core.Parameter metaObject

The underlying UML object

See Also:

Parameter

Constructor Detail

ParameterFacadeLogic

protected ParameterFacadeLogic(org.omg.uml.foundation.core.Parameter 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 ModelElementFacadeLogic

Parameters:

context -

isParameterFacadeMetaType

public boolean isParameterFacadeMetaType()

Specified by:

isParameterFacadeMetaType in interface ParameterFacade

Returns:

boolean true always

See Also:

ParameterFacade

handleGetDefaultValue

protected abstract String handleGetDefaultValue()

Returns:

String

See Also:

ParameterFacade.getDefaultValue()

getDefaultValue

public final String getDefaultValue()

TODO: Model Documentation for ParameterFacade.defaultValue

Specified by:

getDefaultValue in interface ParameterFacade

Returns:

(String)handleGetDefaultValue()

handleIsDefaultValuePresent

protected abstract boolean handleIsDefaultValuePresent()

Returns:

boolean

See Also:

ParameterFacade.isDefaultValuePresent()

isDefaultValuePresent

public final boolean isDefaultValuePresent()

Indicates if the default value is present.

Specified by:

isDefaultValuePresent in interface ParameterFacade

Returns:

(boolean)handleIsDefaultValuePresent()

handleGetGetterName

protected abstract String handleGetGetterName()

Returns:

String

See Also:

ParameterFacade.getGetterName()

getGetterName

public final String getGetterName()

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

Specified by:

getGetterName in interface ParameterFacade

Returns:

(String)handleGetGetterName()

handleGetGetterSetterTypeName

protected abstract String handleGetGetterSetterTypeName()

Returns:

String

See Also:

ParameterFacade.getGetterSetterTypeName()

getGetterSetterTypeName

public final String getGetterSetterTypeName()

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

Specified by:

getGetterSetterTypeName in interface ParameterFacade

Returns:

(String)handleGetGetterSetterTypeName()

handleGetGetterSetterTypeNameImpl

protected abstract String handleGetGetterSetterTypeNameImpl()

Returns:

String

See Also:

ParameterFacade.getGetterSetterTypeNameImpl()

getGetterSetterTypeNameImpl

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

Returns:

(String)handleGetGetterSetterTypeNameImpl()

handleIsRequired

protected abstract boolean handleIsRequired()

Returns:

boolean

See Also:

ParameterFacade.isRequired()

isRequired

public final boolean isRequired()

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

Specified by:

isRequired in interface ParameterFacade

Returns:

(boolean)handleIsRequired()

handleIsReturn

protected abstract boolean handleIsReturn()

Returns:

boolean

See Also:

ParameterFacade.isReturn()

isReturn

public final boolean isReturn()

Whether or not this parameter represents a return parameter.

Specified by:

isReturn in interface ParameterFacade

Returns:

(boolean)handleIsReturn()

handleGetSetterName

protected abstract String handleGetSetterName()

Returns:

String

See Also:

ParameterFacade.getSetterName()

getSetterName

public final String getSetterName()

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

Specified by:

getSetterName in interface ParameterFacade

Returns:

(String)handleGetSetterName()

handleIsReadable

protected abstract boolean handleIsReadable()

Returns:

boolean

See Also:

ParameterFacade.isReadable()

isReadable

public final boolean isReadable()

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

Specified by:

isReadable in interface ParameterFacade

Returns:

(boolean)handleIsReadable()

handleIsWritable

protected abstract boolean handleIsWritable()

Returns:

boolean

See Also:

ParameterFacade.isWritable()

isWritable

public final boolean isWritable()

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

Specified by:

isWritable in interface ParameterFacade

Returns:

(boolean)handleIsWritable()

handleIsInParameter

protected abstract boolean handleIsInParameter()

Returns:

boolean

See Also:

ParameterFacade.isInParameter()

isInParameter

public final boolean isInParameter()

True if this parameter is an 'in' parameter.

Specified by:

isInParameter in interface ParameterFacade

Returns:

(boolean)handleIsInParameter()

handleIsOutParameter

protected abstract boolean handleIsOutParameter()

Returns:

boolean

See Also:

ParameterFacade.isOutParameter()

isOutParameter

public final boolean isOutParameter()

True if this parameter is an 'out' parameter.

Specified by:

isOutParameter in interface ParameterFacade

Returns:

(boolean)handleIsOutParameter()

handleIsInoutParameter

protected abstract boolean handleIsInoutParameter()

Returns:

boolean

See Also:

ParameterFacade.isInoutParameter()

isInoutParameter

public final boolean isInoutParameter()

True if this parameter is an inout parameter.

Specified by:

isInoutParameter in interface ParameterFacade

Returns:

(boolean)handleIsInoutParameter()

handleGetUpper

protected abstract int handleGetUpper()

Returns:

int

See Also:

ParameterFacade.getUpper()

getUpper

public final int getUpper()

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

Specified by:

getUpper in interface ParameterFacade

Returns:

(int)handleGetUpper()

handleGetLower

protected abstract int handleGetLower()

Returns:

int

See Also:

ParameterFacade.getLower()

getLower

public final int getLower()

the lower value for the multiplicity -only applicable for UML2

Specified by:

getLower in interface ParameterFacade

Returns:

(int)handleGetLower()

handleIsUnique

protected abstract boolean handleIsUnique()

Returns:

boolean

See Also:

ParameterFacade.isUnique()

isUnique

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

Returns:

(boolean)handleIsUnique()

handleIsOrdered

protected abstract boolean handleIsOrdered()

Returns:

boolean

See Also:

ParameterFacade.isOrdered()

isOrdered

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

Returns:

(boolean)handleIsOrdered()

handleIsMany

protected abstract boolean handleIsMany()

Returns:

boolean

See Also:

ParameterFacade.isMany()

isMany

public final boolean isMany()

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

Specified by:

isMany in interface ParameterFacade

Returns:

(boolean)handleIsMany()

handleIsException

protected abstract boolean handleIsException()

Returns:

boolean

See Also:

ParameterFacade.isException()

isException

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

Returns:

(boolean)handleIsException()

handleGetEffect

protected abstract String handleGetEffect()

Returns:

String

See Also:

ParameterFacade.getEffect()

getEffect

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

Returns:

(String)handleGetEffect()

getType

public final ClassifierFacade getType()

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:

getType in interface ParameterFacade

Returns:

(ClassifierFacade)handleGetType()

handleGetType

protected abstract Object handleGetType()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getEvent

public final EventFacade getEvent()

The parameters to this event.

Specified by:

getEvent in interface ParameterFacade

Returns:

(EventFacade)handleGetEvent()

handleGetEvent

protected abstract Object handleGetEvent()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getOperation

public final OperationFacade getOperation()

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

Specified by:

getOperation in interface ParameterFacade

Returns:

(OperationFacade)handleGetOperation()

handleGetOperation

protected abstract Object handleGetOperation()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::metafacades::uml::ParameterFacade::parameter needs a type

Error: Each parameter needs a type, you cannot leave the type unspecified.

OCL: context ParameterFacade inv: return = false implies type.name->notEmpty()

Constraint: org::andromda::metafacades::uml::ParameterFacade::non return type parameters must be named

Error: Each parameter that is NOT a return parameter must have a non-empty name.

OCL: context ParameterFacade inv: return = false implies name -> notEmpty()

Constraint: org::andromda::metafacades::uml::ParameterFacade::primitive parameter cannot be used in Collection

Error: Primitive parameters cannot be used in Collections (multiplicity > 1). Use the wrapped type instead.

OCL: context ParameterFacade inv: type.primitive implies (many = false)

Constraint: org::andromda::metafacades::uml::ParameterFacade::primitive parameter must be required

Error: Primitive operation parameters must have a multiplicity lower bound > 0 (must be required). Use a wrapped type, or change the multiplicity.

OCL: context ParameterFacade inv: type.primitive implies (lower > 0)

Constraint: org::andromda::metafacades::uml::ParameterFacade::wrapped primitive parameter should not be required

Error: Wrapped primitive operation parameters must have a multiplicity lower bound = 0 (must be optional). Use the unwrapped type, or change the multiplicity.

OCL: context ParameterFacade inv: type.wrappedPrimitive and many = false implies (lower = 0)

Specified by:

validateInvariants in interface ModelElementFacade

Overrides:

validateInvariants in class ModelElementFacadeLogic

Parameters:

validationMessages - Collection

See Also:

ModelElementFacadeLogic.validateInvariants(Collection validationMessages)