Package org.apache.cayenne.dba
Interface PkGenerator
- All Known Implementing Classes:
- DB2PkGenerator,- DerbyPkGenerator,- FrontBasePkGenerator,- H2PkGenerator,- IngresPkGenerator,- JdbcPkGenerator,- MySQLPkGenerator,- OpenBasePkGenerator,- OraclePkGenerator,- PostgresPkGenerator,- SQLServerPkGenerator,- SybasePkGenerator
public interface PkGenerator
Defines methods to support automatic primary key generation.
- 
Method SummaryModifier and Type Method Description voidcreateAutoPk(DataNode node, List<DbEntity> dbEntities)Generates necessary database objects to provide automatic primary key support.List<String>createAutoPkStatements(List<DbEntity> dbEntities)Returns a list of SQL strings needed to generates database objects to provide automatic primary support for the list of entities.voiddropAutoPk(DataNode node, List<DbEntity> dbEntities)Drops any common database objects associated with automatic primary key generation process.List<String>dropAutoPkStatements(List<DbEntity> dbEntities)Returns SQL string needed to drop database objects associated with automatic primary key generation.ObjectgeneratePk(DataNode dataNode, DbAttribute pk)Generates a unique and non-repeating primary key for specified PK attribute.DbAdaptergetAdapter()Get an adapter associated with current PkGeneratorvoidreset()Resets any cached primary keys forcing generator to go to the database next time id generation is requested.voidsetAdapter(DbAdapter q)Install the adapter associated with current PkGenerator
- 
Method Details- 
createAutoPkGenerates necessary database objects to provide automatic primary key support.- Parameters:
- node- node that provides access to a DataSource.
- dbEntities- a list of entities that require primary key auto-generation support
- Throws:
- Exception
 
- 
createAutoPkStatementsReturns a list of SQL strings needed to generates database objects to provide automatic primary support for the list of entities. No actual database operations are performed.
- 
dropAutoPkDrops any common database objects associated with automatic primary key generation process. This may be lookup tables, special stored procedures or sequences.- Parameters:
- node- node that provides access to a DataSource.
- dbEntities- a list of entities whose primary key auto-generation support should be dropped.
- Throws:
- Exception
 
- 
dropAutoPkStatementsReturns SQL string needed to drop database objects associated with automatic primary key generation. No actual database operations are performed.
- 
generatePkGenerates a unique and non-repeating primary key for specified PK attribute.- Throws:
- Exception
- Since:
- 3.0
 
- 
setAdapterInstall the adapter associated with current PkGenerator- Since:
- 4.1
 
- 
getAdapterDbAdapter getAdapter()Get an adapter associated with current PkGenerator- Since:
- 4.1
 
- 
resetvoid reset()Resets any cached primary keys forcing generator to go to the database next time id generation is requested. May not be applicable for all generator implementations.
 
-