org.andromda.metafacades.uml14

Class TemplateParameterFacadeLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.TemplateParameterFacadeLogic

All Implemented Interfaces:

Serializable, Comparable, TemplateParameterFacade

Direct Known Subclasses:

TemplateParameterFacadeLogicImpl

public abstract class TemplateParameterFacadeLogic
extends MetafacadeBase
implements TemplateParameterFacade

Represents a UML template parameter. Exposes a parameterable element as a formal template parameter of a template. Only UML2 TemplateParameter inherits from ModelElement, so the UML14 implementation cannot extend ModelElement. UML14 TemplateParameter.parameter inherits from Parameter. MetafacadeLogic for TemplateParameterFacade

See Also:

TemplateParameterFacade, Serialized Form

Field Summary

Fields

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

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

contextRoot

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Collection<ClassifierFacade>	getConstrainingClassifiers() Represents a UML template parameter.
ModelElementFacade	getDefaultElement() Represents a UML template parameter.
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) TODO: Model Documentation for TemplateParameterFacade.getDocumentation
String	getFullyQualifiedName() Return the fully qualified name of the template parameter: package + class + parameter name
String	getGetterName() get + capitalized parameter name
String	getGetterSetterTypeName() The type of the template parameter.
String	getName() TODO: Model Documentation for TemplateParameterFacade.name
ModelElementFacade	getOwner() The ModelElement that owns this parameter.
ModelElementFacade	getParameter() Represents a UML template parameter.
String	getSetterName() set + capitalized parameter name
ClassifierFacade	getType() TemplateParameter may be of type Classifier, PackageableElement, Operation or Property.
protected abstract Collection	handleGetConstrainingClassifiers() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetDefaultElement() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetDocumentation(String indent) Method to be implemented in descendants Gets the documentation for the model element, The indent argument is prefixed to each line.
protected abstract String	handleGetDocumentation(String indent, int lineLength) Method to be implemented in descendants 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.
protected abstract String	handleGetDocumentation(String indent, int lineLength, boolean htmlStyle) Method to be implemented in descendants TODO: Model Documentation for TemplateParameterFacade.getDocumentation
protected abstract String	handleGetFullyQualifiedName()
protected abstract String	handleGetGetterName()
protected abstract String	handleGetGetterSetterTypeName()
protected abstract String	handleGetName()
protected abstract ModelElementFacade	handleGetOwner()
protected abstract Object	handleGetParameter() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetSetterName()
protected abstract ClassifierFacade	handleGetType()
boolean	isTemplateParameterFacadeMetaType()
void	resetMetafacadeContext(String context) Reset context only for non-root metafacades
String	toString()
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::metafacades::uml::TemplateParameterFacade::template parameter type must be specified

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

compareTo, equals, getConfiguredProperty, getDebug, getMetafacadeContext, getMetaObject, getValidationName, 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.TemplateParameterFacade

getValidationName, getValidationOwner, initialize

Field Detail

metaObject

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

The underlying UML object

See Also:

TemplateParameter

Constructor Detail

TemplateParameterFacadeLogic

protected TemplateParameterFacadeLogic(org.omg.uml.foundation.core.TemplateParameter 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 -

isTemplateParameterFacadeMetaType

public boolean isTemplateParameterFacadeMetaType()

Specified by:

isTemplateParameterFacadeMetaType in interface TemplateParameterFacade

Returns:

boolean true always

See Also:

TemplateParameterFacade

handleGetType

protected abstract ClassifierFacade handleGetType()

Returns:

ClassifierFacade

See Also:

TemplateParameterFacade.getType()

getType

public final ClassifierFacade getType()

TemplateParameter may be of type Classifier, PackageableElement, Operation or Property. Generally a Class parameter has a name and a type of Classifier.

Specified by:

getType in interface TemplateParameterFacade

Returns:

(ClassifierFacade)handleGetType()

handleGetName

protected abstract String handleGetName()

Returns:

String

See Also:

TemplateParameterFacade.getName()

getName

public final String getName()

TODO: Model Documentation for TemplateParameterFacade.name

Specified by:

getName in interface TemplateParameterFacade

Returns:

(String)handleGetName()

handleGetFullyQualifiedName

protected abstract String handleGetFullyQualifiedName()

Returns:

String

See Also:

TemplateParameterFacade.getFullyQualifiedName()

getFullyQualifiedName

public final String getFullyQualifiedName()

Return the fully qualified name of the template parameter: package + class + parameter name

Specified by:

getFullyQualifiedName in interface TemplateParameterFacade

Returns:

(String)handleGetFullyQualifiedName()

handleGetGetterSetterTypeName

protected abstract String handleGetGetterSetterTypeName()

Returns:

String

See Also:

TemplateParameterFacade.getGetterSetterTypeName()

getGetterSetterTypeName

public final String getGetterSetterTypeName()

The type of the template parameter.

Specified by:

getGetterSetterTypeName in interface TemplateParameterFacade

Returns:

(String)handleGetGetterSetterTypeName()

handleGetGetterName

protected abstract String handleGetGetterName()

Returns:

String

See Also:

TemplateParameterFacade.getGetterName()

getGetterName

public final String getGetterName()

get + capitalized parameter name

Specified by:

getGetterName in interface TemplateParameterFacade

Returns:

(String)handleGetGetterName()

handleGetSetterName

protected abstract String handleGetSetterName()

Returns:

String

See Also:

TemplateParameterFacade.getSetterName()

getSetterName

public final String getSetterName()

set + capitalized parameter name

Specified by:

getSetterName in interface TemplateParameterFacade

Returns:

(String)handleGetSetterName()

handleGetOwner

protected abstract ModelElementFacade handleGetOwner()

Returns:

ModelElementFacade

See Also:

TemplateParameterFacade.getOwner()

getOwner

public final ModelElementFacade getOwner()

The ModelElement that owns this parameter. For UML14, the classifier package. For UML2, the Classifier.

Specified by:

getOwner in interface TemplateParameterFacade

Returns:

(ModelElementFacade)handleGetOwner()

handleGetDocumentation

protected abstract String handleGetDocumentation(String indent)

Method to be implemented in descendants 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).

