org.exolab.castor.jdo.keygen

Class HighLowKeyGenerator

public class HighLowKeyGenerator extends Object implements KeyGenerator

The parent abstract class for HIGH-LOW key generators

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

Constructor Summary
	HighLowKeyGenerator(PersistenceFactory factory, Properties params, int sqlType) Initialize the HIGH-LOW key generator.

Method Summary
Object	generateKey(Connection conn, String tableName, String primKeyName, Properties props)
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)
void	supportsSqlType(int sqlType) Determine if the key generator supports a given sql type.

Constructor Detail

HighLowKeyGenerator

public HighLowKeyGenerator(PersistenceFactory factory, Properties params, int sqlType)

Initialize the HIGH-LOW key generator.

Method Detail

generateKey

public Object generateKey(Connection conn, String tableName, String primKeyName, Properties props)

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