org.exolab.castor.jdo.drivers

Class MaxKeyGenerator

Implemented Interfaces:
KeyGenerator

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

MAX key generator.
Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:08:13 $
Authors:
Oleg Nitz
Leonardo Souza Mario Bueno
See Also:
MaxKeyGeneratorFactory

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

AFTER_INSERT, BEFORE_INSERT, DURING_INSERT

Constructor Summary

MaxKeyGenerator(PersistenceFactory factory, int sqlType)
Initialize the MAX key generator.

Method Summary

Object
generateKey(Connection conn, String tableName, String primKeyName, Properties props)
Generate a new key for the specified table as "MAX(primary_key) + 1".
byte
getStyle()
Style of key generator: BEFORE_INSERT, DURING_INSERT or AFTER_INSERT ?
boolean
isInSameConnection()
Is key generated in the same connection as INSERT?
String
patchSQL(String insert, String primKeyName)
Gives a possibility to patch the Castor-generated SQL statement for INSERT (makes sense for DURING_INSERT key generators)

Constructor Details

MaxKeyGenerator

public MaxKeyGenerator(PersistenceFactory factory,
                       int sqlType)
            throws MappingException
Initialize the MAX key generator.

Method Details

generateKey

public Object generateKey(Connection conn,
                          String tableName,
                          String primKeyName,
                          Properties props)
            throws PersistenceException
Generate a new key for the specified table as "MAX(primary_key) + 1". If there is no records in the table, then the value 1 is returned.
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 String patchSQL(String insert,
                             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

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