org.hibernate.boot.model.relational

Class AbstractAuxiliaryDatabaseObject

java.lang.Object

org.hibernate.boot.model.relational.AbstractAuxiliaryDatabaseObject

All Implemented Interfaces:

Serializable, AuxiliaryDatabaseObject, AuxiliaryDatabaseObject.Expandable, Exportable

Direct Known Subclasses:

SimpleAuxiliaryDatabaseObject

public abstract class AbstractAuxiliaryDatabaseObject
extends Object
implements AuxiliaryDatabaseObject, AuxiliaryDatabaseObject.Expandable

Convenience base class for AuxiliaryDatabaseObjects.

This implementation performs dialect scoping checks strictly based on dialect name comparisons. Custom implementations might want to do instanceof-type checks.

Author:

Steve Ebersole

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.boot.model.relational.AuxiliaryDatabaseObject

AuxiliaryDatabaseObject.Expandable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAuxiliaryDatabaseObject()
	AbstractAuxiliaryDatabaseObject(boolean beforeTables)
protected	AbstractAuxiliaryDatabaseObject(boolean beforeTables, Set<String> dialectScopes)
protected	AbstractAuxiliaryDatabaseObject(Set<String> dialectScopes)

Method Summary

Modifier and Type	Method and Description
void	addDialectScope(String dialectName)
boolean	appliesToDialect(Dialect dialect) Does this database object apply to the given dialect?
boolean	beforeTablesOnCreation() Defines a simple precedence.
Set	getDialectScopes()
String	getExportIdentifier() Get a unique identifier to make sure we are not exporting the same database structure multiple times.

Methods inherited from class java.lang.Object

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

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

sqlCreateStrings, sqlDropStrings

Constructor Detail

AbstractAuxiliaryDatabaseObject

protected AbstractAuxiliaryDatabaseObject()

AbstractAuxiliaryDatabaseObject

public AbstractAuxiliaryDatabaseObject(boolean beforeTables)

AbstractAuxiliaryDatabaseObject

protected AbstractAuxiliaryDatabaseObject(Set<String> dialectScopes)

AbstractAuxiliaryDatabaseObject

protected AbstractAuxiliaryDatabaseObject(boolean beforeTables,
                                          Set<String> dialectScopes)

Method Detail

getExportIdentifier

public String getExportIdentifier()

Description copied from interface: Exportable

Get a unique identifier to make sure we are not exporting the same database structure multiple times.

Specified by:

getExportIdentifier in interface Exportable

Returns:

The exporting identifier.

addDialectScope

public void addDialectScope(String dialectName)

Specified by:

addDialectScope in interface AuxiliaryDatabaseObject.Expandable

getDialectScopes

public Set getDialectScopes()

appliesToDialect

public boolean appliesToDialect(Dialect dialect)

Description copied from interface: AuxiliaryDatabaseObject

Does this database object apply to the given dialect?

Specified by:

appliesToDialect in interface AuxiliaryDatabaseObject

Parameters:

dialect - The dialect to check against.

Returns:

True if this database object does apply to the given dialect.

beforeTablesOnCreation

public boolean beforeTablesOnCreation()

Description copied from interface: AuxiliaryDatabaseObject

Defines a simple precedence. Should creation of this auxiliary object happen before creation of tables? If true, the auxiliary object creation will happen after any explicit schema creations but before table/sequence creations; if false, the auxiliary object creation will happen after explicit schema creations and after table/sequence creations. This precedence is automatically inverted for dropping.

Specified by:

beforeTablesOnCreation in interface AuxiliaryDatabaseObject

Returns:

true indicates this object should be created before tables; false indicates it should be created after.