Package org.hibernate.sql

Class Template

java.lang.Object

org.hibernate.sql.Template

public final class Template
extends Object

Parses SQL fragments specified in mapping documents. The SQL fragment should be written in the native SQL dialect of the target database, with the following special exceptions:

• any backtick-quoted identifier, for example `hello`, is interpreted as a quoted identifier and re-quoted using the native quoted identifier syntax of the database, and
• the literal identifiers true and false are interpreted as literal boolean values, and replaced with dialect-specific literal values.

Implementation Note:

This is based on a simple scanner-based state machine. It is NOT in any way, shape, nor form, a parser, since we simply cannot recognize the syntax of every dialect of SQL we support.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TEMPLATE

Method Summary

Modifier and Type	Method	Description
static List<String>	collectColumnNames(String template)
static List<String>	collectColumnNames(String sql, Dialect dialect, TypeConfiguration typeConfiguration)
static String	renderTransformerReadFragment(String fragment, String... columnNames)
static String	renderWhereStringTemplate(String sql, String alias, Dialect dialect, TypeConfiguration typeConfiguration)	Takes the SQL fragment provided in the mapping attribute and interpolates the given alias, using it to qualify every unqualified column name.
static String	renderWhereStringTemplate(String sql, Dialect dialect, TypeConfiguration typeConfiguration)	Takes the SQL fragment provided in the mapping attribute and interpolates the default placeholder value, which is "{@}", using it to qualify every unqualified column name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TEMPLATE

public static final String TEMPLATE

See Also:

• Constant Field Values

Method Details

renderTransformerReadFragment

public static String renderTransformerReadFragment(String fragment,
 String... columnNames)

renderWhereStringTemplate

public static String renderWhereStringTemplate(String sql,
 Dialect dialect,
 TypeConfiguration typeConfiguration)

Takes the SQL fragment provided in the mapping attribute and interpolates the default placeholder value, which is "{@}", using it to qualify every unqualified column name.

Handles subselects, quoted identifiers, quoted strings, expressions, SQL functions, named parameters, literals.

Parameters:

sql - The SQL string into which to interpolate the placeholder value

dialect - The dialect to apply

Returns:

The rendered SQL fragment

renderWhereStringTemplate

public static String renderWhereStringTemplate(String sql,
 String alias,
 Dialect dialect,
 TypeConfiguration typeConfiguration)

Takes the SQL fragment provided in the mapping attribute and interpolates the given alias, using it to qualify every unqualified column name.

Handles subselects, quoted identifiers, quoted strings, expressions, SQL functions, named parameters, literals.

Parameters:

sql - The SQL string into which to interpolate the alias value

alias - The alias to be interpolated into the SQL

dialect - The dialect to apply

Returns:

The rendered SQL fragment

collectColumnNames

public static List<String> collectColumnNames(String sql,
 Dialect dialect,
 TypeConfiguration typeConfiguration)

collectColumnNames

public static List<String> collectColumnNames(String template)