Modifier and Type	Class and Description
public static class	Template.NoOpColumnMapper
private static class	Template.TrimOperands

Modifier and Type	Field and Description
private static final Set<String>	BEFORE_TABLE_KEYWORDS
private static final Set<String>	FUNCTION_KEYWORDS
private static final Set<String>	KEYWORDS
public static final String	TEMPLATE

Access	Constructor and Description
private	Template()

Method Summary

Modifier and Type	Method and Description
private static String	extractUntil(StringTokenizer tokens, String delimiter)
private static boolean	isFunction(String lcToken, String nextToken, SQLFunctionRegistry functionRegistry)
private static boolean	isFunctionOrKeyword(String lcToken, String nextToken, Dialect dialect, SQLFunctionRegistry functionRegistry)
private static boolean	isIdentifier(String token, Dialect dialect)
private static boolean	isNamedParameter(String token)
public static String	Returns: The rendered `ORDER BY` template. renderOrderByStringTemplate(String The order-by fragment to render. orderByFragment, Dialect The SQL dialect being used. dialect, SQLFunctionRegistry The SQL function registry functionRegistry) Deprecated Use `renderOrderByStringTemplate(String, ColumnMapper, SessionFactoryImplementor, Dialect, SQLFunctionRegistry)` instead Performs order-by template rendering without `column mapping`.
public static String	Returns: The rendered `ORDER BY` template. renderOrderByStringTemplate(String The order-by fragment to render. orderByFragment, final ColumnMapper The column mapping strategy to use. columnMapper, final SessionFactoryImplementor The session factory. sessionFactory, final Dialect The SQL dialect being used. dialect, final SQLFunctionRegistry The SQL function registry functionRegistry) Performs order-by template rendering allowing `column mapping`.
public static String	renderWhereStringTemplate(String sqlWhereString, Dialect dialect, SQLFunctionRegistry functionRegistry)
public static String	renderWhereStringTemplate(String sqlWhereString, String placeholder, Dialect dialect) Deprecated Only intended for annotations usage; use `renderWhereStringTemplate(String, String, Dialect, SQLFunctionRegistry)` instead Same functionality as `renderWhereStringTemplate(String, String, Dialect, SQLFunctionRegistry)`, except that a SQLFunctionRegistry is not provided (i.e., only the dialect-defined functions are considered).
public static String	Returns: The rendered sql fragment renderWhereStringTemplate(String The string into which to interpolate the placeholder value sqlWhereString, String The value to be interpolated into the the sqlWhereString placeholder, Dialect The dialect to apply dialect, SQLFunctionRegistry The registry of all sql functions functionRegistry) Takes the where condition provided in the mapping attribute and interpolates the alias.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BEFORE_TABLE_KEYWORDS	back to summary
private static final Set<String> BEFORE_TABLE_KEYWORDS

FUNCTION_KEYWORDS	back to summary
private static final Set<String> FUNCTION_KEYWORDS

KEYWORDS	back to summary
private static final Set<String> KEYWORDS

TEMPLATE	back to summary
public static final String TEMPLATE

Constructor Detail

Template	back to summary
private Template()

Method Detail

extractUntil	back to summary
private static String extractUntil(StringTokenizer tokens, String delimiter)

isFunction	back to summary
private static boolean isFunction(String lcToken, String nextToken, SQLFunctionRegistry functionRegistry)

isFunctionOrKeyword	back to summary
private static boolean isFunctionOrKeyword(String lcToken, String nextToken, Dialect dialect, SQLFunctionRegistry functionRegistry)

isIdentifier	back to summary
private static boolean isIdentifier(String token, Dialect dialect)

isNamedParameter	back to summary
private static boolean isNamedParameter(String token)

renderOrderByStringTemplate back to summary

