org.castor.cpa.persistence.sql.keygen
Class IdentityKeyGenerator

java.lang.Object
  extended by org.castor.cpa.persistence.sql.keygen.AbstractKeyGenerator
      extended by org.castor.cpa.persistence.sql.keygen.AbstractAfterKeyGenerator
          extended by org.castor.cpa.persistence.sql.keygen.IdentityKeyGenerator
All Implemented Interfaces:
KeyGenerator

public final class IdentityKeyGenerator
extends AbstractAfterKeyGenerator

IDENTITY key generator.

Version:
$Revision: 8377 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
Author:
Oleg Nitz, Stein M. Hugubakken, Bruce Snyder
See Also:
IdentityKeyGeneratorFactory

Constructor Summary
IdentityKeyGenerator(PersistenceFactory factory, int sqlType)
          Initialize the IDENTITY key generator.
 
Method Summary
 java.lang.Object generateKey(java.sql.Connection conn, java.lang.String tableName, java.lang.String primKeyName, java.util.Properties props)
          Generate a new key for the specified table.
 boolean isInSameConnection()
          Is key generated in the same connection as INSERT? For DURING_INSERT style this method is never called.
 
Methods inherited from class org.castor.cpa.persistence.sql.keygen.AbstractAfterKeyGenerator
buildStatement, executeStatement
 
Methods inherited from class org.castor.cpa.persistence.sql.keygen.AbstractKeyGenerator
closeSeparateConnection, getSeparateConnection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdentityKeyGenerator

public IdentityKeyGenerator(PersistenceFactory factory,
                            int sqlType)
                     throws MappingException
Initialize the IDENTITY key generator.

Parameters:
factory - A PersistenceFactory instance.
sqlType - A SQLTypidentifier.
Throws:
MappingException - if this key generator is not compatible with the persistance factory.
Method Detail

generateKey

public java.lang.Object generateKey(java.sql.Connection conn,
                                    java.lang.String tableName,
                                    java.lang.String primKeyName,
                                    java.util.Properties props)
                             throws PersistenceException
Generate a new key for the specified table. This method is called when a new object is about to be created. In some environments the name of the owner of the object is known, e.g. the principal in a J2EE server. This method is never called for DURING_INSERT key generators.

Parameters:
conn - An open connection within the given transaction
tableName - The table name
primKeyName - The primary key name
props - A temporary replacement for Principal object
Returns:
A new key
Throws:
PersistenceException - An error occured talking to persistent storage

isInSameConnection

public boolean isInSameConnection()
Is key generated in the same connection as INSERT? For DURING_INSERT style this method is never called.

Returns:
{code}True{code} If this instance is in same JDBC Connection.


Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com