public abstract class

TrimFunctionTemplate

extends Object
implements SQLFunction
java.lang.Object
   ↳ org.hibernate.dialect.function.TrimFunctionTemplate
Known Direct Subclasses

Class Overview

Defines the basic template support for TRIM functions

Summary

Nested Classes
class TrimFunctionTemplate.Options  
class TrimFunctionTemplate.Specification  
Public Constructors
TrimFunctionTemplate()
Public Methods
Type getReturnType(Type firstArgument, 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 firstArgument, List args, SessionFactoryImplementor factory)
Render the function call as SQL fragment.
Protected Methods
abstract String render(TrimFunctionTemplate.Options options, String trimSource, SessionFactoryImplementor factory)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.hibernate.dialect.function.SQLFunction

Public Constructors

public TrimFunctionTemplate ()

Public Methods

public Type getReturnType (Type firstArgument, Mapping mapping)

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.

Note, the 'firstArgumentType' parameter should match the one passed into render(Type, List, SessionFactoryImplementor)

Parameters
firstArgument The type of the first argument
mapping The mapping source.
Returns
  • The type to be expected as a return.
Throws
QueryException

public boolean hasArguments ()

Does this function have any arguments?

Returns
  • True if the function expects to have parameters; false otherwise.

public boolean hasParenthesesIfNoArguments ()

If there are no arguments, are parentheses required?

Returns
  • True if a no-arg call of this function requires parentheses.

public String render (Type firstArgument, List args, SessionFactoryImplementor factory)

Render the function call as SQL fragment.

Note, the 'firstArgumentType' parameter should match the one passed into getReturnType(Type, Mapping)

Parameters
firstArgument The type of the first argument
args The function arguments
factory The SessionFactory
Returns
  • The rendered function call
Throws
QueryException

Protected Methods

protected abstract String render (TrimFunctionTemplate.Options options, String trimSource, SessionFactoryImplementor factory)