org.andromda.metafacades.uml14

Class EntityLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.ModelElementFacadeLogic

org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

org.andromda.metafacades.uml14.GeneralizableElementFacadeLogic

org.andromda.metafacades.uml14.GeneralizableElementFacadeLogicImpl

org.andromda.metafacades.uml14.ClassifierFacadeLogic

org.andromda.metafacades.uml14.ClassifierFacadeLogicImpl

org.andromda.metafacades.uml14.EntityLogic

All Implemented Interfaces:

Serializable, Comparable, ClassifierFacade, Entity, GeneralizableElementFacade, ModelElementFacade

Direct Known Subclasses:

EntityLogicImpl

public abstract class EntityLogic
extends ClassifierFacadeLogicImpl
implements Entity

Represents a persistent entity. MetafacadeLogic for Entity

See Also:

Entity, 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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityLogic(Object metaObjectIn, String context) Create Metafacade implementation instance using the MetafacadeFactory from the context

Method Summary

Methods

Modifier and Type	Method and Description
Collection<DependencyFacade>	getAllEntityReferences() Represents a persistent entity.
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() Represents a persistent entity.
Collection<EntityAssociationEnd>	getChildEnds() Represents a persistent entity.
Collection<AttributeFacade>	getEmbeddedValues() The embedded values belonging to this entity.
Collection<DependencyFacade>	getEntityReferences() Represents a persistent 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() Represents a persistent entity.
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() Represents a persistent 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() Represents a persistent 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.
protected abstract Collection	handleGetAllEntityReferences() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetAttributeNameList(boolean follow, boolean withIdentifiers) Method to be implemented in descendants Gets a comma separated list of attribute names.
protected abstract String	handleGetAttributeNameList(boolean follow, boolean withIdentifiers, boolean withDerived) Method to be implemented in descendants Gets a comma separated list of attribute names.
protected abstract Collection<AttributeFacade>	handleGetAttributes(boolean follow, boolean withIdentifiers) Method to be implemented in descendants 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.
protected abstract Collection<AttributeFacade>	handleGetAttributes(boolean follow, boolean withIdentifiers, boolean withDerived) Method to be implemented in descendants 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.
protected abstract String	handleGetAttributeTypeList(boolean follow, boolean withIdentifiers) Method to be implemented in descendants Gets a comma separated list of attribute types.
protected abstract Collection	handleGetBusinessOperations() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection	handleGetChildEnds() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection<AttributeFacade>	handleGetEmbeddedValues()
protected abstract Collection	handleGetEntityReferences() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetFullyQualifiedIdentifierTypeName()
protected abstract Collection<AssociationEndFacade>	handleGetIdentifierAssociationEnds() Method to be implemented in descendants Gets all the associationEnds of this entity marked with the identifiers stereotype.
protected abstract String	handleGetIdentifierGetterName()
protected abstract String	handleGetIdentifierName()
protected abstract Collection	handleGetIdentifiers() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection<ModelElementFacade>	handleGetIdentifiers(boolean follow) Method to be implemented in descendants Gets all identifiers for an entity.
protected abstract String	handleGetIdentifierSetterName()
protected abstract String	handleGetIdentifierTypeName()
protected abstract short	handleGetMaxSqlNameLength()
protected abstract String	handleGetOperationCallFromAttributes(boolean withIdentifiers) Method to be implemented in descendants Gets the attributes as a list within an operation call, optionally including the type names and the identifier attributes.
protected abstract String	handleGetOperationCallFromAttributes(boolean withIdentifiers, boolean follow) Method to be implemented in descendants Gets the attributes as a list within an operation call.
protected abstract Object	handleGetParentEnd() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection<ModelElementFacade>	handleGetProperties(boolean follow, boolean withIdentifiers) Method to be implemented in descendants Gets all properties of this entity, this includes the attributes and navigable association ends of the entity.
protected abstract Collection	handleGetQueryOperations() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection<OperationFacade>	handleGetQueryOperations(boolean follow) Method to be implemented in descendants Gets all query operations for an entity.
protected abstract String	handleGetRequiredAttributeNameList(boolean follow, boolean withIdentifiers) Method to be implemented in descendants Gets a comma separated list of required attribute names.
protected abstract Collection<AttributeFacade>	handleGetRequiredAttributes(boolean follow, boolean withIdentifiers) Method to be implemented in descendants Returns all attributes that are specified as 'required' in the model.
protected abstract String	handleGetRequiredAttributeTypeList(boolean follow, boolean withIdentifiers) Method to be implemented in descendants Gets a comma separated list of attribute types with are required.
protected abstract Collection<ModelElementFacade>	handleGetRequiredProperties(boolean follow, boolean withIdentifiers) Method to be implemented in descendants Gets all required properties for this entity.
protected abstract String	handleGetRequiredPropertyNameList(boolean follow, boolean withIdentifiers) Method to be implemented in descendants Creates a comma separated list of the required property names.
protected abstract String	handleGetRequiredPropertyTypeList(boolean follow, boolean withIdentifiers) Method to be implemented in descendants A comma separated list of the required property types.
protected abstract String	handleGetSchema()
protected abstract String	handleGetTableName()
protected abstract boolean	handleIsChild()
protected abstract boolean	handleIsCompositeIdentifier()
protected abstract boolean	handleIsDynamicIdentifiersPresent()
protected abstract boolean	handleIsIdentifiersPresent()
protected abstract boolean	handleIsUsingAssignedIdentifier()
protected abstract boolean	handleIsUsingForeignIdentifier()
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()
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.
void	resetMetafacadeContext(String context) Reset context only for non-root metafacades
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::metafacades::uml::Entity::entity must have at least one primary key