renderOrderByStringTemplate	back to summary
public static String renderOrderByStringTemplate(String orderByFragment, Dialect dialect, SQLFunctionRegistry functionRegistry) Deprecated Use `renderOrderByStringTemplate(String, ColumnMapper, SessionFactoryImplementor, Dialect, SQLFunctionRegistry)` instead Performs order-by template rendering without `column mapping`. An `ORDER BY` template has all column references "qualified" with a placeholder identified by `Template#TEMPLATE` Parameters orderByFragment:String The order-by fragment to render. dialect:Dialect The SQL dialect being used. functionRegistry:SQLFunctionRegistry The SQL function registry Returns:String The rendered `ORDER BY` template.

public static String renderOrderByStringTemplate(String orderByFragment, Dialect dialect, SQLFunctionRegistry functionRegistry)

Deprecated

Use renderOrderByStringTemplate(String, ColumnMapper, SessionFactoryImplementor, Dialect, SQLFunctionRegistry) instead

Performs order-by template rendering without column mapping. An ORDER BY template has all column references "qualified" with a placeholder identified by Template#TEMPLATE

Parameters

orderByFragment:String: The order-by fragment to render.
dialect:Dialect: The SQL dialect being used.
functionRegistry:SQLFunctionRegistry: The SQL function registry

Returns:String

The rendered ORDER BY template.

renderOrderByStringTemplate back to summary

renderOrderByStringTemplate	back to summary
public static String renderOrderByStringTemplate(String orderByFragment, final ColumnMapper columnMapper, final SessionFactoryImplementor sessionFactory, final Dialect dialect, final SQLFunctionRegistry functionRegistry) Performs order-by template rendering allowing `column mapping`. An `ORDER BY` template has all column references "qualified" with a placeholder identified by `Template#TEMPLATE` which can later be used to easily inject the SQL alias. Parameters orderByFragment:String The order-by fragment to render. columnMapper:ColumnMapper The column mapping strategy to use. sessionFactory:SessionFactoryImplementor The session factory. dialect:Dialect The SQL dialect being used. functionRegistry:SQLFunctionRegistry The SQL function registry Returns:String The rendered `ORDER BY` template.

public static String renderOrderByStringTemplate(String orderByFragment, final ColumnMapper columnMapper, final SessionFactoryImplementor sessionFactory, final Dialect dialect, final SQLFunctionRegistry functionRegistry)

Performs order-by template rendering allowing column mapping. An ORDER BY template has all column references "qualified" with a placeholder identified by Template#TEMPLATE which can later be used to easily inject the SQL alias.

Parameters

orderByFragment:String: The order-by fragment to render.
columnMapper:ColumnMapper: The column mapping strategy to use.
sessionFactory:SessionFactoryImplementor: The session factory.
dialect:Dialect: The SQL dialect being used.
functionRegistry:SQLFunctionRegistry: The SQL function registry

Returns:String

The rendered ORDER BY template.

renderWhereStringTemplate	back to summary
public static String renderWhereStringTemplate(String sqlWhereString, Dialect dialect, SQLFunctionRegistry functionRegistry)

renderWhereStringTemplate back to summary

renderWhereStringTemplate	back to summary
public static String renderWhereStringTemplate(String sqlWhereString, String placeholder, Dialect dialect) Deprecated Only intended for annotations usage; use `renderWhereStringTemplate(String, String, Dialect, SQLFunctionRegistry)` instead Same functionality as `renderWhereStringTemplate(String, String, Dialect, SQLFunctionRegistry)`, except that a SQLFunctionRegistry is not provided (i.e., only the dialect-defined functions are considered). This is only intended for use by the annotations project until the many-to-many/map-key-from-target-table feature is pulled into core. Annotations @SuppressWarnings:JavaDoc

public static String renderWhereStringTemplate(String sqlWhereString, String placeholder, Dialect dialect)

Deprecated

Only intended for annotations usage; use renderWhereStringTemplate(String, String, Dialect, SQLFunctionRegistry) instead

