Package org.hibernate.id

Interface PersistentIdentifierGenerator

All Superinterfaces:

ExportableProducer, IdentifierGenerator

All Known Implementing Classes:

MultipleHiLoPerTableGenerator, SequenceGenerator, SequenceHiLoGenerator, SequenceIdentityGenerator, SequenceStyleGenerator, TableGenerator

public interface PersistentIdentifierGenerator
extends IdentifierGenerator, ExportableProducer

An IdentifierGenerator that requires creation of database objects.

All PersistentIdentifierGenerators that also implement Configurable have access to a special mapping parameter: schema

See Also:

IdentifierGenerator, Configurable

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CATALOG	The configuration parameter holding the catalog name
static java.lang.String	IDENTIFIER_NORMALIZER	The key under whcih to find the ObjectNameNormalizer in the config param map.
static java.lang.String	PK	The configuration parameter holding the primary key column name of the generated id
static java.lang.String	SCHEMA	The configuration parameter holding the schema name
static java.lang.String	TABLE	The configuration parameter holding the table name for the generated id
static java.lang.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, GENERATOR_NAME, JPA_ENTITY_NAME

Method Summary

Modifier and Type	Method	Description
java.lang.Object	generatorKey()	Return a key unique to the underlying database objects.
java.lang.String[]	sqlCreateStrings(Dialect dialect)	Deprecated. Utilize the ExportableProducer contract instead
java.lang.String[]	sqlDropStrings(Dialect dialect)	Deprecated. Utilize the ExportableProducer contract instead

Methods inherited from interface org.hibernate.boot.model.relational.ExportableProducer

registerExportables

Methods inherited from interface org.hibernate.id.IdentifierGenerator

generate, supportsJdbcBatchInserts

Field Detail

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

IDENTIFIER_NORMALIZER

static final java.lang.String IDENTIFIER_NORMALIZER

The key under whcih to find the ObjectNameNormalizer in the config param map.

See Also:

Constant Field Values

Method Detail

sqlCreateStrings

@Deprecated
java.lang.String[] sqlCreateStrings(Dialect dialect)
                             throws HibernateException

Deprecated.

Utilize the ExportableProducer contract instead

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

@Deprecated
java.lang.String[] sqlDropStrings(Dialect dialect)
                           throws HibernateException

Deprecated.

Utilize the ExportableProducer contract instead

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