org.andromda.cartridges.hibernate.metafacades

Class HibernateAssociationLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.cartridges.hibernate.metafacades.HibernateAssociationLogic

All Implemented Interfaces:

Serializable, Comparable, HibernateAssociation, AssociationFacade, EntityAssociation, GeneralizableElementFacade, ModelElementFacade

Direct Known Subclasses:

HibernateAssociationLogicImpl

public abstract class HibernateAssociationLogic
extends MetafacadeBase
implements HibernateAssociation

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateAssociation MetafacadeLogic for HibernateAssociation

See Also:

HibernateAssociation, 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	HibernateAssociationLogic(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'.
Object	findTaggedValue(String tagName, boolean follow) Finds the tagged value optional searching the entire inheritance hierarchy if 'follow' is set to true.
Collection<Object>	findTaggedValues(String tagName) Returns all the values for the tagged value with the specified name.
Collection<GeneralizableElementFacade>	getAllGeneralizations() All generalizations for this generalizable element, goes up the inheritance tree.
Collection<GeneralizableElementFacade>	getAllSpecializations() All specializations (travels down the inheritance hierarchy).
AssociationEndFacade	getAssociationEndA() The first association end.
AssociationEndFacade	getAssociationEndB() The second association end.
List<AssociationEndFacade>	getAssociationEnds() Gets the association ends belonging to this association.
String	getBindedFullyQualifiedName(ModelElementFacade bindedElement) Returns the fully qualified name of the model element.
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	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.
int	getEhCacheMaxElementsInMemory() EhCache property.
int	getEhCacheTimeToIdleSeconds() EhCache property.
int	getEhCacheTimeToLiveSeconds() EhCache property.
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 '/'.
GeneralizableElementFacade	getGeneralization() Gets the direct generalization for this generalizable element.
Collection<GeneralizationFacade>	getGeneralizationLinks() Gets the actual links that this generalization element is part of (it plays either the specialization or generalization).
String	getGeneralizationList() A comma separated list of the fully qualified names of all generalizations.
GeneralizableElementFacade	getGeneralizationRoot() The element found when you recursively follow the generalization path up to the root.
Collection<GeneralizableElementFacade>	getGeneralizations() Return all generalizations (ancestors) from this generalizable element.
String	getHibernateCacheType() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateAssociation.hibernateCacheType
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() 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.
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	getRelationName() A name suited for naming this relationship.
PackageFacade	getRootPackage() Gets the root package for the model element.
String	getSchema() The name of the schema that contains the database table
Collection<DependencyFacade>	getSourceDependencies() Gets the dependencies for which this model element is the source.
Collection<GeneralizableElementFacade>	getSpecializations() Gets the direct specializations (i.e.
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.
String	getTableName() The name of the table if this is a many-to-many association.
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
String	getValidationName()
Object	getValidationOwner()
String	getVisibility() The visibility (i.e.
protected abstract int	handleGetEhCacheMaxElementsInMemory()
protected abstract int	handleGetEhCacheTimeToIdleSeconds()
protected abstract int	handleGetEhCacheTimeToLiveSeconds()
protected abstract String	handleGetHibernateCacheType()
protected abstract boolean	handleIsEhCacheEternal()
protected abstract boolean	handleIsEhCacheOverflowToDisk()
protected abstract boolean	handleIsHibernateCacheDistributed()
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	isAbstract() Indicates if this association is 'abstract'.
boolean	isAssociationClass() True if the AssociationFacade is an AssociationClass.
boolean	isAssociationFacadeMetaType()
boolean	isBinary() UML2: Determines whether this association is a binary association, i.e.
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	isDerived() UML2: Returns the value of the 'Is Derived' attribute.
boolean	isDocumentationPresent() Indicates if any documentation is present on this model element.
boolean	isEhCacheEternal() EhCache property.
boolean	isEhCacheOverflowToDisk() EhCache property.
boolean	isEntityAssociation() is this an EntityAssociation?
boolean	isEntityAssociationMetaType()
boolean	isGeneralizableElementFacadeMetaType()
boolean	isHibernateAssociationMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isHibernateCacheDistributed() Specifies whether the cache for this association is distributed.
boolean	isLeaf() True if this association cannot be extended and represent a leaf in the inheritance tree.
boolean	isMany2Many() Indicates whether or not this associations represents a many-to-many relation.
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, 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

HibernateAssociationLogic

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

isHibernateAssociationMetaType

public boolean isHibernateAssociationMetaType()

Description copied from interface: HibernateAssociation

Indicates the metafacade type (used for metafacade mappings).

Specified by:

isHibernateAssociationMetaType in interface HibernateAssociation

Returns:

boolean true always

See Also:

HibernateAssociation

handleGetHibernateCacheType

protected abstract String handleGetHibernateCacheType()

Returns:

String

See Also:

HibernateAssociation.getHibernateCacheType()

getHibernateCacheType

public final String getHibernateCacheType()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateAssociation.hibernateCacheType

Specified by:

getHibernateCacheType in interface HibernateAssociation

Returns:

(String)handleGetHibernateCacheType()

handleIsEhCacheEternal

protected abstract boolean handleIsEhCacheEternal()

Returns:

boolean

See Also:

HibernateAssociation.isEhCacheEternal()

isEhCacheEternal

public final boolean isEhCacheEternal()

EhCache property. Defines if elements are eternal.

Specified by:

isEhCacheEternal in interface HibernateAssociation

Returns:

(boolean)handleIsEhCacheEternal()

handleGetEhCacheMaxElementsInMemory

protected abstract int handleGetEhCacheMaxElementsInMemory()

Returns:

int

See Also:

HibernateAssociation.getEhCacheMaxElementsInMemory()

getEhCacheMaxElementsInMemory

public final int getEhCacheMaxElementsInMemory()

EhCache property. Defines the maximum number of objects that will be created in memory.

Specified by:

getEhCacheMaxElementsInMemory in interface HibernateAssociation

Returns:

(int)handleGetEhCacheMaxElementsInMemory()

handleIsEhCacheOverflowToDisk

protected abstract boolean handleIsEhCacheOverflowToDisk()

Returns:

boolean

See Also:

HibernateAssociation.isEhCacheOverflowToDisk()

isEhCacheOverflowToDisk

public final boolean isEhCacheOverflowToDisk()

EhCache property. Defines if elements can overflow to disk

Specified by:

isEhCacheOverflowToDisk in interface HibernateAssociation

Returns:

(boolean)handleIsEhCacheOverflowToDisk()

handleGetEhCacheTimeToIdleSeconds

protected abstract int handleGetEhCacheTimeToIdleSeconds()

Returns:

int

See Also:

HibernateAssociation.getEhCacheTimeToIdleSeconds()

getEhCacheTimeToIdleSeconds

public final int getEhCacheTimeToIdleSeconds()

EhCache property. Defines the time to idle for an element before it expires.

Specified by:

getEhCacheTimeToIdleSeconds in interface HibernateAssociation

Returns:

(int)handleGetEhCacheTimeToIdleSeconds()

handleGetEhCacheTimeToLiveSeconds

protected abstract int handleGetEhCacheTimeToLiveSeconds()

Returns:

int

See Also:

HibernateAssociation.getEhCacheTimeToLiveSeconds()

getEhCacheTimeToLiveSeconds

public final int getEhCacheTimeToLiveSeconds()

EhCache property. Defines the time to live for an element before it expires.

Specified by:

getEhCacheTimeToLiveSeconds in interface HibernateAssociation

Returns:

(int)handleGetEhCacheTimeToLiveSeconds()

handleIsHibernateCacheDistributed

protected abstract boolean handleIsHibernateCacheDistributed()

Returns:

boolean

See Also:

HibernateAssociation.isHibernateCacheDistributed()

isHibernateCacheDistributed

public final boolean isHibernateCacheDistributed()

Specifies whether the cache for this association is distributed.

Specified by:

isHibernateCacheDistributed in interface HibernateAssociation

Returns:

(boolean)handleIsHibernateCacheDistributed()

isEntityAssociationMetaType

public boolean isEntityAssociationMetaType()

Specified by:

isEntityAssociationMetaType in interface EntityAssociation

Returns:

true

See Also:

EntityAssociation

isAssociationFacadeMetaType

public boolean isAssociationFacadeMetaType()

Specified by:

isAssociationFacadeMetaType in interface AssociationFacade

Returns:

true

See Also:

AssociationFacade

isGeneralizableElementFacadeMetaType

public boolean isGeneralizableElementFacadeMetaType()

Specified by:

isGeneralizableElementFacadeMetaType in interface GeneralizableElementFacade

Returns:

true

See Also:

GeneralizableElementFacade

isModelElementFacadeMetaType

public boolean isModelElementFacadeMetaType()

Specified by:

isModelElementFacadeMetaType in interface ModelElementFacade

Returns:

true

See Also:

ModelElementFacade

getAssociationEndA

public AssociationEndFacade getAssociationEndA()

The first association end.

Specified by:

getAssociationEndA in interface AssociationFacade

See Also:

AssociationFacade.getAssociationEndA()

getAssociationEndB

public AssociationEndFacade getAssociationEndB()

The second association end.

Specified by:

getAssociationEndB in interface AssociationFacade

See Also:

AssociationFacade.getAssociationEndB()

getAssociationEnds

public List<AssociationEndFacade> getAssociationEnds()

Gets the association ends belonging to this association.

Specified by:

getAssociationEnds in interface AssociationFacade

See Also:

AssociationFacade.getAssociationEnds()

getRelationName

public String getRelationName()

A name suited for naming this relationship. This name will be constructed from both association ends.

Specified by:

getRelationName in interface AssociationFacade

See Also:

AssociationFacade.getRelationName()

isAbstract

public boolean isAbstract()

Indicates if this association is 'abstract'.

Specified by:

isAbstract in interface AssociationFacade

See Also:

AssociationFacade.isAbstract()

isAssociationClass

public boolean isAssociationClass()

True if the AssociationFacade is an AssociationClass.

Specified by:

isAssociationClass in interface AssociationFacade

See Also:

AssociationFacade.isAssociationClass()

isBinary

public boolean isBinary()

UML2: Determines whether this association is a binary association, i.e. whether it has exactly two member ends. UML2 allows association classes in the association itself (many2many with association attributes). Default=true: only two member ends.

Specified by:

isBinary in interface AssociationFacade

See Also:

AssociationFacade.isBinary()

isDerived

public boolean isDerived()

UML2: Returns the value of the 'Is Derived' attribute. The default value is "false". If isDerived is true, the value of the attribute is derived from information elsewhere. Specifies whether the Property is derived, i.e., whether its value or values can be computed from other information.

Specified by:

isDerived in interface AssociationFacade

See Also:

AssociationFacade.isDerived()

isLeaf

public boolean isLeaf()

True if this association cannot be extended and represent a leaf in the inheritance tree.

Specified by:

isLeaf in interface AssociationFacade

See Also:

AssociationFacade.isLeaf()

isMany2Many

public boolean isMany2Many()

Indicates whether or not this associations represents a many-to-many relation.

Specified by:

isMany2Many in interface AssociationFacade

See Also:

AssociationFacade.isMany2Many()

getSchema

public String getSchema()

The name of the schema that contains the database table

Specified by:

getSchema in interface EntityAssociation

See Also:

EntityAssociation.getSchema()

getTableName

public String getTableName()

The name of the table if this is a many-to-many association. Otherwise it just returns null if not part of a many-to-many association.

Specified by:

getTableName in interface EntityAssociation

See Also:

EntityAssociation.getTableName()

isEntityAssociation

public boolean isEntityAssociation()

is this an EntityAssociation?

Specified by:

isEntityAssociation in interface EntityAssociation

See Also:

EntityAssociation.isEntityAssociation()

findTaggedValue

public Object findTaggedValue(String tagName,
                     boolean follow)

Finds the tagged value optional searching the entire inheritance hierarchy if 'follow' is set to true.

Specified by:

findTaggedValue in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.findTaggedValue(String tagName, boolean follow)

getAllGeneralizations

public Collection<GeneralizableElementFacade> getAllGeneralizations()

All generalizations for this generalizable element, goes up the inheritance tree.

Specified by:

getAllGeneralizations in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.getAllGeneralizations()

getAllSpecializations

public Collection<GeneralizableElementFacade> getAllSpecializations()

All specializations (travels down the inheritance hierarchy).

Specified by:

getAllSpecializations in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.getAllSpecializations()

getGeneralization

public GeneralizableElementFacade getGeneralization()

Gets the direct generalization for this generalizable element.

Specified by:

getGeneralization in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.getGeneralization()

getGeneralizationLinks

public Collection<GeneralizationFacade> getGeneralizationLinks()

Gets the actual links that this generalization element is part of (it plays either the specialization or generalization).

Specified by:

getGeneralizationLinks in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.getGeneralizationLinks()

getGeneralizationList

public String getGeneralizationList()

A comma separated list of the fully qualified names of all generalizations.

Specified by:

getGeneralizationList in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.getGeneralizationList()

getGeneralizationRoot

public GeneralizableElementFacade getGeneralizationRoot()

The element found when you recursively follow the generalization path up to the root. If an element has no generalization itself will be considered the root.

Specified by:

getGeneralizationRoot in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.getGeneralizationRoot()

getGeneralizations

public Collection<GeneralizableElementFacade> getGeneralizations()

Return all generalizations (ancestors) from this generalizable element.

Specified by:

getGeneralizations in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.getGeneralizations()

getSpecializations

public Collection<GeneralizableElementFacade> getSpecializations()

Gets the direct specializations (i.e. sub elements) for this generalizatble element.

Specified by:

getSpecializations in interface GeneralizableElementFacade

See Also:

GeneralizableElementFacade.getSpecializations()

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

See Also:

MetafacadeBase.getValidationOwner()

getValidationName

public String getValidationName()

Specified by:

getValidationName in interface ModelElementFacade

Overrides:

getValidationName in class MetafacadeBase

Returns:

String getSuperEntityAssociation().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()