Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.query.hql.spi.SqmPathRegistry

Method Summary

Modifier and Type	Method and Description
public SqmAliasedNode<?>	Returns: The matching node, or null findAliasedNodeByAlias(String alias) Find a node (if one) by the explicit alias assigned to it within the select-clause
public SqmAliasedNode<?>	Returns: The matching node, or null findAliasedNodeByPosition(int position) Find an SqmSelection by its position in the SqmSelectClause
public Integer	Returns: The position, or null findAliasedNodePosition(String alias) Find the position of a node with the given alias, relative to the underlying SQL select-list.
public <X extends SqmFrom<?, ?>> X	Returns: matching SqmFrom or `null` findFromByAlias(String identificationVariable, boolean searchParent) Find a SqmFrom by its identification variable (alias).
public <X extends SqmFrom<?, ?>> X	Returns: matching SqmFrom or `null` findFromByPath(NavigablePath navigablePath) Find a SqmFrom by its NavigablePath.
public <X extends SqmFrom<?, ?>> X	Returns: matching SqmFrom or `null` findFromExposing(String navigableName) Find a SqmFrom which exposes a Navigable by the given name.
public void	register(SqmPath<?> sqmPath) Register an SqmPath
public void	register(SqmAliasedNode<?> aliasedNode) Register a node aliased within the select-clause
public <E> void	replace(SqmEntityJoin<E> sqmJoin, SqmRoot<E> sqmRoot) Used with JPA compliance to treat secondary query roots as cross-joins.
public <X extends SqmFrom<?, ?>> X	Returns: The existing or just-created SqmFrom resolveFrom(NavigablePath path, Function<NavigablePath, SqmFrom<?, ?>> creator) Similar to `findFromByPath`, but accepting a producer to be used to create and register a SqmFrom if none yet registered.
public <X extends SqmFrom<?, ?>> X	Returns: The existing or just-created SqmFrom resolveFrom(SqmPath<?> path) Similar to `resolveFrom`, but accepting a SqmPath to be used to create and register a SqmFrom if none yet registered.

Method Detail

findAliasedNodeByAlias	back to summary
public SqmAliasedNode<?> findAliasedNodeByAlias(String alias) Find a node (if one) by the explicit alias assigned to it within the select-clause Returns:SqmAliasedNode<?> The matching node, or null

findAliasedNodeByAlias

back to summary

public SqmAliasedNode<?> findAliasedNodeByAlias(String alias)

Find a node (if one) by the explicit alias assigned to it within the select-clause

Returns:SqmAliasedNode<?>: The matching node, or null

findAliasedNodeByPosition	back to summary
public SqmAliasedNode<?> findAliasedNodeByPosition(int position) Find an SqmSelection by its position in the SqmSelectClause Returns:SqmAliasedNode<?> The matching node, or null

findAliasedNodeByPosition

back to summary

public SqmAliasedNode<?> findAliasedNodeByPosition(int position)

Find an SqmSelection by its position in the SqmSelectClause

Returns:SqmAliasedNode<?>: The matching node, or null

findAliasedNodePosition	back to summary
public Integer findAliasedNodePosition(String alias) Find the position of a node with the given alias, relative to the underlying SQL select-list. Returns:Integer The position, or null

findAliasedNodePosition

back to summary

public Integer findAliasedNodePosition(String alias)

Find the position of a node with the given alias, relative to the underlying SQL select-list.

Returns:Integer: The position, or null

findFromByAlias back to summary

findFromByAlias	back to summary
public <X extends SqmFrom<?, ?>> X findFromByAlias(String identificationVariable, boolean searchParent) Find a SqmFrom by its identification variable (alias). If the SqmFrom is found in a parent context, the correlation for the path will be returned. Returns:X matching SqmFrom or `null`

public <X extends SqmFrom<?, ?>> X findFromByAlias(String identificationVariable, boolean searchParent)

Find a SqmFrom by its identification variable (alias). If the SqmFrom is found in a parent context, the correlation for the path will be returned.

Returns:X: matching SqmFrom or null

findFromByPath back to summary

findFromByPath	back to summary
public <X extends SqmFrom<?, ?>> X findFromByPath(NavigablePath navigablePath) Find a SqmFrom by its NavigablePath. Will search any parent contexts as well Returns:X matching SqmFrom or `null`

public <X extends SqmFrom<?, ?>> X findFromByPath(NavigablePath navigablePath)

Find a SqmFrom by its NavigablePath. Will search any parent contexts as well

Returns:X: matching SqmFrom or null

findFromExposing back to summary

findFromExposing	back to summary
public <X extends SqmFrom<?, ?>> X findFromExposing(String navigableName) Find a SqmFrom which exposes a Navigable by the given name. Will search any parent contexts as well Returns:X matching SqmFrom or `null`

public <X extends SqmFrom<?, ?>> X findFromExposing(String navigableName)

Find a SqmFrom which exposes a Navigable by the given name. Will search any parent contexts as well

Returns:X: matching SqmFrom or null

register	back to summary
public void register(SqmPath<?> sqmPath) Register an SqmPath

register	back to summary
public void register(SqmAliasedNode<?> aliasedNode) Register a node aliased within the select-clause

replace back to summary

replace	back to summary
public <E> void replace(SqmEntityJoin<E> sqmJoin, SqmRoot<E> sqmRoot) Used with JPA compliance to treat secondary query roots as cross-joins. Here we will replace the `sqmRoot` with the `sqmJoin` API Note Care should be taken when calling this method to ensure that nothing has used the previous registration between its registration and this call. Generally, most callers want `register(SqmPath)` instead.

public <E> void replace(SqmEntityJoin<E> sqmJoin, SqmRoot<E> sqmRoot)

Used with JPA compliance to treat secondary query roots as cross-joins. Here we will replace the sqmRoot with the sqmJoin

API Note

Care should be taken when calling this method to ensure that nothing has used the previous registration between its registration and this call. Generally, most callers want register(SqmPath) instead.

resolveFrom back to summary

resolveFrom	back to summary
public <X extends SqmFrom<?, ?>> X resolveFrom(NavigablePath path, Function<NavigablePath, SqmFrom<?, ?>> creator) Similar to `findFromByPath`, but accepting a producer to be used to create and register a SqmFrom if none yet registered. Returns:X The existing or just-created SqmFrom

public <X extends SqmFrom<?, ?>> X resolveFrom(NavigablePath path, Function<NavigablePath, SqmFrom<?, ?>> creator)

Similar to findFromByPath, but accepting a producer to be used to create and register a SqmFrom if none yet registered.

Returns:X: The existing or just-created SqmFrom

resolveFrom back to summary

resolveFrom	back to summary
public <X extends SqmFrom<?, ?>> X resolveFrom(SqmPath<?> path) Similar to `resolveFrom`, but accepting a SqmPath to be used to create and register a SqmFrom if none yet registered. Returns:X The existing or just-created SqmFrom

public <X extends SqmFrom<?, ?>> X resolveFrom(SqmPath<?> path)

Similar to resolveFrom, but accepting a SqmPath to be used to create and register a SqmFrom if none yet registered.

Returns:X: The existing or just-created SqmFrom

public Interface SqmPathRegistry

Method Summary

Method Detail