org.apache.ibatis.annotations

Annotation Type Result

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Repeatable(value=Results.class)
public @interface Result

The annotation that specify a mapping definition for the property.

Author:

Clinton Begin

See Also:

Results

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	column Return the column name(or column label) to map to this argument.
boolean	id Returns whether id column or not.
Class<?>	javaType Return the java type for this argument.
JdbcType	jdbcType Return the jdbc type for column that map to this argument.
Many	many Returns the mapping definition for collection relationship.
One	one Returns the mapping definition for single relationship.
String	property Returns the property name for applying this mapping.
Class<? extends TypeHandler>	typeHandler Returns the TypeHandler type for retrieving a column value from result set.

Element Detail

id

public abstract boolean id

Returns whether id column or not.

Returns:

true if id column; false if otherwise

Default:

false

column

public abstract String column

Return the column name(or column label) to map to this argument.

Returns:

the column name(or column label)

Default:

""

property

public abstract String property

Returns the property name for applying this mapping.

Returns:

the property name

Default:

""

javaType

public abstract Class<?> javaType

Return the java type for this argument.

Returns:

the java type

Default:

void.class

jdbcType

public abstract JdbcType jdbcType

Return the jdbc type for column that map to this argument.

Returns:

the jdbc type

Default:

org.apache.ibatis.type.JdbcType.UNDEFINED

typeHandler

public abstract Class<? extends TypeHandler> typeHandler

Returns the TypeHandler type for retrieving a column value from result set.

Returns:

the TypeHandler type

Default:

org.apache.ibatis.type.UnknownTypeHandler.class

one

public abstract One one

Returns the mapping definition for single relationship.

Returns:

the mapping definition for single relationship

Default:

@org.apache.ibatis.annotations.One

many

public abstract Many many

Returns the mapping definition for collection relationship.

Returns:

the mapping definition for collection relationship

Default:

@org.apache.ibatis.annotations.Many