Top Description Methods
org.hibernate.metamodel.mapping

public Interface SoftDeleteMapping

extends SelectableMapping, VirtualModelPart, SqlExpressible
Known Direct Implementers
org.hibernate.metamodel.mapping.internal.SoftDeleteMappingImpl
Metadata about the indicator column for entities and collections enabled for soft delete
Author
Steve Ebersole
See Also
org.hibernate.annotations.SoftDelete

Method Summary

Modifier and TypeMethod and Description
public default String
getColumnDefinition()

Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getColumnDefinition.

public String
getColumnName()

The name of the soft-delete indicator column.

public default String
getContainingTableExpression()

Implements org.hibernate.metamodel.mapping.SelectableMapping.getContainingTableExpression.

The name of the table to which this selectable is mapped
public default String
getCustomReadExpression()

Implements org.hibernate.metamodel.mapping.SelectableMapping.getCustomReadExpression.

The selection's read expression accounting for formula treatment as well as ColumnTransformer#read()
public default String
getCustomWriteExpression()

Implements org.hibernate.metamodel.mapping.SelectableMapping.getCustomWriteExpression.

The selection's write expression accounting ColumnTransformer#write()
public String
getDeletedLiteralText()

The String representation of the SQL literal value which indicates a deleted row

public Object
getDeletedLiteralValue()

The SQL literal value which indicates a deleted row

public default Long
getLength()

Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getLength.

public String
getNonDeletedLiteralText()

The String representation of the SQL literal value which indicates a non-deleted row

public Object
getNonDeletedLiteralValue()

The SQL literal value which indicates a non-deleted row

public default Integer
getPrecision()

Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getPrecision.

public default Integer
getScale()

Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getScale.

public default String
getSelectableName()

Overrides default org.hibernate.metamodel.mapping.SelectableMapping.getSelectableName.

public default String
getSelectionExpression()

Implements org.hibernate.metamodel.mapping.SelectableMapping.getSelectionExpression.

The selection's expression.
public String
getTableName()

The name of the table which holds the indicator column

public default String
getWriteExpression()

Overrides default org.hibernate.metamodel.mapping.SelectableMapping.getWriteExpression.

public default boolean
isFormula()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isFormula.

Is the mapping a formula instead of a physical column?
public default boolean
isInsertable()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isInsertable.

public default boolean
isNullable()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isNullable.

Is the mapping considered nullable?
public default boolean
isPartitioned()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isPartitioned.

public default boolean
isUpdateable()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isUpdateable.

Inherited from org.hibernate.metamodel.mapping.SelectableMapping:
getSelectablePath
Inherited from org.hibernate.metamodel.mapping.SqlExpressible:
getJdbcMappinggetJdbcMapping
Inherited from org.hibernate.metamodel.mapping.VirtualModelPart:
isVirtual

Method Detail

getColumnDefinitionback to summary
public default String getColumnDefinition()

Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getColumnDefinition.

Annotations
@Override
getColumnNameback to summary
public String getColumnName()

The name of the soft-delete indicator column.

getContainingTableExpressionback to summary
public default String getContainingTableExpression()

Implements org.hibernate.metamodel.mapping.SelectableMapping.getContainingTableExpression.

Doc from org.hibernate.metamodel.mapping.SelectableMapping.getContainingTableExpression.

The name of the table to which this selectable is mapped

Annotations
@Override
getCustomReadExpressionback to summary
public default String getCustomReadExpression()

Implements org.hibernate.metamodel.mapping.SelectableMapping.getCustomReadExpression.

Doc from org.hibernate.metamodel.mapping.SelectableMapping.getCustomReadExpression.

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

Annotations
@Override
getCustomWriteExpressionback to summary
public default String getCustomWriteExpression()

Implements org.hibernate.metamodel.mapping.SelectableMapping.getCustomWriteExpression.

Doc from org.hibernate.metamodel.mapping.SelectableMapping.getCustomWriteExpression.

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

Annotations
@Override
getDeletedLiteralTextback to summary
public String getDeletedLiteralText()

The String representation of the SQL literal value which indicates a deleted row

getDeletedLiteralValueback to summary
public Object getDeletedLiteralValue()

The SQL literal value which indicates a deleted row

getLengthback to summary
public default Long getLength()

Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getLength.

Annotations
@Override
getNonDeletedLiteralTextback to summary
public String getNonDeletedLiteralText()

The String representation of the SQL literal value which indicates a non-deleted row

getNonDeletedLiteralValueback to summary
public Object getNonDeletedLiteralValue()

The SQL literal value which indicates a non-deleted row

API Note

The inverse of getDeletedLiteralValue()

getPrecisionback to summary
public default Integer getPrecision()

Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getPrecision.

Annotations
@Override
getScaleback to summary
public default Integer getScale()

Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getScale.

Annotations
@Override
getSelectableNameback to summary
public default String getSelectableName()

Overrides default org.hibernate.metamodel.mapping.SelectableMapping.getSelectableName.

Annotations
@Override
getSelectionExpressionback to summary
public default String getSelectionExpression()

Implements org.hibernate.metamodel.mapping.SelectableMapping.getSelectionExpression.

Doc from org.hibernate.metamodel.mapping.SelectableMapping.getSelectionExpression.

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

Annotations
@Override
getTableNameback to summary
public String getTableName()

The name of the table which holds the indicator column

getWriteExpressionback to summary
public default String getWriteExpression()

Overrides default org.hibernate.metamodel.mapping.SelectableMapping.getWriteExpression.

Annotations
@Override
isFormulaback to summary
public default boolean isFormula()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isFormula.

Doc from org.hibernate.metamodel.mapping.SelectableMapping.isFormula.

Is the mapping a formula instead of a physical column?

Annotations
@Override
isInsertableback to summary
public default boolean isInsertable()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isInsertable.

Annotations
@Override
isNullableback to summary
public default boolean isNullable()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isNullable.

Doc from org.hibernate.metamodel.mapping.SelectableMapping.isNullable.

Is the mapping considered nullable?

Annotations
@Override
isPartitionedback to summary
public default boolean isPartitioned()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isPartitioned.

Annotations
@Override
isUpdateableback to summary
public default boolean isUpdateable()

Implements org.hibernate.metamodel.mapping.SelectableMapping.isUpdateable.

Annotations
@Override