Fix for http://code.google.com/p/mybatis/issues/detail?id=30 - handle nested result maps with refcursors properly

Author: jeffgbutler

src/main/java/org/apache/ibatis/mapping/MappedStatement.java

@@ -200,6 +200,18 @@ public BoundSql getBoundSql(Object parameterObject) {
     if (parameterMappings == null || parameterMappings.size() <= 0) {
       boundSql = new BoundSql(configuration, boundSql.getSql(), parameterMap.getParameterMappings(), parameterObject);
     }
+    
+    // check for nested result maps in parameter mappings (issue #30)
+    for (ParameterMapping pm : boundSql.getParameterMappings()) {
+        String rmId = pm.getResultMapId();
+        if (rmId != null) {
+            ResultMap rm = configuration.getResultMap(rmId);
+            if (rm != null) {
+                hasNestedResultMaps |= rm.hasNestedResultMaps();
+            }
+        }
+    }
+    
     return boundSql;
   }
 

src/test/java/org/apache/ibatis/submitted/refcursor/MapperConfig.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<!DOCTYPE configuration
+    PUBLIC "-//ibatis.apache.org//DTD Config 3.0//EN"
+    "http://ibatis.apache.org/dtd/ibatis-3-config.dtd">
+<configuration>
+
+  <environments default="development">
+    <environment id="development">
+      <transactionManager type="JDBC">
+        <property name="" value=""/>
+      </transactionManager>
+      <dataSource type="UNPOOLED">
+        <property name="driver" value="org.postgresql.Driver"/>
+        <property name="url" value="jdbc:postgresql:mbtest"/>
+        <property name="username" value="postgres"/>
+        <property name="password" value="root"/>
+      </dataSource>
+    </environment>
+  </environments>
+
+  <mappers>
+    <mapper resource="org/apache/ibatis/submitted/refcursor/OrdersMapper.xml"/>
+  </mappers>
+
+</configuration>

src/test/java/org/apache/ibatis/submitted/refcursor/Order.java

@@ -0,0 +1,27 @@
+package org.apache.ibatis.submitted.refcursor;
+
+import java.util.List;
+
+public class Order {
+    private Integer orderId;
+    private String customerName;
+    private List<OrderDetail> detailLines;
+    public Integer getOrderId() {
+        return orderId;
+    }
+    public void setOrderId(Integer orderId) {
+        this.orderId = orderId;
+    }
+    public String getCustomerName() {
+        return customerName;
+    }
+    public void setCustomerName(String customerName) {
+        this.customerName = customerName;
+    }
+    public List<OrderDetail> getDetailLines() {
+        return detailLines;
+    }
+    public void setDetailLines(List<OrderDetail> detailLines) {
+        this.detailLines = detailLines;
+    }
+}

src/test/java/org/apache/ibatis/submitted/refcursor/OrderDetail.java

@@ -0,0 +1,32 @@
+package org.apache.ibatis.submitted.refcursor;
+
+public class OrderDetail {
+    private Integer orderNumber;
+    private Integer lineNumber;
+    private Integer quantity;
+    private String description;
+    public Integer getLineNumber() {
+        return lineNumber;
+    }
+    public void setLineNumber(Integer lineNumber) {
+        this.lineNumber = lineNumber;
+    }
+    public Integer getQuantity() {
+        return quantity;
+    }
+    public void setQuantity(Integer quantity) {
+        this.quantity = quantity;
+    }
+    public String getDescription() {
+        return description;
+    }
+    public void setDescription(String description) {
+        this.description = description;
+    }
+    public Integer getOrderNumber() {
+        return orderNumber;
+    }
+    public void setOrderNumber(Integer orderNumber) {
+        this.orderNumber = orderNumber;
+    }
+}

src/test/java/org/apache/ibatis/submitted/refcursor/OrdersMapper.java

@@ -0,0 +1,8 @@
+package org.apache.ibatis.submitted.refcursor;
+
+import java.util.Map;
+
+public interface OrdersMapper {
+    void getOrder1(Map<String, Object> parameter);
+    void getOrder2(Map<String, Object> parameter);
+}

src/test/java/org/apache/ibatis/submitted/refcursor/OrdersMapper.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mapper PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN" "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
+<mapper namespace="org.apache.ibatis.submitted.refcursor.OrdersMapper">
+  <resultMap type="org.apache.ibatis.submitted.refcursor.Order" id="OrderResult">
+    <id property="orderId" column="ORDER_ID"/>
+    <result property="customerName" column="CUST_NAME"/>
+    <collection property="detailLines" ofType="org.apache.ibatis.submitted.refcursor.OrderDetail">
+      <id property="lineNumber" column="LINE_NUMBER"/>
+      <result property="quantity" column="QUANTITY"/>
+      <result property="description" column="ITEM_DESCRIPTION"/>
+    </collection>
+  </resultMap>
+  
+  <update id="getOrder1" parameterType="map" statementType="CALLABLE">
+    { #{order,jdbcType=OTHER,mode=OUT,resultMap=OrderResult,javaType=java.sql.ResultSet} = 
+        call mbtest.get_order(#{orderId,jdbcType=INTEGER,mode=IN}) }
+  </update>
+
+  <update id="getOrder2" parameterType="map" statementType="CALLABLE">
+    { #{order,jdbcType=OTHER,mode=OUT,resultMap=org.apache.ibatis.submitted.refcursor.OrdersMapper.OrderResult,javaType=java.sql.ResultSet} = 
+        call mbtest.get_order(#{orderId,jdbcType=INTEGER,mode=IN}) }
+  </update>
+</mapper>

src/test/java/org/apache/ibatis/submitted/refcursor/RefCursorTest.java

@@ -0,0 +1,74 @@
+package org.apache.ibatis.submitted.refcursor;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import java.io.IOException;
+import java.io.Reader;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.ibatis.io.Resources;
+import org.apache.ibatis.session.SqlSession;
+import org.apache.ibatis.session.SqlSessionFactory;
+import org.apache.ibatis.session.SqlSessionFactoryBuilder;
+import org.junit.Ignore;
+import org.junit.Test;
+
+/**
+ * This class contains tests for refcursors.  The tests require a
+ * local install of PostgreSQL and cannot be run as a part of the normal
+ * MyBatis build.  They must be run manually on a box with PostgreSQL
+ * setup as described in setupdb.txt
+ * 
+ * @author Jeff
+ *
+ */
+public class RefCursorTest {
+    @SuppressWarnings("unchecked")
+    @Test
+    @Ignore("See setupdb.txt for instructions on how to run this test")
+    public void testRefCursor1() throws IOException {
+        Reader reader = Resources.getResourceAsReader("org/apache/ibatis/submitted/refcursor/MapperConfig.xml");
+        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
+        SqlSession sqlSession = sqlSessionFactory.openSession();
+        try {
+            OrdersMapper mapper = sqlSession.getMapper(OrdersMapper.class);
+            Map<String, Object> parameter = new HashMap<String, Object>();
+            parameter.put("orderId", 1);
+            mapper.getOrder1(parameter);
+            
+            assertNotNull(parameter.get("order"));
+            List<Order> orders = (List<Order>) parameter.get("order");
+            assertEquals(1, orders.size());
+            Order order = orders.get(0);
+            assertEquals(3, order.getDetailLines().size());
+        } finally {
+            sqlSession.close();
+        }
+    }
+
+    @SuppressWarnings("unchecked")
+    @Test
+    @Ignore("See setupdb.txt for instructions on how to run this test")
+    public void testRefCursor2() throws IOException {
+        Reader reader = Resources.getResourceAsReader("org/apache/ibatis/submitted/refcursor/MapperConfig.xml");
+        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
+        SqlSession sqlSession = sqlSessionFactory.openSession();
+        try {
+            OrdersMapper mapper = sqlSession.getMapper(OrdersMapper.class);
+            Map<String, Object> parameter = new HashMap<String, Object>();
+            parameter.put("orderId", 1);
+            mapper.getOrder2(parameter);
+            
+            assertNotNull(parameter.get("order"));
+            List<Order> orders = (List<Order>) parameter.get("order");
+            assertEquals(1, orders.size());
+            Order order = orders.get(0);
+            assertEquals(3, order.getDetailLines().size());
+        } finally {
+            sqlSession.close();
+        }
+    }
+}