/*
* 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.query.criteria.internal.compile;
import javax.persistence.criteria.ParameterExpression;
import org.hibernate.dialect.Dialect;
import org.hibernate.query.criteria.LiteralHandlingMode;
Used to provide a context and services to the rendering.
Author: Steve Ebersole
/**
* Used to provide a context and services to the rendering.
*
* @author Steve Ebersole
*/
public interface RenderingContext {
Generate a correlation name.
Returns: The generated correlation name
/**
* Generate a correlation name.
*
* @return The generated correlation name
*/
String generateAlias();
Register parameters explicitly encountered in the criteria query.
Params: - criteriaQueryParameter – The parameter expression
Returns: The JPA-QL parameter name
/**
* 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).
Params: - literal – The literal value
- javaType – The java type as which to handle the literal value.
Returns: The JPA-QL parameter name
/**
* 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.
Params: - javaType – The java type.
Returns: The cast type name.
/**
* 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.
Returns: Dialect
/**
* Current Dialect.
*
* @return Dialect
*/
Dialect getDialect();
How literals are going to be handled.
Returns: literal handling strategy
/**
* How literals are going to be handled.
*
* @return literal handling strategy
*/
default LiteralHandlingMode getCriteriaLiteralHandlingMode() {
return LiteralHandlingMode.AUTO;
}
}