Class DelegatingUniqueDelegate

java.lang.Object

org.hibernate.dialect.unique.spi.DelegatingUniqueDelegate

All Implemented Interfaces:

UniqueDelegate

@SPI({USE,IMPLEMENT})
public abstract class DelegatingUniqueDelegate
extends Object
implements UniqueDelegate

Supported base for a provider which decorates another unique-key strategy.

Override only the operations whose database grammar differs. All other operations, including representation and capability answers, are forwarded.

Since:

8.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DelegatingUniqueDelegate(UniqueDelegate delegate)	Construct a decorator which forwards to the given strategy.

Method Summary

Modifier and Type	Method	Description
protected final UniqueDelegate	delegate()
String	getAlterTableToAddUniqueKeyCommand(UniqueKey uniqueKey, Metadata metadata, SqlStringGenerationContext context)	Render the complete command which adds the unique key.
String	getAlterTableToDropUniqueKeyCommand(UniqueKey uniqueKey, Metadata metadata, SqlStringGenerationContext context)	Render the complete command which drops the unique key previously emitted by UniqueDelegate.getAlterTableToAddUniqueKeyCommand(UniqueKey, Metadata, SqlStringGenerationContext).
String	getColumnDefinitionUniquenessFragment(Column column, SqlStringGenerationContext context)	Render the column-definition uniqueness fragment for a column explicitly marked [Column#isUnique() unique].
String	getTableCreationUniqueConstraintsFragment(Table table, SqlStringGenerationContext context)	Render all unique declarations embedded in create table.
UniqueKeyRepresentation	representation(UniqueKeyRepresentationRequest request)	Select whether a logical unique declaration is represented as a constraint or an index.
boolean	supportsNullsNotDistinct()	Whether this delegate can render nulls not distinct for a requested unique constraint.

Methods inherited from class Object

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

Constructor Details

DelegatingUniqueDelegate

@SPI(IMPLEMENT)
protected DelegatingUniqueDelegate(UniqueDelegate delegate)

Construct a decorator which forwards to the given strategy.

Method Details

delegate

protected final UniqueDelegate delegate()

representation

public UniqueKeyRepresentation representation(UniqueKeyRepresentationRequest request)

Description copied from interface: UniqueDelegate

Select whether a logical unique declaration is represented as a constraint or an index.

Specified by:

representation in interface UniqueDelegate

supportsNullsNotDistinct

public boolean supportsNullsNotDistinct()

Description copied from interface: UniqueDelegate

Whether this delegate can render nulls not distinct for a requested unique constraint.

Specified by:

supportsNullsNotDistinct in interface UniqueDelegate

getColumnDefinitionUniquenessFragment

public String getColumnDefinitionUniquenessFragment(Column column,
 SqlStringGenerationContext context)

Description copied from interface: UniqueDelegate

Render the column-definition uniqueness fragment for a column explicitly marked [Column#isUnique() unique]. Return an empty string when uniqueness belongs at another emission point.

Specified by:

getColumnDefinitionUniquenessFragment in interface UniqueDelegate

getTableCreationUniqueConstraintsFragment

public String getTableCreationUniqueConstraintsFragment(Table table,
 SqlStringGenerationContext context)

Description copied from interface: UniqueDelegate

Render all unique declarations embedded in create table. Include the required leading comma, or return an empty string when no declaration is emitted at this point.

Specified by:

getTableCreationUniqueConstraintsFragment in interface UniqueDelegate

getAlterTableToAddUniqueKeyCommand

public String getAlterTableToAddUniqueKeyCommand(UniqueKey uniqueKey,
 Metadata metadata,
 SqlStringGenerationContext context)

Description copied from interface: UniqueDelegate

Render the complete command which adds the unique key. Return an empty string when it was already emitted during table creation or is unsupported.

Specified by:

getAlterTableToAddUniqueKeyCommand in interface UniqueDelegate

getAlterTableToDropUniqueKeyCommand

public String getAlterTableToDropUniqueKeyCommand(UniqueKey uniqueKey,
 Metadata metadata,
 SqlStringGenerationContext context)

Description copied from interface: UniqueDelegate

Render the complete command which drops the unique key previously emitted by UniqueDelegate.getAlterTableToAddUniqueKeyCommand(UniqueKey, Metadata, SqlStringGenerationContext). Return an empty string when no corresponding database object was created.

Specified by:

getAlterTableToDropUniqueKeyCommand in interface UniqueDelegate