org.hibernate.id.enhanced.DatabaseStructure Maven / Gradle / Ivy
package org.hibernate.id.enhanced;
import org.hibernate.engine.SessionImplementor;
import org.hibernate.dialect.Dialect;
/**
* Encapsulates definition of the underlying data structure backing a
* sequence-style generator.
*
* @author Steve Ebersole
*/
public interface DatabaseStructure {
/**
* The name of the database structure (table or sequence).
* @return The structure name.
*/
public String getName();
/**
* How many times has this structure been accessed through this reference?
* @return The number of accesses.
*/
public int getTimesAccessed();
/**
* The configured increment size
* @return The configured increment size
*/
public int getIncrementSize();
/**
* A callback to be able to get the next value from the underlying
* structure as needed.
*
* @param session The session.
* @return The next value.
*/
public AccessCallback buildCallback(SessionImplementor session);
/**
* Prepare this structure for use. Called sometime after instantiation,
* but before first use.
*
* @param optimizer The optimizer being applied to the generator.
*/
public void prepare(Optimizer optimizer);
/**
* Commands needed to create the underlying structures.
* @param dialect The database dialect being used.
* @return The creation commands.
*/
public String[] sqlCreateStrings(Dialect dialect);
/**
* Commands needed to drop the underlying structures.
* @param dialect The database dialect being used.
* @return The drop commands.
*/
public String[] sqlDropStrings(Dialect dialect);
}