org.seasar.doma

Annotation Type Select

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

Indicates a select.

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

 @Entity
 public class Employee {
     ...
 }

 @Dao
 public interface EmployeeDao {

     @Select
     String selectNameById(Integer id);

     @Select
     List<Employee> selectNamesByAgeAndSalary(Integer age, BigDecimal salary);

     @Select
     Employee selectById(Integer id);

     @Select
     List<Employee> selectByExample(Employee example);

     @Select(strategy = SelectStrategyType.STREAM)
     <R> R selectSalary(Integer departmentId, Function<Stream<BigDecimal>, R> mapper);
 }
 

The method may throw following exceptions:

• DomaNullPointerException if any of the method parameters are null
• SqlFileNotFoundException if sqlFile is true and a SQL file is not found
• UnknownColumnException if a property whose mapped column is included in a result set is not found
• NonUniqueResultException if an unique row is expected but two or more rows are found in a result set
• NonSingleColumnException if a single column is expected but two or more columns are found in a result set
• NoResultException if ensureResult() is true and no row is found in a result set
• ResultMappingException if ensureResultMapping() is true and all entity properties are not mapped to columns of a result set
• JdbcException if a JDBC related error occurs

See Also:

SelectOptions

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	ensureResult Whether to ensure that one or more rows are found in a result set.
boolean	ensureResultMapping Whether to ensure that all entity properties are mapped to columns of a result set.
FetchType	fetch
int	fetchSize The fetch size.
MapKeyNamingType	mapKeyNaming The naming convention for keys of Map<Object, String>.
int	maxRows The maximum number of rows.
int	queryTimeout The query timeout in seconds.
SqlLogType	sqlLog
SelectType	strategy

Element Detail

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

fetchSize

public abstract int fetchSize

The fetch size.

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

Returns:

the fetch size

See Also:

Statement.setFetchSize(int)

Default:

-1

maxRows

public abstract int maxRows

The maximum number of rows.

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

Returns:

the maximum number of rows

See Also:

Statement.setMaxRows(int)

Default:

-1

strategy

public abstract SelectType strategy

Returns:

the strategy for handling an object that is mapped to a result set.

Default:

org.seasar.doma.SelectType.RETURN

fetch

public abstract FetchType fetch

Returns:

the fetch type.

Default:

org.seasar.doma.FetchType.LAZY

ensureResult

public abstract boolean ensureResult

Whether to ensure that one or more rows are found in a result set.

if true and no row is found, NoResultException is thrown from the method.

Returns:

whether to ensure that one or more rows are found in a result set

Default:

false

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 method.

Returns:

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

Default:

false

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

sqlLog

public abstract SqlLogType sqlLog

Returns:

the output format of SQL logs.

Default:

org.seasar.doma.jdbc.SqlLogType.FORMATTED