Methods inherited from class org.andromda.metafacades.uml14.ClassifierFacadeLogicImpl

getOwner, getWrapperMappings, handleFindAttribute, handleGetAbstractions, handleGetAllAssociatedClasses, handleGetAllProperties, handleGetAllRequiredConstructorParameters, handleGetArray, handleGetArrayName, handleGetAssociatedClasses, handleGetAssociationEnds, handleGetAttributes, handleGetAttributes, handleGetFullyQualifiedArrayName, handleGetImplementationOperations, handleGetImplementedInterfaceList, handleGetInstanceAttributes, handleGetInstanceOperations, handleGetInterfaceAbstractions, handleGetJavaNewString, handleGetJavaNullString, handleGetName, handleGetNavigableConnectingEnds, handleGetNavigableConnectingEnds, handleGetNonArray, handleGetOperationCallFromAttributes, handleGetOperations, handleGetProperties, handleGetProperties, handleGetRequiredConstructorParameters, handleGetSerialVersionUID, handleGetStaticAttributes, handleGetStaticOperations, handleGetSuperClass, handleGetWrapperName, handleIsAbstract, handleIsArrayType, handleIsAssociationClass, handleIsBlobType, handleIsBooleanType, handleIsCharacterType, handleIsClobType, handleIsCollectionType, handleIsDataType, handleIsDateType, handleIsDoubleType, handleIsEmbeddedValue, handleIsEnumeration, handleIsFileType, handleIsFloatType, handleIsIntegerType, handleIsInterface, handleIsLeaf, handleIsListType, handleIsLongType, handleIsMapType, handleIsPrimitive, handleIsSetType, handleIsStringType, handleIsTimeType, handleIsWrappedPrimitive

Methods inherited from class org.andromda.metafacades.uml14.ClassifierFacadeLogic

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 class org.andromda.metafacades.uml14.GeneralizableElementFacadeLogicImpl

handleFindTaggedValue, handleGetAllGeneralizations, handleGetAllSpecializations, handleGetGeneralization, handleGetGeneralizationLinks, handleGetGeneralizationList, handleGetGeneralizationRoot, handleGetGeneralizations, handleGetSpecializations

Methods inherited from class org.andromda.metafacades.uml14.GeneralizableElementFacadeLogic

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

Methods inherited from class org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

