org.eclipse.jpt.jpa.core
Interface EntityGeneratorDatabaseAnnotationNameBuilder

public interface EntityGeneratorDatabaseAnnotationNameBuilder

Provide a pluggable way to determine whether and how the entity generator prints the names of various database objects.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.1

Method Summary

String	buildColumnAnnotationName(String attributeName, Column column) Given the name of an attribute (field or property) and the column to which it is mapped, build and return a string to be used as the value for the attribute's Column annotation's name element.
String	buildJoinColumnAnnotationName(Column column) Build and return a string to be used as the value for a JoinColumn annotation's name or referencedColumnName element.
String	buildJoinColumnAnnotationName(String attributeName, ForeignKey foreignKey) Given the name of an attribute (field or property) and the many-to-one or many-to-many foreign key to which it is mapped, build and return a string to be used as the value for the attribute's JoinColumn annotation's name element.
String	buildJoinTableAnnotationName(Table table) Build and return a string to be used as the value for a JoinTable annotation's name element.
String	buildTableAnnotationName(String entityName, Table table) Given the name of an entity and the table to which it is mapped, build and return a string to be used as the value for the entity's Table annotation's name element.

Method Detail

buildTableAnnotationName

String buildTableAnnotationName(String entityName,
                                Table table)

Given the name of an entity and the table to which it is mapped, build and return a string to be used as the value for the entity's Table annotation's name element. Return null if the entity maps to the table by default.

buildColumnAnnotationName

String buildColumnAnnotationName(String attributeName,
                                 Column column)

Given the name of an attribute (field or property) and the column to which it is mapped, build and return a string to be used as the value for the attribute's Column annotation's name element. Return null if the attribute maps to the column by default.

buildJoinColumnAnnotationName

String buildJoinColumnAnnotationName(String attributeName,
                                     ForeignKey foreignKey)

Given the name of an attribute (field or property) and the many-to-one or many-to-many foreign key to which it is mapped, build and return a string to be used as the value for the attribute's JoinColumn annotation's name element. Return null if the attribute maps to the join column by default. The specified foreign key consists of a single column pair whose referenced column is the single-column primary key of the foreign key's referenced table.

buildJoinColumnAnnotationName

String buildJoinColumnAnnotationName(Column column)

Build and return a string to be used as the value for a JoinColumn annotation's name or referencedColumnName element. This is called for many-to-one and many-to-many mappings when the default join column name and/or referenced column name are/is not applicable.

See Also:

buildJoinColumnAnnotationName(String, ForeignKey)

buildJoinTableAnnotationName

String buildJoinTableAnnotationName(Table table)

Build and return a string to be used as the value for a JoinTable annotation's name element. This is called for many-to-many mappings when the default join table name is not applicable.