Package org.hibernate.id.enhanced

Class TableStructure

java.lang.Object

org.hibernate.id.enhanced.TableStructure

All Implemented Interfaces:

ExportableProducer, DatabaseStructure

public class TableStructure
extends Object
implements DatabaseStructure

Describes a table used to mimic sequence behavior

Constructor Summary

Constructors

Constructor	Description
TableStructure(String contributor, QualifiedName qualifiedTableName, Identifier valueColumnNameIdentifier, int initialValue, int incrementSize, Class<?> numberType)
TableStructure(String contributor, QualifiedName qualifiedTableName, Identifier valueColumnNameIdentifier, int initialValue, int incrementSize, String options, Class<?> numberType)

Method Summary

Modifier and Type	Method	Description
AccessCallback	buildCallback(SharedSessionContractImplementor session)	A callback to be able to get the next value from the underlying structure as needed.
String[]	getAllSqlForTests()	Deprecated.
int	getIncrementSize()	The configured increment size
int	getInitialValue()	The configured initial value
Identifier	getLogicalValueColumnNameIdentifier()
QualifiedName	getPhysicalName()	The physical name of the database structure (table or sequence).
int	getTimesAccessed()	How many times has this structure been accessed through this reference?
void	initialize(SqlStringGenerationContext context)	Initializes this structure, in particular pre-generates SQL as necessary.
boolean	isPhysicalSequence()	Is the structure physically a sequence?
void	prepare(Optimizer optimizer)	Deprecated.
void	registerExportables(Database database)	Register database objects involved in this structure, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.id.enhanced.DatabaseStructure

configure

Constructor Details

TableStructure

public TableStructure(String contributor,
 QualifiedName qualifiedTableName,
 Identifier valueColumnNameIdentifier,
 int initialValue,
 int incrementSize,
 Class<?> numberType)

TableStructure

public TableStructure(String contributor,
 QualifiedName qualifiedTableName,
 Identifier valueColumnNameIdentifier,
 int initialValue,
 int incrementSize,
 String options,
 Class<?> numberType)

Method Details

getPhysicalName

public QualifiedName getPhysicalName()

Description copied from interface: DatabaseStructure

The physical name of the database structure (table or sequence).

Only available after DatabaseStructure.registerExportables(Database) has been called.

Specified by:

getPhysicalName in interface DatabaseStructure

Returns:

The structure name.

getLogicalValueColumnNameIdentifier

public Identifier getLogicalValueColumnNameIdentifier()

getInitialValue

public int getInitialValue()

Description copied from interface: DatabaseStructure

The configured initial value

Specified by:

getInitialValue in interface DatabaseStructure

Returns:

The configured initial value

getIncrementSize

public int getIncrementSize()

Description copied from interface: DatabaseStructure

The configured increment size

Specified by:

getIncrementSize in interface DatabaseStructure

Returns:

The configured increment size

getTimesAccessed

public int getTimesAccessed()

Description copied from interface: DatabaseStructure

How many times has this structure been accessed through this reference?

Specified by:

getTimesAccessed in interface DatabaseStructure

Returns:

The number of accesses.

getAllSqlForTests

@Deprecated
public String[] getAllSqlForTests()

Deprecated.

Specified by:

getAllSqlForTests in interface DatabaseStructure

prepare

@Deprecated
public void prepare(Optimizer optimizer)

Deprecated.

Description copied from interface: DatabaseStructure

Prepare this structure for use. Called sometime after instantiation, but before first use.

Specified by:

prepare in interface DatabaseStructure

Parameters:

optimizer - The optimizer being applied to the generator.

buildCallback

public AccessCallback buildCallback(SharedSessionContractImplementor session)

Description copied from interface: DatabaseStructure

A callback to be able to get the next value from the underlying structure as needed.

Specified by:

buildCallback in interface DatabaseStructure

Parameters:

session - The session.

Returns:

The next value.

isPhysicalSequence

public boolean isPhysicalSequence()

Description copied from interface: DatabaseStructure

Is the structure physically a sequence?

Specified by:

isPhysicalSequence in interface DatabaseStructure

Returns:

true if the actual database structure is a sequence; false otherwise.

registerExportables

public void registerExportables(Database database)

Description copied from interface: DatabaseStructure

Register database objects involved in this structure, e.g. sequences, tables, etc.

This method is called just once, after DatabaseStructure.configure(Optimizer), but before DatabaseStructure.initialize(SqlStringGenerationContext).

Specified by:

registerExportables in interface DatabaseStructure

Specified by:

registerExportables in interface ExportableProducer

Parameters:

database - The database instance

initialize

public void initialize(SqlStringGenerationContext context)

Description copied from interface: DatabaseStructure

Initializes this structure, in particular pre-generates SQL as necessary.

This method is called just once, after DatabaseStructure.registerExportables(Database), before first use.

Specified by:

initialize in interface DatabaseStructure

Parameters:

context - A context to help generate SQL strings