org.andromda.cartridges.ejb.metafacades

Interface EJBEntityFacade

All Superinterfaces:

ClassifierFacade, Entity, GeneralizableElementFacade, ModelElementFacade

All Known Implementing Classes:

EJBEntityFacadeLogic, EJBEntityFacadeLogicImpl

public interface EJBEntityFacade
extends Entity

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

Method Summary

Methods

Modifier and Type	Method and Description
Collection	getAllEntityRelations() Find all associations that define relations to other entities.
List	getAllInstanceAttributes() All instanceAttributes for this entity.
Collection	getConstants(boolean follow) Gets all constants for this entity.
Collection	getCreateMethods(boolean follow) Gets create methods for the entity.
Collection	getEntityRelations() TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.entityRelations
Collection	getEnvironmentEntries(boolean follow) Gets all env-entries for the specified entity EJB.
String	getHomeInterfaceName() A String representing the name of a home interface for this entity EJB.
List	getInheritedInstanceAttributes() All inherited instanceAttributes this class.
String	getJndiName() TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.jndiName
Collection	getSelectMethods(boolean follow) Gets select methods for the entity, if all is set to 'true' then ALL select methods will be retrieved (including those inherited from any superclasses).
String	getSqlType() TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.getSqlType
String	getTransactionType() Gets the transaction type for this entity (i.e.
Collection	getValueDependencies() TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.valueDependencies
String	getViewType() A string indicating whether the Bean is a local or remotely accessable bean.
boolean	isAttributePresent(String att) TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.isAttributePresent
boolean	isEJBEntityFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isIdentifierPresent(String id) TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.isIdentifierPresent
boolean	isOperationPresent(String op) TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.isOperationPresent
boolean	isSyntheticCreateMethodAllowed() Whether or not to allow a synthetic (auto generated) create method.

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

getAllEntityReferences, getAttributeNameList, getAttributeNameList, getAttributes, getAttributes, getAttributeTypeList, getBusinessOperations, getChildEnds, getEmbeddedValues, getEntityReferences, getFullyQualifiedIdentifierTypeName, getIdentifierAssociationEnds, getIdentifierGetterName, getIdentifierName, getIdentifiers, getIdentifiers, getIdentifierSetterName, getIdentifierTypeName, getMaxSqlNameLength, getOperationCallFromAttributes, getOperationCallFromAttributes, getParentEnd, getProperties, getQueryOperations, getQueryOperations, getRequiredAttributeNameList, getRequiredAttributes, getRequiredAttributeTypeList, getRequiredProperties, getRequiredPropertyNameList, getRequiredPropertyTypeList, getSchema, getTableName, isChild, isCompositeIdentifier, isDynamicIdentifiersPresent, isEntityMetaType, isIdentifiersPresent, isUsingAssignedIdentifier, isUsingForeignIdentifier

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

findAttribute, getAbstractions, getAllAssociatedClasses, getAllProperties, getAllRequiredConstructorParameters, getArray, getArrayName, getAssociatedClasses, getAssociationEnds, getAttributes, getAttributes, getFullyQualifiedArrayName, getImplementationOperations, getImplementedInterfaceList, getInstanceAttributes, getInstanceOperations, getInterfaceAbstractions, getJavaNewString, getJavaNullString, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getProperties, getProperties, getRequiredConstructorParameters, getSerialVersionUID, getStaticAttributes, getStaticOperations, getSuperClass, getWrapperName, isAbstract, isArrayType, isAssociationClass, isBlobType, isBooleanType, isCharacterType, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

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

findTaggedValue, getAllGeneralizations, getAllSpecializations, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getSpecializations, isGeneralizableElementFacadeMetaType

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

isEJBEntityFacadeMetaType

boolean isEJBEntityFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAllEntityRelations

Collection getAllEntityRelations()

Find all associations that define relations to other entities. This method returns the source association ends for all associations that define a container managed relation. The returned collection includes both direct relations and inherited relations. A direct relation is an association with some other class matching the following criteria: 1) The class at the other side of the association is stereotyped <> 2) The association is navigable from to the other side. An inherited relation is an association from an abstract super type matching the following criteria: 1) The inheritance path to this abstract super type, including this super type itself, consists only of abstract classes with stereotype <> 2) The class at the other side of the association is stereotyped <>. 3) The association is navigable from this abstract super type to the other side. Relations must match the following integrity constraint: - The <> at the target end is not abstract. The integrity constraint is necessary because the target of a container managed relation in the EJB framework must be a concrete entity bean; there is no such thing as an "abstract entity bean" in the EJB specification. It is possible, however, to generate and compile code for this case, an error will only show up at deploy time. In order to catch this kind of error at the earliest possible stage, this method checks the integrity constraint and throws an exception if it is violated.

Returns:

Collection

getAllInstanceAttributes

List getAllInstanceAttributes()

All instanceAttributes for this entity. The list includes the instanceAttributes that are inherited from super classes. The list contains the inherited instanceAttributes first, followed by the instanceAttributes defined in this class.

Returns:

List

getConstants

Collection getConstants(boolean follow)

Gets all constants for this entity. Constants are defined as static read-only attributes which do NOT have the <> stereotype. If 'follow' is true, then the inheritance hierachy will be followed and we'll retrieve all constants from any super types as well.

Parameters:

follow - boolean

Returns:

Collection

getCreateMethods

Collection getCreateMethods(boolean follow)

Gets create methods for the entity. If 'follow'l is set to true, create methods from any super types will also be retrieved by following up the inheritance chain.

Parameters:

follow - boolean

Returns:

Collection

getEntityRelations

Collection getEntityRelations()

TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.entityRelations

Returns:

Collection

getEnvironmentEntries

Collection getEnvironmentEntries(boolean follow)

Gets all env-entries for the specified entity EJB. Env-entries are stored as static attributes on the entity and stereotyped as <>. If 'follow' is true, then the inheritance hierachy will be followed and we'll retrieve all env-entries from any super types as well.

Parameters:

follow - boolean

Returns:

Collection

getHomeInterfaceName

String getHomeInterfaceName()

A String representing the name of a home interface for this entity EJB.

Returns:

String

getInheritedInstanceAttributes

List getInheritedInstanceAttributes()

All inherited instanceAttributes this class. The instanceAttributes are grouped by the class that defines the instanceAttributes, with instanceAttributes from the most removed super class first.

Returns:

List

getJndiName

String getJndiName()

TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.jndiName

Returns:

String

getSelectMethods

Collection getSelectMethods(boolean follow)

Gets select methods for the entity, if all is set to 'true' then ALL select methods will be retrieved (including those inherited from any superclasses).

Parameters:

follow - boolean

Returns:

Collection

getSqlType

String getSqlType()

TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.getSqlType

Returns:

String

getTransactionType

String getTransactionType()

Gets the transaction type for this entity (i.e. REQUIRED, etc)

Returns:

String

getValueDependencies

Collection getValueDependencies()

TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.valueDependencies

Returns:

Collection

getViewType

String getViewType()

A string indicating whether the Bean is a local or remotely accessable bean.

Returns:

String

isAttributePresent

boolean isAttributePresent(String att)

TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.isAttributePresent

Parameters:

att - String

Returns:

boolean

isIdentifierPresent

boolean isIdentifierPresent(String id)

TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.isIdentifierPresent

Parameters:

id - String

Returns:

boolean

isOperationPresent

boolean isOperationPresent(String op)

TODO: Model Documentation for org.andromda.cartridges.ejb.metafacades.EJBEntityFacade.isOperationPresent

Parameters:

op - String

Returns:

boolean

isSyntheticCreateMethodAllowed

boolean isSyntheticCreateMethodAllowed()

Whether or not to allow a synthetic (auto generated) create method.

Returns:

boolean