Package org.hibernate.dialect.function
Class TrimFunctionTemplate
- java.lang.Object
-
- org.hibernate.dialect.function.TrimFunctionTemplate
-
- All Implemented Interfaces:
SQLFunction
- Direct Known Subclasses:
AnsiTrimFunction
public abstract class TrimFunctionTemplate extends java.lang.Object implements SQLFunction
Defines the basic template support for TRIM functions
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
TrimFunctionTemplate.Options
protected static class
TrimFunctionTemplate.Specification
-
Constructor Summary
Constructors Constructor Description TrimFunctionTemplate()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description 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?protected abstract java.lang.String
render(TrimFunctionTemplate.Options options, java.lang.String trimSource, SessionFactoryImplementor factory)
java.lang.String
render(Type firstArgument, java.util.List args, SessionFactoryImplementor factory)
Render the function call as SQL fragment.
-
-
-
Method Detail
-
hasArguments
public boolean hasArguments()
Description copied from interface:SQLFunction
Does this function have any arguments?- Specified by:
hasArguments
in interfaceSQLFunction
- Returns:
- True if the function expects to have parameters; false otherwise.
-
hasParenthesesIfNoArguments
public boolean hasParenthesesIfNoArguments()
Description copied from interface:SQLFunction
If there are no arguments, are parentheses required?- Specified by:
hasParenthesesIfNoArguments
in interfaceSQLFunction
- Returns:
- True if a no-arg call of this function requires parentheses.
-
getReturnType
public Type getReturnType(Type firstArgument, Mapping mapping) throws QueryException
Description copied from interface: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. Note, the 'firstArgumentType' parameter should match the one passed intoSQLFunction.render(org.hibernate.type.Type, java.util.List, org.hibernate.engine.spi.SessionFactoryImplementor)
- Specified by:
getReturnType
in interfaceSQLFunction
- Parameters:
firstArgument
- The type of the first argumentmapping
- The mapping source.- Returns:
- The type to be expected as a return.
- Throws:
QueryException
- Indicates an issue resolving the return type.
-
render
public java.lang.String render(Type firstArgument, java.util.List args, SessionFactoryImplementor factory) throws QueryException
Description copied from interface:SQLFunction
Render the function call as SQL fragment. Note, the 'firstArgumentType' parameter should match the one passed intoSQLFunction.getReturnType(org.hibernate.type.Type, org.hibernate.engine.spi.Mapping)
- Specified by:
render
in interfaceSQLFunction
- Parameters:
firstArgument
- The type of the first argumentargs
- The function argumentsfactory
- The SessionFactory- Returns:
- The rendered function call
- Throws:
QueryException
- Indicates a problem rendering the function call.
-
render
protected abstract java.lang.String render(TrimFunctionTemplate.Options options, java.lang.String trimSource, SessionFactoryImplementor factory)
-
-