public class SQLFunctionTemplate extends Object implements SQLFunction
Represents HQL functions that can have different representations in different SQL dialects where that difference can be handled via a template/pattern. <p/> E.g. in HQL we can define function <code>concat(?1, ?2)</code> to concatenate two strings p1 and p2. Dialects would register different versions of this class using the same name (concat) but with different templates or patterns; <code>(?1 || ?2)</code> for Oracle, <code>concat(?1, ?2)</code> for MySql, <code>(?1 + ?2)</code> for MS SQL. Each dialect will define a template as a string (exactly like above) marking function parameters with '?' followed by parameter’s index (first index is 1).
Constructor and Description |
---|
SQLFunctionTemplate(Type type,
String template)
Constructs a SQLFunctionTemplate
|
SQLFunctionTemplate(Type type,
String template,
boolean hasParenthesesIfNoArgs)
Constructs a SQLFunctionTemplate
|
Modifier and Type | Method and Description |
---|---|
Type |
getReturnType(Type argumentType,
Mapping mapping)
The return type of the function.
|
boolean |
hasArguments()
Does this function have any arguments?
|
boolean |
hasParenthesesIfNoArguments()
If there are no arguments, are parentheses required?
|
String |
render(Type argumentType,
List args,
SessionFactoryImplementor factory)
Render the function call as SQL fragment.
|
String |
toString() |
public SQLFunctionTemplate(Type type, String template)
Constructs a SQLFunctionTemplate
type
- The functions return typetemplate
- The function templatepublic String render(Type argumentType, List args, SessionFactoryImplementor factory)
SQLFunction
Render the function call as SQL fragment.
<p/>
Note, the 'firstArgumentType' parameter should match the one passed into SQLFunction.getReturnType(org.hibernate.type.Type, org.hibernate.engine.spi.Mapping)
render
in interface SQLFunction
argumentType
- The type of the first argumentargs
- The function argumentsfactory
- The SessionFactorypublic Type getReturnType(Type argumentType, Mapping mapping) throws QueryException
SQLFunction
The return type of the function. May be either a concrete type which is preset, or variable depending upon
the type of the first function argument.
<p/>
Note, the 'firstArgumentType' parameter should match the one passed into SQLFunction.render(org.hibernate.type.Type, java.util.List, org.hibernate.engine.spi.SessionFactoryImplementor)
getReturnType
in interface SQLFunction
argumentType
- The type of the first argumentmapping
- The mapping source.QueryException
- Indicates an issue resolving the return type.public boolean hasArguments()
SQLFunction
Does this function have any arguments?
hasArguments
in interface SQLFunction
public boolean hasParenthesesIfNoArguments()
SQLFunction
If there are no arguments, are parentheses required?
hasParenthesesIfNoArguments
in interface SQLFunction
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.