org.hibernate.id
Interface PersistentIdentifierGenerator

All Superinterfaces:

IdentifierGenerator

All Known Implementing Classes:

MultipleHiLoPerTableGenerator, SequenceGenerator, SequenceStyleGenerator, TableGenerator, TableGenerator

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 org.apache.commons.logging.Log	SQL
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 Detail

SCHEMA

public static final String SCHEMA

The configuration parameter holding the schema name

See Also:

Constant Field Values

TABLE

public static final String TABLE

The configuration parameter holding the table name for the generated id

See Also:

Constant Field Values

TABLES

public static final 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

public static final String PK

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

See Also:

Constant Field Values

CATALOG

public static final String CATALOG

The configuration parameter holding the catalog name

See Also:

Constant Field Values

SQL

public static final org.apache.commons.logging.Log SQL

Method Detail

sqlCreateStrings

public String[] sqlCreateStrings(Dialect dialect)
                          throws HibernateException

The SQL required to create the underlying database objects.

Parameters:

dialect -

Returns:

String[]

Throws:

HibernateException

sqlDropStrings

public String[] sqlDropStrings(Dialect dialect)
                        throws HibernateException

The SQL required to remove the underlying database objects.

Parameters:

dialect -

Returns:

String

Throws:

HibernateException

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