org.hibernate.id

Interface PersistentIdentifierGenerator

All Superinterfaces:
IdentifierGenerator
Known Implementing Classes:
MultipleHiLoPerTableGenerator, SequenceGenerator, SequenceHiLoGenerator, SequenceIdentityGenerator, SequenceStyleGenerator, TableGenerator, TableGenerator, TableHiLoGenerator

public interface PersistentIdentifierGenerator
extends IdentifierGenerator

An IdentifierGenerator that requires creation of database objects.

All PersistentIdentifierGenerators that also implement Configurable have access to a special mapping parameter: schema
Author:
Gavin King
See Also:
IdentifierGenerator, Configurable

Field Summary

static String
CATALOG
The configuration parameter holding the catalog name
static String
PK
The configuration parameter holding the primary key column name of the generated id
static String
SCHEMA
The configuration parameter holding the schema name
static SQLStatementLogger
SQL_STATEMENT_LOGGER
static String
TABLE
The configuration parameter holding the table name for the generated id
static String
TABLES
The configuration parameter holding the table names for all tables for which the id must be unique

Fields inherited from interface org.hibernate.id.IdentifierGenerator

ENTITY_NAME

Method Summary

Object
generatorKey()
Return a key unique to the underlying database objects.
String[]
sqlCreateStrings(Dialect dialect)
The SQL required to create the underlying database objects.
String[]
sqlDropStrings(Dialect dialect)
The SQL required to remove the underlying database objects.

Methods inherited from interface org.hibernate.id.IdentifierGenerator

generate

Field Details

CATALOG

public static final String CATALOG
The configuration parameter holding the catalog name

PK

public static final String PK
The configuration parameter holding the primary key column name of the generated id

SCHEMA

public static final String SCHEMA
The configuration parameter holding the schema name

SQL_STATEMENT_LOGGER

public static final SQLStatementLogger SQL_STATEMENT_LOGGER

TABLE

public static final String TABLE
The configuration parameter holding the table name for the generated id

TABLES

public static final String TABLES
The configuration parameter holding the table names for all tables for which the id must be unique

Method Details

generatorKey

public Object generatorKey()
Return a key unique to the underlying database objects. Prevents us from trying to create/remove them multiple times.
Returns:
Object an identifying key for this generator

sqlCreateStrings

public String[] sqlCreateStrings(Dialect dialect)
            throws HibernateException
The SQL required to create the underlying database objects.
Parameters:
dialect - The dialect against which to generate the create command(s)
Returns:
The create command(s)
Throws:
HibernateException - problem creating the create command(s)

sqlDropStrings

public String[] sqlDropStrings(Dialect dialect)
            throws HibernateException
The SQL required to remove the underlying database objects.
Parameters:
dialect - The dialect against which to generate the drop command(s)
Returns:
The drop command(s)
Throws:
HibernateException - problem creating the drop command(s)