PersistentIdentifierGenerator

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> hibernate >> [ id overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.hibernate.id.PersistentIdentifierGenerator

SOURCE |

Download org.hibernate.id.PersistentIdentifierGenerator

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.hibernate.id
Interface PersistentIdentifierGenerator

All Superinterfaces:: IdentifierGenerator

All Known Implementing Classes:: MultipleHiLoPerTableGenerator, SequenceGenerator, 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

Field Summary

static java.lang.String CATALOG
          The configuration parameter holding the catalog name

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


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

Method Summary

java.lang.Object generatorKey()
          Return a key unique to the underlying database objects.

java.lang.String[] sqlCreateStrings(org.hibernate.dialect.Dialect dialect)
          The SQL required to create the underlying database objects.

java.lang.String[] sqlDropStrings(org.hibernate.dialect.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 java.lang.String SCHEMA

The configuration parameter holding the schema name

See Also:: Constant Field Values

TABLE

public static final java.lang.String TABLE

The configuration parameter holding the table name for the generated id

See Also:: Constant Field Values

TABLES

public 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

public 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

public static final java.lang.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 java.lang.String[] sqlCreateStrings(org.hibernate.dialect.Dialect dialect)
                                    throws org.hibernate.HibernateException

The SQL required to create the underlying database objects.

sqlDropStrings

public java.lang.String[] sqlDropStrings(org.hibernate.dialect.Dialect dialect)
                                  throws org.hibernate.HibernateException

The SQL required to remove the underlying database objects.

generatorKey

public java.lang.Object generatorKey()

Return a key unique to the underlying database objects. Prevents us from trying to create/remove them multiple times.