Module org.seasar.doma.core

Package org.seasar.doma

Annotation Interface Update

@Target(METHOD)
@Retention(RUNTIME)
public @interface Update

Indicates an update operation.

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

 @Entity
 public class Employee {
     ...
 }

 @Dao
 public interface EmployeeDao {

     @Update
     int update(Employee employee);
 }
 

The method may throw following exceptions:

• DomaNullPointerException if any of the method parameters are null
• OptimisticLockException if optimistic locking is enabled and an update count is 0 for each entity
• UniqueConstraintException if an unique constraint is violated
• SqlFileNotFoundException if sqlFile is true and the SQL file is not found
• JdbcException if a JDBC related error occurs

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	exclude	The properties whose mapped columns are excluded from SQL UPDATE statements.
boolean	excludeNull	Whether SQL NULL columns are excluded from SQL INSERT statements.
boolean	ignoreVersion	Whether the version property is ignored.
String[]	include	The properties whose mapped columns are included in SQL UPDATE statements.
boolean	includeUnchanged	Whether columns mapped to unchanged properties are included in SQL UPDATE statements.
int	queryTimeout	The query timeout in seconds.
Returning	returning
boolean	sqlFile
SqlLogType	sqlLog
boolean	suppressOptimisticLockException	Whether OptimisticLockException is suppressed.

Element Details

sqlFile

boolean sqlFile

Returns:

whether the annotated method should be mapped to an SQL file.

Default:

false

queryTimeout

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

excludeNull

boolean excludeNull

Whether SQL NULL columns are excluded from SQL INSERT statements.

Only if sqlFile() is false, this element value is used.

Returns:

whether SQL NULL columns are excluded

Default:

false

ignoreVersion

boolean ignoreVersion

Whether the version property is ignored.

If true, the column that mapped to the version property is excluded from SQL UPDATE statements.

Returns:

whether the version property is ignored

Default:

false

includeUnchanged

boolean includeUnchanged

Whether columns mapped to unchanged properties are included in SQL UPDATE statements.

Only if the method parameter type is entity class that has a OriginalStates annotated filed, this element value is used.

Returns:

whether columns mapped to unchanged properties are included

Default:

false

include

String[] include

The properties whose mapped columns are included in SQL UPDATE statements.

Only if sqlFile() is false, this value is used.

Returns:

the included properties

Default:

{}

exclude

String[] exclude

The properties whose mapped columns are excluded from SQL UPDATE statements.

Only if sqlFile() is false, this value is used.

Returns:

the excluded properties

Default:

{}

suppressOptimisticLockException

boolean suppressOptimisticLockException

Whether OptimisticLockException is suppressed.

Only if sqlFile() is false, this element value is used.

Returns:

whether OptimisticLockException is suppressed

Default:

false

sqlLog

SqlLogType sqlLog

Returns:

the output format to be used for SQL logs when this update operation is executed.

Default:

FORMATTED

returning

Returning returning

Returns:

the Returning annotation configuration, which defines inclusions or exclusions for returning values.

Default:

@org.seasar.doma.Returning