org.andromda.cartridges.ejb.metafacades

Class EJBAssociationEndFacadeLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.cartridges.ejb.metafacades.EJBAssociationEndFacadeLogic

All Implemented Interfaces:

Serializable, Comparable, EJBAssociationEndFacade, AssociationEndFacade, EntityAssociationEnd, ModelElementFacade

Direct Known Subclasses:

EJBAssociationEndFacadeLogicImpl

public abstract class EJBAssociationEndFacadeLogic
extends MetafacadeBase
implements EJBAssociationEndFacade

Represents an EJB association end. MetafacadeLogic for EJBAssociationEndFacade

See Also:

EJBAssociationEndFacade, 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, logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EJBAssociationEndFacadeLogic(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	getAdderName() A name suitable for use when adding new elements to this association end in programming code.
String	getAggregationKind() Returns the value of the 'Aggregation' attribute (none, shared, composite).
AssociationFacade	getAssociation() The association owning this association end.
String	getBindedFullyQualifiedName(ModelElementFacade bindedElement) Returns the fully qualified name of the model element.
String	getColumnIndex() The name of the index to create on a column that persists the foreign key attribute.
String	getColumnName() The name of the column that makes up the foreign key.
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	getDefault() UML2: Returns the value of the 'Default' attribute.
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	getForeignKeyConstraintName() The name of the foreign key constraint to use for databases.
String	getForeignKeySuffix() The current foreign key suffix specified for this entity association end facade.
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() A name suitable for use when accessing this association end in programming code.
String	getGetterSetterTypeName() The name of the type that is returned on the accessor and mutator operations, determined in part by the multiplicity.
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.
AssociationEndFacade	getOtherEnd() The other association end owned by this end's association.
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	getRelationType() The target type for a relation.
String	getRemoverName() A name suitable for use when removing element from this association end in programming code.
PackageFacade	getRootPackage() Gets the root package for the model element.
String	getSetterName() A name suitable for use when accessing this association end in programming code.
Collection<DependencyFacade>	getSourceDependencies() Gets the dependencies for which this model element is the source.
String	getSqlType() The SQL type for this the foreign key column of this association end.
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
ClassifierFacade	getType() The classifier attached to this association end.
String	getUniqueGroup() The name of the unique-key that this unique association end belongs
int	getUpper() the upper value for the multiplicity (will be -1 for *) -only applicable for UML2
String	getValidationName()
Object	getValidationOwner()
String	getVisibility() The visibility (i.e.
protected abstract String	handleGetRelationType()
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	isAggregation() True if this association end represents an aggregation relationship.
boolean	isAssociationEndFacadeMetaType()
boolean	isBidirectional() Is true if update of one side of the association should also update the other side.
boolean	isBindingDependenciesPresent() True if there are target dependencies from this element that are instances of BindingFacade.
boolean	isChild() Returns whether or not (true/false) this association end is the child end of the assocation (i.e.
boolean	isComposition() True if this association end represents a composition relationship.
boolean	isConstraintsPresent() Indicates if any constraints are present on this model element.
boolean	isDerived() If the association end is derived (its value is computed).
boolean	isDocumentationPresent() Indicates if any documentation is present on this model element.
boolean	isEJBAssociationEndFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isEntityAssociationEndMetaType()
boolean	isForeignIdentifier() Indicates whether or not a foreign identifier should be used for the entity that owns this association end.
boolean	isIdentifier() True if this association is an identifier for its entity.
boolean	isIdentifiersPresent() True if the associationEnd is marked with identifiers stereotype, false otherwise.
boolean	isLeaf() IsLeaf property in the association end property.
boolean	isMany() True if this association end's multiplicity is greater than one.
boolean	isMany2Many() True if this association end's and the other end's multiplicities are both many.
boolean	isMany2One() True if this association end's multiplicity is many while the other end's is one.
boolean	isModelElementFacadeMetaType()
boolean	isNavigable() True if it is possible to navigate from the other end to this association end .
boolean	isOne2Many() True if this association end's multiplicity is one while the other end's is many.
boolean	isOne2One() True if this association end's and the other end's multiplicities are both one.
boolean	isOrdered() Indicates whether or not the association ends are ordered (if multiplicity is greater than 1).
boolean	isReadOnly() True if the association end cannot be changed.
boolean	isRequired() True if this association end's multiplicity is strictly greater than zero.
boolean	isReservedWord() True if this element name is a reserved word in Java, C#, ANSI or ISO C, C++, JavaScript.
boolean	isStatic() Indicates if this associationEnd is 'static', meaning it has a classifier scope.
boolean	isTemplateParametersPresent() True is there are template parameters on this model element.
boolean	isTransient() Indicates this association end should be ignored by the persistence layer.
boolean	isUnique() UML2: If the association attribute is unique within the Collection type.
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, 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

EJBAssociationEndFacadeLogic

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

isEJBAssociationEndFacadeMetaType

public boolean isEJBAssociationEndFacadeMetaType()

Description copied from interface: EJBAssociationEndFacade

Indicates the metafacade type (used for metafacade mappings).

Specified by:

isEJBAssociationEndFacadeMetaType in interface EJBAssociationEndFacade

Returns:

boolean true always

See Also:

EJBAssociationEndFacade

handleGetRelationType

protected abstract String handleGetRelationType()

Returns:

String

See Also:

EJBAssociationEndFacade.getRelationType()

getRelationType

public final String getRelationType()

The target type for a relation. If the relation target has a multiplicity of 0..1 or 1, this is the fully qualified type name of the target. If it has a multiplicity of >1, this is the string 'Collection'

Specified by:

getRelationType in interface EJBAssociationEndFacade

Returns:

(String)handleGetRelationType()

isEntityAssociationEndMetaType

public boolean isEntityAssociationEndMetaType()

Specified by:

isEntityAssociationEndMetaType in interface EntityAssociationEnd

Returns:

true

See Also:

EntityAssociationEnd

isAssociationEndFacadeMetaType

public boolean isAssociationEndFacadeMetaType()

Specified by:

isAssociationEndFacadeMetaType in interface AssociationEndFacade

Returns:

true

See Also:

AssociationEndFacade

isModelElementFacadeMetaType

public boolean isModelElementFacadeMetaType()

Specified by:

isModelElementFacadeMetaType in interface ModelElementFacade

Returns:

true

See Also:

ModelElementFacade

getAdderName

public String getAdderName()

A name suitable for use when adding new elements to this association end in programming code.

Specified by:

getAdderName in interface AssociationEndFacade

See Also:

AssociationEndFacade.getAdderName()

getAggregationKind

public String getAggregationKind()

Returns the value of the 'Aggregation' attribute (none, shared, composite). The default value is "none". The literals are from the enumeration org.eclipse.uml2.uml.AggregationKind. Specifies the kind of aggregation that applies to the Property.

Specified by:

getAggregationKind in interface AssociationEndFacade

See Also:

AssociationEndFacade.getAggregationKind()

getAssociation

public AssociationFacade getAssociation()

The association owning this association end.

Specified by:

getAssociation in interface AssociationEndFacade

See Also:

AssociationEndFacade.getAssociation()

getDefault

public String getDefault()

UML2: Returns the value of the 'Default' attribute. Specifies a String that represents a value to be used when no argument is supplied for the Property. A String that is evaluated to give a default value for the Property when an object of the owning Classifier is instantiated. Can be something like: new ValueObject(values);

Specified by:

getDefault in interface AssociationEndFacade

See Also:

AssociationEndFacade.getDefault()

getGetterName

public String getGetterName()

A name suitable for use when accessing this association end in programming code.

Specified by:

getGetterName in interface AssociationEndFacade

See Also:

AssociationEndFacade.getGetterName()

getGetterSetterTypeName

public String getGetterSetterTypeName()

The name of the type that is returned on the accessor and mutator operations, determined in part by the multiplicity.

Specified by:

getGetterSetterTypeName in interface AssociationEndFacade

See Also:

AssociationEndFacade.getGetterSetterTypeName()

getLower

public int getLower()

the lower value for the multiplicity -only applicable for UML2

Specified by:

getLower in interface AssociationEndFacade

See Also:

AssociationEndFacade.getLower()

getOtherEnd

public AssociationEndFacade getOtherEnd()

The other association end owned by this end's association.

Specified by:

getOtherEnd in interface AssociationEndFacade

See Also:

AssociationEndFacade.getOtherEnd()

getRemoverName

public String getRemoverName()

A name suitable for use when removing element from this association end in programming code.

Specified by:

getRemoverName in interface AssociationEndFacade

See Also:

AssociationEndFacade.getRemoverName()

getSetterName

public String getSetterName()

A name suitable for use when accessing this association end in programming code.

Specified by:

getSetterName in interface AssociationEndFacade

See Also:

AssociationEndFacade.getSetterName()

getType

public ClassifierFacade getType()

The classifier attached to this association end.

Specified by:

getType in interface AssociationEndFacade

See Also:

AssociationEndFacade.getType()

getUpper

public int getUpper()

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

Specified by:

getUpper in interface AssociationEndFacade

See Also:

AssociationEndFacade.getUpper()

isAggregation

public boolean isAggregation()

True if this association end represents an aggregation relationship.

Specified by:

isAggregation in interface AssociationEndFacade

See Also:

AssociationEndFacade.isAggregation()

isBidirectional

public boolean isBidirectional()

Is true if update of one side of the association should also update the other side. false if not.

Specified by:

isBidirectional in interface AssociationEndFacade

See Also:

AssociationEndFacade.isBidirectional()

isChild

public boolean isChild()

Returns whether or not (true/false) this association end is the child end of the assocation (i.e. the other end's aggregation is composition).

Specified by:

isChild in interface AssociationEndFacade

See Also:

AssociationEndFacade.isChild()

isComposition

public boolean isComposition()

True if this association end represents a composition relationship.

Specified by:

isComposition in interface AssociationEndFacade

See Also:

AssociationEndFacade.isComposition()

isDerived

public boolean isDerived()

If the association end is derived (its value is computed). UML2 only. UML14 always returns false. Default=false.

Specified by:

isDerived in interface AssociationEndFacade

See Also:

AssociationEndFacade.isDerived()

isLeaf

public boolean isLeaf()

IsLeaf property in the association end property. If true, attribute is final, cannot be extended or implemented by a descendant. Default=false.

Specified by:

isLeaf in interface AssociationEndFacade

See Also:

AssociationEndFacade.isLeaf()

isMany

public boolean isMany()

True if this association end's multiplicity is greater than one.

Specified by:

isMany in interface AssociationEndFacade

See Also:

AssociationEndFacade.isMany()

isMany2Many

public boolean isMany2Many()

True if this association end's and the other end's multiplicities are both many.

Specified by:

isMany2Many in interface AssociationEndFacade

See Also:

AssociationEndFacade.isMany2Many()

isMany2One

public boolean isMany2One()

True if this association end's multiplicity is many while the other end's is one.

Specified by:

isMany2One in interface AssociationEndFacade

See Also:

AssociationEndFacade.isMany2One()

isNavigable

public boolean isNavigable()

True if it is possible to navigate from the other end to this association end .

Specified by:

isNavigable in interface AssociationEndFacade

See Also:

AssociationEndFacade.isNavigable()

isOne2Many

public boolean isOne2Many()

True if this association end's multiplicity is one while the other end's is many.

Specified by:

isOne2Many in interface AssociationEndFacade

See Also:

AssociationEndFacade.isOne2Many()

isOne2One

public boolean isOne2One()

True if this association end's and the other end's multiplicities are both one.

Specified by:

isOne2One in interface AssociationEndFacade

See Also:

AssociationEndFacade.isOne2One()

isOrdered

public boolean isOrdered()

Indicates whether or not the association ends are ordered (if multiplicity is greater than 1).

Specified by:

isOrdered in interface AssociationEndFacade

See Also:

AssociationEndFacade.isOrdered()

isReadOnly

public boolean isReadOnly()

True if the association end cannot be changed.

Specified by:

isReadOnly in interface AssociationEndFacade

See Also:

AssociationEndFacade.isReadOnly()

isRequired

public boolean isRequired()

True if this association end's multiplicity is strictly greater than zero.

Specified by:

isRequired in interface AssociationEndFacade

See Also:

AssociationEndFacade.isRequired()

isStatic

public boolean isStatic()

Indicates if this associationEnd is 'static', meaning it has a classifier scope.

Specified by:

isStatic in interface AssociationEndFacade

See Also:

AssociationEndFacade.isStatic()

isUnique

public boolean isUnique()

UML2: If the association attribute is unique within the Collection type. UML14 always returns false. Unique+Ordered determines the implementation Collection type. Default=false.

Specified by:

isUnique in interface AssociationEndFacade

See Also:

AssociationEndFacade.isUnique()

getColumnIndex

public String getColumnIndex()

The name of the index to create on a column that persists the foreign key attribute.

Specified by:

getColumnIndex in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.getColumnIndex()

getColumnName

public String getColumnName()

The name of the column that makes up the foreign key.

Specified by:

getColumnName in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.getColumnName()

getForeignKeyConstraintName

public String getForeignKeyConstraintName()

The name of the foreign key constraint to use for databases.

Specified by:

getForeignKeyConstraintName in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.getForeignKeyConstraintName()

getForeignKeySuffix

public String getForeignKeySuffix()

The current foreign key suffix specified for this entity association end facade.

Specified by:

getForeignKeySuffix in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.getForeignKeySuffix()

getSqlType

public String getSqlType()

The SQL type for this the foreign key column of this association end.

Specified by:

getSqlType in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.getSqlType()

getUniqueGroup

public String getUniqueGroup()

The name of the unique-key that this unique association end belongs

Specified by:

getUniqueGroup in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.getUniqueGroup()

isForeignIdentifier

public boolean isForeignIdentifier()

Indicates whether or not a foreign identifier should be used for the entity that owns this association end. This would only make sense in the case of a child in a one-to-one parent-child association. If this flag is true, then the identifier of this entity should also be used as the foreign key to the related parent entity.

Specified by:

isForeignIdentifier in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.isForeignIdentifier()

isIdentifier

public boolean isIdentifier()

True if this association is an identifier for its entity.

Specified by:

isIdentifier in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.isIdentifier()

isIdentifiersPresent

public boolean isIdentifiersPresent()

True if the associationEnd is marked with identifiers stereotype, false otherwise.

Specified by:

isIdentifiersPresent in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.isIdentifiersPresent()

isTransient

public boolean isTransient()

Indicates this association end should be ignored by the persistence layer.

Specified by:

isTransient in interface EntityAssociationEnd

See Also:

EntityAssociationEnd.isTransient()

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)

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

See Also:

MetafacadeBase.getValidationOwner()

getValidationName

public String getValidationName()

Specified by:

getValidationName in interface ModelElementFacade

Overrides:

getValidationName in class MetafacadeBase

Returns:

String getSuperEntityAssociationEnd().getValidationName()

See Also:

MetafacadeBase.getValidationName()

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

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