|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.avaje.ebean.config.AbstractNamingConvention
public abstract class AbstractNamingConvention
Provides some base implementation for NamingConventions.
Field Summary | |
---|---|
static String |
DEFAULT_SEQ_FORMAT
The Constant DEFAULT_SEQ_FORMAT. |
Constructor Summary | |
---|---|
AbstractNamingConvention()
Construct with the default sequence format ("{table}_seq") and useForeignKeyPrefix as true. |
|
AbstractNamingConvention(String sequenceFormat)
Construct with a sequence format. |
|
AbstractNamingConvention(String sequenceFormat,
boolean useForeignKeyPrefix)
Construct with a sequence format and useForeignKeyPrefix setting. |
Method Summary | |
---|---|
String |
getCatalog()
Return the catalog. |
TableName |
getM2MJoinTableName(TableName lhsTable,
TableName rhsTable)
Returns the ManyToMany join table name (aka the intersection table). |
String |
getSchema()
Return the schema. |
String |
getSequenceFormat()
Returns the sequence format. |
String |
getSequenceName(String tableName)
Return the sequence name given the table name (for DB's that use sequences). |
TableName |
getTableName(Class<?> beanClass)
Returns the table name for a given entity bean. |
boolean |
isUseForeignKeyPrefix()
Return true if a prefix should be used building a foreign key name. |
void |
setCatalog(String catalog)
Sets the catalog. |
void |
setDatabasePlatform(DatabasePlatform databasePlatform)
Set the associated DatabasePlaform. |
void |
setSchema(String schema)
Sets the schema. |
void |
setSequenceFormat(String sequenceFormat)
Set the sequence format used to generate the sequence name. |
void |
setUseForeignKeyPrefix(boolean useForeignKeyPrefix)
Set this to false when the primary key columns matching your foreign key columns. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.avaje.ebean.config.NamingConvention |
---|
getColumnFromProperty, getPropertyFromColumn |
Field Detail |
---|
public static final String DEFAULT_SEQ_FORMAT
Constructor Detail |
---|
public AbstractNamingConvention(String sequenceFormat, boolean useForeignKeyPrefix)
public AbstractNamingConvention(String sequenceFormat)
sequenceFormat
- the sequence formatpublic AbstractNamingConvention()
Method Detail |
---|
public void setDatabasePlatform(DatabasePlatform databasePlatform)
NamingConvention
This is set after the DatabasePlatform has been associated.
The purpose of this is to enable NamingConvention to be able to support database platform specific configuration.
setDatabasePlatform
in interface NamingConvention
databasePlatform
- the database platformpublic String getSequenceName(String tableName)
NamingConvention
Typically you might append "_seq" to the table name as an example.
getSequenceName
in interface NamingConvention
tableName
- the table name
public String getCatalog()
public void setCatalog(String catalog)
public String getSchema()
public void setSchema(String schema)
public String getSequenceFormat()
public void setSequenceFormat(String sequenceFormat)
The format should include "{table}". When generating the sequence name {table} is replaced with the actual table name.
sequenceFormat
- string containing "{table}" which is replaced with the actual
table name to generate the sequence name.public boolean isUseForeignKeyPrefix()
This by default is true and this works well when the primary key column names are simply "ID". In this case a prefix (such as "ORDER" and "CUSTOMER" etc) is added to the foreign key column producing "ORDER_ID" and "CUSTOMER_ID".
This should return false when your primary key columns are the same as the foreign key columns. For example, when the primary key columns are "ORDER_ID", "CUST_ID" etc ... and they are the same as the foreign key column names.
isUseForeignKeyPrefix
in interface NamingConvention
public void setUseForeignKeyPrefix(boolean useForeignKeyPrefix)
public TableName getTableName(Class<?> beanClass)
This first checks for the @Table annotation and if not present uses the naming convention to define the table name.
getTableName
in interface NamingConvention
beanClass
- the bean class
getTableNameFromAnnotation(Class)
,
getTableNameByConvention(Class)
public TableName getM2MJoinTableName(TableName lhsTable, TableName rhsTable)
NamingConvention
getM2MJoinTableName
in interface NamingConvention
lhsTable
- the left hand side bean tablerhsTable
- the right hand side bean table
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |