Interface KeyGeneratorFactory

All Known Implementing Classes:
Db2SequenceKeyGeneratorFactory, HighLowKeyGeneratorFactory, HsqlSequenceKeyGeneratorFactory, IdentityKeyGeneratorFactory, MaxKeyGeneratorFactory, OracleSequenceKeyGeneratorFactory, PostgresqlSequenceKeyGeneratorFactory, SapdbSequenceKeyGeneratorFactory, SequenceKeyGeneratorFactory, UUIDKeyGeneratorFactory

public interface KeyGeneratorFactory
Interface 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

    Modifier and Type
    Method
    Description
    Create a default key generator instance with the algorithm the factory is responsible for.
    Create a key generator instance from the given definition with the algorithm the factory is responsible for.
    Get name of key generator algorithm.
    boolean
    Does the algorithm has mandatory parameters and therefore requires a key generator definition in mapping file?
  • Method Details

    • getAlgorithmName

      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:
      true if algorithm has mandatory parameters and therefore requires a key generator definition in mapping file. false if 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.