org.nuiton.topia.templates

Class TopiaHibernateTagValues

java.lang.Object

org.nuiton.eugene.models.extension.tagvalue.provider.DefaultTagValueMetadatasProvider

org.nuiton.topia.templates.TopiaHibernateTagValues

All Implemented Interfaces:

org.nuiton.eugene.models.extension.tagvalue.provider.TagValueMetadatasProvider

public class TopiaHibernateTagValues
extends org.nuiton.eugene.models.extension.tagvalue.provider.DefaultTagValueMetadatasProvider

All extra tag values usable in topia generators.

Since:

2.5

Author:

Tony Chemit - chemit@codelutin.com

Plexus component:

role: "org.nuiton.eugene.models.extension.tagvalue.provider.TagValueMetadatasProvider" role-hint: "topia-hibernate"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopiaHibernateTagValues.Store

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,String>	HIBERNATE_ATTRIBUTE_TYPE_DEFAULT_VALUES

Fields inherited from class org.nuiton.eugene.models.extension.tagvalue.provider.DefaultTagValueMetadatasProvider

matcher, tagValues

Constructor Summary

Constructors

Constructor and Description
TopiaHibernateTagValues()

Method Summary

Modifier and Type	Method and Description
String	getAccessTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.access tag value on the given attribute.
String	getAttributeType(org.nuiton.eugene.models.object.ObjectModelAttribute attribute, org.nuiton.eugene.models.object.ObjectModelClassifier classifier, org.nuiton.eugene.models.object.ObjectModelPackage aPackage, org.nuiton.eugene.models.object.ObjectModel model) Obtain the value of the TopiaHibernateTagValues.Store.attributeType tag value on the given attribute, classifier or model.
String	getDbNameTagValue(org.nuiton.eugene.models.object.ObjectModelElement element) Obtain the value of the TopiaHibernateTagValues.Store.dbName tag value on the given element.
String	getDbSchemaNameTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier, org.nuiton.eugene.models.object.ObjectModelPackage aPackage, org.nuiton.eugene.models.object.ObjectModel model) Obtain the value of the TopiaHibernateTagValues.Store.dbSchema tag value on the given classifier.
String	getDeprecatedAttributeTagValueMessage(org.nuiton.eugene.models.object.ObjectModelClass clazz, org.nuiton.eugene.models.object.ObjectModelAttribute attr, String deprecatedTagValue, String newTagValue, String value)
String	getDeprecatedModelTagValueMessage(org.nuiton.eugene.models.object.ObjectModel model, String deprecatedTagValue, String newTagValue, String value)
String	getDescription()
String	getFetchTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.fetch tag value on the given attribute.
String	getHibernateAttributeType(org.nuiton.eugene.models.object.ObjectModelAttribute attribute, org.nuiton.eugene.models.object.ObjectModelClassifier classifier, org.nuiton.eugene.models.object.ObjectModelPackage aPackage, org.nuiton.eugene.models.object.ObjectModel model) Obtain the value of the TopiaHibernateTagValues.Store.hibernateAttributeType tag value on the given attribute, classifier or model.
boolean	getIndexForeignKeysTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute, org.nuiton.eugene.models.object.ObjectModelPackage aPackage, org.nuiton.eugene.models.object.ObjectModel model) Obtains the value of the tag value TopiaHibernateTagValues.Store.indexForeignKeys on the model or on the given attribute.
String	getInheritanceStrategyTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier, org.nuiton.eugene.models.object.ObjectModelPackage aPackage) Obtain the value of the TopiaHibernateTagValues.Store.inheritanceStrategy tag value on the given classifier.
String	getInverseTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.inverse tag value on the given attribute.
String	getLazyTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.lazy tag value on the given attribute.
String	getLengthTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.length tag value on the given attribute.
String	getManytoManyTableNameTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.manyToManyTableName tag value on the given attribute.
boolean	getNaturalIdMutableTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier) Obtain the value of the TopiaHibernateTagValues.Store.naturalIdMutable tag value on the given classifier.
boolean	getNaturalIdTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.naturalId tag value on the given attribute.
Boolean	getNotNullTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.notNull tag value on the given attribute.
String	getOrderByTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.orderBy tag value on the given attribute.
String	getPersistenceTypeTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier) Obtain the value of the TopiaHibernateTagValues.Store.persistenceType tag value on the given classifier.
String	getProxyInterfaceTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier, org.nuiton.eugene.models.object.ObjectModelPackage aPackage, org.nuiton.eugene.models.object.ObjectModel model) Obtain the value of the TopiaHibernateTagValues.Store.hibernateProxyInterface tag value on the given classifier.
boolean	getSortAttributeTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier, org.nuiton.eugene.models.object.ObjectModelPackage aPackage, org.nuiton.eugene.models.object.ObjectModel model) Obtain the value of the TopiaHibernateTagValues.Store.sortAttribute tag value on the given classifier.
String	getSqlTypeTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Obtain the value of the TopiaHibernateTagValues.Store.sqlType tag value on the given attribute.
String	getTypeTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute) Deprecated. since 3.0, use now getHibernateAttributeType(ObjectModelAttribute, ObjectModelClassifier, ObjectModelPackage, ObjectModel) or getAttributeType(ObjectModelAttribute, ObjectModelClassifier, ObjectModelPackage, ObjectModel)
boolean	hasUseEnumerationNameTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attr, org.nuiton.eugene.models.object.ObjectModelClassifier classifier, org.nuiton.eugene.models.object.ObjectModelPackage aPackage, org.nuiton.eugene.models.object.ObjectModel model)
boolean	isGenerateForeignKeyNames(org.nuiton.eugene.models.object.ObjectModelClassifier classifier, org.nuiton.eugene.models.object.ObjectModel model) Obtain the value of the TopiaHibernateTagValues.Store.generateForeignKeyNames tag value on the given model or classifier and returns true if the tag value was found and value true.

