org.hibernate.sql.ast.produce.ordering.internal.OrderByFragmentParser Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation

Hibernate's core ORM functionality

There is a newer version: 7.0.0.Alpha3

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
 */
package org.hibernate.sql.ast.produce.ordering.internal;

import java.util.ArrayList;
import java.util.List;

import org.hibernate.metamodel.model.domain.spi.PersistentCollectionDescriptor;
import org.hibernate.query.sqm.produce.internal.hql.SemanticQueryBuilder;
import org.hibernate.query.sqm.produce.internal.hql.grammar.HqlParser;
import org.hibernate.query.sqm.tree.from.SqmFrom;
import org.hibernate.query.sqm.tree.order.SqmOrderByClause;
import org.hibernate.query.sqm.tree.order.SqmSortSpecification;

import org.jboss.logging.Logger;

/**
 * Specialized HQL parse tree visitation for handling {@link javax.persistence.OrderBy} which allows for a
 * "valid JPQL order-by fragment", as opposed to {@link org.hibernate.annotations.OrderBy} which
 * expects raw SQL.
 *
 * @author Steve Ebersole
 */
public class OrderByFragmentParser extends SemanticQueryBuilder {
	private static final Logger log = Logger.getLogger( OrderByFragmentParser.class.getName() );

	public static SqmOrderByClause convertOrderByFragmentParseTree(
			TranslationContext translationContext,
			PersistentCollectionDescriptor collectionDescriptor,
			HqlParser.OrderByClauseContext orderByClauseContext) {
		return new OrderByFragmentParser( translationContext, collectionDescriptor )
				.visitOrderByClause( orderByClauseContext );
	}

	private final List sqmSortSpecifications = new ArrayList<>();


	public OrderByFragmentParser(TranslationContext translationContext, PersistentCollectionDescriptor collectionDescriptor) {
		super( translationContext.getSessionFactory() );

		final SqmFrom sqmFromBase = new SqmFromImpl( this, collectionDescriptor );

		getSemanticPathPartStack().push( new SemanticPathPartRoot( sqmFromBase ) );

		primeStack( getParameterDeclarationContextStack(), () -> false );
	}

	@Override
	public SqmSortSpecification visitSortSpecification(HqlParser.SortSpecificationContext ctx) {
		final SqmSortSpecification spec = super.visitSortSpecification( ctx );
		sqmSortSpecifications.add( spec );
		return spec;
	}

	public List getSqmSortSpecifications() {
		return sqmSortSpecifications;
	}
}