moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Make OldExcelExtractor Closeable to be able to free up resources if getText() was not called

Browse Source 
Allow Excel files which have an entry "Workbook" instead of "Book" like other classes do
Add some more unit tests to cover more of the code

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1727653 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dominik Stadler 2016-01-29 22:09:03 +00:00
parent d70d496f84
commit 68997de5f0
2 changed files with 197 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/java/org/apache/poi/hssf/extractor/OldExcelExtractor.java
View File

@ -21,6 +21,7 @@ import java.io.BufferedInputStream;
import java.io.Closeable;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
@ -51,7 +52,7 @@ import org.apache.poi.ss.usermodel.Cell;
* by Apache Tika, but not really intended for display to the user.
* </p>
*/
public class OldExcelExtractor {
public class OldExcelExtractor implements Closeable {
private RecordInputStream ris;
private Closeable input;
private int biffVersion;
@ -65,6 +66,7 @@ public class OldExcelExtractor {
open(bstream);
}
}
public OldExcelExtractor(File f) throws IOException {
try {
open(new NPOIFSFileSystem(f));
@ -74,9 +76,11 @@ public class OldExcelExtractor {
open(new FileInputStream(f));
}
}
public OldExcelExtractor(NPOIFSFileSystem fs) throws IOException {
open(fs);
}
public OldExcelExtractor(DirectoryNode directory) throws IOException {
open(directory);
}
@ -86,12 +90,21 @@ public class OldExcelExtractor {
ris = new RecordInputStream(biffStream);
prepare();
}
private void open(NPOIFSFileSystem fs) throws IOException {
input = fs;
open(fs.getRoot());
}
private void open(DirectoryNode directory) throws IOException {
DocumentNode book = (DocumentNode)directory.getEntry("Book");
DocumentNode book;
try {
book = (DocumentNode)directory.getEntry("Book");
} catch (FileNotFoundException e) {
// some files have "Workbook" instead
book = (DocumentNode)directory.getEntry("Workbook");
}
if (book == null) {
throw new IOException("No Excel 5/95 Book stream found");
}
@ -108,6 +121,7 @@ public class OldExcelExtractor {
}
OldExcelExtractor extractor = new OldExcelExtractor(new File(args[0]));
System.out.println(extractor.getText());
extractor.close();
}
private void prepare() {
@ -229,15 +243,20 @@ public class OldExcelExtractor {
}
}
close();
ris = null;
return text.toString();
}
@Override
public void close() {
if (input != null) {
try {
input.close();
} catch (IOException e) {}
input = null;
}
ris = null;
return text.toString();
}
protected void handleNumericCell(StringBuffer text, double value) {

182
src/testcases/org/apache/poi/hssf/extractor/TestOldExcelExtractor.java
View File

@ -21,10 +21,22 @@ import static org.apache.poi.POITestCase.assertContains;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import org.apache.poi.EmptyFileException;
import org.apache.poi.POIDataSamples;
import org.apache.poi.hssf.HSSFTestDataSamples;
import org.apache.poi.poifs.filesystem.NPOIFSFileSystem;
import org.apache.poi.poifs.filesystem.OfficeXmlFileException;
import org.junit.Ignore;
import org.junit.Test;
/**
@ -32,18 +44,13 @@ import org.junit.Test;
* extractor
*/
public final class TestOldExcelExtractor {
private static OldExcelExtractor createExtractor(String sampleFileName) {
private static OldExcelExtractor createExtractor(String sampleFileName) throws IOException {
File file = HSSFTestDataSamples.getSampleFile(sampleFileName);
try {
return new OldExcelExtractor(file);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
@Test
public void testSimpleExcel3() {
public void testSimpleExcel3() throws Exception {
OldExcelExtractor extractor = createExtractor("testEXCEL_3.xls");
// Check we can call getText without error
@ -63,10 +70,21 @@ public final class TestOldExcelExtractor {
// Check the type
assertEquals(3, extractor.getBiffVersion());
assertEquals(0x10, extractor.getFileType());
extractor.close();
}
@Test
public void testSimpleExcel3NoReading() throws Exception {
OldExcelExtractor extractor = createExtractor("testEXCEL_3.xls");
assertNotNull(extractor);
extractor.close();
}
@Test
public void testSimpleExcel4() {
public void testSimpleExcel4() throws Exception {
OldExcelExtractor extractor = createExtractor("testEXCEL_4.xls");
// Check we can call getText without error
@ -83,10 +101,12 @@ public final class TestOldExcelExtractor {
// Check the type
assertEquals(4, extractor.getBiffVersion());
assertEquals(0x10, extractor.getFileType());
extractor.close();
}
@Test
public void testSimpleExcel5() {
public void testSimpleExcel5() throws Exception {
for (String ver : new String[] {"5", "95"}) {
OldExcelExtractor extractor = createExtractor("testEXCEL_"+ver+".xls");
@ -107,11 +127,13 @@ public final class TestOldExcelExtractor {
// Check the type
assertEquals(5, extractor.getBiffVersion());
assertEquals(0x05, extractor.getFileType());
extractor.close();
}
}
@Test
public void testStrings() {
public void testStrings() throws Exception {
OldExcelExtractor extractor = createExtractor("testEXCEL_4.xls");
String text = extractor.getText();
@ -127,10 +149,12 @@ public final class TestOldExcelExtractor {
// Formula based strings
// TODO Find some then test
extractor.close();
}
@Test
public void testFormattedNumbersExcel4() {
public void testFormattedNumbersExcel4() throws Exception {
OldExcelExtractor extractor = createExtractor("testEXCEL_4.xls");
String text = extractor.getText();
@ -146,10 +170,12 @@ public final class TestOldExcelExtractor {
// TODO
// assertContains(text, "55,624");
// assertContains(text, "11,743,477");
extractor.close();
}
@Test
public void testFormattedNumbersExcel5() {
public void testFormattedNumbersExcel5() throws Exception {
for (String ver : new String[] {"5", "95"}) {
OldExcelExtractor extractor = createExtractor("testEXCEL_"+ver+".xls");
String text = extractor.getText();
@ -170,6 +196,8 @@ public final class TestOldExcelExtractor {
// assertContains(text, "1,234,500");
// assertContains(text, "$169.00");
// assertContains(text, "$1,253.82");
extractor.close();
}
}
@ -183,6 +211,136 @@ public final class TestOldExcelExtractor {
String text = extractor.getText();
assertNotNull(text);
assertTrue(text.length() > 100);
extractor.close();
}
}
@Test
public void testOpenInvalidFile() throws Exception {
// a file that exists, but is a different format
try {
createExtractor("WithVariousData.xlsx");
fail("Should catch Exception here");
} catch (OfficeXmlFileException e) {
// expected here
}
}
@Test
public void testOpenNonExistingFile() throws Exception {
// a file that exists, but is a different format
try {
OldExcelExtractor extractor = new OldExcelExtractor(new File("notexistingfile.xls"));
extractor.close();
fail("Should catch Exception here");
} catch (EmptyFileException e) {
// expected here
}
}
@Test
public void testInputStream() throws Exception {
File file = HSSFTestDataSamples.getSampleFile("testEXCEL_3.xls");
InputStream stream = new FileInputStream(file);
try {
OldExcelExtractor extractor = new OldExcelExtractor(stream);
String text = extractor.getText();
assertNotNull(text);
extractor.close();
} finally {
stream.close();
}
}
@Test
public void testInputStreamNPOIHeader() throws Exception {
File file = HSSFTestDataSamples.getSampleFile("FormulaRefs.xls");
InputStream stream = new FileInputStream(file);
try {
OldExcelExtractor extractor = new OldExcelExtractor(stream);
extractor.close();
} finally {
stream.close();
}
}
@Test
public void testNPOIFSFileSystem() throws Exception {
File file = HSSFTestDataSamples.getSampleFile("FormulaRefs.xls");
NPOIFSFileSystem fs = new NPOIFSFileSystem(file);
try {
OldExcelExtractor extractor = new OldExcelExtractor(fs);
extractor.close();
} finally {
fs.close();
}
}
@Test
public void testDirectoryNode() throws Exception {
File file = HSSFTestDataSamples.getSampleFile("FormulaRefs.xls");
NPOIFSFileSystem fs = new NPOIFSFileSystem(file);
try {
OldExcelExtractor extractor = new OldExcelExtractor(fs.getRoot());
extractor.close();
} finally {
fs.close();
}
}
@Test
public void testDirectoryNodeInvalidFile() throws Exception {
File file = POIDataSamples.getDocumentInstance().getFile("test.doc");
NPOIFSFileSystem fs = new NPOIFSFileSystem(file);
try {
OldExcelExtractor extractor = new OldExcelExtractor(fs.getRoot());
extractor.close();
fail("Should catch exception here");
} catch (FileNotFoundException e) {
// expected here
} finally {
fs.close();
}
}
@Ignore("Calls System.exit()")
@Test
public void testMainUsage() throws Exception {
PrintStream save = System.err;
try {
ByteArrayOutputStream out = new ByteArrayOutputStream();
try {
PrintStream str = new PrintStream(out);
System.setErr(str);
OldExcelExtractor.main(new String[] {});
} finally {
out.close();
}
} finally {
System.setErr(save);
}
}
@Test
public void testMain() throws Exception {
File file = HSSFTestDataSamples.getSampleFile("testEXCEL_3.xls");
PrintStream save = System.out;
try {
ByteArrayOutputStream out = new ByteArrayOutputStream();
try {
PrintStream str = new PrintStream(out);
System.setOut(str);
OldExcelExtractor.main(new String[] {file.getAbsolutePath()});
} finally {
out.close();
}
String string = new String(out.toByteArray());
assertTrue("Had: " + string,
string.contains("Table C-13--Lemons"));
} finally {
System.setOut(save);
}
}
}