getArraySuffix, getValidationName, handleCopyTaggedValues, handleFindTaggedValue, handleFindTaggedValues, handleGetBindedFullyQualifiedName, handleGetConstraints, handleGetConstraints, handleGetDocumentation, handleGetDocumentation, handleGetDocumentation, handleGetFullyQualifiedName, handleGetFullyQualifiedName, handleGetFullyQualifiedNamePath, handleGetId, handleGetKeywords, handleGetLabel, handleGetLanguageMappings, handleGetModel, handleGetOwnedElements, handleGetOwner, handleGetPackage, handleGetPackageName, handleGetPackageName, handleGetPackagePath, handleGetQualifiedName, handleGetRootPackage, handleGetSourceDependencies, handleGetStateMachineContext, handleGetStereotypeNames, handleGetStereotypes, handleGetTaggedValues, handleGetTargetDependencies, handleGetTemplateParameter, handleGetTemplateParameters, handleGetVisibility, handleHasExactStereotype, handleHasKeyword, handleHasStereotype, handleIsBindingDependenciesPresent, handleIsConstraintsPresent, handleIsDocumentationPresent, handleIsReservedWord, handleIsTemplateParametersPresent, handleIsValidIdentifierName, handleTranslateConstraint, handleTranslateConstraints, handleTranslateConstraints

Methods inherited from class org.andromda.metafacades.uml14.ModelElementFacadeLogic

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, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, toString, translateConstraint, translateConstraints, translateConstraints

Methods inherited from class org.andromda.core.metafacade.MetafacadeBase

compareTo, equals, getConfiguredProperty, getDebug, getMetafacadeContext, getMetaObject, getValidationOwner, hashCode, initialize, isConfiguredProperty, isMetafacadePropertyCachingEnabled, setMetafacadeContext, setProperty, shieldedElement, shieldedElements, THIS, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Field Detail

metaObject

protected Object metaObject

The underlying UML object

See Also:

Object

Constructor Detail

EntityLogic

protected EntityLogic(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 ClassifierFacadeLogic

Parameters:

context -

isEntityMetaType

public boolean isEntityMetaType()

Specified by:

isEntityMetaType in interface Entity

Returns:

boolean true always

See Also:

Entity

handleIsChild

protected abstract boolean handleIsChild()

Returns:

boolean

See Also:

Entity.isChild()

isChild

public final 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).

Specified by:

isChild in interface Entity

Returns:

(boolean)handleIsChild()

handleGetTableName

protected abstract String handleGetTableName()

Returns:

String

See Also:

Entity.getTableName()

getTableName

public final String getTableName()

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

Specified by:

getTableName in interface Entity

Returns:

(String)handleGetTableName()

handleIsIdentifiersPresent

protected abstract boolean handleIsIdentifiersPresent()

Returns:

boolean

See Also:

Entity.isIdentifiersPresent()

isIdentifiersPresent

public final boolean isIdentifiersPresent()

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

Specified by:

isIdentifiersPresent in interface Entity

Returns:

(boolean)handleIsIdentifiersPresent()

handleGetMaxSqlNameLength

protected abstract short handleGetMaxSqlNameLength()

Returns:

short

See Also:

Entity.getMaxSqlNameLength()

getMaxSqlNameLength

public final short getMaxSqlNameLength()

The maximum length a SQL name may be.

Specified by:

getMaxSqlNameLength in interface Entity

Returns:

(short)handleGetMaxSqlNameLength()

handleIsUsingForeignIdentifier

protected abstract boolean handleIsUsingForeignIdentifier()

Returns:

boolean

See Also:

Entity.isUsingForeignIdentifier()

isUsingForeignIdentifier

public final 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.

Specified by:

isUsingForeignIdentifier in interface Entity

Returns:

(boolean)handleIsUsingForeignIdentifier()

handleIsDynamicIdentifiersPresent

protected abstract boolean handleIsDynamicIdentifiersPresent()

Returns:

boolean

See Also:

Entity.isDynamicIdentifiersPresent()

isDynamicIdentifiersPresent

public final boolean isDynamicIdentifiersPresent()

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

Specified by:

isDynamicIdentifiersPresent in interface Entity

Returns:

(boolean)handleIsDynamicIdentifiersPresent()

handleIsUsingAssignedIdentifier

protected abstract boolean handleIsUsingAssignedIdentifier()

Returns:

boolean

See Also:

Entity.isUsingAssignedIdentifier()

isUsingAssignedIdentifier

public final boolean isUsingAssignedIdentifier()

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

Specified by:

isUsingAssignedIdentifier in interface Entity

Returns:

(boolean)handleIsUsingAssignedIdentifier()

handleGetSchema

protected abstract String handleGetSchema()

Returns:

String

See Also:

Entity.getSchema()

getSchema

public final String getSchema()

The name of the schema that contains the database table

Specified by:

getSchema in interface Entity

Returns:

(String)handleGetSchema()

handleIsCompositeIdentifier

protected abstract boolean handleIsCompositeIdentifier()

Returns:

boolean

See Also:

Entity.isCompositeIdentifier()

isCompositeIdentifier

public final boolean isCompositeIdentifier()

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

Specified by:

isCompositeIdentifier in interface Entity

Returns:

(boolean)handleIsCompositeIdentifier()

handleGetEmbeddedValues

protected abstract Collection<AttributeFacade> handleGetEmbeddedValues()

Returns:

Collection

See Also:

Entity.getEmbeddedValues()

getEmbeddedValues

public final Collection<AttributeFacade> getEmbeddedValues()

The embedded values belonging to this entity.

Specified by:

getEmbeddedValues in interface Entity

Returns:

(Collection)handleGetEmbeddedValues()

handleGetFullyQualifiedIdentifierTypeName

protected abstract String handleGetFullyQualifiedIdentifierTypeName()

Returns:

String

See Also:

Entity.getFullyQualifiedIdentifierTypeName()

getFullyQualifiedIdentifierTypeName

public final 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.

Specified by:

getFullyQualifiedIdentifierTypeName in interface Entity

Returns:

(String)handleGetFullyQualifiedIdentifierTypeName()

handleGetIdentifierGetterName

protected abstract String handleGetIdentifierGetterName()

Returns:

String

See Also:

Entity.getIdentifierGetterName()

getIdentifierGetterName

public final String getIdentifierGetterName()

The getter name of the identifier.

Specified by:

getIdentifierGetterName in interface Entity

Returns:

(String)handleGetIdentifierGetterName()

handleGetIdentifierName

protected abstract String handleGetIdentifierName()

Returns:

String

See Also:

Entity.getIdentifierName()

getIdentifierName

public final String getIdentifierName()

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

Specified by:

getIdentifierName in interface Entity

Returns:

(String)handleGetIdentifierName()

handleGetIdentifierSetterName

protected abstract String handleGetIdentifierSetterName()

Returns:

String

See Also:

Entity.getIdentifierSetterName()

getIdentifierSetterName

public final String getIdentifierSetterName()

The setter name of the identifier.

Specified by:

getIdentifierSetterName in interface Entity

Returns:

(String)handleGetIdentifierSetterName()

handleGetIdentifierTypeName

protected abstract String handleGetIdentifierTypeName()

Returns:

String

See Also:

Entity.getIdentifierTypeName()

getIdentifierTypeName

public final 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.

Specified by:

getIdentifierTypeName in interface Entity

Returns:

(String)handleGetIdentifierTypeName()

handleGetOperationCallFromAttributes

protected abstract String handleGetOperationCallFromAttributes(boolean withIdentifiers)

Method to be implemented in descendants Gets the attributes as a list within an operation call, optionally including the type names and the identifier attributes.

Parameters:

withIdentifiers -

Returns:

String

getOperationCallFromAttributes

public String getOperationCallFromAttributes(boolean withIdentifiers)

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

Specified by:

getOperationCallFromAttributes in interface Entity

Parameters:

withIdentifiers - boolean True if you want to include identifiers within the attribute list, false otherwise.

Returns:

handleGetOperationCallFromAttributes(withIdentifiers)

handleGetIdentifiers

protected abstract Collection<ModelElementFacade> handleGetIdentifiers(boolean follow)

