Further to bug 17491:set sheet order - now made accessible from usermodel, rudimentary testcase added. Testcase to be enhanced.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353032 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java

@@ -256,10 +256,22 @@ public class HSSFWorkbook
 
         // none currently
     }
-
+    
+    /**
+     * sets the order of appearance for a given sheet.
+     *
+     * @param sheetname the name of the sheet to reorder
+     * @param pos the position that we want to insert the sheet into (0 based)
+     */
+    
+    public void setSheetOrder(String sheetname, int pos ) {
+        workbook.setSheetOrder(sheetname, pos);
+    }
+    
     public final static byte ENCODING_COMPRESSED_UNICODE = 0;
     public final static byte ENCODING_UTF_16             = 1;
     
+     
     /**
      * set the sheet name.
      * @param sheet number (0 based)

src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheetOrder.java

@@ -0,0 +1,103 @@
+/* ====================================================================
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2002 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution,
+ *    if any, must include the following acknowledgment:
+ *       "This product includes software developed by the
+ *        Apache Software Foundation (http://www.apache.org/)."
+ *    Alternately, this acknowledgment may appear in the software itself,
+ *    if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "Apache" and "Apache Software Foundation" and
+ *    "Apache POI" must not be used to endorse or promote products
+ *    derived from this software without prior written permission. For
+ *    written permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache",
+ *    "Apache POI", nor may "Apache" appear in their name, without
+ *    prior written permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+package org.apache.poi.hssf.usermodel;
+
+import junit.framework.TestCase;
+
+import org.apache.poi.hssf.model.Sheet;
+
+/**
+ * Tests HSSFWorkbook method setSheetOrder()
+ *
+ *
+ * @author Ruel Loehr (loehr1 at us.ibm.com)
+ */
+
+public class TestHSSFSheetOrder
+        extends TestCase
+{
+    public TestHSSFSheetOrder(String s)
+    {
+        super(s);
+    }
+
+    /**
+     * Test the sheet set order method
+     */
+
+    public void testBackupRecord()
+            throws Exception
+    {
+        HSSFWorkbook wb = new HSSFWorkbook();
+        
+        for (int i=0; i < 10; i++)
+        {
+			HSSFSheet s = wb.createSheet("Sheet " + i);
+			Sheet sheet = s.getSheet();
+        }
+
+        wb.getWorkbook().setSheetOrder("Sheet 6", 0);
+	  wb.getWorkbook().setSheetOrder("Sheet 3", 7);
+	  wb.getWorkbook().setSheetOrder("Sheet 1", 9);
+          
+          //TODO read it in and see if it is correct. 
+	  
+	 
+    }
+
+
+}
+
+