Interface AuxiliaryMapping

All Known Subinterfaces:

AuditMapping, SoftDeleteMapping, TemporalMapping

@Incubating
public interface AuxiliaryMapping

Unified mapping contract for state management strategies (soft-delete, temporal, audit).

Since:

7.4

Method Summary

Modifier and Type	Method	Description
default void	addToInsertGroup(MutationGroupBuilder insertGroupBuilder, EntityPersister persister)
void	applyPredicate(Supplier<Consumer<Predicate>> predicateCollector, SqlAstCreationState creationState, TableGroup tableGroup, NamedTableReference rootTableReference, EntityMappingType entityMappingType)
void	applyPredicate(EntityMappingType associatedEntityMappingType, Consumer<Predicate> predicateConsumer, LazyTableGroup lazyTableGroup, NavigablePath navigablePath, SqlAstCreationState creationState)
void	applyPredicate(EntityMappingType associatedEntityDescriptor, Consumer<Predicate> predicateConsumer, TableGroup tableGroup, SqlAliasBaseGenerator sqlAliasBaseGenerator, LoadQueryInfluencers influencers)
void	applyPredicate(PluralAttributeMapping associatedEntityDescriptor, Consumer<Predicate> predicateConsumer, TableGroup tableGroup, SqlAliasBaseGenerator sqlAliasBaseGenerator, LoadQueryInfluencers influencers)
default void	applyPredicate(TableGroupJoin tableGroupJoin, LoadQueryInfluencers loadQueryInfluencers)	Deprecated. Use applyPredicate(TableGroupJoin, SqlAliasBaseGenerator, LoadQueryInfluencers) instead.
void	applyPredicate(TableGroupJoin tableGroupJoin, SqlAliasBaseGenerator sqlAliasBaseGenerator, LoadQueryInfluencers loadQueryInfluencers)
default void	applyPredicate(TableReferenceJoin tableReferenceJoin, NamedTableReference primaryTableReference, String originalTableName, EntityMappingType entityMappingType, SqlAliasBaseGenerator sqlAliasBaseGenerator, LoadQueryInfluencers influencers)	Apply the auxiliary restriction to a joined table reference.
default List<String>	getExtraSelectExpressions()	Additional column expressions to include in each SELECT of a TABLE_PER_CLASS union subquery (e.g.
JdbcMapping	getJdbcMapping()
String	getTableName()	The name of the primary auxiliary table.
boolean	isAffectedByInfluencers(LoadQueryInfluencers influencers)
default String	resolveTableName(String originalTableName)	Resolve the auxiliary table name for the given original table.
boolean	useAuxiliaryTable(LoadQueryInfluencers influencers)

Method Details

getTableName

String getTableName()

The name of the primary auxiliary table. For multi-table strategies (e.g. audit), use resolveTableName(String) to resolve per-table instead.

resolveTableName

default String resolveTableName(String originalTableName)

Resolve the auxiliary table name for the given original table. For multi-table inheritance or @SecondaryTable, each table may have its own auxiliary table. Defaults to getTableName().

addToInsertGroup

default void addToInsertGroup(MutationGroupBuilder insertGroupBuilder,
 EntityPersister persister)

applyPredicate

void applyPredicate(EntityMappingType associatedEntityMappingType,
 Consumer<Predicate> predicateConsumer,
 LazyTableGroup lazyTableGroup,
 NavigablePath navigablePath,
 SqlAstCreationState creationState)

applyPredicate

void applyPredicate(EntityMappingType associatedEntityDescriptor,
 Consumer<Predicate> predicateConsumer,
 TableGroup tableGroup,
 SqlAliasBaseGenerator sqlAliasBaseGenerator,
 LoadQueryInfluencers influencers)

applyPredicate

void applyPredicate(PluralAttributeMapping associatedEntityDescriptor,
 Consumer<Predicate> predicateConsumer,
 TableGroup tableGroup,
 SqlAliasBaseGenerator sqlAliasBaseGenerator,
 LoadQueryInfluencers influencers)

applyPredicate

void applyPredicate(TableGroupJoin tableGroupJoin,
 SqlAliasBaseGenerator sqlAliasBaseGenerator,
 LoadQueryInfluencers loadQueryInfluencers)

applyPredicate

@Deprecated
default void applyPredicate(TableGroupJoin tableGroupJoin,
 LoadQueryInfluencers loadQueryInfluencers)

Deprecated.

Use applyPredicate(TableGroupJoin, SqlAliasBaseGenerator, LoadQueryInfluencers) instead.

applyPredicate

void applyPredicate(Supplier<Consumer<Predicate>> predicateCollector,
 SqlAstCreationState creationState,
 TableGroup tableGroup,
 NamedTableReference rootTableReference,
 EntityMappingType entityMappingType)

applyPredicate

default void applyPredicate(TableReferenceJoin tableReferenceJoin,
 NamedTableReference primaryTableReference,
 String originalTableName,
 EntityMappingType entityMappingType,
 SqlAliasBaseGenerator sqlAliasBaseGenerator,
 LoadQueryInfluencers influencers)

Apply the auxiliary restriction to a joined table reference. Used for JOINED inheritance where each table in the hierarchy has its own auxiliary table.

Parameters:

originalTableName - the original (non-auxiliary) table name

getExtraSelectExpressions

default List<String> getExtraSelectExpressions()

Additional column expressions to include in each SELECT of a TABLE_PER_CLASS union subquery (e.g. REV, REVTYPE for audit).

getJdbcMapping

JdbcMapping getJdbcMapping()

useAuxiliaryTable

boolean useAuxiliaryTable(LoadQueryInfluencers influencers)

isAffectedByInfluencers

boolean isAffectedByInfluencers(LoadQueryInfluencers influencers)