Interface SoftDeleteMapping

All Superinterfaces:

AuxiliaryMapping, Bindable, JdbcMappingContainer, MappingModelExpressible, ModelPart, SelectableMapping, SqlExpressible, SqlTypedMapping, VirtualModelPart

public interface SoftDeleteMapping
extends AuxiliaryMapping, SelectableMapping, VirtualModelPart, SqlExpressible

Metadata about the indicator column for entities and collections enabled for soft delete

See Also:

• SoftDelete

Nested Class Summary

Nested classes/interfaces inherited from interface Bindable

Bindable.JdbcValuesBiConsumer<X,Y>, Bindable.JdbcValuesConsumer

Nested classes/interfaces inherited from interface ModelPart

ModelPart.JdbcValueBiConsumer<X,Y>, ModelPart.JdbcValueConsumer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE_NAME

Method Summary

Modifier and Type	Method	Description
ColumnValueBinding	createDeletedValueBinding(ColumnReference softDeleteColumnReference)	Create a ColumnValueBinding for deleted indicator.
Predicate	createNonDeletedRestriction(TableReference tableReference)	Create a SQL AST Predicate for restricting matches to non-deleted rows
Predicate	createNonDeletedRestriction(TableReference tableReference, SqlExpressionResolver expressionResolver)	Create a SQL AST Predicate for restricting matches to non-deleted rows
ColumnValueBinding	createNonDeletedValueBinding(ColumnReference softDeleteColumnReference)	Create a ColumnValueBinding for non-deleted indicator.
Assignment	createSoftDeleteAssignment(TableReference tableReference)	Create a SQL AST Assignment for setting the soft-delete column to its indicated "deleted" value
default @Nullable Integer	getArrayLength()
String	getColumnName()	The name of the soft-delete indicator column.
default String	getContainingTableExpression()	The name of the table to which this selectable is mapped
default @Nullable String	getCustomReadExpression()	The selection's read expression accounting for formula treatment as well as ColumnTransformer.read()
default @Nullable String	getCustomWriteExpression()	The selection's write expression accounting ColumnTransformer.write()
default @Nullable Long	getLength()
default @Nullable Integer	getPrecision()
default @Nullable Integer	getScale()
default String	getSelectableName()
default String	getSelectionExpression()	The selection's expression.
SoftDeleteType	getSoftDeleteStrategy()	The soft-delete strategy - how to interpret indicator values
String	getTableName()	The name of the table which holds the indicator column
default @Nullable Integer	getTemporalPrecision()
default boolean	isFormula()	Is the mapping a formula instead of a physical column?
default boolean	isInsertable()
default boolean	isNullable()	Is the mapping considered nullable?
default boolean	isPartitioned()
default boolean	isUpdateable()

Methods inherited from interface AuxiliaryMapping

addToInsertGroup, applyPredicate, applyPredicate, applyPredicate, applyPredicate, applyPredicate, applyPredicate, getExtraSelectExpressions, getJdbcMapping, isAffectedByInfluencers, resolveTableName, useAuxiliaryTable

Methods inherited from interface Bindable

addToCacheKey, disassemble, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, getJdbcTypeCount

Methods inherited from interface JdbcMappingContainer

forEachJdbcType, getSingleJdbcMapping

Methods inherited from interface ModelPart

applySqlSelections, applySqlSelections, areEqual, asAttributeMapping, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, breakDownJdbcValues, createDomainResult, decompose, decompose, findContainingEntityMapping, forEachSelectable, forEachSelectable, getJavaType, getNavigableRole, getPartMappingType, getPartName, hasPartitionedSelectionMapping, isEntityIdentifierMapping

Methods inherited from interface SelectableMapping

getSelectablePath, getWriteExpression

Methods inherited from interface SqlExpressible

getJdbcMapping, getJdbcMapping

Methods inherited from interface SqlTypedMapping

getJdbcMapping, isLob, toSize

Methods inherited from interface VirtualModelPart

isVirtual

Field Details

ROLE_NAME

static final String ROLE_NAME

See Also:

• Constant Field Values

