Package org.hibernate.query.hql.spi

Interface SqmPathRegistry

  • All Known Implementing Classes:
    SqmPathRegistryImpl
    @Incubatingpublic interfaceSqmPathRegistry
    Registry for SqmPath references providing the ability to access them in multiple ways - by alias, by NavigablePath, etc

    • Method Detail

      • register

        void register​(SqmPath<?> sqmPath)
        Register an SqmPath

      • registerByAliasOnly

        void registerByAliasOnly​(SqmFrom<?,​?> sqmFrom)
        Register an SqmFrom by alias only. Effectively, this makes the from node only resolvable via the alias, which means that the from node is ignored infindFromExposing(String).

      • replace

        <E> void replace​(SqmEntityJoin<E> sqmJoin,SqmRoot<E> sqmRoot)
        Used withJPA compliance to treat secondary query roots as cross-joins. Here we will replace thesqmRoot with thesqmJoin
        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 wantregister(SqmPath) instead.

      • findFromByAlias

        <X extendsSqmFrom<?,​?>> 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:
        matching SqmFrom ornull

      • findFromByPath

        <X extendsSqmFrom<?,​?>> X findFromByPath​(NavigablePath navigablePath)
        Find a SqmFrom by its NavigablePath. Will search any parent contexts as well
        Returns:
        matching SqmFrom ornull

      • findFromExposing

        <X extendsSqmFrom<?,​?>> X findFromExposing​(String navigableName)
        Find a SqmFrom which exposes a Navigable by the given name. Will search any parent contexts as well
        Returns:
        matching SqmFrom ornull

      • register

        void register​(SqmAliasedNode<?> aliasedNode)
        Register a node aliased within the select-clause

      • findAliasedNodeByAlias

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

      • findAliasedNodePosition

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

      • findAliasedNodeByPosition

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