Methods inherited from class org.nuiton.eugene.models.extension.tagvalue.provider.DefaultTagValueMetadatasProvider

getDefinitionForMatcher, getTagValue, getTagValues, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HIBERNATE_ATTRIBUTE_TYPE_DEFAULT_VALUES

protected static final Map<String,String> HIBERNATE_ATTRIBUTE_TYPE_DEFAULT_VALUES

Constructor Detail

TopiaHibernateTagValues

public TopiaHibernateTagValues()

Method Detail

getDescription

public String getDescription()

getPersistenceTypeTagValue

public String getPersistenceTypeTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier)

Obtain the value of the TopiaHibernateTagValues.Store.persistenceType tag value on the given classifier.

Parameters:

classifier - classifier to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.persistenceType

getInheritanceStrategyTagValue

public String getInheritanceStrategyTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier,
                                             org.nuiton.eugene.models.object.ObjectModelPackage aPackage)

Obtain the value of the TopiaHibernateTagValues.Store.inheritanceStrategy tag value on the given classifier.

Parameters:

classifier - classifier to seek

aPackage - package to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

TopiaHibernateTagValues.Store.inheritanceStrategy

getDbNameTagValue

public String getDbNameTagValue(org.nuiton.eugene.models.object.ObjectModelElement element)

Obtain the value of the TopiaHibernateTagValues.Store.dbName tag value on the given element. Note: We just try a direct search on the element and do not walk through his declaring elements if not found (see https://forge.nuiton.org/issues/2342).

Parameters:

element - element to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.dbName

getDbSchemaNameTagValue

public String getDbSchemaNameTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier,
                                      org.nuiton.eugene.models.object.ObjectModelPackage aPackage,
                                      org.nuiton.eugene.models.object.ObjectModel model)

Obtain the value of the TopiaHibernateTagValues.Store.dbSchema tag value on the given classifier.

Parameters:

classifier - classifier to seek

aPackage - package to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.dbSchema

getManytoManyTableNameTagValue

public String getManytoManyTableNameTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.manyToManyTableName tag value on the given attribute. Note that it won't and search on declaring element or anywhere else than on the given element. See https://forge.nuiton.org/issues/2342

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.9.2

See Also:

TopiaHibernateTagValues.Store.manyToManyTableName

getLengthTagValue

public String getLengthTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.length tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.length

getAccessTagValue

public String getAccessTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.access tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.access

getNaturalIdTagValue

public boolean getNaturalIdTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.naturalId tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.naturalId

getNaturalIdMutableTagValue

public boolean getNaturalIdMutableTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier)

Obtain the value of the TopiaHibernateTagValues.Store.naturalIdMutable tag value on the given classifier.

Parameters:

classifier - classifier to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.naturalIdMutable

getInverseTagValue

public String getInverseTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.inverse tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.inverse

getLazyTagValue

public String getLazyTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.lazy tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.lazy

getFetchTagValue

public String getFetchTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.fetch tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.fetch

getOrderByTagValue

public String getOrderByTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.orderBy tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.orderBy

getNotNullTagValue

public Boolean getNotNullTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.notNull tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.notNull

getProxyInterfaceTagValue

public String getProxyInterfaceTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier,
                                        org.nuiton.eugene.models.object.ObjectModelPackage aPackage,
                                        org.nuiton.eugene.models.object.ObjectModel model)

Obtain the value of the TopiaHibernateTagValues.Store.hibernateProxyInterface tag value on the given classifier.

Parameters:

classifier - classifier to seek