Same functionality as renderWhereStringTemplate(String, String, Dialect, SQLFunctionRegistry), except that a SQLFunctionRegistry is not provided (i.e., only the dialect-defined functions are considered). This is only intended for use by the annotations project until the many-to-many/map-key-from-target-table feature is pulled into core.

Annotations

@SuppressWarnings:JavaDoc

renderWhereStringTemplate	back to summary
public static String renderWhereStringTemplate(String sqlWhereString, String placeholder, Dialect dialect, SQLFunctionRegistry functionRegistry) Takes the where condition provided in the mapping attribute and interpolates the alias. Handles sub-selects, quoted identifiers, quoted strings, expressions, SQL functions, named parameters. Parameters sqlWhereString:String The string into which to interpolate the placeholder value placeholder:String The value to be interpolated into the the sqlWhereString dialect:Dialect The dialect to apply functionRegistry:SQLFunctionRegistry The registry of all sql functions Returns:String The rendered sql fragment

renderWhereStringTemplate

back to summary

public static String renderWhereStringTemplate(String sqlWhereString, String placeholder, Dialect dialect, SQLFunctionRegistry functionRegistry)

Takes the where condition provided in the mapping attribute and interpolates the alias. Handles sub-selects, quoted identifiers, quoted strings, expressions, SQL functions, named parameters.

Parameters

sqlWhereString:String: The string into which to interpolate the placeholder value
placeholder:String: The value to be interpolated into the the sqlWhereString
dialect:Dialect: The dialect to apply
functionRegistry:SQLFunctionRegistry: The registry of all sql functions

Returns:String

The rendered sql fragment

org.hibernate.sql back to summary

public Class Template.NoOpColumnMapper

Class Inheritance

extends Object
implements ColumnMapper

java.lang.Object
org.hibernate.sql.Template.NoOpColumnMapper

All Implemented Interfaces

org.hibernate.sql.ordering.antlr.ColumnMapper

Field Summary

Modifier and Type	Field and Description
public static final Template.NoOpColumnMapper	INSTANCE

Constructor Summary

Access	Constructor and Description
public	NoOpColumnMapper()

Method Summary

Modifier and Type	Method and Description
public String[]	map(String The property reference name. reference) Implements org.hibernate.sql.ordering.antlr.ColumnMapper.map. Resolve the property reference to its underlying columns.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INSTANCE	back to summary
public static final Template.NoOpColumnMapper INSTANCE

Constructor Detail

NoOpColumnMapper	back to summary
public NoOpColumnMapper()

Method Detail

map	back to summary
public String[] map(String reference) Implements org.hibernate.sql.ordering.antlr.ColumnMapper.map. Doc from org.hibernate.sql.ordering.antlr.ColumnMapper.map. Resolve the property reference to its underlying columns. Parameters reference:String The property reference name. Returns:String[] The underlying columns, or null if the property reference is unknown.

map

back to summary

public String[] map(String reference)

Implements org.hibernate.sql.ordering.antlr.ColumnMapper.map.

Doc from org.hibernate.sql.ordering.antlr.ColumnMapper.map.

Resolve the property reference to its underlying columns.

Parameters

reference:String: The property reference name.

Returns:String[]

The underlying columns, or null if the property reference is unknown.

org.hibernate.sql back to summary

private Class Template.TrimOperands

Class Inheritance

extends Object

java.lang.Object
org.hibernate.sql.Template.TrimOperands

Field Summary

Modifier and Type	Field and Description
private final String	from
private final String	trimChar
private final String	trimSource
private final String	trimSpec

Constructor Summary

Access	Constructor and Description
private	TrimOperands(List<String> operands)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

from	back to summary
private final String from

trimChar	back to summary
private final String trimChar

trimSource	back to summary
private final String trimSource

trimSpec	back to summary
private final String trimSpec

Constructor Detail

TrimOperands	back to summary
private TrimOperands(List<String> operands)

public final Class Template

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Template.NoOpColumnMapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Template.TrimOperands

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail