Top Description Fields Constructors Methods
org.hibernate.boot.model.relational

public abstract Class AbstractAuxiliaryDatabaseObject

extends Object
implements AuxiliaryDatabaseObject, Expandable
Class Inheritance
All Implemented Interfaces
org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.Expandable, org.hibernate.boot.model.relational.AuxiliaryDatabaseObject, java.io.Serializable, org.hibernate.boot.model.relational.Exportable
Known Direct Subclasses
org.hibernate.boot.model.relational.SimpleAuxiliaryDatabaseObject
Imports
java.util.HashSet, .Set, java.util.concurrent.atomic.AtomicInteger, org.hibernate.dialect.Dialect
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

Field Summary

Modifier and TypeField and Description
private final boolean
beforeTables

private static final AtomicInteger
counter

private final Set<String>
dialectScopes

private static final String
EXPORT_IDENTIFIER_PREFIX

private final String
exportIdentifier

Constructor Summary

AccessConstructor and Description
protected
AbstractAuxiliaryDatabaseObject()

public
AbstractAuxiliaryDatabaseObject(boolean beforeTables)

protected
AbstractAuxiliaryDatabaseObject(Set<String> dialectScopes)

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

Method Summary

Modifier and TypeMethod and Description
public void
addDialectScope(String dialectName)

Implements org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.Expandable.addDialectScope.

public boolean
appliesToDialect(Dialect
The dialect to check against.
dialect)

Implements org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.appliesToDialect.

Does this database object apply to the given dialect?
public boolean
beforeTablesOnCreation()

Implements org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.beforeTablesOnCreation.

Defines a simple precedence.
public Set<String>
getDialectScopes()

public String
getExportIdentifier()

Implements org.hibernate.boot.model.relational.Exportable.getExportIdentifier.

Get a unique identifier to make sure we are not exporting the same database structure multiple times.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

beforeTablesback to summary
private final boolean beforeTables
counterback to summary
private static final AtomicInteger counter
dialectScopesback to summary
private final Set<String> dialectScopes
EXPORT_IDENTIFIER_PREFIXback to summary
private static final String EXPORT_IDENTIFIER_PREFIX
exportIdentifierback to summary
private final String exportIdentifier

Constructor Detail

AbstractAuxiliaryDatabaseObjectback to summary
protected AbstractAuxiliaryDatabaseObject()
AbstractAuxiliaryDatabaseObjectback to summary
public AbstractAuxiliaryDatabaseObject(boolean beforeTables)
AbstractAuxiliaryDatabaseObjectback to summary
protected AbstractAuxiliaryDatabaseObject(Set<String> dialectScopes)
AbstractAuxiliaryDatabaseObjectback to summary
protected AbstractAuxiliaryDatabaseObject(boolean beforeTables, Set<String> dialectScopes)

Method Detail

addDialectScopeback to summary
public void addDialectScope(String dialectName)

Implements org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.Expandable.addDialectScope.

Annotations
@Override
appliesToDialectback to summary
public boolean appliesToDialect(Dialect dialect)

Implements org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.appliesToDialect.

Doc from org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.appliesToDialect.

Does this database object apply to the given dialect?

Parameters
dialect:Dialect

The dialect to check against.

Returns:boolean

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

Annotations
@Override
beforeTablesOnCreationback to summary
public boolean beforeTablesOnCreation()

Implements org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.beforeTablesOnCreation.

Doc from org.hibernate.boot.model.relational.AuxiliaryDatabaseObject.beforeTablesOnCreation.

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 creation but before creation of tables and sequences.
  • If false, the auxiliary object creation will happen after explicit schema creation and after creation of tables and sequences.

This precedence is automatically inverted for when the schema is dropped.

Returns:boolean

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

Annotations
@Override
getDialectScopesback to summary
public Set<String> getDialectScopes()
getExportIdentifierback to summary
public String getExportIdentifier()

Implements org.hibernate.boot.model.relational.Exportable.getExportIdentifier.

Doc from org.hibernate.boot.model.relational.Exportable.getExportIdentifier.

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

Returns:String

The exporting identifier.

Annotations
@Override