org.andromda.cartridges.ejb3.metafacades

Interface EJB3AssociationEndFacade

All Superinterfaces:

AssociationEndFacade, EntityAssociationEnd, ModelElementFacade

All Known Subinterfaces:

EJB3ManageableEntityAssociationEndFacade

All Known Implementing Classes:

EJB3AssociationEndFacadeLogic, EJB3AssociationEndFacadeLogicImpl, EJB3ManageableEntityAssociationEndFacadeLogic, EJB3ManageableEntityAssociationEndFacadeLogicImpl

public interface EJB3AssociationEndFacade
extends EntityAssociationEnd

Represents an EJB association end. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAggregationCascadeType() Returns the default cascade property specified for UML aggregation.
String	getCacheType() Provides the cache policy for the entity association Collection.
String	getCascadeType() Return the cascade type attributes as an array of this association end or null if no relevant cascade attribute is found.
String	getCollectionIndexName() Returns the association end collection index name.
String	getCollectionIndexType() this will only apply for Maps; it will return the type of the attribute specified on the CollectionIndexName tagged value
String	getCollectionType() Returns the collection type defined on this association end using the andromda_persistence_collection_type tagged value.
String	getCollectionTypeImplemenationClass() The fully qualified class name of the collection implementation type.
String	getCollectionTypeImplementation() The actual implementation of the collection type.
String	getCollectionTypeImplementation(String arg) The actual implementation of the collection type.
String	getColumnDefinition() Defines the column definition DDL used when creating table schema - use to override default container DDL.
String	getCompositionCascadeType() Returns the default cascade property specified for UML composition.
String	getDefaultCollectionInterface() Returns the default collection interface from namespace descriptor.
String	getFetchType() Get the fetch type for this association end(CMR).
String	getForeignKeyConstraintName(String suffix) Returns the name of the foreign key constraint to use for name property of org.hibernate.annotations.ForeignKey annotation used for Many-To-One, One-To-One and Many-To-Many relationships.
String	getForeignKeyName(String suffix) Returns the name of the foreign key to use for name property of JoinColumn/InverseJoinColumn used in JoinTable for One-To-Many and Many-To-Many relationships.
String	getGetterLabelName() Returns the getter name for the label name of the display attribute of the manageable entity.
String	getHibernateCascadeType() Returns the Hibernate cascade attribute of this association end.
String	getLabelName() Returns the label name for the association end used as the display attribute for manageable entities.
String	getOrderByClause() The order by clause set to order the returning Collection object on the many side of an association.
String	getSetterLabelName() Returns the setter name for the label name of the display attribute of the manageable entity.
boolean	hasTaggedValue(String name) Returns true if the tagged value with the specified name exists for the association end.
boolean	isAssociationCacheEnabled() Returns true if association caching has been enabled via namespace property hibernateEnableAssociationCache.
boolean	isCollection() Returns true if the collection type is a collection.
boolean	isCollectionInterfaceSortedSet() Returns true if the collection interface for this association end is java.util.SortedSet.
boolean	isColumnNullable() Whether the column can be nullable.
boolean	isEager() Determine if the fetch type for this entity relationship end is eager loading.
boolean	isEJB3AssociationEndFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isForeignKeyConstraintDefined() Returns true if a foreign key constraint has been defined explicitly by the user.
boolean	isHibernateCascadeExists() Returns true if a Hibernate cascade attribute is defined for this association end.
boolean	isLazy() Determine if the fetch type for this entity relationship end is lazy loading.
boolean	isList() Returns true if the collection type is a list.
boolean	isMap() Returns true if the collection type is a map.
boolean	isOptional() Sets the optional attribute on the annotation to determine if a null value is allowed.
boolean	isOwning() Determines if this association end if the owning side.
boolean	isSet() Returns true if the collection type is a set.

Methods inherited from interface org.andromda.metafacades.uml.EntityAssociationEnd

getColumnIndex, getColumnName, getForeignKeyConstraintName, getForeignKeySuffix, getSqlType, getUniqueGroup, isEntityAssociationEndMetaType, isForeignIdentifier, isIdentifier, isIdentifiersPresent, isTransient

Methods inherited from interface org.andromda.metafacades.uml.AssociationEndFacade

getAdderName, getAggregationKind, getAssociation, getDefault, getGetterName, getGetterSetterTypeName, getLower, getOtherEnd, getRemoverName, getSetterName, getType, getUpper, isAggregation, isAssociationEndFacadeMetaType, isBidirectional, isChild, isComposition, isDerived, isLeaf, isMany, isMany2Many, isMany2One, isNavigable, isOne2Many, isOne2One, isOrdered, isReadOnly, isRequired, isStatic, isUnique

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isEJB3AssociationEndFacadeMetaType

boolean isEJB3AssociationEndFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAggregationCascadeType

String getAggregationCascadeType()

Returns the default cascade property specified for UML aggregation.

Returns:

String

getCacheType

String getCacheType()

Provides the cache policy for the entity association Collection. Posible values are NONE, READ_WRITE, NONSTRICT_READ_WRITE, READ_ONLY, TRANSACTIONAL.

Returns:

String

getCascadeType

String getCascadeType()

Return the cascade type attributes as an array of this association end or null if no relevant cascade attribute is found.

Returns:

String

getCollectionIndexName

String getCollectionIndexName()

Returns the association end collection index name.

Returns:

String

getCollectionIndexType

String getCollectionIndexType()

