Package org.hibernate.dialect.function
Class AbstractAnsiTrimEmulationFunction
- java.lang.Object
-
- org.hibernate.dialect.function.AbstractAnsiTrimEmulationFunction
-
- All Implemented Interfaces:
SQLFunction
- Direct Known Subclasses:
AnsiTrimEmulationFunction
public abstract class AbstractAnsiTrimEmulationFunction extends java.lang.Object implements SQLFunction
ASQLFunction
providing support for implementing TRIM functionality (as defined by both the ANSI SQL and JPA specs) in cases where the dialect may not support the full trim function itself. Follows the template pattern in order to implement therender(org.hibernate.type.Type, java.util.List, org.hibernate.engine.spi.SessionFactoryImplementor)
method.
-
-
Constructor Summary
Constructors Constructor Description AbstractAnsiTrimEmulationFunction()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method 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?java.lang.String
render(Type argumentType, java.util.List args, SessionFactoryImplementor factory)
Render the function call as SQL fragment.protected abstract SQLFunction
resolveBothSpaceTrimFromFunction()
Resolve the function definition which should be used to trim both leading and trailing spaces.protected abstract SQLFunction
resolveBothSpaceTrimFunction()
Resolve the function definition which should be used to trim both leading and trailing spaces.protected abstract SQLFunction
resolveBothTrimFunction()
Resolve the function definition which should be used to trim the specified character from both the beginning (leading) and end (trailing) of the trim source.protected abstract SQLFunction
resolveLeadingSpaceTrimFunction()
Resolve the function definition which should be used to trim leading spaces.protected abstract SQLFunction
resolveLeadingTrimFunction()
Resolve the function definition which should be used to trim the specified character from the beginning (leading) of the trim source.protected abstract SQLFunction
resolveTrailingSpaceTrimFunction()
Resolve the function definition which should be used to trim trailing spaces.protected abstract SQLFunction
resolveTrailingTrimFunction()
Resolve the function definition which should be used to trim the specified character from the end (trailing) of the trim source.
-
-
-
Method Detail
-
hasArguments
public final 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 final 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 final Type getReturnType(Type argumentType, 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:
argumentType
- 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 final java.lang.String render(Type argumentType, 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:
argumentType
- 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.
-
resolveBothSpaceTrimFunction
protected abstract SQLFunction resolveBothSpaceTrimFunction()
Resolve the function definition which should be used to trim both leading and trailing spaces. In this form, the imput arguments is missing the FROM keyword.- Returns:
- The sql function
-
resolveBothSpaceTrimFromFunction
protected abstract SQLFunction resolveBothSpaceTrimFromFunction()
Resolve the function definition which should be used to trim both leading and trailing spaces. The same as {#link resolveBothSpaceTrimFunction} except that here theFROM is included and will need to be accounted for duringSQLFunction.render(org.hibernate.type.Type, java.util.List, org.hibernate.engine.spi.SessionFactoryImplementor)
processing.- Returns:
- The sql function
-
resolveLeadingSpaceTrimFunction
protected abstract SQLFunction resolveLeadingSpaceTrimFunction()
Resolve the function definition which should be used to trim leading spaces.- Returns:
- The sql function
-
resolveTrailingSpaceTrimFunction
protected abstract SQLFunction resolveTrailingSpaceTrimFunction()
Resolve the function definition which should be used to trim trailing spaces.- Returns:
- The sql function
-
resolveBothTrimFunction
protected abstract SQLFunction resolveBothTrimFunction()
Resolve the function definition which should be used to trim the specified character from both the beginning (leading) and end (trailing) of the trim source.- Returns:
- The sql function
-
resolveLeadingTrimFunction
protected abstract SQLFunction resolveLeadingTrimFunction()
Resolve the function definition which should be used to trim the specified character from the beginning (leading) of the trim source.- Returns:
- The sql function
-
resolveTrailingTrimFunction
protected abstract SQLFunction resolveTrailingTrimFunction()
Resolve the function definition which should be used to trim the specified character from the end (trailing) of the trim source.- Returns:
- The sql function
-
-