aPackage - FIXME

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.hibernateProxyInterface

getSortAttributeTagValue

public boolean getSortAttributeTagValue(org.nuiton.eugene.models.object.ObjectModelClassifier classifier,
                                        org.nuiton.eugene.models.object.ObjectModelPackage aPackage,
                                        org.nuiton.eugene.models.object.ObjectModel model)

Obtain the value of the TopiaHibernateTagValues.Store.sortAttribute tag value on the given classifier.

Parameters:

classifier - classifier to seek

aPackage - FIXME

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.sortAttribute

isGenerateForeignKeyNames

public boolean isGenerateForeignKeyNames(org.nuiton.eugene.models.object.ObjectModelClassifier classifier,
                                         org.nuiton.eugene.models.object.ObjectModel model)

Obtain the value of the TopiaHibernateTagValues.Store.generateForeignKeyNames tag value on the given model or classifier and returns true if the tag value was found and value true. It will first look on the model, and then in the given classifier.

Parameters:

model - model to seek

classifier - classifier to seek

Returns:

true if tag value was found on classifier or model and his value is true, otherwise false.

Since:

2.10

See Also:

TopiaHibernateTagValues.Store.generateForeignKeyNames

getHibernateAttributeType

public String getHibernateAttributeType(org.nuiton.eugene.models.object.ObjectModelAttribute attribute,
                                        org.nuiton.eugene.models.object.ObjectModelClassifier classifier,
                                        org.nuiton.eugene.models.object.ObjectModelPackage aPackage,
                                        org.nuiton.eugene.models.object.ObjectModel model)

Obtain the value of the TopiaHibernateTagValues.Store.hibernateAttributeType tag value on the given attribute, classifier or model.

Parameters:

attribute - attribute to seek

aPackage - FIXME

model - FIXME

classifier - FIXME

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

TopiaHibernateTagValues.Store.hibernateAttributeType

getAttributeType

public String getAttributeType(org.nuiton.eugene.models.object.ObjectModelAttribute attribute,
                               org.nuiton.eugene.models.object.ObjectModelClassifier classifier,
                               org.nuiton.eugene.models.object.ObjectModelPackage aPackage,
                               org.nuiton.eugene.models.object.ObjectModel model)

Obtain the value of the TopiaHibernateTagValues.Store.attributeType tag value on the given attribute, classifier or model.

Parameters:

attribute - attribute to seek

aPackage - FIXME

model - FIXME

classifier - FIXME

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0.1

See Also:

TopiaHibernateTagValues.Store.attributeType

getSqlTypeTagValue

public String getSqlTypeTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Obtain the value of the TopiaHibernateTagValues.Store.sqlType tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.sqlType

getIndexForeignKeysTagValue

public boolean getIndexForeignKeysTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute,
                                           org.nuiton.eugene.models.object.ObjectModelPackage aPackage,
                                           org.nuiton.eugene.models.object.ObjectModel model)

Obtains the value of the tag value TopiaHibernateTagValues.Store.indexForeignKeys on the model or on the given attribute.

Parameters:

attribute - attribute to test

model - model to test

aPackage - FIXME

Returns:

none empty value of the found tag value or null if not found nor empty.

Since:

2.6.5

See Also:

TopiaHibernateTagValues.Store.indexForeignKeys

hasUseEnumerationNameTagValue

public boolean hasUseEnumerationNameTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attr,
                                             org.nuiton.eugene.models.object.ObjectModelClassifier classifier,
                                             org.nuiton.eugene.models.object.ObjectModelPackage aPackage,
                                             org.nuiton.eugene.models.object.ObjectModel model)

getTypeTagValue

@Deprecated
public String getTypeTagValue(org.nuiton.eugene.models.object.ObjectModelAttribute attribute)

Deprecated. since 3.0, use now getHibernateAttributeType(ObjectModelAttribute, ObjectModelClassifier, ObjectModelPackage, ObjectModel) or getAttributeType(ObjectModelAttribute, ObjectModelClassifier, ObjectModelPackage, ObjectModel)

Obtain the value of the TopiaHibernateTagValues.Store.type tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.5

See Also:

TopiaHibernateTagValues.Store.type

getDeprecatedAttributeTagValueMessage

public String getDeprecatedAttributeTagValueMessage(org.nuiton.eugene.models.object.ObjectModelClass clazz,
                                                    org.nuiton.eugene.models.object.ObjectModelAttribute attr,
                                                    String deprecatedTagValue,
                                                    String newTagValue,
                                                    String value)

getDeprecatedModelTagValueMessage

public String getDeprecatedModelTagValueMessage(org.nuiton.eugene.models.object.ObjectModel model,
                                                String deprecatedTagValue,
                                                String newTagValue,
                                                String value)