this will only apply for Maps; it will return the type of the attribute specified on the CollectionIndexName tagged value

Returns:

String

getCollectionType

String getCollectionType()

Returns the collection type defined on this association end using the andromda_persistence_collection_type tagged value. If undefined use the following strategy: - If ordered collection type: return a list - Otherwise, return the default association collection type.

Returns:

String

getCollectionTypeImplemenationClass

String getCollectionTypeImplemenationClass()

The fully qualified class name of the collection implementation type.

Returns:

String

getCollectionTypeImplementation

String getCollectionTypeImplementation()

The actual implementation of the collection type.

Returns:

String

getCollectionTypeImplementation

String getCollectionTypeImplementation(String arg)

The actual implementation of the collection type.

Parameters:

arg - String

Returns:

String

getColumnDefinition

String getColumnDefinition()

Defines the column definition DDL used when creating table schema - use to override default container DDL.

Returns:

String

getCompositionCascadeType

String getCompositionCascadeType()

Returns the default cascade property specified for UML composition.

Returns:

String

getDefaultCollectionInterface

String getDefaultCollectionInterface()

Returns the default collection interface from namespace descriptor.

Returns:

String

getFetchType

String getFetchType()

Get the fetch type for this association end(CMR). If no fetch type tagged value is specified and COMPOSITION_DEFINES_EAGER_LOADING is enabled, then:

• aggregation: lazy-loaded
• composition: eager-loaded

Otherwise, the default fetch type for CMR of type One2Many and Many2Many is LAZY. Default fetch type for CMR of type Many2One and One2One is EAGER. This will return either EAGER or LAZY.

Returns:

String

getForeignKeyConstraintName

String getForeignKeyConstraintName(String suffix)

Returns the name of the foreign key constraint to use for name property of org.hibernate.annotations.ForeignKey annotation used for Many-To-One, One-To-One and Many-To-Many relationships.

Parameters:

suffix - String

Returns:

String

getForeignKeyName

String getForeignKeyName(String suffix)

Returns the name of the foreign key to use for name property of JoinColumn/InverseJoinColumn used in JoinTable for One-To-Many and Many-To-Many relationships.

Parameters:

suffix - String

Returns:

String

getGetterLabelName

String getGetterLabelName()

Returns the getter name for the label name of the display attribute of the manageable entity.

Returns:

String

getHibernateCascadeType

String getHibernateCascadeType()

Returns the Hibernate cascade attribute of this association end.

Returns:

String

getLabelName

String getLabelName()

Returns the label name for the association end used as the display attribute for manageable entities.

Returns:

String

getOrderByClause

String getOrderByClause()

The order by clause set to order the returning Collection object on the many side of an association.

Returns:

String

getSetterLabelName

String getSetterLabelName()

Returns the setter name for the label name of the display attribute of the manageable entity.

Returns:

String

hasTaggedValue

boolean hasTaggedValue(String name)

Returns true if the tagged value with the specified name exists for the association end.

Parameters:

name - String

Returns:

boolean

isAssociationCacheEnabled

boolean isAssociationCacheEnabled()

Returns true if association caching has been enabled via namespace property hibernateEnableAssociationCache.

Returns:

boolean

isCollection

boolean isCollection()

Returns true if the collection type is a collection. This will only be the case if the association end multiplicity is defined as ordered.

Returns:

boolean

isCollectionInterfaceSortedSet

boolean isCollectionInterfaceSortedSet()

Returns true if the collection interface for this association end is java.util.SortedSet.

Returns:

boolean

isColumnNullable

boolean isColumnNullable()

Whether the column can be nullable. False for identifier and unique fields. If andromda_persistence_column_nullable tag is set, the tagged value is used. Otherwise, determine if this attribute is required from the multiplicity set on the attribute.

Returns:

boolean

isEager

boolean isEager()

Determine if the fetch type for this entity relationship end is eager loading.

Returns:

boolean

isForeignKeyConstraintDefined

boolean isForeignKeyConstraintDefined()

Returns true if a foreign key constraint has been defined explicitly by the user. Otherwise returns false. This will determine if the ForeignKey annotation will be rendered. We require this because there is no clean way of defining the constraint name for all constraints as there may be a chance that two constraints may have the same name. This vilates the database integrity.

Returns:

boolean

isHibernateCascadeExists

boolean isHibernateCascadeExists()

Returns true if a Hibernate cascade attribute is defined for this association end.

Returns:

boolean

isLazy

boolean isLazy()

Determine if the fetch type for this entity relationship end is lazy loading.

Returns:

boolean

isList

boolean isList()

Returns true if the collection type is a list. This will only be the case if the association end multiplicity is defined as ordered.

Returns:

boolean

isMap

boolean isMap()

Returns true if the collection type is a map. This will only be the case if the association end multiplicity is defined as unordered.

Returns:

boolean

isOptional

boolean isOptional()

Sets the optional attribute on the annotation to determine if a null value is allowed. If set to false, non-null relationships must always exist. If the andromda_persistence_optional tag is set, then use the tagged value, otherwise determine if null value is allowed by way of multiplicity on the association end.

Returns:

boolean

isOwning

boolean isOwning()

Determines if this association end if the owning side. Used in one-to-one and many-to-many relationships.

Returns:

boolean

isSet

boolean isSet()

Returns true if the collection type is a set. This will only be the case if the association end multiplicity is defined as unordered.

Returns:

boolean