Package org.apache.ibatis.annotations
Annotation Interface Result
The annotation that specify a mapping definition for the property.
- Author:
- Clinton Begin
- See Also:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionReturn the column name(or column label) to map to this argument.boolean
Returns whether id column or not.Class<?>
Return the java type for this argument.Return the jdbc type for column that map to this argument.Returns the mapping definition for collection relationship.Returns the mapping definition for single relationship.Returns the property name for applying this mapping.Class<? extends TypeHandler>
Returns theTypeHandler
type for retrieving a column value from result set.
-
Element Details
-
id
boolean idReturns whether id column or not.- Returns:
true
if id column;false
if otherwise
- Default:
- false
-
column
String columnReturn the column name(or column label) to map to this argument.- Returns:
- the column name(or column label)
- Default:
- ""
-
property
String propertyReturns the property name for applying this mapping.- Returns:
- the property name
- Default:
- ""
-
javaType
Class<?> javaTypeReturn the java type for this argument.- Returns:
- the java type
- Default:
- void.class
-
jdbcType
JdbcType jdbcTypeReturn the jdbc type for column that map to this argument.- Returns:
- the jdbc type
- Default:
- UNDEFINED
-
typeHandler
Class<? extends TypeHandler> typeHandlerReturns theTypeHandler
type for retrieving a column value from result set.- Returns:
- the
TypeHandler
type
- Default:
- org.apache.ibatis.type.UnknownTypeHandler.class
-
one
One oneReturns the mapping definition for single relationship.- Returns:
- the mapping definition for single relationship
- Default:
- @org.apache.ibatis.annotations.One
-
many
Many manyReturns the mapping definition for collection relationship.- Returns:
- the mapping definition for collection relationship
- Default:
- @org.apache.ibatis.annotations.Many
-