Module org.seasar.doma.core

Package org.seasar.doma.jdbc.query

Class AutoFunctionQuery<RESULT>

java.lang.Object

org.seasar.doma.jdbc.query.AbstractQuery

org.seasar.doma.jdbc.query.AutoModuleQuery

org.seasar.doma.jdbc.query.AutoFunctionQuery<RESULT>

Type Parameters:

RESULT - the type of the function result

All Implemented Interfaces:

FunctionQuery<RESULT>, ModuleQuery, Query

public class AutoFunctionQuery<RESULT>
extends AutoModuleQuery
implements FunctionQuery<RESULT>

An auto function query that calls a database function.

This class implements FunctionQuery to provide functionality for calling database functions. It handles parameter binding and result retrieval.

Field Summary

Fields

Modifier and Type	Field	Description
protected ResultParameter<RESULT>	resultParameter	The parameter that will hold the function result.

Fields inherited from class org.seasar.doma.jdbc.query.AutoModuleQuery

catalogName, isQuoteRequired, moduleName, parameters, qualifiedName, schemaName, sql, sqlLogType

Fields inherited from class org.seasar.doma.jdbc.query.AbstractQuery

callerClassName, callerMethodName, config, message, method, queryTimeout

Constructor Summary

Constructors

Constructor	Description
AutoFunctionQuery()

Method Summary

Modifier and Type	Method	Description
RESULT	getResult()	Returns the result of the function call.
void	prepare()	Prepares this query for execution.
protected void	prepareSql()	Prepares the SQL for this function query.
void	setFunctionName(String functionName)	Sets the function name.
void	setResultParameter(ResultParameter<RESULT> parameter)	Sets the result parameter.

Methods inherited from class org.seasar.doma.jdbc.query.AutoModuleQuery

addParameter, complete, getQualifiedName, getSql, getSqlLogType, prepareOptions, prepareQualifiedName, setCatalogName, setModuleName, setQuoteRequired, setSchemaName, setSqlLogType

Methods inherited from class org.seasar.doma.jdbc.query.AbstractQuery

comment, getClassName, getConfig, getMethod, getMethodName, getQueryTimeout, setCallerClassName, setCallerMethodName, setConfig, setMessage, setMethod, setQueryTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.seasar.doma.jdbc.query.ModuleQuery

getQualifiedName, getSql, getSqlLogType

Methods inherited from interface org.seasar.doma.jdbc.query.Query

comment, complete, getClassName, getConfig, getMethod, getMethodName, getQueryTimeout

Field Details

resultParameter

protected ResultParameter<RESULT> resultParameter

The parameter that will hold the function result.

Constructor Details

AutoFunctionQuery

public AutoFunctionQuery()

Method Details

prepare

public void prepare()

Prepares this query for execution. This method must be called before the query is executed.

Specified by:

prepare in interface Query

Overrides:

prepare in class AbstractQuery

prepareSql

protected void prepareSql()

Prepares the SQL for this function query.

This method builds the callable SQL statement for the function call.

setFunctionName

public void setFunctionName(String functionName)

Sets the function name.

Parameters:

functionName - the function name

setResultParameter

public void setResultParameter(ResultParameter<RESULT> parameter)

Sets the result parameter.

Parameters:

parameter - the result parameter

getResult

public RESULT getResult()

Returns the result of the function call.

This method is called after executing the function to retrieve the result value. The result type depends on the function's return type and the Java type mapping.

Specified by:

getResult in interface FunctionQuery<RESULT>

Returns:

the function result