org.andromda.metafacades.uml

Interface Entity

All Superinterfaces:

ClassifierFacade, GeneralizableElementFacade, ModelElementFacade

All Known Subinterfaces:

ManageableEntity

public interface Entity
extends ClassifierFacade

Represents a persistent entity. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<DependencyFacade>	getAllEntityReferences() Returns a collection of all entities this entity and its ancestors have a relation to.
String	getAttributeNameList(boolean follow, boolean withIdentifiers) Gets a comma separated list of attribute names.
String	getAttributeNameList(boolean follow, boolean withIdentifiers, boolean withDerived) Gets a comma separated list of attribute names.
Collection<AttributeFacade>	getAttributes(boolean follow, boolean withIdentifiers) Gets all attributes of the entity, and optionally retieves the super entities attributes as well as excludes the entity's identifiers if 'withIdentifiers' is set to false.
Collection<AttributeFacade>	getAttributes(boolean follow, boolean withIdentifiers, boolean withDerived) Gets all attributes of the entity, and optionally retieves the super entities attributes as well as excludes the entity's identifiers if 'withIdentifiers' is set to false and exclude derived attributes if 'withDerived' is set to false.
String	getAttributeTypeList(boolean follow, boolean withIdentifiers) Gets a comma separated list of attribute types.
Collection<OperationFacade>	getBusinessOperations() All business operations of the entity, these include any operations that aren't queries.
Collection<EntityAssociationEnd>	getChildEnds() Gets any children association ends (i.e.
Collection<AttributeFacade>	getEmbeddedValues() The embedded values belonging to this entity.
Collection<DependencyFacade>	getEntityReferences() All entities referenced by this entity.
String	getFullyQualifiedIdentifierTypeName() The full name of the type of the identifier.
Collection<AssociationEndFacade>	getIdentifierAssociationEnds() Gets all the associationEnds of this entity marked with the identifiers stereotype.
String	getIdentifierGetterName() The getter name of the identifier.
String	getIdentifierName() The name of the identifier.
Collection<ModelElementFacade>	getIdentifiers() All the attributes of the entity which make up its identifier (primary key).
Collection<ModelElementFacade>	getIdentifiers(boolean follow) Gets all identifiers for an entity.
String	getIdentifierSetterName() The setter name of the identifier.
String	getIdentifierTypeName() The name of the type of the identifier.
short	getMaxSqlNameLength() The maximum length a SQL name may be.
String	getOperationCallFromAttributes(boolean withIdentifiers) Gets the attributes as a list within an operation call, optionally including the type names and the identifier attributes.
String	getOperationCallFromAttributes(boolean withIdentifiers, boolean follow) Gets the attributes as a list within an operation call.
EntityAssociationEnd	getParentEnd() Returns the parent association end of this entity if its a child entity.
Collection<ModelElementFacade>	getProperties(boolean follow, boolean withIdentifiers) Gets all properties of this entity, this includes the attributes and navigable association ends of the entity.
Collection<EntityQueryOperation>	getQueryOperations() Returns all the operations that can perform queries on the entity.
Collection<OperationFacade>	getQueryOperations(boolean follow) Gets all query operations for an entity.
String	getRequiredAttributeNameList(boolean follow, boolean withIdentifiers) Gets a comma separated list of required attribute names.
Collection<AttributeFacade>	getRequiredAttributes(boolean follow, boolean withIdentifiers) Returns all attributes that are specified as 'required' in the model.
String	getRequiredAttributeTypeList(boolean follow, boolean withIdentifiers) Gets a comma separated list of attribute types with are required.
Collection<ModelElementFacade>	getRequiredProperties(boolean follow, boolean withIdentifiers) Gets all required properties for this entity.
String	getRequiredPropertyNameList(boolean follow, boolean withIdentifiers) Creates a comma separated list of the required property names.
String	getRequiredPropertyTypeList(boolean follow, boolean withIdentifiers) A comma separated list of the required property types.
String	getSchema() The name of the schema that contains the database table
String	getTableName() The name of the database table to which this entity is persisted.
boolean	isChild() Returns true/false depending on whether or not this entity represetns a child in an association (this occurs when this entity is on the opposite end of an assocation end defined as composite).
boolean	isCompositeIdentifier() True if this entity identifier is a composite (consists of multiple key columns, typically abstracted into an external composite identifier class)
boolean	isDynamicIdentifiersPresent() True if the entity has its identifiers dynamically added, false otherwise.
boolean	isEntityMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isIdentifiersPresent() True if the entity has any identifiers defined, false otherwise.
boolean	isUsingAssignedIdentifier() Indiciates if this entity is using an assigned identifier or not.
boolean	isUsingForeignIdentifier() Indicates whether or not this entity is using a foreign identifier as its identifiers.

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

isEntityMetaType

boolean isEntityMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAllEntityReferences

Collection<DependencyFacade> getAllEntityReferences()

Returns a collection of all entities this entity and its ancestors have a relation to.

Returns:

Collection

getAttributeNameList

String getAttributeNameList(boolean follow,
                          boolean withIdentifiers)

Gets a comma separated list of attribute names. If 'follow' is true, will travel up the inheritance hiearchy to include attributes in parent entities as well. If 'withIdentifiers' is true, will include identifiers.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

String

getAttributeNameList

String getAttributeNameList(boolean follow,
                          boolean withIdentifiers,
                          boolean withDerived)

Gets a comma separated list of attribute names. If 'follow' is true, will travel up the inheritance hiearchy to include attributes in parent entities as well. If 'withIdentifiers' is true, will include identifiers and if 'withDerived' is set to true, will include derived attributes.

Parameters:

follow - boolean

withIdentifiers - boolean

withDerived - boolean

Returns:

String

getAttributeTypeList

String getAttributeTypeList(boolean follow,
                          boolean withIdentifiers)

Gets a comma separated list of attribute types. If 'follow' is true, will travel up the inheritance hierarchy to include attributes in parent entities as well. If 'withIdentifiers' is true, will include identifiers.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

String

getAttributes

Collection<AttributeFacade> getAttributes(boolean follow,
                                        boolean withIdentifiers)

Gets all attributes of the entity, and optionally retieves the super entities attributes as well as excludes the entity's identifiers if 'withIdentifiers' is set to false.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

Collection

getAttributes

Collection<AttributeFacade> getAttributes(boolean follow,
                                        boolean withIdentifiers,
                                        boolean withDerived)

Gets all attributes of the entity, and optionally retieves the super entities attributes as well as excludes the entity's identifiers if 'withIdentifiers' is set to false and exclude derived attributes if 'withDerived' is set to false.

Parameters:

follow - boolean

withIdentifiers - boolean

withDerived - boolean

Returns:

Collection

getBusinessOperations

Collection<OperationFacade> getBusinessOperations()

All business operations of the entity, these include any operations that aren't queries.

Returns:

Collection

getChildEnds

Collection<EntityAssociationEnd> getChildEnds()

Gets any children association ends (i.e. entity association ends that are participants in an association with this entity and this entity has composite aggregation defined for those associations).

Returns:

Collection

getEmbeddedValues

Collection<AttributeFacade> getEmbeddedValues()

The embedded values belonging to this entity.

Returns:

Collection

getEntityReferences

Collection<DependencyFacade> getEntityReferences()

All entities referenced by this entity.

Returns:

Collection

getFullyQualifiedIdentifierTypeName

String getFullyQualifiedIdentifierTypeName()

The full name of the type of the identifier. If composite identifier add the PK sufix to the class name. If not, retorns the fully qualified name of the identifier.

Returns:

String

getIdentifierAssociationEnds

Collection<AssociationEndFacade> getIdentifierAssociationEnds()

Gets all the associationEnds of this entity marked with the identifiers stereotype.

Returns:

Collection

getIdentifierGetterName

String getIdentifierGetterName()

The getter name of the identifier.

Returns:

String

getIdentifierName

String getIdentifierName()

The name of the identifier. If composite identifier add the Pk suffix. If not composite returns the attribute name of the identifier.

Returns:

String

getIdentifierSetterName

String getIdentifierSetterName()

The setter name of the identifier.

Returns:

String

getIdentifierTypeName

String getIdentifierTypeName()

The name of the type of the identifier. If composite identifier add the PK suffix to the class name. If not, returns the name of the identifier.

Returns:

String

getIdentifiers

Collection<ModelElementFacade> getIdentifiers()

All the attributes of the entity which make up its identifier (primary key). Will search any super classes as well. If no identifiers exist, a default identifier will be created if the allowDefaultIdentifiers property is set to true.

Returns:

Collection

getIdentifiers

Collection<ModelElementFacade> getIdentifiers(boolean follow)

Gets all identifiers for an entity. If 'follow' is true, and if no identifiers can be found on the entity, a search up the inheritance chain will be performed, and the identifiers from the first super class having them will be used. If no identifiers exist, a default identifier will be created if the allowDefaultIdentifiers property is set to true. Identifiers can be on attributes or associations (composite primary key).

Parameters:

follow - boolean

Returns:

Collection

getMaxSqlNameLength

short getMaxSqlNameLength()

The maximum length a SQL name may be.

Returns:

short

getOperationCallFromAttributes

String getOperationCallFromAttributes(boolean withIdentifiers)

Gets the attributes as a list within an operation call, optionally including the type names and the identifier attributes.

Parameters:

withIdentifiers - boolean

Returns:

String

getOperationCallFromAttributes

String getOperationCallFromAttributes(boolean withIdentifiers,
                                    boolean follow)

Gets the attributes as a list within an operation call. If 'withTypeNames' is true, it will include the type names, if 'withIdentifiers' is true it will include the identifiers. If 'follow' is true it will follow the inheritance hierarchy and get the attributes of the super class as well.

Parameters:

withIdentifiers - boolean

follow - boolean

Returns:

String

getParentEnd

EntityAssociationEnd getParentEnd()

Returns the parent association end of this entity if its a child entity. The parent is the entity that is the participant the association that has composite aggregation defined. Will return null if the entity has no parent.

Returns:

EntityAssociationEnd

getProperties

Collection<ModelElementFacade> getProperties(boolean follow,
                                           boolean withIdentifiers)

Gets all properties of this entity, this includes the attributes and navigable association ends of the entity. The 'follow' flag indcates whether or not the inheritance hierarchy should be followed when getting all the properties. The 'withIdentifiers' flag indicates whether or not identifiers should be included in the collection of properties.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

Collection

getQueryOperations

Collection<EntityQueryOperation> getQueryOperations()

Returns all the operations that can perform queries on the entity.

Returns:

Collection

getQueryOperations

Collection<OperationFacade> getQueryOperations(boolean follow)

Gets all query operations for an entity. If 'follow' is true, and if no query operations can be found on the entity, a search up the inheritance chain will be performed, and the identifiers from the first super class having them will be used. If no identifiers exist, a default identifier will be created if the allowDefaultIdentifiers property is set to true.

Parameters:

follow - boolean

Returns:

Collection

getRequiredAttributeNameList

String getRequiredAttributeNameList(boolean follow,
                                  boolean withIdentifiers)

Gets a comma separated list of required attribute names. If 'follow' is true, will travel up the inheritance hierarchy to include attributes in parent entities as well. If 'withIdentifiers' is true, will include identifiers.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

String

getRequiredAttributeTypeList

String getRequiredAttributeTypeList(boolean follow,
                                  boolean withIdentifiers)

Gets a comma separated list of attribute types with are required. If 'follow' is true, will travel up the inheritance hierarchy to include attributes in parent entities as well. If 'withIdentifiers' is true, will include identifiers.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

String

getRequiredAttributes

Collection<AttributeFacade> getRequiredAttributes(boolean follow,
                                                boolean withIdentifiers)

Returns all attributes that are specified as 'required' in the model. If 'follow' is true, then required attributes in super classes will also be returned, if false, just the ones directly on the entity will be returned. If 'withIdentifiers' is true, the identifiers will be include, if false, no identifiers will be included.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

Collection

getRequiredProperties

Collection<ModelElementFacade> getRequiredProperties(boolean follow,
                                                   boolean withIdentifiers)

Gets all required properties for this entity. These consist of any required attributes as well as navigable associations that are marked as 'required'. If 'follow' is true, then the inheritance hierchy will be followed and all required properties from super classes will be included as well. If 'withIdentifiers' is true, the identifiers will be include, if false, no identifiers will be included.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

Collection

getRequiredPropertyNameList

String getRequiredPropertyNameList(boolean follow,
                                 boolean withIdentifiers)

Creates a comma separated list of the required property names.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

String

getRequiredPropertyTypeList

String getRequiredPropertyTypeList(boolean follow,
                                 boolean withIdentifiers)

A comma separated list of the required property types.

Parameters:

follow - boolean

withIdentifiers - boolean

Returns:

String

getSchema

String getSchema()

The name of the schema that contains the database table

Returns:

String

getTableName

String getTableName()

The name of the database table to which this entity is persisted.

Returns:

String

isChild

boolean isChild()

Returns true/false depending on whether or not this entity represetns a child in an association (this occurs when this entity is on the opposite end of an assocation end defined as composite).

Returns:

boolean

isCompositeIdentifier

boolean isCompositeIdentifier()

True if this entity identifier is a composite (consists of multiple key columns, typically abstracted into an external composite identifier class)

Returns:

boolean

isDynamicIdentifiersPresent

boolean isDynamicIdentifiersPresent()

True if the entity has its identifiers dynamically added, false otherwise.

Returns:

boolean

isIdentifiersPresent

boolean isIdentifiersPresent()

True if the entity has any identifiers defined, false otherwise.

Returns:

boolean

isUsingAssignedIdentifier

boolean isUsingAssignedIdentifier()

Indiciates if this entity is using an assigned identifier or not.

Returns:

boolean

isUsingForeignIdentifier

boolean isUsingForeignIdentifier()

Indicates whether or not this entity is using a foreign identifier as its identifiers. That is: the foreignIdentifier flag was set on an incoming association end and the entity is therefore using the related foreign parent entity's identifier.

Returns:

boolean