org.andromda.cartridges.spring.metafacades

Interface SpringEntity

All Superinterfaces:

ClassifierFacade, Entity, GeneralizableElementFacade, ModelElementFacade

All Known Subinterfaces:

SpringManageableEntity

All Known Implementing Classes:

SpringEntityLogic, SpringEntityLogicImpl, SpringManageableEntityLogic, SpringManageableEntityLogicImpl

public interface SpringEntity
extends Entity

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

Method Summary

Methods

Modifier and Type	Method and Description
Collection<ClassifierFacade>	getAllValueObjectReferences() Returns all value object references (this includes all those that are inherited from any parent entities)
String	getAttributeEmbeddedValueList() A quoted comma separated list of the names of embedded values belonging to this entity (that represented as attributes)
String	getBeanName(boolean targetSuffix) Gets the Spring bean name, and optionally adds a target suffix, if 'targetSuffix' is set to true.
String	getDaoBaseName() The DAO base class name.
Collection<SpringEntityOperation>	getDaoBusinessOperations() The business operations modeled on the entity that will be generated on the DAO (Data Access Object).
String	getDaoImplementationName() The DAO implementation class name.
String	getDaoName() The name of the DAO for the specified entity.
String	getDaoNoTransformationConstantName() The constant name denoting no transformation is to be applied.
String	getEntityImplementationName() The implementation name for the entity.
String	getEntityName() The name of the plain entity name.
String	getFullyQualifiedDaoBaseName() The fully qualified name of the base DAO.
String	getFullyQualifiedDaoImplementationName() The fully qualified name of the DAO implemetation.
String	getFullyQualifiedDaoName() The fully qualified name of the DAO.
String	getFullyQualifiedEntityImplementationName() The fully qualified name of the entity implementation class.
String	getFullyQualifiedEntityName() The fully qualified name of the entity class.
String	getHibernateInheritanceStrategy() Return the value of the tagged value andromda_hibernate_inheritance.
SpringEntity	getRoot() Travels up the inheritance hierarchy and retrieves the root of this entity.
Collection<ClassifierFacade>	getValueObjectReferences() A Classifier is a classification of instances - it describes a set of instances that have features in common.
boolean	isDaoBusinessOperationsPresent() Indicates whether or not any business DAO operations are present.
boolean	isDaoImplementationRequired() True if an implementation is required for the dao class, this is the case when there are business operations or value-object transformation.
boolean	isHibernateInheritanceClass() Return true if the hibernate inheritance strategy is class.
boolean	isHibernateInheritanceConcrete() Return true if the hibernate inheritance strategy is concrete.
boolean	isHibernateInheritanceInterface() Return true if the hibernate inheritance strategy is interface.
boolean	isHibernateInheritanceSubclass() Return true if the hibernate inheritance strategy is subclass.
boolean	isRequiresHibernateMapping() Indicates whether or not this entity requires a Hibernate mapping cfg.xml file within the Spring application context.
boolean	isRichClient() Returns true if this entity is meant to be used in a richt client application.
boolean	isSpringEntityMetaType() Indicates the metafacade type (used for metafacade mappings).

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

isSpringEntityMetaType

boolean isSpringEntityMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAllValueObjectReferences

Collection<ClassifierFacade> getAllValueObjectReferences()

Returns all value object references (this includes all those that are inherited from any parent entities)

Returns:

Collection

getAttributeEmbeddedValueList

String getAttributeEmbeddedValueList()

A quoted comma separated list of the names of embedded values belonging to this entity (that represented as attributes)

Returns:

String

getBeanName

String getBeanName(boolean targetSuffix)

Gets the Spring bean name, and optionally adds a target suffix, if 'targetSuffix' is set to true.

Parameters:

targetSuffix - boolean

Returns:

String

getDaoBaseName

String getDaoBaseName()

The DAO base class name. This is the abstract DAO that contains CRUD operations as well as any generated finders defined on an entity.

Returns:

String

getDaoBusinessOperations

Collection<SpringEntityOperation> getDaoBusinessOperations()

The business operations modeled on the entity that will be generated on the DAO (Data Access Object).

Returns:

Collection

getDaoImplementationName

String getDaoImplementationName()

The DAO implementation class name.

Returns:

String

getDaoName

String getDaoName()

The name of the DAO for the specified entity.

Returns:

String

getDaoNoTransformationConstantName

String getDaoNoTransformationConstantName()

The constant name denoting no transformation is to be applied.

Returns:

String

getEntityImplementationName

String getEntityImplementationName()

The implementation name for the entity.

Returns:

String

getEntityName

String getEntityName()

The name of the plain entity name.

Returns:

String

getFullyQualifiedDaoBaseName

String getFullyQualifiedDaoBaseName()

The fully qualified name of the base DAO.

Returns:

String

getFullyQualifiedDaoImplementationName

String getFullyQualifiedDaoImplementationName()

The fully qualified name of the DAO implemetation.

Returns:

String

getFullyQualifiedDaoName

String getFullyQualifiedDaoName()

The fully qualified name of the DAO.

Returns:

String

getFullyQualifiedEntityImplementationName

String getFullyQualifiedEntityImplementationName()

The fully qualified name of the entity implementation class.

Returns:

String

getFullyQualifiedEntityName

String getFullyQualifiedEntityName()

The fully qualified name of the entity class.

Returns:

String

getHibernateInheritanceStrategy

String getHibernateInheritanceStrategy()

Return the value of the tagged value andromda_hibernate_inheritance.

Returns:

String

getRoot

SpringEntity getRoot()

Travels up the inheritance hierarchy and retrieves the root of this entity. If the root is the entity itself then just the entity is returned.

Returns:

SpringEntity

getValueObjectReferences

Collection<ClassifierFacade> getValueObjectReferences()

A Classifier is a classification of instances - it describes a set of instances that have features in common. Can specify a generalization hierarchy by referencing its general classifiers. It may be a Class, DataType, PrimitiveType, Association, Collaboration, UseCase, etc. Can specify a generalization hierarchy by referencing its general classifiers. Has the capability to own collaboration uses. These collaboration uses link a collaboration with the classifier to give a description of the workings of the classifier. Classifier is defined to be a kind of templateable element so that a classifier can be parameterized. It is also defined to be a kind of parameterable element so that a classifier can be a formal template parameter.

Returns:

Collection

isDaoBusinessOperationsPresent

boolean isDaoBusinessOperationsPresent()

Indicates whether or not any business DAO operations are present.

Returns:

boolean

isDaoImplementationRequired

boolean isDaoImplementationRequired()

True if an implementation is required for the dao class, this is the case when there are business operations or value-object transformation.

Returns:

boolean

isHibernateInheritanceClass

boolean isHibernateInheritanceClass()

Return true if the hibernate inheritance strategy is class.

Returns:

boolean

isHibernateInheritanceConcrete

boolean isHibernateInheritanceConcrete()

Return true if the hibernate inheritance strategy is concrete.

Returns:

boolean

isHibernateInheritanceInterface

boolean isHibernateInheritanceInterface()

Return true if the hibernate inheritance strategy is interface.

Returns:

boolean

isHibernateInheritanceSubclass

boolean isHibernateInheritanceSubclass()

Return true if the hibernate inheritance strategy is subclass.

Returns:

boolean

isRequiresHibernateMapping

boolean isRequiresHibernateMapping()

Indicates whether or not this entity requires a Hibernate mapping cfg.xml file within the Spring application context.

Returns:

boolean

isRichClient

boolean isRichClient()

Returns true if this entity is meant to be used in a richt client application.

Returns:

boolean