org.andromda.cartridges.hibernate.metafacades

Interface HibernateEntity

All Superinterfaces:

ClassifierFacade, Entity, GeneralizableElementFacade, ModelElementFacade

All Known Implementing Classes:

HibernateEntityLogic, HibernateEntityLogicImpl

public interface HibernateEntity
extends Entity

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

Method Summary

Methods

Modifier and Type	Method and Description
Collection	getAllBusinessOperations() Return all the user defined operations for this entity.
int	getEhCacheMaxElementsInMemory() EhCache property.
int	getEhCacheTimeToIdleSeconds() EhCache property.
int	getEhCacheTimeToLiveSeconds() EhCache property.
String	getEntityImplementationName() The name of the implementation class.
String	getEntityName() The name used for the hibernate entity.
String	getFullyQualifiedEntityImplementationName() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.fullyQualifiedEntityImplementationName
String	getFullyQualifiedEntityName() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.fullyQualifiedEntityName
String	getHibernateCacheType() Cache policy for the entity.
String	getHibernateDefaultCascade() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.hibernateDefaultCascade
String	getHibernateDiscriminatorColumn() The name of the discriminator column.
int	getHibernateDiscriminatorLength() The standard length of a discriminator value.
String	getHibernateDiscriminatorType() The type of the hibernate discriminator column.
String	getHibernateDiscriminatorValue() The name of the discriminator value.
String	getHibernateGeneratorClass() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.hibernateGeneratorClass
String	getHibernateInheritanceStrategy() Return the value of andromda.hibernate.inheritance tagged value.
String	getHibernateVersionProperty() Stores the value of the Hibernate version property.
String	getHibernateVersionPropertySqlName() The SQL name of the hibernate version property.
String	getMappingClassName() Returns the mapping class name to use (this is will be 'class', 'subclass', etc) depending on whether the entity is a specialization and what type of inheritance strategy is employed.
String	getSequenceName() Gets the sequence name.
String	getSubclassKeyColumn() Gets the name of the key column if the inheritance strategy is "subclass".
int	getVersion() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.version
String	getXmlTagName() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.xmlTagName
boolean	isBusinessOperationsPresent() Indicates whether or not any entity operations are present.
boolean	isDynamicInsert() Specifies if hibernate dynamic-insert will be enabled / disabled for this entity
boolean	isDynamicUpdate() Specifies if hibernate dynamic-update will be enabled / disabled for this entity
boolean	isEhCacheEternal() EhCache property.
boolean	isEhCacheOverflowToDisk() EhCache property.
boolean	isForeignHibernateGeneratorClass() Indicates whether or not hibernate generator class for this SpringEntity is foreign or not.
boolean	isHibernateCacheDistributed() Specifies whether the cache for this entity is to be distributed.
boolean	isHibernateEntityMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isHibernateInheritanceClass() Return true if the hibernate inheritance strategy as specified by the tagged value andromda_inheritance_strategy is defined as class.
boolean	isHibernateInheritanceConcrete() Return true if the hibernate inheritance strategy as specified by the tagged value andromda_inheritance_strategy is defined as concrete.
boolean	isHibernateInheritanceInterface() Return true if the hibernate inheritance strategy as specified by the tagged value andromda_inheritance_strategy is defined as interface.
boolean	isHibernateInheritanceSubclass() Return true if the hibernate inheritance strategy as specified by the tagged value andromda_inheritance_strategy is defined as subclass.
boolean	isHibernateInheritanceUnionSubClass() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.hibernateInheritanceUnionSubClass
boolean	isHibernateProxy() TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.hibernateProxy
boolean	isLazy() Specifies whether the entity should be loaded lazily.
boolean	isMappingRequiresSuperProperties() Indicates whether or not the mapping for the the entity requires the properties of the super entity to be included within the mapping.
boolean	isRequiresMapping() Indicates if this entity requires a mapping of its own.
boolean	isRequiresSpecializationMapping() Indicates if the entity requires specialization mappng.
boolean	isSequenceHibernateGeneratorClass() Indicates whether or not the hibernate generator class is specified as "sequence".
boolean	isTableRequired() Indicates if a table is required for this entity (sometimes it will not be depending on the inheritance strategy used).

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

isHibernateEntityMetaType

boolean isHibernateEntityMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAllBusinessOperations

Collection getAllBusinessOperations()

Return all the user defined operations for this entity. Used when leafImpl is true.

Returns:

Collection

getEhCacheMaxElementsInMemory

int getEhCacheMaxElementsInMemory()

EhCache property. Defines the maximum number of objects that will be created in memory.

Returns:

int

getEhCacheTimeToIdleSeconds

int getEhCacheTimeToIdleSeconds()

EhCache property. Defines the time to idle for an element before it expires.

Returns:

int

getEhCacheTimeToLiveSeconds

int getEhCacheTimeToLiveSeconds()

EhCache property. Defines the time to live for an element before it expires.

Returns:

int

getEntityImplementationName

String getEntityImplementationName()

The name of the implementation class.

Returns:

String

getEntityName

String getEntityName()

The name used for the hibernate entity.

Returns:

String

getFullyQualifiedEntityImplementationName

String getFullyQualifiedEntityImplementationName()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.fullyQualifiedEntityImplementationName

Returns:

String

getFullyQualifiedEntityName

String getFullyQualifiedEntityName()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.fullyQualifiedEntityName

Returns:

String

getHibernateCacheType

String getHibernateCacheType()

Cache policy for the entity. Posible values are read-write, nonstrict-read-write, read-only

Returns:

String

getHibernateDefaultCascade

String getHibernateDefaultCascade()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.hibernateDefaultCascade

Returns:

String

getHibernateDiscriminatorColumn

String getHibernateDiscriminatorColumn()

The name of the discriminator column. Default is class.

Returns:

String

getHibernateDiscriminatorLength

int getHibernateDiscriminatorLength()

The standard length of a discriminator value. Default is 1.

Returns:

int

getHibernateDiscriminatorType

String getHibernateDiscriminatorType()

The type of the hibernate discriminator column. Default is string.

Returns:

String

getHibernateDiscriminatorValue

String getHibernateDiscriminatorValue()

The name of the discriminator value. Default is the name of the class

Returns:

String

getHibernateGeneratorClass

String getHibernateGeneratorClass()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.hibernateGeneratorClass

Returns:

String

getHibernateInheritanceStrategy

String getHibernateInheritanceStrategy()

Return the value of andromda.hibernate.inheritance tagged value.

Returns:

String

getHibernateVersionProperty

String getHibernateVersionProperty()

Stores the value of the Hibernate version property.

Returns:

String

getHibernateVersionPropertySqlName

String getHibernateVersionPropertySqlName()

The SQL name of the hibernate version property.

Returns:

String

getMappingClassName

String getMappingClassName()

Returns the mapping class name to use (this is will be 'class', 'subclass', etc) depending on whether the entity is a specialization and what type of inheritance strategy is employed.

Returns:

String

getSequenceName

String getSequenceName()

Gets the sequence name.

Returns:

String

getSubclassKeyColumn

String getSubclassKeyColumn()

Gets the name of the key column if the inheritance strategy is "subclass". If the strategy is not "subclass" this returns null.

Returns:

String

getVersion

int getVersion()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.version

Returns:

int

getXmlTagName

String getXmlTagName()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.xmlTagName

Returns:

String

isBusinessOperationsPresent

boolean isBusinessOperationsPresent()

Indicates whether or not any entity operations are present.

Returns:

boolean

isDynamicInsert

boolean isDynamicInsert()

Specifies if hibernate dynamic-insert will be enabled / disabled for this entity

Returns:

boolean

isDynamicUpdate

boolean isDynamicUpdate()

Specifies if hibernate dynamic-update will be enabled / disabled for this entity

Returns:

boolean

isEhCacheEternal

boolean isEhCacheEternal()

EhCache property. Defines if elements are eternal.

Returns:

boolean

isEhCacheOverflowToDisk

boolean isEhCacheOverflowToDisk()

EhCache property. Defines if elements can overflow to disk

Returns:

boolean

isForeignHibernateGeneratorClass

boolean isForeignHibernateGeneratorClass()

Indicates whether or not hibernate generator class for this SpringEntity is foreign or not.

Returns:

boolean

isHibernateCacheDistributed

boolean isHibernateCacheDistributed()

Specifies whether the cache for this entity is to be distributed.

Returns:

boolean

isHibernateInheritanceClass

boolean isHibernateInheritanceClass()

Return true if the hibernate inheritance strategy as specified by the tagged value andromda_inheritance_strategy is defined as class.

Returns:

boolean

isHibernateInheritanceConcrete

boolean isHibernateInheritanceConcrete()

Return true if the hibernate inheritance strategy as specified by the tagged value andromda_inheritance_strategy is defined as concrete.

Returns:

boolean

isHibernateInheritanceInterface

boolean isHibernateInheritanceInterface()

Return true if the hibernate inheritance strategy as specified by the tagged value andromda_inheritance_strategy is defined as interface.

Returns:

boolean

isHibernateInheritanceSubclass

boolean isHibernateInheritanceSubclass()

Return true if the hibernate inheritance strategy as specified by the tagged value andromda_inheritance_strategy is defined as subclass.

Returns:

boolean

isHibernateInheritanceUnionSubClass

boolean isHibernateInheritanceUnionSubClass()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.hibernateInheritanceUnionSubClass

Returns:

boolean

isHibernateProxy

boolean isHibernateProxy()

TODO: Model Documentation for org.andromda.cartridges.hibernate.metafacades.HibernateEntity.hibernateProxy

Returns:

boolean

isLazy

boolean isLazy()

Specifies whether the entity should be loaded lazily.

Returns:

boolean

isMappingRequiresSuperProperties

boolean isMappingRequiresSuperProperties()

Indicates whether or not the mapping for the the entity requires the properties of the super entity to be included within the mapping. If this evalutes to true, then the properties of this entity would be rendered into the specialization's mapping file.

Returns:

boolean

isRequiresMapping

boolean isRequiresMapping()

Indicates if this entity requires a mapping of its own.

Returns:

boolean

isRequiresSpecializationMapping

boolean isRequiresSpecializationMapping()

Indicates if the entity requires specialization mappng. This happens when the inheritance strategy is "subclass", or "class".

Returns:

boolean

isSequenceHibernateGeneratorClass

boolean isSequenceHibernateGeneratorClass()

Indicates whether or not the hibernate generator class is specified as "sequence".

Returns:

boolean

isTableRequired

boolean isTableRequired()

Indicates if a table is required for this entity (sometimes it will not be depending on the inheritance strategy used).

Returns:

boolean