org.andromda.metafacades.uml14

Class FrontEndParameterLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.ModelElementFacadeLogic

org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

org.andromda.metafacades.uml14.ParameterFacadeLogic

org.andromda.metafacades.uml14.ParameterFacadeLogicImpl

org.andromda.metafacades.uml14.FrontEndParameterLogic

All Implemented Interfaces:

Serializable, Comparable, FrontEndParameter, ModelElementFacade, ParameterFacade

Direct Known Subclasses:

FrontEndParameterLogicImpl

public abstract class FrontEndParameterLogic
extends ParameterFacadeLogicImpl
implements FrontEndParameter

A front-end parameter is a parameter passed between front-end action states. MetafacadeLogic for FrontEndParameter

See Also:

FrontEndParameter, 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	FrontEndParameterLogic(Object metaObjectIn, String context) Create Metafacade implementation instance using the MetafacadeFactory from the context

Method Summary

Methods

Modifier and Type	Method and Description
FrontEndAction	getAction() All parameters sent by this "front-end" action.
FrontEndControllerOperation	getControllerOperation() The set of fields in the form made up form this controller operation's parameters.
Collection<String>	getTableAttributeNames() A collection of all possible attribute names of a table (this will only work when your table is modeled as an array..not a collection).
Collection<String>	getTableColumnNames() All the columns for this parameter if it represents a table variable.
Collection<String>	getTableColumns() A list of all attributes which make up the table columns of this table (this only contains attributes when the table is represented by an array).
FrontEndView	getView() All those variables that will be present as variables in the target view.
protected abstract Object	handleGetAction() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetControllerOperation() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection<String>	handleGetTableAttributeNames()
protected abstract Collection<String>	handleGetTableColumnNames()
protected abstract Collection<String>	handleGetTableColumns()
protected abstract Object	handleGetView() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract boolean	handleIsActionParameter()
protected abstract boolean	handleIsContainedInFrontEndUseCase()
protected abstract boolean	handleIsControllerOperationArgument()
protected abstract boolean	handleIsTable()
boolean	isActionParameter() Indicates whether or not this is an action parameter or not.
boolean	isContainedInFrontEndUseCase() Indicates if this parameter is contained in a "front-end" use case.
boolean	isControllerOperationArgument() Indicates whether or not this parameter is an argument of a controller operation.
boolean	isFrontEndParameterMetaType()
boolean	isTable() Indicates whether or not this parameter represents a table.
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.ParameterFacadeLogicImpl

getValidationOwner, handleGetDefaultValue, handleGetEffect, handleGetEvent, handleGetGetterName, handleGetGetterSetterTypeName, handleGetGetterSetterTypeNameImpl, handleGetLower, handleGetName, handleGetOperation, handleGetSetterName, handleGetType, handleGetUpper, handleIsDefaultValuePresent, handleIsException, handleIsInoutParameter, handleIsInParameter, handleIsMany, handleIsOrdered, handleIsOutParameter, handleIsReadable, handleIsRequired, handleIsReturn, handleIsUnique, handleIsWritable

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

getDefaultValue, getEffect, getEvent, getGetterName, getGetterSetterTypeName, getGetterSetterTypeNameImpl, getLower, getOperation, getSetterName, getType, getUpper, isDefaultValuePresent, isException, isInoutParameter, isInParameter, isMany, isOrdered, isOutParameter, isParameterFacadeMetaType, isReadable, isRequired, isReturn, isUnique, isWritable

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, 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, 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.ParameterFacade

getDefaultValue, getEffect, getEvent, getGetterName, getGetterSetterTypeName, getGetterSetterTypeNameImpl, getLower, getOperation, getSetterName, getType, getUpper, isDefaultValuePresent, isException, isInoutParameter, isInParameter, isMany, isOrdered, isOutParameter, isParameterFacadeMetaType, isReadable, isRequired, isReturn, isUnique, isWritable

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 Object metaObject

The underlying UML object

See Also:

Object

Constructor Detail

FrontEndParameterLogic

