Top Description Methods
org.hibernate.query.criteria

public Interface JpaCteCriteria<T>

extends JpaCriteriaNode
Known Direct Implementers
org.hibernate.query.sqm.tree.cte.SqmCteStatement
Annotations
@Incubating
Imports
java.util.Arrays, .List, org.hibernate.Incubating, org.hibernate.sql.ast.tree.cte.CteMaterialization, .CteSearchClauseKind
A CTE (common table expression) criteria.

Method Summary

Modifier and TypeMethod and Description
public default void
cycle(String cycleMarkAttributeName, JpaCteCriteriaAttribute... cycleColumns)

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

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

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

public default void
cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, JpaCteCriteriaAttribute... cycleColumns)

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

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

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

public JpaCteContainer
getCteContainer()

The container within this CTE is registered.

public JpaSelectCriteria<?>
getCteDefinition()

The definition of the CTE.

public List<JpaCteCriteriaAttribute>
getCycleAttributes()

The attributes to use for cycle detection.

public String
getCycleMarkAttributeName()

The attribute name which is used to mark when a cycle has been detected.

public String
getCyclePathAttributeName()

The attribute name that represents the computation path, which is used for cycle detection.

public Object
getCycleValue()

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

public CteMaterialization
getMaterialization()

The materialization hint for the CTE.

public String
getName()

The name under which this CTE is registered.

public Object
getNoCycleValue()

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

public String
getSearchAttributeName()

The attribute name by which one can order the final CTE result, to achieve the search order.

public List<JpaSearchOrder>
getSearchBySpecifications()

The order by which should be searched.

public CteSearchClauseKind
getSearchClauseKind()

The kind of search (breadth-first or depth-first) that should be done for a recursive query.

public JpaCteCriteriaType<T>
getType()

The type of the CTE.

public default void
search(CteSearchClauseKind kind, String searchAttributeName, JpaSearchOrder... searchOrders)

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

public void
setMaterialization(CteMaterialization materialization)

Method Detail

cycleback to summary
public default void cycle(String cycleMarkAttributeName, JpaCteCriteriaAttribute... cycleColumns)
cycleback to summary
public default void cycle(String cycleMarkAttributeName, List<JpaCteCriteriaAttribute> cycleColumns)
cycleback to summary
public default <X> void cycle(String cycleMarkAttributeName, X cycleValue, X noCycleValue, JpaCteCriteriaAttribute... cycleColumns)
cycleback to summary
public default <X> void cycle(String cycleMarkAttributeName, X cycleValue, X noCycleValue, List<JpaCteCriteriaAttribute> cycleColumns)
cycleUsingback to summary
public default void cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, JpaCteCriteriaAttribute... cycleColumns)
cycleUsingback to summary
public default void cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, List<JpaCteCriteriaAttribute> cycleColumns)
cycleUsingback to summary
public default <X> void cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, X cycleValue, X noCycleValue, JpaCteCriteriaAttribute... cycleColumns)
cycleUsingback to summary
public <X> void cycleUsing(String cycleMarkAttributeName, String cyclePathAttributeName, X cycleValue, X noCycleValue, List<JpaCteCriteriaAttribute> cycleColumns)
getCteContainerback to summary
public JpaCteContainer getCteContainer()

The container within this CTE is registered.

getCteDefinitionback to summary
public JpaSelectCriteria<?> getCteDefinition()

The definition of the CTE.

getCycleAttributesback to summary
public List<JpaCteCriteriaAttribute> getCycleAttributes()

The attributes to use for cycle detection.

getCycleMarkAttributeNameback to summary
public 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.

getCyclePathAttributeNameback to summary
public 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.

getCycleValueback to summary
public Object getCycleValue()

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

getMaterializationback to summary
public CteMaterialization getMaterialization()

The materialization hint for the CTE.

getNameback to summary
public String getName()

The name under which this CTE is registered.

getNoCycleValueback to summary
public Object getNoCycleValue()

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

getSearchAttributeNameback to summary
public 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.

getSearchBySpecificationsback to summary
public List<JpaSearchOrder> getSearchBySpecifications()

The order by which should be searched.

getSearchClauseKindback to summary
public 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.

getTypeback to summary
public JpaCteCriteriaType<T> getType()

The type of the CTE.

searchback to summary
public default void search(CteSearchClauseKind kind, String searchAttributeName, JpaSearchOrder... searchOrders)
searchback to summary
public void search(CteSearchClauseKind kind, String searchAttributeName, List<JpaSearchOrder> searchOrders)
setMaterializationback to summary
public void setMaterialization(CteMaterialization materialization)