Class StandardAggregateSupport

java.lang.Object

org.hibernate.dialect.aggregate.spi.StandardAggregateSupport

All Implemented Interfaces:

AggregateSupport

@SPI(IMPLEMENT)
public class StandardAggregateSupport
extends Object
implements AggregateSupport

Standard aggregate base for focused provider overrides.

Since:

8.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StandardAggregateSupport()	Create a provider aggregate support by selectively overriding the standard behavior.

Method Summary

Modifier and Type	Method	Description
List<AggregateAuxiliaryObject>	aggregateAuxiliaryObjects(AggregateAuxiliaryObjectRequest request)	Declare auxiliary schema objects required by an aggregate type.
String	aggregateComponentAssignmentExpression(AggregateComponentAssignmentRequest request)	Render the assignment target for one component of an aggregate column.
String	aggregateComponentCustomReadExpression(AggregateComponentReadRequest request)	Render the read expression for one component of an aggregate column.
int	aggregateComponentSqlTypeCode(int aggregateCode, int columnCode)	Resolve the effective SQL type code of a component within an aggregate representation.
String	aggregateCustomWriteExpression(AggregateCustomWriteRequest request)	Render a custom JDBC write expression for the complete aggregate value.
AggregateWriteExpressionRenderer	aggregateCustomWriteExpressionRenderer(AggregateWriteRendererRequest request)	Supply the renderer for a partial aggregate assignment.
boolean	preferBindAggregateMapping(int code)	Determine whether binding should write the aggregate as one value instead of binding its components independently.
boolean	preferSelectAggregateMapping(int code)	Determine whether selection should read the aggregate as one value instead of selecting its components independently.
boolean	requiresAggregateCustomWriteExpressionRenderer(int code)	Determine whether partial updates of this aggregate representation require a custom renderer.
boolean	supportsComponentCheckConstraints()	Determine whether component nullability and checks may be expressed as a check constraint on the containing table.

Methods inherited from class Object

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

Constructor Details

StandardAggregateSupport

@SPI(IMPLEMENT)
protected StandardAggregateSupport()

Create a provider aggregate support by selectively overriding the standard behavior.

Since:

8.0

Method Details

aggregateComponentCustomReadExpression

public String aggregateComponentCustomReadExpression(AggregateComponentReadRequest request)

Description copied from interface: AggregateSupport

Render the read expression for one component of an aggregate column.

Specified by:

aggregateComponentCustomReadExpression in interface AggregateSupport

Parameters:

request - the call-scoped read facts; do not retain it

Returns:

the component read expression

aggregateComponentAssignmentExpression

public String aggregateComponentAssignmentExpression(AggregateComponentAssignmentRequest request)

Description copied from interface: AggregateSupport

Render the assignment target for one component of an aggregate column.

Specified by:

aggregateComponentAssignmentExpression in interface AggregateSupport

Parameters:

request - the call-scoped assignment facts; do not retain it

Returns:

the component assignment expression

aggregateCustomWriteExpression

public String aggregateCustomWriteExpression(AggregateCustomWriteRequest request)

Description copied from interface: AggregateSupport

Render a custom JDBC write expression for the complete aggregate value.

Specified by:

aggregateCustomWriteExpression in interface AggregateSupport

Parameters:

request - the call-scoped aggregate facts; do not retain it

Returns:

the custom write expression, or null to use ordinary binding

requiresAggregateCustomWriteExpressionRenderer

public boolean requiresAggregateCustomWriteExpressionRenderer(int code)

Description copied from interface: AggregateSupport

Determine whether partial updates of this aggregate representation require a custom renderer.

Specified by:

requiresAggregateCustomWriteExpressionRenderer in interface AggregateSupport

preferSelectAggregateMapping

public boolean preferSelectAggregateMapping(int code)

Description copied from interface: AggregateSupport

Determine whether selection should read the aggregate as one value instead of selecting its components independently.

Specified by:

preferSelectAggregateMapping in interface AggregateSupport

preferBindAggregateMapping

public boolean preferBindAggregateMapping(int code)

Description copied from interface: AggregateSupport

Determine whether binding should write the aggregate as one value instead of binding its components independently.

Specified by:

preferBindAggregateMapping in interface AggregateSupport

aggregateCustomWriteExpressionRenderer

public AggregateWriteExpressionRenderer aggregateCustomWriteExpressionRenderer(AggregateWriteRendererRequest request)

Description copied from interface: AggregateSupport

Supply the renderer for a partial aggregate assignment.

Specified by:

aggregateCustomWriteExpressionRenderer in interface AggregateSupport

Parameters:

request - the call-scoped selectable mappings; do not retain it

Returns:

the renderer for this assignment

See Also:

• AggregateWriteExpressionRenderer

aggregateAuxiliaryObjects

public List<AggregateAuxiliaryObject> aggregateAuxiliaryObjects(AggregateAuxiliaryObjectRequest request)

Description copied from interface: AggregateSupport

Declare auxiliary schema objects required by an aggregate type. Return immutable descriptors and never mutate Hibernate's namespace model.

Specified by:

aggregateAuxiliaryObjects in interface AggregateSupport

Parameters:

request - the call-scoped aggregate facts; do not retain it

aggregateComponentSqlTypeCode

public int aggregateComponentSqlTypeCode(int aggregateCode,
 int columnCode)

Description copied from interface: AggregateSupport

Resolve the effective SQL type code of a component within an aggregate representation.

Specified by:

aggregateComponentSqlTypeCode in interface AggregateSupport

supportsComponentCheckConstraints

public boolean supportsComponentCheckConstraints()

Description copied from interface: AggregateSupport

Determine whether component nullability and checks may be expressed as a check constraint on the containing table.

Specified by:

supportsComponentCheckConstraints in interface AggregateSupport