org.exolab.castor.jdo.keygen

Class SequenceKeyGenerator

public final class SequenceKeyGenerator extends Object implements KeyGenerator

SEQUENCE key generator.

Version: $Revision: 6238 $ $Date: 2006-04-13 06:47:36 -0600 (Thu, 13 Apr 2006) $

Field Summary
protected PersistenceFactory	_factory
protected String	_factoryName
protected String	_seqName

Constructor Summary
	SequenceKeyGenerator(PersistenceFactory factory, Properties params, int sqlType) Initialize the SEQUENCE 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.

Field Detail

_factory

protected final PersistenceFactory _factory

_factoryName

protected final String _factoryName

_seqName

protected final String _seqName

Constructor Detail

SequenceKeyGenerator

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

Initialize the SEQUENCE 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 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 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