org.hibernate.id
Interface PersistentIdentifierGenerator

All Superinterfaces:

IdentifierGenerator

All 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

SCHEMA

static final java.lang.String SCHEMA

The configuration parameter holding the schema name

See Also:

Constant Field Values

TABLE

static final java.lang.String TABLE

The configuration parameter holding the table name for the generated id

See Also:

Constant Field Values

TABLES

static final java.lang.String TABLES

The configuration parameter holding the table names for all tables for which the id must be unique

See Also:

Constant Field Values

PK

static final java.lang.String PK

The configuration parameter holding the primary key column name of the generated id

See Also:

Constant Field Values

CATALOG

static final java.lang.String CATALOG

The configuration parameter holding the catalog name

See Also:

Constant Field Values

SQL_STATEMENT_LOGGER

static final SQLStatementLogger SQL_STATEMENT_LOGGER

sqlCreateStrings

java.lang.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

java.lang.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)

generatorKey

java.lang.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