org.hibernate.query.criteria.internal.compile.RenderingContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* 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 .
*/
package org.hibernate.query.criteria.internal.compile;
import javax.persistence.criteria.ParameterExpression;
import org.hibernate.dialect.Dialect;
import org.hibernate.internal.util.collections.Stack;
import org.hibernate.query.criteria.LiteralHandlingMode;
import org.hibernate.query.criteria.internal.expression.function.FunctionExpression;
import org.hibernate.sql.ast.Clause;
/**
* Used to provide a context and services to the rendering.
*
* @author Steve Ebersole
*/
public interface RenderingContext {
/**
* Generate a correlation name.
*
* @return The generated correlation name
*/
String generateAlias();
/**
* Register parameters explicitly encountered in the criteria query.
*
* @param criteriaQueryParameter The parameter expression
*
* @return The JPA-QL parameter name
*/
ExplicitParameterInfo registerExplicitParameter(ParameterExpression criteriaQueryParameter);
/**
* Register a parameter that was not part of the criteria query (at least not as a parameter).
*
* @param literal The literal value
* @param javaType The java type as which to handle the literal value.
*
* @return The JPA-QL parameter name
*/
String registerLiteralParameterBinding(Object literal, Class javaType);
/**
* Given a java type, determine the proper cast type name.
*
* @param javaType The java type.
*
* @return The cast type name.
*/
String getCastType(Class javaType);
/**
* Current Dialect.
*
* @return Dialect
*/
Dialect getDialect();
/**
* How literals are going to be handled.
*
* @return literal handling strategy
*/
default LiteralHandlingMode getCriteriaLiteralHandlingMode() {
return LiteralHandlingMode.AUTO;
}
Stack getClauseStack();
Stack getFunctionStack();
}