org.andromda.cartridges.ejb3.metafacades

Interface EJB3EntityAttributeFacade

All Superinterfaces:

AttributeFacade, EntityAttribute, ModelElementFacade

All Known Subinterfaces:

EJB3ManageableEntityAttributeFacade, EJB3MappedSuperclassAttributeFacade

All Known Implementing Classes:

EJB3EntityAttributeFacadeLogic, EJB3EntityAttributeFacadeLogicImpl, EJB3ManageableEntityAttributeFacadeLogic, EJB3ManageableEntityAttributeFacadeLogicImpl, EJB3MappedSuperclassAttributeFacadeLogic, EJB3MappedSuperclassAttributeFacadeLogicImpl

public interface EJB3EntityAttributeFacade
extends EntityAttribute

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getColumnDefinition() Defines the column definition DDL used when creating table schema - use to override default container DDL.
String	getColumnPrecision() Set the column precision value.
String	getColumnScale() Column scale use denotes the decimal precision.
String	getEnumerationType() Returns the persistent property/field enumeration type.
String	getFetchType() Gets the fetch type for this attribute.
int	getGeneratorAllocationSize() Returns the amount to increment the generator value when allocating id numbers.
String	getGeneratorGenericStrategy() Returns the org.hibernate.annotations.GenericGenerator strategy either a predefined Hibernate strategy or a fully qualified class name.
int	getGeneratorInitialValue() Returns the inital value assigned when allocating ids from the specified generator.
String	getGeneratorName() Return the name for the generator, if one exists and should exists for SequenceGenerator and TableGenerator, which can be reference by the id for its generator.
String	getGeneratorPkColumnValue() Returns the name of the primary key value in the generator table assigned to this set of generated values.
String	getGeneratorSourceName() Returns the sequence name or table name for the generator depending on the generator type specified.
String	getGeneratorType() Determine the generator type for the Id annotation on the entity attribute - the PK strategy.
String	getLobType() Returns the user overridden lob type for this property.
String	getOverrideType() The overridden hibernate type for the annotation on the entity attribute, to manually specify a type using the @org.hibernate.annotations.Type or in other persistence provider.
String	getTemporalType() Returns the temporal type value set via tagged value on attribute if one exists.
boolean	isColumnNullable() Whether the column can be nullable.
boolean	isContainsEmbeddedObject() Returns true if this attribute's type is an embedded value object.
boolean	isEager() Determine if the fetch type for this attribute is eager loading.
boolean	isEJB3EntityAttributeFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isGeneratorTypeAuto() Returns true if an auto generator has been assigned to this attribute, false otherwise.
boolean	isGeneratorTypeGeneric() Returns true if a generic generator has been assigned to this attribute, false otherwise.
boolean	isGeneratorTypeIdentity() Returns true if an identity generator has been assigned to this attribute, false otherwise.
boolean	isGeneratorTypeNone() Returns true no generator has been assigned to this attribute, false otherwise.
boolean	isGeneratorTypeSequence() Returns true if a sequence generator has been assigned to this attribute, false otherwise.
boolean	isGeneratorTypeTable() Returns true if a table generator has been assigned to this attribute, false otherwise.
boolean	isInsertEnabled() Specifies whether a mapped column should be included in SQL INSERT statements.
boolean	isLazy() Determine if the fetch type for this attribute is lazy loading.
boolean	isLob() Returns true if the property type is specified as datatype::Blob or datatype::Clob.
boolean	isUpdateEnabled() Specifies whether a mapped column should be included in SQL UPDATE statements.
boolean	isVersion() True is this attribute is a version property (optimistic lock value) for this entity class.

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

getColumnIndex, getColumnLength, getColumnName, getJdbcMappings, getJdbcType, getSqlMappings, getSqlType, getUniqueGroup, isEntityAttributeMetaType, isIdentifier, isTransient

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

findTaggedValue, getDefaultValue, getEnumeration, getEnumerationLiteralParameters, getEnumerationValue, getGetterName, getGetterSetterTypeName, getLower, getOwner, getSetterName, getType, getUpper, isAddOnly, isAttributeFacadeMetaType, isChangeable, isDefaultValuePresent, isDerived, isEnumerationLiteral, isEnumerationLiteralParametersExist, isEnumerationMember, isLeaf, isMany, isOrdered, isReadOnly, isRequired, isStatic, isUnique

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

isEJB3EntityAttributeFacadeMetaType

boolean isEJB3EntityAttributeFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getColumnDefinition

String getColumnDefinition()

Defines the column definition DDL used when creating table schema - use to override default container DDL. This is automatically defined if the attribute type is an enumeration.

Returns:

String

getColumnPrecision

String getColumnPrecision()

Set the column precision value. Only applies to double and float columns. ie Use for setting dollar precision.

Returns:

String

getColumnScale

String getColumnScale()

Column scale use denotes the decimal precision. ie Use to set the 2 digit cent scale.

Returns:

String

getEnumerationType

