org.exolab.castor.persist.spi
Interface KeyGeneratorFactory

All Known Implementing Classes:

HighLowKeyGeneratorFactory, IdentityKeyGeneratorFactory, MaxKeyGeneratorFactory, SequenceKeyGeneratorFactory, UUIDKeyGeneratorFactory

public interface KeyGeneratorFactory

Interface for a key generator factory. The key generator factory is used for producing key generators for concrete databases with given parameters

Version:

$Revision: 7091 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

Author:

Oleg Nitz

Method Summary

KeyGenerator	getKeyGenerator(PersistenceFactory factory, java.util.Properties params, int sqlType) Produce the key generator.
java.lang.String	getName() Get the short name of the key generator.

Method Detail

getKeyGenerator

public KeyGenerator getKeyGenerator(PersistenceFactory factory,
                                    java.util.Properties params,
                                    int sqlType)
                             throws org.exolab.castor.mapping.MappingException

Produce the key generator.

Parameters:

factory - Helper object for obtaining database-specific QuerySyntax.

params - Parameters for key generator.

sqlType - The SQL type of the primary key, the generated identities must have the corresponding Java type, e.g. java.sql.Types.INTEGER corresponds to java.lang.Integer, java.sql.Types.NUMERIC corresponds to java.lang.BigDecimal.

Throws:

org.exolab.castor.mapping.MappingException

getName

public java.lang.String getName()

Get the short name of the key generator. It is used to reference key generators in a mapping configuration file. If several key generators of the same type are used for the same database, then they are referenced by aliases.