Class SqmCteStatement<T>

java.lang.Object

org.hibernate.query.sqm.tree.spi.AbstractSqmNode

org.hibernate.query.sqm.tree.spi.cte.SqmCteStatement<T>

All Implemented Interfaces:

Serializable, JpaCriteriaNode, JpaCteCriteria<T>, SqmCacheable, SqmNode, SqmVisitableNode

public class SqmCteStatement<T>
extends AbstractSqmNode
implements SqmVisitableNode, JpaCteCriteria<T>

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
SqmCteStatement(String name, SqmSelectQuery<T> nonRecursiveQueryPart, boolean unionDistinct, Function<JpaCteCriteria<T>, AbstractQuery<T>> finalCriteriaProducer, SqmCteContainer cteContainer, NodeBuilder nodeBuilder)
SqmCteStatement(String name, SqmSelectQuery<T> cteDefinition, SqmCteContainer cteContainer, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
int	cacheHashCode()
SqmCteStatement<T>	copy(SqmCopyContext context)
<X> void	cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, X cycleValue, X noCycleValue, List<JpaCteCriteriaAttribute> cycleAttributes)	Define the CTE cycle clause with an explicit path attribute.
boolean	equals(Object object)
SqmCteContainer	getCteContainer()	The container within this CTE is registered.
SqmSelectQuery<?>	getCteDefinition()	The definition of the CTE.
SqmCteTable<?>	getCteTable()
List<JpaCteCriteriaAttribute>	getCycleAttributes()	The attributes to use for cycle detection.
SqmLiteral<Object>	getCycleLiteral()
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.
SqmLiteral<Object>	getNoCycleLiteral()
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.
int	hashCode()
boolean	isCompatible(Object object)
void	search(CteSearchClauseKind kind, String searchAttributeName, List<JpaSearchOrder> searchOrders)	Define the CTE search clause.
void	setMaterialization(CteMaterialization materialization)	Set the CTE materialization hint.

Methods inherited from class AbstractSqmNode

nodeBuilder

Methods inherited from class Object

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

Methods inherited from interface JpaCteCriteria

cycle, cycle, cycle, cycle, cycleUsing, cycleUsing, cycleUsing, search

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmVisitableNode

toHqlString

Constructor Details

SqmCteStatement

public SqmCteStatement(@Nonnull
 String name,
 @Nonnull
 SqmSelectQuery<T> cteDefinition,
 @Nonnull
 SqmCteContainer cteContainer,
 @Nonnull
 NodeBuilder nodeBuilder)

SqmCteStatement

public SqmCteStatement(@Nonnull
 String name,
 @Nonnull
 SqmSelectQuery<T> nonRecursiveQueryPart,
 boolean unionDistinct,
 @Nonnull
 Function<JpaCteCriteria<T>, AbstractQuery<T>> finalCriteriaProducer,
 @Nonnull
 SqmCteContainer cteContainer,
 @Nonnull
 NodeBuilder nodeBuilder)

Method Details

copy

@Nonnull
public SqmCteStatement<T> copy(@Nonnull
 SqmCopyContext context)

Specified by:

copy in interface SqmNode

getName

@Nullable
public String getName()

Description copied from interface: JpaCteCriteria

The name under which this CTE is registered.

Specified by:

getName in interface JpaCteCriteria<T>

getCteTable

@Nonnull
public SqmCteTable<?> getCteTable()

getCteDefinition

@Nonnull
public SqmSelectQuery<?> getCteDefinition()

Description copied from interface: JpaCteCriteria

The definition of the CTE.

Specified by:

getCteDefinition in interface JpaCteCriteria<T>

getCteContainer

@Nonnull
public SqmCteContainer getCteContainer()

Description copied from interface: JpaCteCriteria

The container within this CTE is registered.

Specified by:

getCteContainer in interface JpaCteCriteria<T>

getMaterialization

@Nonnull
public CteMaterialization getMaterialization()

Description copied from interface: JpaCteCriteria

The materialization hint for the CTE.

Specified by:

getMaterialization in interface JpaCteCriteria<T>

setMaterialization

public void setMaterialization(@Nonnull
 CteMaterialization materialization)

Description copied from interface: JpaCteCriteria

Set the CTE materialization hint.

Specified by:

setMaterialization in interface JpaCteCriteria<T>

getSearchClauseKind

@Nullable
public CteSearchClauseKind getSearchClauseKind()

Description copied from interface: JpaCteCriteria

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.

Specified by:

getSearchClauseKind in interface JpaCteCriteria<T>

getSearchBySpecifications

@Nonnull
public List<JpaSearchOrder> getSearchBySpecifications()

Description copied from interface: JpaCteCriteria

The order by which should be searched.

Specified by:

getSearchBySpecifications in interface JpaCteCriteria<T>

getSearchAttributeName

@Nullable
public String getSearchAttributeName()

Description copied from interface: JpaCteCriteria

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.

Specified by:

getSearchAttributeName in interface JpaCteCriteria<T>

getCycleAttributes

@Nonnull
public List<JpaCteCriteriaAttribute> getCycleAttributes()

Description copied from interface: JpaCteCriteria

The attributes to use for cycle detection.

Specified by:

getCycleAttributes in interface JpaCteCriteria<T>

getCycleMarkAttributeName

@Nullable
public String getCycleMarkAttributeName()

Description copied from interface: JpaCteCriteria

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.

Specified by:

getCycleMarkAttributeName in interface JpaCteCriteria<T>

getCyclePathAttributeName

@Nullable
public String getCyclePathAttributeName()

Description copied from interface: JpaCteCriteria

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.

Specified by:

getCyclePathAttributeName in interface JpaCteCriteria<T>

getCycleValue

@Nullable
public Object getCycleValue()

Description copied from interface: JpaCteCriteria

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

Specified by:

getCycleValue in interface JpaCteCriteria<T>

getNoCycleValue

@Nullable
public Object getNoCycleValue()

Description copied from interface: JpaCteCriteria

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

Specified by:

getNoCycleValue in interface JpaCteCriteria<T>

getCycleLiteral

@Nullable
public SqmLiteral<Object> getCycleLiteral()

getNoCycleLiteral

@Nullable
public SqmLiteral<Object> getNoCycleLiteral()

getType

@Nonnull
public JpaCteCriteriaType<T> getType()

Description copied from interface: JpaCteCriteria

The type of the CTE.

Specified by:

getType in interface JpaCteCriteria<T>

search

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

Description copied from interface: JpaCteCriteria

Define the CTE search clause.

Specified by:

search in interface JpaCteCriteria<T>

cycleUsing

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

Description copied from interface: JpaCteCriteria

Define the CTE cycle clause with an explicit path attribute.

Specified by:

cycleUsing in interface JpaCteCriteria<T>

accept

@Nullable
public <X> X accept(@Nonnull
 SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

appendHqlString

public void appendHqlString(@Nonnull
 StringBuilder hql,
 @Nonnull
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCompatible

public boolean isCompatible(@Nullable
 Object object)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable