|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.cayenne.dba.JdbcPkGenerator
org.apache.cayenne.dba.openbase.OpenBasePkGenerator
public class OpenBasePkGenerator
| Field Summary |
|---|
| Fields inherited from class org.apache.cayenne.dba.JdbcPkGenerator |
|---|
DEFAULT_PK_CACHE_SIZE, pkCache, pkCacheSize |
| Constructor Summary | |
|---|---|
OpenBasePkGenerator()
|
|
| Method Summary | |
|---|---|
protected boolean |
canCreatePK(DbEntity entity)
|
void |
createAutoPk(DataNode node,
List dbEntities)
Generates necessary database objects to provide automatic primary key support. |
List |
createAutoPkStatements(List dbEntities)
Returns a list of SQL strings needed to generates database objects to provide automatic primary support for the list of entities. |
protected String |
createPKString(DbEntity entity)
Returns a String to create PK support for an entity. |
protected String |
createUniquePKIndexString(DbEntity entity)
Returns a String to create a unique index on table primary key columns per OpenBase recommendations. |
void |
dropAutoPk(DataNode node,
List dbEntities)
Drops table named "AUTO_PK_SUPPORT" if it exists in the database. |
List |
dropAutoPkStatements(List dbEntities)
Returns an empty list, since OpenBase doesn't support this operation. |
Object |
generatePk(DataNode node,
DbAttribute pk)
Returns a non-repeating primary key for a given PK attribute. |
Object |
generatePkForDbEntity(DataNode node,
DbEntity entity)
Deprecated. since 3.0 |
int |
getPkCacheSize()
Returns zero, since PK caching is not feasible with OpenBase PK generation mechanism. |
protected long |
longPkFromDatabase(DataNode node,
DbEntity entity)
Generates new (unique and non-repeating) primary key for specified DbEntity. |
protected String |
newIDString(DbEntity ent)
Returns SQL string that can generate new (unique and non-repeating) primary key for specified DbEntity. |
protected int |
pkFromDatabase(DataNode node,
DbEntity entity)
Deprecated. since 3.0 |
void |
reset()
Resets any cached primary keys forcing generator to go to the database next time id generation is requested. |
void |
setPkCacheSize(int pkCacheSize)
Sets the size of the entity primary key cache. |
| Methods inherited from class org.apache.cayenne.dba.JdbcPkGenerator |
|---|
autoPkTableExists, binaryPK, dropAutoPkString, pkCreateString, pkDeleteString, pkSelectString, pkTableCreateString, pkUpdateString, runUpdate |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public OpenBasePkGenerator()
| Method Detail |
|---|
public Object generatePkForDbEntity(DataNode node,
DbEntity entity)
throws Exception
generatePkForDbEntity in interface PkGeneratorgeneratePkForDbEntity in class JdbcPkGeneratorentity - DbEntity for which automatic PK is generated.
Exception
public Object generatePk(DataNode node,
DbAttribute pk)
throws Exception
generatePk in interface PkGeneratorgeneratePk in class JdbcPkGeneratorException
protected long longPkFromDatabase(DataNode node,
DbEntity entity)
throws Exception
NEWID FOR Table ColumnCOLUMN must be marked as UNIQUE in order for this to work properly.
longPkFromDatabase in class JdbcPkGeneratorException
protected int pkFromDatabase(DataNode node,
DbEntity entity)
throws Exception
NEWID FOR Table ColumnCOLUMN must be marked as UNIQUE in order for this to work properly.
pkFromDatabase in class JdbcPkGeneratorExceptionprotected String newIDString(DbEntity ent)
public void createAutoPk(DataNode node,
List dbEntities)
throws Exception
PkGenerator
createAutoPk in interface PkGeneratorcreateAutoPk in class JdbcPkGeneratornode - node that provides access to a DataSource.dbEntities - a list of entities that require primary key auto-generation
support
Exceptionpublic List createAutoPkStatements(List dbEntities)
PkGenerator
createAutoPkStatements in interface PkGeneratorcreateAutoPkStatements in class JdbcPkGeneratorprotected boolean canCreatePK(DbEntity entity)
public void dropAutoPk(DataNode node,
List dbEntities)
throws Exception
JdbcPkGenerator
dropAutoPk in interface PkGeneratordropAutoPk in class JdbcPkGeneratornode - node that provides access to a DataSource.dbEntities - a list of entities whose primary key auto-generation support
should be dropped.
Exceptionpublic List dropAutoPkStatements(List dbEntities)
dropAutoPkStatements in interface PkGeneratordropAutoPkStatements in class JdbcPkGeneratorprotected String createPKString(DbEntity entity)
protected String createUniquePKIndexString(DbEntity entity)
public void reset()
PkGenerator
reset in interface PkGeneratorreset in class JdbcPkGeneratorpublic int getPkCacheSize()
getPkCacheSize in class JdbcPkGeneratorpublic void setPkCacheSize(int pkCacheSize)
JdbcPkGeneratorpkCacheSize
parameter is less than 1, cache size is set to "one".
Note that our tests show that setting primary key cache value to anything much bigger than 20 does not give any significant performance increase. Therefore it does not make sense to use bigger values, since this may potentially create big gaps in the database primary key sequences in cases like application crashes or restarts.
setPkCacheSize in class JdbcPkGenerator
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||