My favorites | Sign in
Project Home Downloads Issues Source
New issue   Search
  Advanced search   Search tips   Subscriptions
Issue 1: a new @ResultMap annotation to allow for @Select annotations on methods in mapper interfaces to use ResultMaps declared in XML files
4 people starred this issue and may be notified of changes. Back to list
Project Member Reported by, May 17, 2010
Reporter:  Travis Hein	 

Would it be possible to create a new annotation (or does one exist already
and I just have not found it yet), where I can specify that @Select results
should be a <resultMap> that exists in the mapper XML file ?

For example,

Consider a "country" table,

   CODE varchar(2) NOT NULL,
   ISO_CODE varchar(3) NOT NULL,
   NAME varchar(2147483647),
   COUNTRY_CODE varchar(10),

And the java Bean,

public class Country {
  Long id;
  String code; // 2 digit ISO country code
  String isoCode; // 3 digit ISO country code
  String name; // string name
  String countryCode; // the telephone dialing prefix (e.g. +1)
  boolean active = true;

  // and all the get() set() methods for these bean properties

And then the mapper interface,

public interface CountryDAO {

  * Selects all country entries.
  * Though it appears when we use the annotations, we need to specify the
results every time ?
  @Select( value = { "select * from country where active = true" })
  @Results(value = {
      @Result(property="isoCode", column="iso_code"),
      @Result(property="name", column="name"),
      @Result(property="countryCode", column="country_code"),
      @Result(property="active", column="active")
  List<Country> getAllActive();

  // TODO: all these methods would also be select queries, where I would
want the same results map as above
  Country getById(Long id);
  Country getByCode(String code);
  Country getByIsoCode(String isoCode);

Where, instead of the @Results annotation, which would need to be
duplicated with its nested @Result annotations on every select method that
I want to return the same mapping, what I would wish to have would be
something like a


annotation, where the myMapperID would be the ID of a <resultMap> I have
declared in the mapper's xml file that will be included by the
SqlMapConfig.xml (which I have anyway to bind to this mapper interface, and
also because I have some more complex queries declared in the xml mapper
file too).

Where in this example, I already have a

<mapper namespace="CountryDAO">

<resultMap type="Country" id="countryResult">
<result property="id" column="id"/>
<result property="code" column="code"/>
<result property="isoCode" column="iso_code"/>
<result property="name" column="name"/>
<result property="countryCode" column="country_code"/>
<result property="active" column="active"/>

So this wishful @ResultMap annotation would then make the mapper interface
look like:

public interface CountryDAO {

  @Select( value = { "select * from country where active = true" })
  @ResultMap(value = "countryResult")
  List<Country> getAllActive();

  // and now other things that want to select into this map can do so,
re-using the single map declaration
  // that is referenced in the xml.

  @Select( value = { "select * from country where id = #{id} })
  @ResultMap(value = "countryResult")
  Country getById(Long id);

  @Select( value = { "select * from country where code = #{code} })
  @ResultMap(value = "countryResult")
  Country getByCode(String code);

  @Select( value = { "select * from country where isoCode = #{isoCode} })
  @ResultMap(value = "countryResult")
  Country getByIsoCode(String isoCode);

I think having something like this @ResultMap annotation would be a good
thing to have, what do you think? 

May 17, 2010
Project Member #1
(No comment was entered for this change.)
Labels: -Type-Defect Type-Enhancement
May 17, 2010
Project Member #2
(No comment was entered for this change.)
Labels: -Type-Enhancement -Priority-Medium Type-Feature Priority-Low Version-Release3.x Component-SqlMaps
Jun 1, 2010
Project Member #3
(No comment was entered for this change.)
Status: Accepted
Sep 28, 2010
I edited org.apache.ibatis.annotations.Options and org.apache.ibatis.builder.annotation.MapperAnnotationBuilder to make it.
Instead of adding a new annotation, I added the resultMap attribute to @Options.
Use it this way :
922 bytes   View   Download
15.3 KB   View   Download
Dec 26, 2010
Project Member #5
 Issue 17  has been merged into this issue.
Dec 29, 2010
Project Member #6
Fixed in SVN for 3.0.4.  I went with a new @ResultMap annotation because I think the @Options annotation is getting a bit overloaded and there are possible unintended consequences of using that annotation.
Status: Fixed
Owner: jeffgbutler
Cc: clinton.begin
Labels: Target-Release3.0.4
May 16, 2011
Hi, (Travis Hein, original reporter here).

I have upgraded to 3.0.4, and now able to make use of this @ResultMap annotation. 
It works perfectly ! 

Thank you for the time and consideration to implement this feature.
Sign in to add a comment

Powered by Google Project Hosting