fixes #493 Apply ResultHandler on REFCURSOR OUT parameters.

Author: harawata

src/main/java/org/apache/ibatis/binding/MapperMethod.java

@@ -20,6 +20,7 @@
 import org.apache.ibatis.cursor.Cursor;
 import org.apache.ibatis.mapping.MappedStatement;
 import org.apache.ibatis.mapping.SqlCommandType;
+import org.apache.ibatis.mapping.StatementType;
 import org.apache.ibatis.reflection.MetaObject;
 import org.apache.ibatis.reflection.ParamNameResolver;
 import org.apache.ibatis.reflection.TypeParameterResolver;
@@ -113,9 +114,10 @@ private Object rowCountResult(int rowCount) {
 
   private void executeWithResultHandler(SqlSession sqlSession, Object[] args) {
     MappedStatement ms = sqlSession.getConfiguration().getMappedStatement(command.getName());
-    if (void.class.equals(ms.getResultMaps().get(0).getType())) {
-      throw new BindingException("method " + command.getName() 
-          + " needs either a @ResultMap annotation, a @ResultType annotation," 
+    if (!StatementType.CALLABLE.equals(ms.getStatementType())
+        && void.class.equals(ms.getResultMaps().get(0).getType())) {
+      throw new BindingException("method " + command.getName()
+          + " needs either a @ResultMap annotation, a @ResultType annotation,"
           + " or a resultType attribute in XML so a ResultHandler can be used as a parameter.");
     }
     Object param = method.convertArgsToSqlCommandParam(args);

src/main/java/org/apache/ibatis/executor/resultset/DefaultResultSetHandler.java

@@ -162,10 +162,14 @@ private void handleRefCursorOutputParameter(ResultSet rs, ParameterMapping param
     try {
       final String resultMapId = parameterMapping.getResultMapId();
       final ResultMap resultMap = configuration.getResultMap(resultMapId);
-      final DefaultResultHandler resultHandler = new DefaultResultHandler(objectFactory);
       final ResultSetWrapper rsw = new ResultSetWrapper(rs, configuration);
-      handleRowValues(rsw, resultMap, resultHandler, new RowBounds(), null);
-      metaParam.setValue(parameterMapping.getProperty(), resultHandler.getResultList());
+      if (this.resultHandler == null) {
+        final DefaultResultHandler resultHandler = new DefaultResultHandler(objectFactory);
+        handleRowValues(rsw, resultMap, resultHandler, new RowBounds(), null);
+        metaParam.setValue(parameterMapping.getProperty(), resultHandler.getResultList());
+      } else {
+        handleRowValues(rsw, resultMap, resultHandler, new RowBounds(), null);
+      }
     } finally {
       // issue #228 (close resultsets)
       closeResultSet(rs);

src/test/java/org/apache/ibatis/submitted/usesjava8/refcursor/CreateDB.sql

@@ -78,6 +78,20 @@ $BODY$
   LANGUAGE plpgsql VOLATILE
   COST 100 |
 
+
+CREATE OR REPLACE FUNCTION mbtest.get_order_out_params(
+  order_number integer,
+  detail_count out integer,
+  header_curs out refcursor
+) AS $BODY$
+BEGIN
+  open header_curs for select * from mbtest.order_header where order_id = ORDER_NUMBER;
+  select count(*) into detail_count from mbtest.order_detail where order_id = ORDER_NUMBER;
+END;
+$BODY$
+  LANGUAGE plpgsql VOLATILE
+  COST 100 |
+
 -- @DELIMITER ;
 
 ALTER FUNCTION mbtest.get_order(integer) OWNER TO postgres;

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

@@ -17,7 +17,12 @@
 
 import java.util.Map;
 
+import org.apache.ibatis.session.ResultHandler;
+
 public interface OrdersMapper {
-    void getOrder1(Map<String, Object> parameter);
-    void getOrder2(Map<String, Object> parameter);
+  void getOrder1(Map<String, Object> parameter);
+
+  void getOrder2(Map<String, Object> parameter);
+
+  void getOrder3(Map<String, Object> parameter, ResultHandler<Order> resultHandler);
 }

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

@@ -40,4 +40,18 @@
     { #{order,jdbcType=OTHER,mode=OUT,resultMap=org.apache.ibatis.submitted.usesjava8.refcursor.OrdersMapper.OrderResult,javaType=java.sql.ResultSet} = 
         call mbtest.get_order(#{orderId,jdbcType=INTEGER,mode=IN}) }
   </update>
+
+  <resultMap id="OrderHeaderResult" type="org.apache.ibatis.submitted.usesjava8.refcursor.Order">
+    <id property="orderId" column="ORDER_ID"/>
+    <result property="customerName" column="CUST_NAME" />
+  </resultMap>
+
+  <select id="getOrder3" statementType="CALLABLE">
+    { call mbtest.get_order_out_params(
+      #{orderId,jdbcType=INTEGER,mode=IN},
+      #{detailCount,jdbcType=INTEGER,mode=OUT,javaType=int},
+      #{order,jdbcType=OTHER,mode=OUT,resultMap=OrderHeaderResult,javaType=java.sql.ResultSet}
+    ) }
+  </select>
+
 </mapper>

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

@@ -15,13 +15,13 @@
  */
 package org.apache.ibatis.submitted.usesjava8.refcursor;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.*;
 
 import java.io.IOException;
 import java.io.Reader;
 import java.nio.file.Paths;
 import java.sql.Connection;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
@@ -32,6 +32,8 @@
 import org.apache.ibatis.jdbc.ScriptRunner;
 import org.apache.ibatis.mapping.Environment;
 import org.apache.ibatis.session.Configuration;
+import org.apache.ibatis.session.ResultContext;
+import org.apache.ibatis.session.ResultHandler;
 import org.apache.ibatis.session.SqlSession;
 import org.apache.ibatis.session.SqlSessionFactory;
 import org.apache.ibatis.session.SqlSessionFactoryBuilder;
@@ -114,4 +116,34 @@ public void testRefCursor2() throws IOException {
       assertEquals(3, order.getDetailLines().size());
     }
   }
+
+  @Test
+  public void shouldUseResultHandlerOnOutputParam() throws IOException {
+    class OrderResultHandler implements ResultHandler<Order> {
+      private List<Order> orders = new ArrayList<Order>();
+
+      @Override
+      public void handleResult(ResultContext<? extends Order> resultContext) {
+        Order order = resultContext.getResultObject();
+        order.setCustomerName("Anonymous");
+        orders.add(order);
+      }
+
+      List<Order> getResult() {
+        return orders;
+      }
+    }
+
+    try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
+      OrdersMapper mapper = sqlSession.getMapper(OrdersMapper.class);
+      OrderResultHandler handler = new OrderResultHandler();
+      Map<String, Object> parameter = new HashMap<String, Object>();
+      parameter.put("orderId", 1);
+      mapper.getOrder3(parameter, handler);
+
+      assertNull(parameter.get("order"));
+      assertEquals(Integer.valueOf(3), parameter.get("detailCount"));
+      assertEquals("Anonymous", handler.getResult().get(0).getCustomerName());
+    }
+  }
 }