org.seasar.doma

Annotation Type Function

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface Function

Indicates a stored function call.

The annotated method must be a member of a Dao annotated interface.

 @Dao
 public interface EmployeeDao {

     @Function
     BigDecimal getSalary(@In Integer id, @Out Reference<String> name);
 }
 

The method may throw following exceptions:

• DomaNullPointerException if any of the method parameters are null
• UnknownColumnException if ResultSet is used and a column is not found in the result set
• JdbcException if a JDBC related error occurs

See Also:

In, InOut, Out, ResultSet

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	catalog
boolean	ensureResultMapping Whether to ensure that all entity properties are mapped to columns of a result set.
MapKeyNamingType	mapKeyNaming The naming convention for keys of Map<Object, String>.
java.lang.String	name The stored function name.
int	queryTimeout The query timeout in seconds.
boolean	quote
java.lang.String	schema
SqlLogType	sqlLog

Element Detail

catalog

public abstract java.lang.String catalog

Returns:

the catalog name.

Default:

""

schema

public abstract java.lang.String schema

Returns:

the schema name.

Default:

""

name

public abstract java.lang.String name

The stored function name.

If not specified, the annotated method name is used.

Returns:

the stored function name

Default:

""

quote

public abstract boolean quote

Returns:

whether quotation marks are used for the catalog name, the schema name and the stored function name.

Default:

false

queryTimeout

public abstract int queryTimeout

The query timeout in seconds.

If not specified, Config.getQueryTimeout() is used.

Returns:

the query timeout

See Also:

Statement.setQueryTimeout(int)

Default:

-1

mapKeyNaming

public abstract MapKeyNamingType mapKeyNaming

The naming convention for keys of Map<Object, String>.

This value is used only if a result set is fetched as Map<Object, String> or List<Map<Object, String>>.

Returns:

the naming convention

Default:

org.seasar.doma.MapKeyNamingType.NONE

ensureResultMapping

public abstract boolean ensureResultMapping

Whether to ensure that all entity properties are mapped to columns of a result set.

This value is used only if the result set is fetched as an entity or a entity list.

If true and there are some unmapped properties、 ResultMappingException is thrown from the annotated method.

Returns:

whether to ensure that all entity properties are mapped to columns of a result set

Default:

false

sqlLog

public abstract SqlLogType sqlLog

Returns:

the output format of SQL logs.

Default:

org.seasar.doma.jdbc.SqlLogType.FORMATTED