Allow the passing of a File object to WorkbookFactory.create, which permits lower...

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

diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml
index e0ba0b061a4c540507db9a02070af265facbe149..e976ca7f1f7d0f94d119a6efb3823d206b409e57 100644 (file)
--- a/src/documentation/content/xdocs/status.xml
+++ b/src/documentation/content/xdocs/status.xml
@@ -34,6 +34,7 @@
 
     <changes>
         <release version="3.8-beta5" date="2011-??-??">
+           <action dev="poi-developers" type="add">Allow the passing of a File object to WorkbookFactory.create, which permits lower memory processing than the InputStream version</action>
            <action dev="poi-developers" type="fix">51873 - update HSMF to ignore Outlook 2002 Olk10SideProp entries, which don't behave like normal chunks</action>
            <action dev="poi-developers" type="fix">51850 - support creating comments in XSSF on an earlier slide when later ones already have them</action>
            <action dev="poi-developers" type="add">51804 - optionally include Master Slide text in XSLF text extraction, as HSLF already offers</action>

diff --git a/src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java b/src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
index a3ce259e54383e9d990990187a65ccdd72a50f97..6b86e4de7db64455801e515bb8525158537c3e03 100644 (file)
--- a/src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
+++ b/src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
@@ -16,6 +16,8 @@
 ==================================================================== */
 package org.apache.poi.ss.usermodel;
 
+import java.io.File;
+import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.PushbackInputStream;
@@ -24,6 +26,8 @@ import org.apache.poi.POIXMLDocument;
 import org.apache.poi.hssf.usermodel.HSSFWorkbook;
 import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
 import org.apache.poi.openxml4j.opc.OPCPackage;
+import org.apache.poi.poifs.filesystem.NPOIFSFileSystem;
+import org.apache.poi.poifs.filesystem.OfficeXmlFileException;
 import org.apache.poi.poifs.filesystem.POIFSFileSystem;
 import org.apache.poi.xssf.usermodel.XSSFWorkbook;
 
@@ -64,4 +68,21 @@ public class WorkbookFactory {
                }
                throw new IllegalArgumentException("Your InputStream was neither an OLE2 stream, nor an OOXML stream");
        }
+   /**
+    * Creates the appropriate HSSFWorkbook / XSSFWorkbook from
+    *  the given File, which must exist and be readable.
+    */
+       public static Workbook create(File file) throws IOException, InvalidFormatException {
+          if(! file.exists()) {
+             throw new FileNotFoundException(file.toString());
+          }
+          
+          try {
+             NPOIFSFileSystem fs = new NPOIFSFileSystem(file);
+             return new HSSFWorkbook(fs.getRoot(), true);
+          } catch(OfficeXmlFileException e) {
+             OPCPackage pkg = OPCPackage.openOrCreate(file);
+             return new XSSFWorkbook(pkg);
+          }
+       }
 }

diff --git a/src/ooxml/testcases/org/apache/poi/ss/TestWorkbookFactory.java b/src/ooxml/testcases/org/apache/poi/ss/TestWorkbookFactory.java
index 6858e93acb510a99547770afa3bc53dfa60164b7..9dee1a5c01e51e83edebe466f16a079fec5e6a22 100644 (file)
--- a/src/ooxml/testcases/org/apache/poi/ss/TestWorkbookFactory.java
+++ b/src/ooxml/testcases/org/apache/poi/ss/TestWorkbookFactory.java
@@ -77,7 +77,21 @@ public final class TestWorkbookFactory extends TestCase {
                );
                assertNotNull(wb);
                assertTrue(wb instanceof XSSFWorkbook);
+               
+               // File -> either
+      wb = WorkbookFactory.create(
+            HSSFTestDataSamples.getSampleFile(xls)
+      );
+      assertNotNull(wb);
+      assertTrue(wb instanceof HSSFWorkbook);
 
+      wb = WorkbookFactory.create(
+            HSSFTestDataSamples.getSampleFile(xlsx)
+      );
+      assertNotNull(wb);
+      assertTrue(wb instanceof XSSFWorkbook);
+
+               // Invalid type -> exception
                try {
                        wb = WorkbookFactory.create(
                                        HSSFTestDataSamples.openSampleFileStream(txt)

diff --git a/src/testcases/org/apache/poi/hssf/HSSFTestDataSamples.java b/src/testcases/org/apache/poi/hssf/HSSFTestDataSamples.java
index 46e4ec55ef97b3c5ff4ed8bc4f2ec57521410902..f684676e9154557fe7bdc7886b301345f910ec78 100644 (file)
--- a/src/testcases/org/apache/poi/hssf/HSSFTestDataSamples.java
+++ b/src/testcases/org/apache/poi/hssf/HSSFTestDataSamples.java
@@ -38,7 +38,7 @@ public final class HSSFTestDataSamples {
        public static InputStream openSampleFileStream(String sampleFileName) {
                return _inst.openResourceAsStream(sampleFileName);
        }
-       public static File getSampeFile(String sampleFileName) {
+       public static File getSampleFile(String sampleFileName) {
           return _inst.getFile(sampleFileName);
        }
        public static byte[] getTestDataFileContent(String fileName) {

diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFWorkbook.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFWorkbook.java
index 68ec3b2260ce55a3a4bd05f512520afbf40e5812..68462a2e2f9d17ebcb88a4b0a8dc7ffa50b9c1a0 100644 (file)
--- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFWorkbook.java
+++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFWorkbook.java
@@ -540,7 +540,7 @@ public final class TestHSSFWorkbook extends BaseTestWorkbook {
        // Open the two filesystems
        DirectoryNode[] files = new DirectoryNode[2];
        files[0] = (new POIFSFileSystem(HSSFTestDataSamples.openSampleFileStream("Simple.xls"))).getRoot();
-       files[1] = (new NPOIFSFileSystem(HSSFTestDataSamples.getSampeFile("Simple.xls"))).getRoot();
+       files[1] = (new NPOIFSFileSystem(HSSFTestDataSamples.getSampleFile("Simple.xls"))).getRoot();
        
        // Open without preserving nodes 
        for(DirectoryNode dir : files) {
@@ -563,7 +563,7 @@ public final class TestHSSFWorkbook extends BaseTestWorkbook {
        // Open the two filesystems
        DirectoryNode[] files = new DirectoryNode[2];
        files[0] = (new POIFSFileSystem(HSSFTestDataSamples.openSampleFileStream("WithEmbeddedObjects.xls"))).getRoot();
-       files[1] = (new NPOIFSFileSystem(HSSFTestDataSamples.getSampeFile("WithEmbeddedObjects.xls"))).getRoot();
+       files[1] = (new NPOIFSFileSystem(HSSFTestDataSamples.getSampleFile("WithEmbeddedObjects.xls"))).getRoot();
        
        // Check the embedded parts
        for(DirectoryNode root : files) {