Method to be implemented in descendants 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 -

Returns:

Collection

getIdentifiers

public 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).

Specified by:

getIdentifiers in interface Entity

Parameters:

follow - boolean TODO: Model Documentation for Entity.getIdentifiers(follow)

Returns:

handleGetIdentifiers(follow)

handleGetOperationCallFromAttributes

protected abstract String handleGetOperationCallFromAttributes(boolean withIdentifiers,
                                          boolean follow)

Method to be implemented in descendants 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 -

follow -

Returns:

String

getOperationCallFromAttributes

public 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.

Specified by:

getOperationCallFromAttributes in interface Entity

Parameters:

withIdentifiers - boolean If true, identifiers will be included in the list.

follow - boolean If this is true, the inheritance hierarchy will be followed when retrieving all attrbutes.

Returns:

handleGetOperationCallFromAttributes(withIdentifiers, follow)

handleGetRequiredAttributes

protected abstract Collection<AttributeFacade> handleGetRequiredAttributes(boolean follow,
                                                      boolean withIdentifiers)

Method to be implemented in descendants 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 -

withIdentifiers -

Returns:

Collection

getRequiredAttributes

public 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.

Specified by:

getRequiredAttributes in interface Entity

Parameters:

follow - boolean Whether or not to follow the inheritance hierarchy when retreiving the attributes. If true, the required attributes in super classes will also be returned, if false, just the ones directly on the entity will be returned.

withIdentifiers - boolean Whether or not to include identifiers in the list of required attributes.

Returns:

handleGetRequiredAttributes(follow, withIdentifiers)

handleGetRequiredProperties

protected abstract Collection<ModelElementFacade> handleGetRequiredProperties(boolean follow,
                                                         boolean withIdentifiers)

Method to be implemented in descendants 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 -

withIdentifiers -

Returns:

Collection

getRequiredProperties

public 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.

Specified by:

getRequiredProperties in interface Entity

Parameters:

follow - boolean Whether or not to follow the inheritance hierarchy when retreiving the properties. If true, the required propertis in super classes will also be returned, if false, just the ones directly on the entity will be returned.

withIdentifiers - boolean Whether or not to include identifiers in the list of required attributes.

Returns:

handleGetRequiredProperties(follow, withIdentifiers)

handleGetAttributes

protected abstract Collection<AttributeFacade> handleGetAttributes(boolean follow,
                                              boolean withIdentifiers)

Method to be implemented in descendants 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 -

withIdentifiers -

Returns:

Collection

getAttributes

public 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.

Specified by:

getAttributes in interface Entity

Parameters:

follow - boolean Whether or not to follow the inheritance hierarchy when retreiving attributes.

withIdentifiers - boolean Whether or not to include identifiers in the returned attributes.

Returns:

handleGetAttributes(follow, withIdentifiers)

handleGetAttributeTypeList

protected abstract String handleGetAttributeTypeList(boolean follow,
                                boolean withIdentifiers)

Method to be implemented in descendants 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 -

withIdentifiers -

Returns:

String

getAttributeTypeList

public 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.

Specified by:

getAttributeTypeList in interface Entity

Parameters:

follow - boolean Whether or not to 'follow' the inheritance hierarchy.

withIdentifiers - boolean Whether or not to include identifiers.

Returns:

handleGetAttributeTypeList(follow, withIdentifiers)

handleGetAttributeNameList

protected abstract String handleGetAttributeNameList(boolean follow,
                                boolean withIdentifiers)

Method to be implemented in descendants 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 -

withIdentifiers -

Returns:

String

getAttributeNameList

public 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.

Specified by:

getAttributeNameList in interface Entity

Parameters:

follow - boolean Whether or not to 'follow' the inheritance hierarchy.

withIdentifiers - boolean Whether or not to include identifiers in the returned attributes.

Returns:

handleGetAttributeNameList(follow, withIdentifiers)

handleGetRequiredAttributeTypeList

protected abstract String handleGetRequiredAttributeTypeList(boolean follow,
                                        boolean withIdentifiers)

Method to be implemented in descendants 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 -

withIdentifiers -

