Interface JpaCteCriteria<T>

All Superinterfaces:

JpaCriteriaNode, Serializable

All Known Implementing Classes:

SqmCteStatement

@Incubating(since="6.3")
public interface JpaCteCriteria<T>
extends JpaCriteriaNode

A CTE (common table expression) criteria.

Method Summary

Modifier and Type	Method	Description
default void	cycle(String cycleMarkAttributeName, List<JpaCteCriteriaAttribute> cycleColumns)	Define the CTE cycle clause.
default void	cycle(String cycleMarkAttributeName, JpaCteCriteriaAttribute... cycleColumns)	Define the CTE cycle clause.
default <X> void	cycle(String cycleMarkAttributeName, X cycleValue, X noCycleValue, List<JpaCteCriteriaAttribute> cycleColumns)	Define the CTE cycle clause.
default <X> void	cycle(String cycleMarkAttributeName, X cycleValue, X noCycleValue, JpaCteCriteriaAttribute... cycleColumns)	Define the CTE cycle clause.
default void	cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, List<JpaCteCriteriaAttribute> cycleColumns)	Define the CTE cycle clause with an explicit path attribute.
default void	cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, JpaCteCriteriaAttribute... cycleColumns)	Define the CTE cycle clause with an explicit path attribute.
<X> void	cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, X cycleValue, X noCycleValue, List<JpaCteCriteriaAttribute> cycleColumns)	Define the CTE cycle clause with an explicit path attribute.
default <X> void	cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, X cycleValue, X noCycleValue, JpaCteCriteriaAttribute... cycleColumns)	Define the CTE cycle clause with an explicit path attribute.
JpaCteContainer	getCteContainer()	The container within this CTE is registered.
JpaSelectCriteria<?>	getCteDefinition()	The definition of the CTE.
List<JpaCteCriteriaAttribute>	getCycleAttributes()	The attributes to use for cycle detection.
String	getCycleMarkAttributeName()	The attribute name which is used to mark when a cycle has been detected.
String	getCyclePathAttributeName()	The attribute name that represents the computation path, which is used for cycle detection.
Object	getCycleValue()	The value which is set for the cycle mark attribute when a cycle is detected.
CteMaterialization	getMaterialization()	The materialization hint for the CTE.
String	getName()	The name under which this CTE is registered.
Object	getNoCycleValue()	The default value for the cycle mark attribute when no cycle is detected.
String	getSearchAttributeName()	The attribute name by which one can order the final CTE result, to achieve the search order.
List<JpaSearchOrder>	getSearchBySpecifications()	The order by which should be searched.
CteSearchClauseKind	getSearchClauseKind()	The kind of search (breadth-first or depth-first) that should be done for a recursive query.
JpaCteCriteriaType<T>	getType()	The type of the CTE.
void	search(CteSearchClauseKind kind, String searchAttributeName, List<JpaSearchOrder> searchOrders)	Define the CTE search clause.
default void	search(CteSearchClauseKind kind, String searchAttributeName, JpaSearchOrder... searchOrders)	Define the CTE search clause.
void	setMaterialization(CteMaterialization materialization)	Set the CTE materialization hint.

Method Details

getName

@Nullable
String getName()

The name under which this CTE is registered.

getType

@Nonnull
JpaCteCriteriaType<T> getType()

The type of the CTE.

getCteDefinition

@Nonnull
JpaSelectCriteria<?> getCteDefinition()

The definition of the CTE.

getCteContainer

@Nonnull
JpaCteContainer getCteContainer()

The container within this CTE is registered.

getMaterialization

@Nonnull
CteMaterialization getMaterialization()

The materialization hint for the CTE.

setMaterialization

void setMaterialization(@Nonnull
 CteMaterialization materialization)

Set the CTE materialization hint.

getSearchClauseKind

@Nullable
CteSearchClauseKind getSearchClauseKind()

