Add XSSF eventusermodel support
git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@642788 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
7cf696f7c4
commit
396813285d
@ -0,0 +1,167 @@
|
||||
/* ====================================================================
|
||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
contributor license agreements. See the NOTICE file distributed with
|
||||
this work for additional information regarding copyright ownership.
|
||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
(the "License"); you may not use this file except in compliance with
|
||||
the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
==================================================================== */
|
||||
package org.apache.poi.xssf.eventusermodel;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.util.Iterator;
|
||||
|
||||
import org.apache.poi.xssf.model.SharedStringsTable;
|
||||
import org.apache.poi.xssf.model.StylesTable;
|
||||
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
|
||||
import org.openxml4j.exceptions.InvalidFormatException;
|
||||
import org.openxml4j.exceptions.OpenXML4JException;
|
||||
import org.openxml4j.opc.Package;
|
||||
import org.openxml4j.opc.PackagePart;
|
||||
import org.openxml4j.opc.PackagePartName;
|
||||
import org.openxml4j.opc.PackageRelationship;
|
||||
import org.openxml4j.opc.PackageRelationshipCollection;
|
||||
import org.openxml4j.opc.PackageRelationshipTypes;
|
||||
import org.openxml4j.opc.PackagingURIHelper;
|
||||
|
||||
/**
|
||||
* This class makes it easy to get at individual parts
|
||||
* of an OOXML .xlsx file, suitable for low memory sax
|
||||
* parsing or similar.
|
||||
* It makes up the core part of the EventUserModel support
|
||||
* for XSSF.
|
||||
*/
|
||||
public class XSSFReader {
|
||||
private Package pkg;
|
||||
private PackagePart workbookPart;
|
||||
|
||||
/**
|
||||
* Creates a new XSSFReader, for the given package
|
||||
*/
|
||||
public XSSFReader(Package pkg) throws IOException, OpenXML4JException {
|
||||
this.pkg = pkg;
|
||||
|
||||
PackageRelationship coreDocRelationship = this.pkg.getRelationshipsByType(
|
||||
PackageRelationshipTypes.CORE_DOCUMENT).getRelationship(0);
|
||||
|
||||
// Get the part that holds the workbook
|
||||
workbookPart = this.pkg.getPart(coreDocRelationship);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Opens up the Shared Strings Table, parses it, and
|
||||
* returns a handy object for working with
|
||||
* shared strings.
|
||||
*/
|
||||
public SharedStringsTable getSharedStringsTable() throws IOException, InvalidFormatException {
|
||||
return new SharedStringsTable(getSharedStringsData());
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens up the Styles Table, parses it, and
|
||||
* returns a handy object for working with cell styles
|
||||
*/
|
||||
public StylesTable getStylesTable() throws IOException, InvalidFormatException {
|
||||
return new StylesTable(getStylesData());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Returns an InputStream to read the contents of the
|
||||
* shared strings table.
|
||||
*/
|
||||
public InputStream getSharedStringsData() throws IOException, InvalidFormatException {
|
||||
return XSSFWorkbook.SHARED_STRINGS.getContents(workbookPart);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an InputStream to read the contents of the
|
||||
* styles table.
|
||||
*/
|
||||
public InputStream getStylesData() throws IOException, InvalidFormatException {
|
||||
return XSSFWorkbook.STYLES.getContents(workbookPart);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an InputStream to read the contents of the
|
||||
* main Workbook, which contains key overall data for
|
||||
* the file, including sheet definitions.
|
||||
*/
|
||||
public InputStream getWorkbookData() throws IOException, InvalidFormatException {
|
||||
return workbookPart.getInputStream();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an InputStream to read the contents of the
|
||||
* specified Sheet.
|
||||
* @param relId The relationId of the sheet, from a r:id on the workbook
|
||||
*/
|
||||
public InputStream getSheet(String relId) throws IOException, InvalidFormatException {
|
||||
PackageRelationship rel = workbookPart.getRelationship(relId);
|
||||
if(rel == null) {
|
||||
throw new IllegalArgumentException("No Sheet found with r:id " + relId);
|
||||
}
|
||||
|
||||
PackagePartName relName = PackagingURIHelper.createPartName(rel.getTargetURI());
|
||||
PackagePart sheet = pkg.getPart(relName);
|
||||
if(sheet == null) {
|
||||
throw new IllegalArgumentException("No data found for Sheet with r:id " + relId);
|
||||
}
|
||||
return sheet.getInputStream();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an Iterator which will let you get at all the
|
||||
* different Sheets in turn.
|
||||
* Each sheet's InputStream is only opened when fetched
|
||||
* from the Iterator. It's up to you to close the
|
||||
* InputStreams when done with each one.
|
||||
*/
|
||||
public Iterator<InputStream> getSheetsData() throws IOException, InvalidFormatException {
|
||||
return new SheetDataIterator();
|
||||
}
|
||||
|
||||
private class SheetDataIterator implements Iterator<InputStream> {
|
||||
private Iterator<PackageRelationship> sheetRels;
|
||||
private SheetDataIterator() throws IOException, InvalidFormatException {
|
||||
// Find all the sheets
|
||||
PackageRelationshipCollection sheets =
|
||||
workbookPart.getRelationshipsByType(
|
||||
XSSFWorkbook.WORKSHEET.getRelation()
|
||||
);
|
||||
sheetRels = sheets.iterator();
|
||||
}
|
||||
|
||||
public boolean hasNext() {
|
||||
return sheetRels.hasNext();
|
||||
}
|
||||
|
||||
public InputStream next() {
|
||||
PackageRelationship sheet = sheetRels.next();
|
||||
try {
|
||||
PackagePartName relName = PackagingURIHelper.createPartName(sheet.getTargetURI());
|
||||
PackagePart sheetPkg = pkg.getPart(relName);
|
||||
return sheetPkg.getInputStream();
|
||||
} catch(IOException e) {
|
||||
throw new RuntimeException(e);
|
||||
} catch(InvalidFormatException ife) {
|
||||
throw new RuntimeException(ife);
|
||||
}
|
||||
}
|
||||
|
||||
public void remove() {
|
||||
throw new IllegalStateException("Not supported");
|
||||
}
|
||||
}
|
||||
}
|
@ -87,6 +87,13 @@ public class SharedStringsTable implements SharedStringSource, XSSFModel {
|
||||
strings.add(s);
|
||||
return strings.size() - 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* For unit testing only!
|
||||
*/
|
||||
public int _getNumberOfStrings() {
|
||||
return strings.size();
|
||||
}
|
||||
|
||||
/**
|
||||
* Write this table out as XML.
|
||||
|
@ -0,0 +1,111 @@
|
||||
/* ====================================================================
|
||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
contributor license agreements. See the NOTICE file distributed with
|
||||
this work for additional information regarding copyright ownership.
|
||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
(the "License"); you may not use this file except in compliance with
|
||||
the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
==================================================================== */
|
||||
|
||||
package org.apache.poi.xssf.eventusermodel;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.InputStream;
|
||||
import java.util.Iterator;
|
||||
|
||||
import junit.framework.TestCase;
|
||||
|
||||
import org.apache.poi.util.IOUtils;
|
||||
import org.openxml4j.opc.Package;
|
||||
|
||||
/**
|
||||
* Tests for XSSFReader
|
||||
*/
|
||||
public class TestXSSFReader extends TestCase {
|
||||
private String dirName;
|
||||
|
||||
public TestXSSFReader(String name) {
|
||||
super(name);
|
||||
|
||||
dirName = System.getProperty("HSSF.testdata.path");
|
||||
assertNotNull(dirName);
|
||||
assertTrue( (new File(dirName)).exists() );
|
||||
|
||||
// Use system out logger
|
||||
System.setProperty(
|
||||
"org.apache.poi.util.POILogger",
|
||||
"org.apache.poi.util.SystemOutLogger"
|
||||
);
|
||||
}
|
||||
|
||||
public void testGetBits() throws Exception {
|
||||
File f = new File(dirName, "SampleSS.xlsx");
|
||||
Package pkg = Package.open(f.toString());
|
||||
|
||||
XSSFReader r = new XSSFReader(pkg);
|
||||
|
||||
assertNotNull(r.getWorkbookData());
|
||||
assertNotNull(r.getSharedStringsData());
|
||||
assertNotNull(r.getStylesData());
|
||||
|
||||
assertNotNull(r.getSharedStringsTable());
|
||||
assertNotNull(r.getStylesTable());
|
||||
}
|
||||
|
||||
public void testStyles() throws Exception {
|
||||
File f = new File(dirName, "SampleSS.xlsx");
|
||||
Package pkg = Package.open(f.toString());
|
||||
|
||||
XSSFReader r = new XSSFReader(pkg);
|
||||
|
||||
assertEquals(3, r.getStylesTable()._getFontsSize());
|
||||
assertEquals(0, r.getStylesTable()._getNumberFormatSize());
|
||||
}
|
||||
|
||||
public void testStrings() throws Exception {
|
||||
File f = new File(dirName, "SampleSS.xlsx");
|
||||
Package pkg = Package.open(f.toString());
|
||||
|
||||
XSSFReader r = new XSSFReader(pkg);
|
||||
|
||||
assertEquals(11, r.getSharedStringsTable()._getNumberOfStrings());
|
||||
assertEquals("Test spreadsheet", r.getSharedStringsTable().getSharedStringAt(0));
|
||||
}
|
||||
|
||||
public void testSheets() throws Exception {
|
||||
File f = new File(dirName, "SampleSS.xlsx");
|
||||
Package pkg = Package.open(f.toString());
|
||||
|
||||
XSSFReader r = new XSSFReader(pkg);
|
||||
byte[] data = new byte[4096];
|
||||
|
||||
// By r:id
|
||||
assertNotNull(r.getSheet("rId2"));
|
||||
int read = IOUtils.readFully(r.getSheet("rId2"), data);
|
||||
assertEquals(974, read);
|
||||
|
||||
// All
|
||||
Iterator<InputStream> it = r.getSheetsData();
|
||||
|
||||
int count = 0;
|
||||
while(it.hasNext()) {
|
||||
count++;
|
||||
InputStream inp = it.next();
|
||||
assertNotNull(inp);
|
||||
read = IOUtils.readFully(inp, data);
|
||||
inp.close();
|
||||
|
||||
assertTrue(read > 400);
|
||||
assertTrue(read < 1500);
|
||||
}
|
||||
assertEquals(3, count);
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user