程序包 org.hibernate.dialect.function

类 StandardSQLFunction

java.lang.Object

org.hibernate.dialect.function.StandardSQLFunction

所有已实现的接口:

SQLFunction

直接已知子类:

ConditionalParenthesisFunction, DB2SubstringFunction, StandardAnsiSqlAggregationFunctions.AvgFunction, StandardAnsiSqlAggregationFunctions.CountFunction, StandardAnsiSqlAggregationFunctions.MaxFunction, StandardAnsiSqlAggregationFunctions.MinFunction, StandardAnsiSqlAggregationFunctions.SumFunction, StandardJDBCEscapeFunction

public class StandardSQLFunction
extends Object
implements SQLFunction

Provides a standard implementation that supports the majority of the HQL functions that are translated to SQL. The Dialect and its sub-classes use this class to provide details required for processing of the associated function.

作者:

David Channon

构造器概要

构造器

构造器	说明
StandardSQLFunction(String name)	Construct a standard SQL function definition with a variable return type; the actual return type will depend on the types to which the function is applied.
StandardSQLFunction(String name, Type registeredType)	Construct a standard SQL function definition with a static return type.

方法概要

修饰符和类型	方法	说明
String	getName()	Function name accessor
protected String	getRenderedName(List arguments)
Type	getReturnType(Type firstArgumentType, Mapping mapping)	The return type of the function.
Type	getType()	Function static return type accessor.
boolean	hasArguments()	Does this function have any arguments?
boolean	hasParenthesesIfNoArguments()	If there are no arguments, are parentheses required?
String	render(Type firstArgumentType, List arguments, SessionFactoryImplementor sessionFactory)	Render the function call as SQL fragment.
String	toString()

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

StandardSQLFunction

public StandardSQLFunction(String name)

Construct a standard SQL function definition with a variable return type; the actual return type will depend on the types to which the function is applied.

Using this form, the return type is considered non-static and assumed to be the type of the first argument.

参数:

name - The name of the function.

StandardSQLFunction

public StandardSQLFunction(String name,
                           Type registeredType)

Construct a standard SQL function definition with a static return type.

参数:

name - The name of the function.

registeredType - The static return type.

方法详细资料

getName

public String getName()

Function name accessor

返回:

The function name.

getType

public Type getType()

Function static return type accessor.

返回:

The static function return type; or null if return type is not static.

hasArguments

public boolean hasArguments()

从接口复制的说明: SQLFunction

Does this function have any arguments?

指定者:

hasArguments 在接口中 SQLFunction

返回:

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

hasParenthesesIfNoArguments

public boolean hasParenthesesIfNoArguments()

从接口复制的说明: SQLFunction

If there are no arguments, are parentheses required?

指定者:

hasParenthesesIfNoArguments 在接口中 SQLFunction

返回:

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

getReturnType

public Type getReturnType(Type firstArgumentType,
                          Mapping mapping)

从接口复制的说明: 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 into SQLFunction.render(org.hibernate.type.Type, java.util.List, org.hibernate.engine.spi.SessionFactoryImplementor)

指定者:

getReturnType 在接口中 SQLFunction

参数:

firstArgumentType - The type of the first argument

mapping - The mapping source.

返回:

The type to be expected as a return.

render

public String render(Type firstArgumentType,
                     List arguments,
                     SessionFactoryImplementor sessionFactory)

从接口复制的说明: SQLFunction

Render the function call as SQL fragment.

Note, the 'firstArgumentType' parameter should match the one passed into SQLFunction.getReturnType(org.hibernate.type.Type, org.hibernate.engine.spi.Mapping)

指定者:

render 在接口中 SQLFunction

参数:

firstArgumentType - The type of the first argument

arguments - The function arguments

sessionFactory - The SessionFactory

返回:

The rendered function call

getRenderedName

protected String getRenderedName(List arguments)

toString

public String toString()

覆盖:

toString 在类中 Object