org.andromda.metafacades.uml14

Class ModelElementFacadeLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.ModelElementFacadeLogic

All Implemented Interfaces:

Serializable, Comparable, ModelElementFacade

Direct Known Subclasses:

ModelElementFacadeLogicImpl

public abstract class ModelElementFacadeLogic
extends MetafacadeBase
implements ModelElementFacade

Represents a model element. It may be an Element or NamedElement. A named element is an element in a model that may have a name. An element is a constituent of a model. As such, it has the capability of owning other elements. MetafacadeLogic for ModelElementFacade

See Also:

ModelElementFacade, Serialized Form

Field Summary

Fields

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

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

contextRoot

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelElementFacadeLogic(org.omg.uml.foundation.core.ModelElement 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 the model element to which the constraint applies (i.e.
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	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	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.
ModelFacade	getModel() Represents a model element.
String	getName() The name of the model element.
ModelElementFacade	getPackage() Represents a model element.
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.
PackageFacade	getRootPackage() Gets all the model elements belonging to the root package.
Collection<DependencyFacade>	getSourceDependencies() The source element of this dependency.
StateMachineFacade	getStateMachineContext() Represents a model element.
Collection<String>	getStereotypeNames() The collection of ALL stereotype names for this model element.
Collection<StereotypeFacade>	getStereotypes() Represents a model element.
Collection<TaggedValueFacade>	getTaggedValues() Represents a model element.
Collection<DependencyFacade>	getTargetDependencies() Gets the element to which the dependencies belong.
Object	getTemplateParameter(String parameterName) Get the template parameter for this model element having the parameterName
Collection<TemplateParameterFacade>	getTemplateParameters() Represents a model element.
String	getVisibility() The visibility (i.e.
protected abstract void	handleCopyTaggedValues(ModelElementFacade element) Method to be implemented in descendants Copies all tagged values from the given ModelElementFacade to this model element facade.
protected abstract Object	handleFindTaggedValue(String tagName) Method to be implemented in descendants Finds the tagged value with the specified 'tagName'.
protected abstract Collection<Object>	handleFindTaggedValues(String tagName) Method to be implemented in descendants Returns all the values for the tagged value with the specified name.
protected abstract String	handleGetBindedFullyQualifiedName(ModelElementFacade bindedElement) Method to be implemented in descendants Returns the fully qualified name of the model element.
protected abstract Collection	handleGetConstraints() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection<ConstraintFacade>	handleGetConstraints(String kind) Method to be implemented in descendants Returns the constraints of the argument kind that have been placed onto this model.
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 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	handleGetFullyQualifiedName()
protected abstract String	handleGetFullyQualifiedName(boolean modelName) Method to be implemented in descendants Returns the fully qualified name of the model element.
protected abstract String	handleGetFullyQualifiedNamePath()
protected abstract String	handleGetId()
protected abstract Collection<String>	handleGetKeywords()
protected abstract String	handleGetLabel()
protected abstract TypeMappings	handleGetLanguageMappings()
protected abstract Object	handleGetModel() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetName()
protected abstract Object	handleGetPackage() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetPackageName()
protected abstract String	handleGetPackageName(boolean modelName) Method to be implemented in descendants Gets the package name (optionally providing the ability to retrieve the model name and not the mapped name).
protected abstract String	handleGetPackagePath()
protected abstract String	handleGetQualifiedName()
protected abstract Object	handleGetRootPackage() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection	handleGetSourceDependencies() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetStateMachineContext() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection<String>	handleGetStereotypeNames()
protected abstract Collection	handleGetStereotypes() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection	handleGetTaggedValues() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection	handleGetTargetDependencies() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetTemplateParameter(String parameterName) Method to be implemented in descendants Get the template parameter for this model element having the parameterName
protected abstract Collection	handleGetTemplateParameters() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetVisibility()
protected abstract boolean	handleHasExactStereotype(String stereotypeName) Method to be implemented in descendants 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.
protected abstract boolean	handleHasKeyword(String keywordName) Method to be implemented in descendants Does the UML Element contain the named Keyword? Keywords can be separated by space, comma, pipe, semicolon, or << >>
protected abstract boolean	handleHasStereotype(String stereotypeName) Method to be implemented in descendants Returns true if the model element has the specified stereotype.
protected abstract boolean	handleIsBindingDependenciesPresent()
protected abstract boolean	handleIsConstraintsPresent()
protected abstract boolean	handleIsDocumentationPresent()
protected abstract boolean	handleIsReservedWord()
protected abstract boolean	handleIsTemplateParametersPresent()
protected abstract boolean	handleIsValidIdentifierName()
protected abstract String	handleTranslateConstraint(String name, String translation) Method to be implemented in descendants 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.
protected abstract String[]	handleTranslateConstraints(String translation) Method to be implemented in descendants Translates all constraints belonging to this model element with the given 'translation'.
protected abstract String[]	handleTranslateConstraints(String kind, String translation) Method to be implemented in descendants Translates the constraints of the specified 'kind' belonging to this model element.
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.
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	isDocumentationPresent() Indicates if any documentation is present on this model element.
boolean	isModelElementFacadeMetaType()
boolean	isReservedWord() True if this element name is a reserved word in Java, C#, ANSI or ISO C, C++, JavaScript.
boolean	isTemplateParametersPresent() True is there are template parameters on this model element.
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, 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.ModelElementFacade

getValidationName, getValidationOwner, initialize

Field Detail

metaObject

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

The underlying UML object

See Also:

ModelElement

Constructor Detail

ModelElementFacadeLogic

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

isModelElementFacadeMetaType

public boolean isModelElementFacadeMetaType()

Specified by:

isModelElementFacadeMetaType in interface ModelElementFacade

Returns:

boolean true always

See Also:

ModelElementFacade

handleGetVisibility

protected abstract String handleGetVisibility()

Returns:

String

See Also:

ModelElementFacade.getVisibility()

getVisibility

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

Returns:

(String)handleGetVisibility()

handleGetPackagePath

protected abstract String handleGetPackagePath()

Returns:

String

See Also:

ModelElementFacade.getPackagePath()

getPackagePath

public final String getPackagePath()

Returns the package as a path, the returned value always starts with out a slash '/'.

Specified by:

getPackagePath in interface ModelElementFacade

Returns:

(String)handleGetPackagePath()

handleGetName

protected abstract String handleGetName()

Returns:

String

See Also:

ModelElementFacade.getName()

getName

public final String getName()

The name of the model element.

Specified by:

getName in interface ModelElementFacade

Returns:

(String)handleGetName()

handleGetPackageName

protected abstract String handleGetPackageName()

Returns:

String

See Also:

ModelElementFacade.getPackageName()

getPackageName

public final String getPackageName()

The name of this model element's package.

Specified by:

getPackageName in interface ModelElementFacade

Returns:

(String)handleGetPackageName()

handleGetFullyQualifiedName

protected abstract String handleGetFullyQualifiedName()

Returns:

String

See Also:

ModelElementFacade.getFullyQualifiedName()

getFullyQualifiedName

public final String getFullyQualifiedName()

The fully qualified name of this model element.

Specified by:

getFullyQualifiedName in interface ModelElementFacade

Returns:

(String)handleGetFullyQualifiedName()

handleGetFullyQualifiedNamePath

protected abstract String handleGetFullyQualifiedNamePath()

Returns:

String

See Also:

ModelElementFacade.getFullyQualifiedNamePath()

getFullyQualifiedNamePath

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

Returns:

(String)handleGetFullyQualifiedNamePath()

handleGetLanguageMappings

protected abstract TypeMappings handleGetLanguageMappings()

Returns:

TypeMappings

See Also:

ModelElementFacade.getLanguageMappings()

getLanguageMappings

public final TypeMappings getLanguageMappings()

The language mappings that have been set for this model element.

Specified by:

getLanguageMappings in interface ModelElementFacade

Returns:

(TypeMappings)handleGetLanguageMappings()

handleGetStereotypeNames

protected abstract Collection<String> handleGetStereotypeNames()

Returns:

Collection

See Also:

ModelElementFacade.getStereotypeNames()

getStereotypeNames

public final Collection<String> getStereotypeNames()

The collection of ALL stereotype names for this model element.

Specified by:

getStereotypeNames in interface ModelElementFacade

Returns:

(Collection)handleGetStereotypeNames()

handleGetId

protected abstract String handleGetId()

Returns:

String

See Also:

ModelElementFacade.getId()

getId

public final String getId()

Gets the unique identifier of the underlying model element.

Specified by:

getId in interface ModelElementFacade

Returns:

(String)handleGetId()

handleIsConstraintsPresent

protected abstract boolean handleIsConstraintsPresent()

Returns:

boolean

See Also:

ModelElementFacade.isConstraintsPresent()

isConstraintsPresent

public final boolean isConstraintsPresent()

Indicates if any constraints are present on this model element.

Specified by:

isConstraintsPresent in interface ModelElementFacade

Returns:

(boolean)handleIsConstraintsPresent()

handleIsBindingDependenciesPresent

protected abstract boolean handleIsBindingDependenciesPresent()

Returns:

boolean

See Also:

ModelElementFacade.isBindingDependenciesPresent()

isBindingDependenciesPresent

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

Returns:

(boolean)handleIsBindingDependenciesPresent()

handleIsTemplateParametersPresent

protected abstract boolean handleIsTemplateParametersPresent()

Returns:

boolean

See Also:

ModelElementFacade.isTemplateParametersPresent()

isTemplateParametersPresent

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

Returns:

(boolean)handleIsTemplateParametersPresent()

handleGetKeywords

protected abstract Collection<String> handleGetKeywords()

Returns:

Collection

See Also:

ModelElementFacade.getKeywords()

getKeywords

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

Returns:

(Collection)handleGetKeywords()

handleGetLabel

protected abstract String handleGetLabel()

Returns:

String

See Also:

ModelElementFacade.getLabel()

getLabel

public final String getLabel()

UML2: Retrieves a localized label for this named element.

Specified by:

getLabel in interface ModelElementFacade

Returns:

(String)handleGetLabel()

handleGetQualifiedName

protected abstract String handleGetQualifiedName()

Returns:

String

See Also:

ModelElementFacade.getQualifiedName()

getQualifiedName

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

Returns:

(String)handleGetQualifiedName()

handleIsReservedWord

protected abstract boolean handleIsReservedWord()

Returns:

boolean

See Also:

ModelElementFacade.isReservedWord()

isReservedWord

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

Returns:

(boolean)handleIsReservedWord()

handleIsDocumentationPresent

protected abstract boolean handleIsDocumentationPresent()

Returns:

boolean

See Also:

ModelElementFacade.isDocumentationPresent()

isDocumentationPresent

public final boolean isDocumentationPresent()

Indicates if any documentation is present on this model element.

Specified by:

isDocumentationPresent in interface ModelElementFacade

Returns:

(boolean)handleIsDocumentationPresent()

handleIsValidIdentifierName

protected abstract boolean handleIsValidIdentifierName()

Returns:

boolean

See Also:

ModelElementFacade.isValidIdentifierName()

isValidIdentifierName

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

Returns:

(boolean)handleIsValidIdentifierName()

handleFindTaggedValue

protected abstract Object handleFindTaggedValue(String tagName)

Method to be implemented in descendants Finds the tagged value with the specified 'tagName'. In case there are more values the first one found will be returned.

Parameters:

tagName -

Returns:

Object

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

Parameters:

tagName - String TODO: Model Documentation for ModelElementFacade.findTaggedValue(tagName)

Returns:

handleFindTaggedValue(tagName)

handleHasStereotype

protected abstract boolean handleHasStereotype(String stereotypeName)

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

Parameters:

stereotypeName -

Returns:

boolean

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

Parameters:

stereotypeName - String TODO: Model Documentation for ModelElementFacade.hasStereotype(stereotypeName)

Returns:

handleHasStereotype(stereotypeName)

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 ModelElementFacade

Parameters:

indent - String

Specifies the amount to indent by.

Returns:

handleGetDocumentation(indent)

handleGetFullyQualifiedName

protected abstract String handleGetFullyQualifiedName(boolean modelName)

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

Parameters:

modelName -

Returns:

String

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

Parameters:

modelName - boolean If true, then the original model name will be returned regardless of any underlying language mappings used.

Returns:

handleGetFullyQualifiedName(modelName)

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 ModelElementFacade

Parameters:

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

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

Returns:

handleGetDocumentation(indent, lineLength)

handleHasExactStereotype

protected abstract boolean handleHasExactStereotype(String stereotypeName)

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

Parameters:

stereotypeName -

Returns:

boolean

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

Parameters:

stereotypeName - String The name of the stereotype to check for.

Returns:

handleHasExactStereotype(stereotypeName)

handleTranslateConstraint

protected abstract String handleTranslateConstraint(String name,
                               String translation)

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

Parameters:

name -

translation -

Returns:

String

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

Parameters:

name - String The name of the constraint to find.

translation - String The name of the translation to use. This must be a translation within a translation library discovered by the framework.

Returns:

handleTranslateConstraint(name, translation)

handleTranslateConstraints

protected abstract String[] handleTranslateConstraints(String kind,
                                  String translation)

Method to be implemented in descendants Translates the constraints of the specified 'kind' belonging to this model element.

Parameters:

kind -

translation -

Returns:

String[]

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

Parameters:

kind - String The 'kind' of the constraint (i.e. inv, body, pre, post, etc.).

translation - String The name of the translation to use. This must be a translation within a translation library discovered by the framework.

Returns:

handleTranslateConstraints(kind, translation)

handleTranslateConstraints

protected abstract String[] handleTranslateConstraints(String translation)

Method to be implemented in descendants Translates all constraints belonging to this model element with the given 'translation'.

Parameters:

translation -

Returns:

String[]

translateConstraints

public String[] translateConstraints(String translation)

Translates all constraints belonging to this model element with the given 'translation'.

Specified by:

translateConstraints in interface ModelElementFacade

Parameters:

translation - String The name of the translation to use. This must be a translation within a translation library discovered by the framework.

Returns:

handleTranslateConstraints(translation)

handleGetConstraints

protected abstract Collection<ConstraintFacade> handleGetConstraints(String kind)

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

Parameters:

kind -

Returns:

Collection

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

Parameters:

kind - String TODO: Model Documentation for ModelElementFacade.getConstraints(kind)

Returns:

handleGetConstraints(kind)

handleFindTaggedValues

protected abstract Collection<Object> handleFindTaggedValues(String tagName)

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

Parameters:

tagName -

Returns:

Collection