Class SequenceStructure

java.lang.Object

org.hibernate.id.enhanced.SequenceStructure

All Implemented Interfaces:

ExportableProducer, DatabaseStructure

Direct Known Subclasses:

OrderedSequenceStructure

public class SequenceStructure
extends Object
implements DatabaseStructure

Describes a sequence.

Field Summary

Fields

Modifier and Type	Field	Description
protected QualifiedName	physicalSequenceName

Constructor Summary

Constructors

Constructor	Description
SequenceStructure(String contributor, QualifiedName qualifiedSequenceName, int initialValue, int incrementSize, Class<?> numberType)
SequenceStructure(String contributor, QualifiedName qualifiedSequenceName, 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.
protected void	buildSequence(Database database)
void	configure(Optimizer optimizer)	Configures this structure with the given arguments.
String[]	getAllSqlForTests()	Deprecated.
int	getIncrementSize()	The configured increment size
int	getInitialValue()	The configured initial value
QualifiedName	getPhysicalName()	The physical name of the database structure (table or sequence).
protected QualifiedName	getQualifiedName()
protected final int	getSourceIncrementSize()
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	registerExportables(Database database)	Register database objects involved in this structure, e.g.
void	registerExtraExportables(Table table, Optimizer optimizer)	Register additional database objects which need to be aware of the table for which this structure is used to generate values.

Methods inherited from class Object

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

Methods inherited from interface DatabaseStructure

prepare

Field Details

physicalSequenceName

protected QualifiedName physicalSequenceName

Constructor Details

SequenceStructure

public SequenceStructure(String contributor,
 QualifiedName qualifiedSequenceName,
 int initialValue,
 int incrementSize,
 Class<?> numberType)

SequenceStructure

public SequenceStructure(String contributor,
 QualifiedName qualifiedSequenceName,
 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.

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.

getInitialValue

public int getInitialValue()

Description copied from interface: DatabaseStructure

The configured initial value

Specified by:

getInitialValue in interface DatabaseStructure

Returns:

The configured initial value

getAllSqlForTests

@Deprecated
public String[] getAllSqlForTests()

Deprecated.

Specified by:

getAllSqlForTests in interface DatabaseStructure

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.

configure

public void configure(Optimizer optimizer)

Description copied from interface: DatabaseStructure

Configures this structure with the given arguments.

Called just after instantiation, before DatabaseStructure.initialize(SqlStringGenerationContext)

Specified by:

configure in interface DatabaseStructure

Parameters:

optimizer - The optimizer being applied to the generator.

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

registerExtraExportables

public void registerExtraExportables(Table table,
 Optimizer optimizer)

Description copied from interface: DatabaseStructure

Register additional database objects which need to be aware of the table for which this structure is used to generate values. Used to deal with automatic sequence resynchronization after data import.

Specified by:

registerExtraExportables in interface DatabaseStructure

Parameters:

table - The table for which this structure is used to generate values

optimizer - The Optimizer for this generator

See Also:

• SchemaManager.resynchronizeGenerators()

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.

getSourceIncrementSize

protected final int getSourceIncrementSize()

getQualifiedName

protected QualifiedName getQualifiedName()

buildSequence

protected void buildSequence(Database database)