The kind of search (breadth-first or depth-first) that should be done for a recursive query. May be null if unspecified or if this is not a recursive query.

getSearchBySpecifications

@Nonnull
List<JpaSearchOrder> getSearchBySpecifications()

The order by which should be searched.

getSearchAttributeName

@Nullable
String getSearchAttributeName()

The attribute name by which one can order the final CTE result, to achieve the search order. Note that an implicit JpaCteCriteriaAttribute will be made available for this.

search

default void search(@Nullable
 CteSearchClauseKind kind,
 @Nullable
 String searchAttributeName,
 @Nonnull
 JpaSearchOrder... searchOrders)

Define the CTE search clause.

search

void search(@Nullable
 CteSearchClauseKind kind,
 @Nullable
 String searchAttributeName,
 @Nullable
 List<JpaSearchOrder> searchOrders)

Define the CTE search clause.

getCycleAttributes

@Nonnull
List<JpaCteCriteriaAttribute> getCycleAttributes()

The attributes to use for cycle detection.

getCycleMarkAttributeName

@Nullable
String getCycleMarkAttributeName()

The attribute name which is used to mark when a cycle has been detected. Note that an implicit JpaCteCriteriaAttribute will be made available for this.

getCyclePathAttributeName

@Nullable
String getCyclePathAttributeName()

The attribute name that represents the computation path, which is used for cycle detection. Note that an implicit JpaCteCriteriaAttribute will be made available for this.

getCycleValue

@Nullable
Object getCycleValue()

The value which is set for the cycle mark attribute when a cycle is detected.

getNoCycleValue

@Nullable
Object getNoCycleValue()

The default value for the cycle mark attribute when no cycle is detected.

cycle

default void cycle(@Nullable
 String cycleMarkAttributeName,
 @Nonnull
 JpaCteCriteriaAttribute... cycleColumns)

Define the CTE cycle clause.

cycle

default void cycle(@Nullable
 String cycleMarkAttributeName,
 @Nullable
 List<JpaCteCriteriaAttribute> cycleColumns)

Define the CTE cycle clause.

cycleUsing

default void cycleUsing(@Nullable
 String cycleMarkAttributeName,
 @Nullable
 String cyclePathAttributeName,
 @Nonnull
 JpaCteCriteriaAttribute... cycleColumns)

Define the CTE cycle clause with an explicit path attribute.

cycleUsing

default void cycleUsing(@Nullable
 String cycleMarkAttributeName,
 @Nullable
 String cyclePathAttributeName,
 @Nullable
 List<JpaCteCriteriaAttribute> cycleColumns)

Define the CTE cycle clause with an explicit path attribute.

cycle

default <X> void cycle(@Nullable
 String cycleMarkAttributeName,
 @Nullable
 X cycleValue,
 @Nullable
 X noCycleValue,
 @Nonnull
 JpaCteCriteriaAttribute... cycleColumns)

Define the CTE cycle clause.

cycle

default <X> void cycle(@Nullable
 String cycleMarkAttributeName,
 @Nullable
 X cycleValue,
 @Nullable
 X noCycleValue,
 @Nullable
 List<JpaCteCriteriaAttribute> cycleColumns)

Define the CTE cycle clause.

cycleUsing

default <X> void cycleUsing(@Nullable
 String cycleMarkAttributeName,
 @Nullable
 String cyclePathAttributeName,
 @Nullable
 X cycleValue,
 @Nullable
 X noCycleValue,
 @Nonnull
 JpaCteCriteriaAttribute... cycleColumns)

Define the CTE cycle clause with an explicit path attribute.

cycleUsing

<X> void cycleUsing(@Nullable
 String cycleMarkAttributeName,
 @Nullable
 String cyclePathAttributeName,
 @Nullable
 X cycleValue,
 @Nullable
 X noCycleValue,
 @Nullable
 List<JpaCteCriteriaAttribute> cycleColumns)

Define the CTE cycle clause with an explicit path attribute.