Package org.castor.ddlgen
Interface KeyGeneratorFactory
-
- All Known Implementing Classes:
Db2SequenceKeyGeneratorFactory,HighLowKeyGeneratorFactory,HsqlSequenceKeyGeneratorFactory,IdentityKeyGeneratorFactory,MaxKeyGeneratorFactory,OracleSequenceKeyGeneratorFactory,PostgresqlSequenceKeyGeneratorFactory,SapdbSequenceKeyGeneratorFactory,SequenceKeyGeneratorFactory,UUIDKeyGeneratorFactory
public interface KeyGeneratorFactoryInterface to be implemented by all key generator factories.- Since:
- 1.1
- Version:
- $Revision: 5951 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
- Author:
- Le Duc Bao, Ralf Joachim
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description KeyGeneratorcreateKeyGenerator()Create a default key generator instance with the algorithm the factory is responsible for.KeyGeneratorcreateKeyGenerator(KeyGeneratorDef definition)Create a key generator instance from the given definition with the algorithm the factory is responsible for.java.lang.StringgetAlgorithmName()Get name of key generator algorithm.booleanhasMandatoryParameters()Does the algorithm has mandatory parameters and therefore requires a key generator definition in mapping file?
-
-
-
Method Detail
-
getAlgorithmName
java.lang.String getAlgorithmName()
Get name of key generator algorithm.- Returns:
- Name of key generator algorithm.
-
hasMandatoryParameters
boolean hasMandatoryParameters()
Does the algorithm has mandatory parameters and therefore requires a key generator definition in mapping file?- Returns:
trueif algorithm has mandatory parameters and therefore requires a key generator definition in mapping file.falseif algorithm does not require parameters or has only optional parameters.
-
createKeyGenerator
KeyGenerator createKeyGenerator() throws GeneratorException
Create a default key generator instance with the algorithm the factory is responsible for. This is only possible for those algorithms that do not require mandatory parameters.- Returns:
- A default key generator instance with the algorithm the factory is responsible for.
- Throws:
GeneratorException- If creation of default key generator is not possible due to required mandatory parameters.
-
createKeyGenerator
KeyGenerator createKeyGenerator(KeyGeneratorDef definition) throws GeneratorException
Create a key generator instance from the given definition with the algorithm the factory is responsible for.- Parameters:
definition- The definition to initialize the key generator.- Returns:
- A key generator instance initialized with given definition with the algorithm the factory is responsible for.
- Throws:
GeneratorException- If failed to create a key generator instance.
-
-