Returns:

String

getRequiredAttributeTypeList

public 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.

Specified by:

getRequiredAttributeTypeList in interface Entity

Parameters:

follow - boolean Whether or not to 'follow' the inheritance hierarchy.

withIdentifiers - boolean Whether or not to include identifiers in the list of required attributes.

Returns:

handleGetRequiredAttributeTypeList(follow, withIdentifiers)

handleGetRequiredAttributeNameList

protected abstract String handleGetRequiredAttributeNameList(boolean follow,
                                        boolean withIdentifiers)

Method to be implemented in descendants 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 -

withIdentifiers -

Returns:

String

getRequiredAttributeNameList

public 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.

Specified by:

getRequiredAttributeNameList in interface Entity

Parameters:

follow - boolean Whether or not to follow the inheritance hierarchy when retreiving the attributes. If true, the required attributes in super classes will also be used, if false, just the ones directly on the entity will be added to the list.

withIdentifiers - boolean Whether or not to include identifiers in the list of required attribute names.

Returns:

handleGetRequiredAttributeNameList(follow, withIdentifiers)

handleGetQueryOperations

protected abstract Collection<OperationFacade> handleGetQueryOperations(boolean follow)

Method to be implemented in descendants 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 -

Returns:

Collection

getQueryOperations

public 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.

Specified by:

getQueryOperations in interface Entity

Parameters:

follow - boolean TODO: Model Documentation for Entity.getQueryOperations(follow)

Returns:

handleGetQueryOperations(follow)

handleGetRequiredPropertyNameList

protected abstract String handleGetRequiredPropertyNameList(boolean follow,
                                       boolean withIdentifiers)

Method to be implemented in descendants Creates a comma separated list of the required property names.

Parameters:

follow -

withIdentifiers -

Returns:

String

getRequiredPropertyNameList

public String getRequiredPropertyNameList(boolean follow,
                                 boolean withIdentifiers)

Creates a comma separated list of the required property names.

Specified by:

getRequiredPropertyNameList in interface Entity

Parameters:

follow - boolean Whether or not to follow the inheritance hierarchy when retrieving the properties.

withIdentifiers - boolean Whether or not to include identifiers in the list.

Returns:

handleGetRequiredPropertyNameList(follow, withIdentifiers)

handleGetRequiredPropertyTypeList

protected abstract String handleGetRequiredPropertyTypeList(boolean follow,
                                       boolean withIdentifiers)

Method to be implemented in descendants A comma separated list of the required property types.

Parameters:

follow -

withIdentifiers -

Returns:

String

getRequiredPropertyTypeList

public String getRequiredPropertyTypeList(boolean follow,
                                 boolean withIdentifiers)

A comma separated list of the required property types.

Specified by:

getRequiredPropertyTypeList in interface Entity

Parameters:

follow - boolean Whether or not to follow the inheritance hierarchy

withIdentifiers - boolean Whether or not to include identifiers in the list.

Returns:

handleGetRequiredPropertyTypeList(follow, withIdentifiers)

handleGetProperties

protected abstract Collection<ModelElementFacade> handleGetProperties(boolean follow,
                                                 boolean withIdentifiers)

Method to be implemented in descendants 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 -

withIdentifiers -

Returns:

Collection

getProperties

public 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.

Specified by:

getProperties in interface Entity

Parameters:

follow - boolean TODO: Model Documentation for Entity.getProperties(follow)

withIdentifiers - boolean TODO: Model Documentation for Entity.getProperties(withIdentifiers)

Returns:

handleGetProperties(follow, withIdentifiers)

handleGetIdentifierAssociationEnds

protected abstract Collection<AssociationEndFacade> handleGetIdentifierAssociationEnds()

Method to be implemented in descendants Gets all the associationEnds of this entity marked with the identifiers stereotype.

Returns:

Collection

getIdentifierAssociationEnds

public Collection<AssociationEndFacade> getIdentifierAssociationEnds()

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

Specified by:

getIdentifierAssociationEnds in interface Entity

Returns:

handleGetIdentifierAssociationEnds()