Parameters:

indent -

Returns:

String

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 TemplateParameterFacade

Parameters:

indent - String

Specifies the amount to indent by.

Returns:

handleGetDocumentation(indent)

handleGetDocumentation

protected abstract String handleGetDocumentation(String indent,
                            int lineLength)

Method to be implemented in descendants 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).

Parameters:

indent -

lineLength -

Returns:

String

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 TemplateParameterFacade

Parameters:

indent - String TODO: Model Documentation for TemplateParameterFacade.getDocumentation(indent)

lineLength - int TODO: Model Documentation for TemplateParameterFacade.getDocumentation(lineLength)

Returns:

handleGetDocumentation(indent, lineLength)

handleGetDocumentation

protected abstract String handleGetDocumentation(String indent,
                            int lineLength,
                            boolean htmlStyle)

Method to be implemented in descendants TODO: Model Documentation for TemplateParameterFacade.getDocumentation

Parameters:

indent -

lineLength -

htmlStyle -

Returns:

String

getDocumentation

public String getDocumentation(String indent,
                      int lineLength,
                      boolean htmlStyle)

TODO: Model Documentation for TemplateParameterFacade.getDocumentation

Specified by:

getDocumentation in interface TemplateParameterFacade

Parameters:

indent - String TODO: Model Documentation for TemplateParameterFacade.getDocumentation(indent)

lineLength - int TODO: Model Documentation for TemplateParameterFacade.getDocumentation(lineLength)

htmlStyle - boolean TODO: Model Documentation for TemplateParameterFacade.getDocumentation(htmlStyle)

Returns:

handleGetDocumentation(indent, lineLength, htmlStyle)

getDefaultElement

public final ModelElementFacade getDefaultElement()

Represents a UML template parameter. Exposes a parameterable element as a formal template parameter of a template. Only UML2 TemplateParameter inherits from ModelElement, so the UML14 implementation cannot extend ModelElement. UML14 TemplateParameter.parameter inherits from Parameter.

Specified by:

getDefaultElement in interface TemplateParameterFacade

Returns:

(ModelElementFacade)handleGetDefaultElement()

handleGetDefaultElement

protected abstract Object handleGetDefaultElement()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getParameter

public final ModelElementFacade getParameter()

Represents a UML template parameter. Exposes a parameterable element as a formal template parameter of a template. Only UML2 TemplateParameter inherits from ModelElement, so the UML14 implementation cannot extend ModelElement. UML14 TemplateParameter.parameter inherits from Parameter.

Specified by:

getParameter in interface TemplateParameterFacade

Returns:

(ModelElementFacade)handleGetParameter()

handleGetParameter

protected abstract Object handleGetParameter()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getConstrainingClassifiers

public final Collection<ClassifierFacade> getConstrainingClassifiers()

Represents a UML template parameter. Exposes a parameterable element as a formal template parameter of a template. Only UML2 TemplateParameter inherits from ModelElement, so the UML14 implementation cannot extend ModelElement. UML14 TemplateParameter.parameter inherits from Parameter.

Specified by:

getConstrainingClassifiers in interface TemplateParameterFacade

Returns:

(Collection)handleGetConstrainingClassifiers()

handleGetConstrainingClassifiers

protected abstract Collection handleGetConstrainingClassifiers()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::metafacades::uml::TemplateParameterFacade::template parameter type must be specified

Error: Template Parameter type must be specified.

OCL: context TemplateParameterFacade inv: type.name->notEmpty()

Specified by:

validateInvariants in interface TemplateParameterFacade

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