Class TupleCountSupport

java.lang.Object

org.hibernate.dialect.function.spi.TupleCountSupport

@SPI({USE,SUPPLY})
public final class TupleCountSupport
extends Object

Immutable description of a Dialect's aggregate tuple-count syntax.

Providers supply a stable profile through Dialect.getTupleCountSupport(). Ordinary tuple counts and distinct tuple counts are independent syntax choices. Select TupleCountSupport.Syntax.UNSUPPORTED to request Hibernate's existing emulation, TupleCountSupport.Syntax.ARGUMENT_LIST for forms such as count(a, b), or TupleCountSupport.Syntax.PARENTHESIZED_TUPLE for forms such as count((a, b)).

Do not infer the distinct form from the ordinary form. A database may, for example, accept count((a, b)) while requiring count(distinct a, b) for the distinct form.

Since:

8.0

See Also:

• Dialect.getTupleCountSupport()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TupleCountSupport.Builder	Build an immutable tuple-count-support profile.
static enum	TupleCountSupport.Syntax	A complete native syntax choice for one tuple-count form.

Field Summary

Fields

Modifier and Type	Field	Description
static final TupleCountSupport	NONE	Neither ordinary nor distinct tuple counts have native syntax.
static final TupleCountSupport	STANDARD	The base-Dialect profile: emulate ordinary tuple counts and render distinct tuples as an argument list.

Method Summary

Modifier and Type	Method	Description
static TupleCountSupport.Builder	builder()	Create a builder initialized from STANDARD.
static TupleCountSupport.Builder	builder(TupleCountSupport base)	Create a builder initialized with both syntax choices from the given profile.
TupleCountSupport.Syntax	getDistinctSyntax()	The syntax for distinct multi-expression counts.
TupleCountSupport.Syntax	getNonDistinctSyntax()	The syntax for ordinary multi-expression counts.

Methods inherited from class Object

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

Field Details

NONE

public static final TupleCountSupport NONE

Neither ordinary nor distinct tuple counts have native syntax.

STANDARD

public static final TupleCountSupport STANDARD

The base-Dialect profile: emulate ordinary tuple counts and render distinct tuples as an argument list.

Method Details

builder

public static TupleCountSupport.Builder builder()

Create a builder initialized from STANDARD.

builder

public static TupleCountSupport.Builder builder(TupleCountSupport base)

Create a builder initialized with both syntax choices from the given profile.

Parameters:

base - the non-null profile to copy

getNonDistinctSyntax

public TupleCountSupport.Syntax getNonDistinctSyntax()

The syntax for ordinary multi-expression counts.

getDistinctSyntax

public TupleCountSupport.Syntax getDistinctSyntax()

The syntax for distinct multi-expression counts.