org.exolab.castor.jdo.keygen

Class MaxKeyGenerator

public final class MaxKeyGenerator extends Object implements KeyGenerator

MAX key generator.

Version: $Revision: 5951 $ $Date: 2006-04-10 16:39:24 -0600 (Mon, 10 Apr 2006) $

Author: Oleg Nitz Leonardo Souza Mario Bueno Bruce Snyder

See Also: MaxKeyGeneratorFactory

Constructor Summary
MaxKeyGenerator(PersistenceFactory factory, int sqlType)
Initialize the MAX key generator.
Method Summary
ObjectgenerateKey(Connection conn, String tableName, String primKeyName, Properties props)
Generate a new key for the specified table as "MAX(primary_key) + 1".
bytegetStyle()
Style of key generator: BEFORE_INSERT, DURING_INSERT or AFTER_INSERT ?
booleanisInSameConnection()
Is key generated in the same connection as INSERT?
StringpatchSQL(String insert, String primKeyName)
Gives a possibility to patch the Castor-generated SQL statement for INSERT (makes sense for DURING_INSERT key generators)
voidsupportsSqlType(int sqlType)
Determine if the key generator supports a given sql type.

Constructor Detail

MaxKeyGenerator

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

Method Detail

generateKey

public Object generateKey(Connection conn, String tableName, String primKeyName, Properties props)
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.

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 ?

isInSameConnection

public boolean isInSameConnection()
Is key generated in the same connection as INSERT?

patchSQL

public final 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)

supportsSqlType

public void supportsSqlType(int sqlType)
Determine if the key generator supports a given sql type.

Parameters: sqlType

Throws: MappingException

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