handleGetAttributes

protected abstract Collection<AttributeFacade> handleGetAttributes(boolean follow,
                                              boolean withIdentifiers,
                                              boolean withDerived)

Method to be implemented in descendants 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 -

withIdentifiers -

withDerived -

Returns:

Collection

getAttributes

public 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.

Specified by:

getAttributes in interface Entity

Parameters:

follow - boolean Whether or not to follow the inheritance hierarchy when retreiving attributes.

withIdentifiers - boolean Whether or not to include identifiers in the returned attributes.

withDerived - boolean Whether or not to include derived attributes in the returned attributes.

Returns:

handleGetAttributes(follow, withIdentifiers, withDerived)

handleGetAttributeNameList

protected abstract String handleGetAttributeNameList(boolean follow,
                                boolean withIdentifiers,
                                boolean withDerived)

Method to be implemented in descendants 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 -

withIdentifiers -

withDerived -

Returns:

String

getAttributeNameList

public 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.

Specified by:

getAttributeNameList in interface Entity

Parameters:

follow - boolean Whether or not to 'follow' the inheritance hierarchy.

withIdentifiers - boolean Whether or not to include identifiers in the returned attributes.

withDerived - boolean Whether or not to include derived attributes in the returned attributes.

Returns:

handleGetAttributeNameList(follow, withIdentifiers, withDerived)

getEntityReferences

public final Collection<DependencyFacade> getEntityReferences()

Represents a persistent entity.

Specified by:

getEntityReferences in interface Entity

Returns:

(Collection)handleGetEntityReferences()

handleGetEntityReferences

protected abstract Collection handleGetEntityReferences()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

getParentEnd

public final EntityAssociationEnd getParentEnd()

Represents a persistent entity.

Specified by:

getParentEnd in interface Entity

Returns:

(EntityAssociationEnd)handleGetParentEnd()

handleGetParentEnd

protected abstract Object handleGetParentEnd()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getIdentifiers

public final Collection<ModelElementFacade> getIdentifiers()

Represents a persistent entity.

Specified by:

getIdentifiers in interface Entity

Returns:

(Collection)handleGetIdentifiers()

handleGetIdentifiers

protected abstract Collection handleGetIdentifiers()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

getChildEnds

public final Collection<EntityAssociationEnd> getChildEnds()

Represents a persistent entity.

Specified by:

getChildEnds in interface Entity

Returns:

(Collection)handleGetChildEnds()

handleGetChildEnds

protected abstract Collection handleGetChildEnds()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

getQueryOperations

public final Collection<EntityQueryOperation> getQueryOperations()

Represents a persistent entity.

Specified by:

getQueryOperations in interface Entity

Returns:

(Collection)handleGetQueryOperations()

handleGetQueryOperations

protected abstract Collection handleGetQueryOperations()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

getBusinessOperations

public final Collection<OperationFacade> getBusinessOperations()

Represents a persistent entity.

Specified by:

getBusinessOperations in interface Entity

Returns:

(Collection)handleGetBusinessOperations()

handleGetBusinessOperations

protected abstract Collection handleGetBusinessOperations()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

getAllEntityReferences

public final Collection<DependencyFacade> getAllEntityReferences()

Represents a persistent entity.

Specified by:

getAllEntityReferences in interface Entity

Returns:

(Collection)handleGetAllEntityReferences()

handleGetAllEntityReferences

protected abstract Collection handleGetAllEntityReferences()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::metafacades::uml::Entity::entity must have at least one primary key

Error: Each entity must have at least one identifier defined.

OCL: context Entity inv: identifiersPresent

Constraint: org::andromda::metafacades::uml::Entity::entities can only specialize other entites

Error: An entity can only specialize another entity.

OCL: context Entity inv : specializations -> notEmpty() implies specializations -> forAll(oclIsKindOf(Entity))

Specified by:

validateInvariants in interface ModelElementFacade

Overrides:

validateInvariants in class ClassifierFacadeLogic

Parameters:

validationMessages - Collection

See Also:

ClassifierFacadeLogic.validateInvariants(Collection validationMessages)