public class EJB3NamingStrategy extends Object implements NamingStrategy, Serializable
Naming strategy implementing the EJB3 standards
Modifier and Type | Field and Description |
---|---|
static NamingStrategy |
INSTANCE |
Constructor and Description |
---|
EJB3NamingStrategy() |
Modifier and Type | Method and Description |
---|---|
String |
classToTableName(String className)
Return a table name for an entity class
|
String |
collectionTableName(String ownerEntity,
String ownerEntityTable,
String associatedEntity,
String associatedEntityTable,
String propertyName)
Return a collection table name ie an association having a join table
|
String |
columnName(String columnName)
Alter the column name given in the mapping document
|
String |
foreignKeyColumnName(String propertyName,
String propertyEntityName,
String propertyTableName,
String referencedColumnName)
Return the foreign key column name for the given parameters
|
String |
joinKeyColumnName(String joinedColumn,
String joinedTable)
Return the join key column name ie a FK column used in a JOINED strategy or for a secondary table
|
String |
logicalCollectionColumnName(String columnName,
String propertyName,
String referencedColumn)
Returns the logical foreign key column name used to refer to this column in the mapping metadata
|
String |
logicalCollectionTableName(String tableName,
String ownerEntityTable,
String associatedEntityTable,
String propertyName)
Returns the logical collection table name used to refer to a table in the mapping metadata
|
String |
logicalColumnName(String columnName,
String propertyName)
Return the logical column name used to refer to a column in the metadata
(like index, unique constraints etc)
A full bijection is required between logicalNames and physical ones
logicalName have to be case insersitively unique for a given table
|
String |
propertyToColumnName(String propertyName)
Return a column name for a property path expression
|
String |
tableName(String tableName)
Alter the table name given in the mapping document
|
public static final NamingStrategy INSTANCE
public String classToTableName(String className)
NamingStrategy
Return a table name for an entity class
classToTableName
in interface NamingStrategy
className
- the fully-qualified class namepublic String propertyToColumnName(String propertyName)
NamingStrategy
Return a column name for a property path expression
propertyToColumnName
in interface NamingStrategy
propertyName
- a property pathpublic String tableName(String tableName)
NamingStrategy
Alter the table name given in the mapping document
tableName
in interface NamingStrategy
tableName
- a table namepublic String columnName(String columnName)
NamingStrategy
Alter the column name given in the mapping document
columnName
in interface NamingStrategy
columnName
- a column namepublic String collectionTableName(String ownerEntity, String ownerEntityTable, String associatedEntity, String associatedEntityTable, String propertyName)
NamingStrategy
Return a collection table name ie an association having a join table
collectionTableName
in interface NamingStrategy
ownerEntityTable
- owner side table nameassociatedEntityTable
- reverse side table name if anypropertyName
- collection rolepublic String joinKeyColumnName(String joinedColumn, String joinedTable)
NamingStrategy
Return the join key column name ie a FK column used in a JOINED strategy or for a secondary table
joinKeyColumnName
in interface NamingStrategy
joinedColumn
- joined column name (logical one) used to join withjoinedTable
- joined table name (ie the referenced table) used to join withpublic String foreignKeyColumnName(String propertyName, String propertyEntityName, String propertyTableName, String referencedColumnName)
NamingStrategy
Return the foreign key column name for the given parameters
foreignKeyColumnName
in interface NamingStrategy
propertyName
- the property name involvedpropertyTableName
- the property table name involved (logical one)referencedColumnName
- the referenced column name involved (logical one)public String logicalColumnName(String columnName, String propertyName)
NamingStrategy
Return the logical column name used to refer to a column in the metadata (like index, unique constraints etc) A full bijection is required between logicalNames and physical ones logicalName have to be case insersitively unique for a given table
logicalColumnName
in interface NamingStrategy
columnName
- given column name if anypropertyName
- property name of this columnpublic String logicalCollectionTableName(String tableName, String ownerEntityTable, String associatedEntityTable, String propertyName)
NamingStrategy
Returns the logical collection table name used to refer to a table in the mapping metadata
logicalCollectionTableName
in interface NamingStrategy
tableName
- the metadata explicit nameownerEntityTable
- owner table entity table name (logical one)associatedEntityTable
- reverse side table name if any (logical one)propertyName
- collection rolepublic String logicalCollectionColumnName(String columnName, String propertyName, String referencedColumn)
NamingStrategy
Returns the logical foreign key column name used to refer to this column in the mapping metadata
logicalCollectionColumnName
in interface NamingStrategy
columnName
- given column name in the metadata if anypropertyName
- property namereferencedColumn
- referenced column name (logical one) in the joinCopyright © 2001-2018 Red Hat, Inc. All Rights Reserved.