Method Details

getSoftDeleteStrategy

@Internal
SoftDeleteType getSoftDeleteStrategy()

The soft-delete strategy - how to interpret indicator values

getColumnName

@Internal
String getColumnName()

The name of the soft-delete indicator column.

getTableName

String getTableName()

The name of the table which holds the indicator column

Specified by:

getTableName in interface AuxiliaryMapping

createSoftDeleteAssignment

Assignment createSoftDeleteAssignment(TableReference tableReference)

Create a SQL AST Assignment for setting the soft-delete column to its indicated "deleted" value

Parameters:

tableReference - Reference for the table containing the soft-delete column

createNonDeletedRestriction

Predicate createNonDeletedRestriction(TableReference tableReference)

Create a SQL AST Predicate for restricting matches to non-deleted rows

Parameters:

tableReference - Reference for the table containing the soft-delete column

createNonDeletedRestriction

Predicate createNonDeletedRestriction(TableReference tableReference,
 SqlExpressionResolver expressionResolver)

Create a SQL AST Predicate for restricting matches to non-deleted rows

Parameters:

tableReference - Reference for the table containing the soft-delete column

expressionResolver - Resolver for SQL AST Expressions

createNonDeletedValueBinding

ColumnValueBinding createNonDeletedValueBinding(ColumnReference softDeleteColumnReference)

Create a ColumnValueBinding for non-deleted indicator.

Parameters:

softDeleteColumnReference - Reference to the soft-delete column

API Note:

Generally used as a restriction in a SQL AST

createDeletedValueBinding

ColumnValueBinding createDeletedValueBinding(ColumnReference softDeleteColumnReference)

Create a ColumnValueBinding for deleted indicator.

Parameters:

softDeleteColumnReference - Reference to the soft-delete column

API Note:

Generally used as an assignment in a SQL AST

getSelectionExpression

default String getSelectionExpression()

Description copied from interface: SelectableMapping

The selection's expression. This is the column name or formula

Specified by:

getSelectionExpression in interface SelectableMapping

getSelectableName

default String getSelectableName()

Specified by:

getSelectableName in interface SelectableMapping

getContainingTableExpression

default String getContainingTableExpression()

Description copied from interface: SelectableMapping

The name of the table to which this selectable is mapped

Specified by:

getContainingTableExpression in interface SelectableMapping

getCustomReadExpression

default @Nullable String getCustomReadExpression()

Description copied from interface: SelectableMapping

The selection's read expression accounting for formula treatment as well as ColumnTransformer.read()

Specified by:

getCustomReadExpression in interface SelectableMapping

getCustomWriteExpression

default @Nullable String getCustomWriteExpression()

Description copied from interface: SelectableMapping

The selection's write expression accounting ColumnTransformer.write()

Specified by:

getCustomWriteExpression in interface SelectableMapping

isFormula

default boolean isFormula()

Description copied from interface: SelectableMapping

Is the mapping a formula instead of a physical column?

Specified by:

isFormula in interface SelectableMapping

isNullable

default boolean isNullable()

Description copied from interface: SelectableMapping

Is the mapping considered nullable?

Specified by:

isNullable in interface SelectableMapping

isInsertable

default boolean isInsertable()

Specified by:

isInsertable in interface SelectableMapping

isUpdateable

default boolean isUpdateable()

Specified by:

isUpdateable in interface SelectableMapping

isPartitioned

default boolean isPartitioned()

Specified by:

isPartitioned in interface SelectableMapping

getLength

default @Nullable Long getLength()

Specified by:

getLength in interface SqlTypedMapping

getArrayLength

default @Nullable Integer getArrayLength()

Specified by:

getArrayLength in interface SqlTypedMapping

getPrecision

default @Nullable Integer getPrecision()

Specified by:

getPrecision in interface SqlTypedMapping

getScale

default @Nullable Integer getScale()

Specified by:

getScale in interface SqlTypedMapping

getTemporalPrecision

default @Nullable Integer getTemporalPrecision()

Specified by:

getTemporalPrecision in interface SqlTypedMapping