String getEnumerationType()

Returns the persistent property/field enumeration type. Will return either ORDINAL for enums mapped as an integer or STRING for enums mapped as a string. If not specified on an enumerated type, then the ORDINAL type is assumed

Returns:

String

getFetchType

String getFetchType()

Gets the fetch type for this attribute. Default fetch type for attribute is EAGER. This will return either EAGER or LAZY.

Returns:

String

getGeneratorAllocationSize

int getGeneratorAllocationSize()

Returns the amount to increment the generator value when allocating id numbers.

Returns:

int

getGeneratorGenericStrategy

String getGeneratorGenericStrategy()

Returns the org.hibernate.annotations.GenericGenerator strategy either a predefined Hibernate strategy or a fully qualified class name.

Returns:

String

getGeneratorInitialValue

int getGeneratorInitialValue()

Returns the inital value assigned when allocating ids from the specified generator.

Returns:

int

getGeneratorName

String getGeneratorName()

Return the name for the generator, if one exists and should exists for SequenceGenerator and TableGenerator, which can be reference by the id for its generator.

Returns:

String

getGeneratorPkColumnValue

String getGeneratorPkColumnValue()

Returns the name of the primary key value in the generator table assigned to this set of generated values.

Returns:

String

getGeneratorSourceName

String getGeneratorSourceName()

Returns the sequence name or table name for the generator depending on the generator type specified.

Returns:

String

getGeneratorType

String getGeneratorType()

Determine the generator type for the Id annotation on the entity attribute - the PK strategy. If the attribute type is numeric, the default generator type is AUTO. Otherwise, the generator type is NONE, ie for String types.

Returns:

String

getLobType

String getLobType()

Returns the user overridden lob type for this property. This is set via tagged value andromda_persistence_lob_type. Default values are String for Clob and byte[] for Blob.

Returns:

String

getOverrideType

String getOverrideType()

The overridden hibernate type for the annotation on the entity attribute, to manually specify a type using the @org.hibernate.annotations.Type or in other persistence provider. Generally used for Boolean types in legacy databases, i.e yes_no, true_false. Could be:The name of a Hibernate basic type: integer, string, character, date, timestamp, float, binary, serializable, object, blob etc.; The name of a Java class with a default basic type: int, float, char, String, java.util.Date, java.lang.Integer, java.sql.Clob etc.; The name of a serializable Java class; The class name of a custom type: com.illflow.type.MyCustomType etc.

Returns:

String

getTemporalType

String getTemporalType()

Returns the temporal type value set via tagged value on attribute if one exists. Expect one of DATE, TIME, TIMESTAMP or NONE. This can only be applied to attributes of type java.util.Date or java.util.Calendar.

Returns:

String

isColumnNullable

boolean isColumnNullable()

Whether the column can be nullable. False for identifier and unique fields. If andromda_persistence_column_nullable tag is set, the tagged value is used. Otherwise, determine if this attribute is required from the multiplicity set on the attribute.

Returns:

boolean

isContainsEmbeddedObject

boolean isContainsEmbeddedObject()

Returns true if this attribute's type is an embedded value object.

Returns:

boolean

isEager

boolean isEager()

Determine if the fetch type for this attribute is eager loading.

Returns:

boolean

isGeneratorTypeAuto

boolean isGeneratorTypeAuto()

Returns true if an auto generator has been assigned to this attribute, false otherwise.

Returns:

boolean

isGeneratorTypeGeneric

boolean isGeneratorTypeGeneric()

Returns true if a generic generator has been assigned to this attribute, false otherwise.

Returns:

boolean

isGeneratorTypeIdentity

boolean isGeneratorTypeIdentity()

Returns true if an identity generator has been assigned to this attribute, false otherwise.

Returns:

boolean

isGeneratorTypeNone

boolean isGeneratorTypeNone()

Returns true no generator has been assigned to this attribute, false otherwise.

Returns:

boolean

isGeneratorTypeSequence

boolean isGeneratorTypeSequence()

Returns true if a sequence generator has been assigned to this attribute, false otherwise.

Returns:

boolean

isGeneratorTypeTable

boolean isGeneratorTypeTable()

Returns true if a table generator has been assigned to this attribute, false otherwise.

Returns:

boolean

isInsertEnabled

boolean isInsertEnabled()

Specifies whether a mapped column should be included in SQL INSERT statements.

Returns:

boolean

isLazy

boolean isLazy()

Determine if the fetch type for this attribute is lazy loading.

Returns:

boolean

isLob

boolean isLob()

Returns true if the property type is specified as datatype::Blob or datatype::Clob. LOB type is CLOB for characters or BLOB for binary data.

Returns:

boolean

isUpdateEnabled

boolean isUpdateEnabled()

Specifies whether a mapped column should be included in SQL UPDATE statements.

Returns:

boolean

isVersion

boolean isVersion()

True is this attribute is a version property (optimistic lock value) for this entity class.

Returns:

boolean