org.exolab.castor.jdo.keygen

Class IdentityKeyGenerator

java.lang.Object

org.exolab.castor.jdo.keygen.IdentityKeyGenerator

All Implemented Interfaces:

KeyGenerator

public final class IdentityKeyGenerator
extends java.lang.Object
implements KeyGenerator

IDENTITY key generator.

Version:

$Revision: 6117 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Oleg Nitz, Stein M. Hugubakken, Bruce Snyder

See Also:

IdentityKeyGeneratorFactory

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	fName

Fields inherited from interface org.exolab.castor.persist.spi.KeyGenerator

AFTER_INSERT, BEFORE_INSERT, DURING_INSERT

Constructor Summary

Constructors

Constructor and Description
IdentityKeyGenerator(PersistenceFactory factory, int sqlType) Initialize the IDENTITY key generator.

Method Summary

Modifier and Type	Method and Description
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.
byte	getStyle() Style of key generator: BEFORE_INSERT, DURING_INSERT or AFTER_INSERT ?
boolean	isInSameConnection() Is key generated in the same connection as INSERT?
java.lang.String	patchSQL(java.lang.String insert, java.lang.String primKeyName) Gives a possibility to patch the Castor-generated SQL statement for INSERT (makes sense for DURING_INSERT key generators)
void	supportsSqlType(int sqlType) Determine if the key generator supports a given sql type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fName

java.lang.String fName

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

supportsSqlType

public void supportsSqlType(int sqlType)
                     throws MappingException

Determine if the key generator supports a given sql type.

Specified by:

supportsSqlType in interface KeyGenerator

Parameters:

sqlType -

Throws:

MappingException

generateKey

public java.lang.Object generateKey(java.sql.Connection conn,
                                    java.lang.String tableName,
                                    java.lang.String primKeyName,
                                    java.util.Properties props)
                             throws PersistenceException

Description copied from interface: KeyGenerator

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.

Specified by:

generateKey in interface KeyGenerator

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

getStyle

public final byte getStyle()

Style of key generator: BEFORE_INSERT, DURING_INSERT or AFTER_INSERT ?

Specified by:

getStyle in interface KeyGenerator

isInSameConnection

public boolean isInSameConnection()

Is key generated in the same connection as INSERT?

Specified by:

isInSameConnection in interface KeyGenerator

patchSQL

public final java.lang.String patchSQL(java.lang.String insert,
                                       java.lang.String primKeyName)
                                throws MappingException

Gives a possibility to patch the Castor-generated SQL statement for INSERT (makes sense for DURING_INSERT key generators)

Specified by:

patchSQL in interface KeyGenerator

Parameters:

insert - Castor-generated INSERT statement

primKeyName - The primary key name

Throws:

MappingException