protected FrontEndParameterLogic(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 ParameterFacadeLogic

Parameters:

context -

isFrontEndParameterMetaType

public boolean isFrontEndParameterMetaType()

Specified by:

isFrontEndParameterMetaType in interface FrontEndParameter

Returns:

boolean true always

See Also:

FrontEndParameter

handleIsControllerOperationArgument

protected abstract boolean handleIsControllerOperationArgument()

Returns:

boolean

See Also:

FrontEndParameter.isControllerOperationArgument()

isControllerOperationArgument

public final boolean isControllerOperationArgument()

Indicates whether or not this parameter is an argument of a controller operation.

Specified by:

isControllerOperationArgument in interface FrontEndParameter

Returns:

(boolean)handleIsControllerOperationArgument()

handleIsContainedInFrontEndUseCase

protected abstract boolean handleIsContainedInFrontEndUseCase()

Returns:

boolean

See Also:

FrontEndParameter.isContainedInFrontEndUseCase()

isContainedInFrontEndUseCase

public final boolean isContainedInFrontEndUseCase()

Indicates if this parameter is contained in a "front-end" use case.

Specified by:

isContainedInFrontEndUseCase in interface FrontEndParameter

Returns:

(boolean)handleIsContainedInFrontEndUseCase()

handleIsActionParameter

protected abstract boolean handleIsActionParameter()

Returns:

boolean

See Also:

FrontEndParameter.isActionParameter()

isActionParameter

public final boolean isActionParameter()

Indicates whether or not this is an action parameter or not.

Specified by:

isActionParameter in interface FrontEndParameter

Returns:

(boolean)handleIsActionParameter()

handleIsTable

protected abstract boolean handleIsTable()

Returns:

boolean

See Also:

FrontEndParameter.isTable()

isTable

public final boolean isTable()

Indicates whether or not this parameter represents a table.

Specified by:

isTable in interface FrontEndParameter

Returns:

(boolean)handleIsTable()

handleGetTableColumnNames

protected abstract Collection<String> handleGetTableColumnNames()

Returns:

Collection

See Also:

FrontEndParameter.getTableColumnNames()

getTableColumnNames

public final Collection<String> getTableColumnNames()

All the columns for this parameter if it represents a table variable. If a column is linked by an event (action) a FrontEndParameter instance is included in the return value, otherwise a plain String representing the column name.

Specified by:

getTableColumnNames in interface FrontEndParameter

Returns:

(Collection)handleGetTableColumnNames()

handleGetTableColumns

protected abstract Collection<String> handleGetTableColumns()

Returns:

Collection

See Also:

FrontEndParameter.getTableColumns()

getTableColumns

public final Collection<String> getTableColumns()

A list of all attributes which make up the table columns of this table (this only contains attributes when the table is represented by an array).

Specified by:

getTableColumns in interface FrontEndParameter

Returns:

(Collection)handleGetTableColumns()

handleGetTableAttributeNames

protected abstract Collection<String> handleGetTableAttributeNames()

Returns:

Collection

See Also:

FrontEndParameter.getTableAttributeNames()

getTableAttributeNames

public final Collection<String> getTableAttributeNames()

A collection of all possible attribute names of a table (this will only work when your table is modeled as an array..not a collection).

Specified by:

getTableAttributeNames in interface FrontEndParameter

Returns:

(Collection)handleGetTableAttributeNames()

getView

public final FrontEndView getView()

All those variables that will be present as variables in the target view. These are the trigger parameters on the incoming transitions.

Specified by:

getView in interface FrontEndParameter

Returns:

(FrontEndView)handleGetView()

handleGetView

protected abstract Object handleGetView()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getAction

public final FrontEndAction getAction()

All parameters sent by this "front-end" action.

Specified by:

getAction in interface FrontEndParameter

Returns:

(FrontEndAction)handleGetAction()

handleGetAction

protected abstract Object handleGetAction()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getControllerOperation

public final FrontEndControllerOperation getControllerOperation()

The set of fields in the form made up form this controller operation's parameters.

Specified by:

getControllerOperation in interface FrontEndParameter

Returns:

(FrontEndControllerOperation)handleGetControllerOperation()

handleGetControllerOperation

protected abstract Object handleGetControllerOperation()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Description copied from class: ParameterFacadeLogic

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 ParameterFacadeLogic

Parameters:

validationMessages - Collection

See Also:

ParameterFacadeLogic.validateInvariants(Collection validationMessages)