From 0c32d34befcd37c9b5da11ee402ee7e698b0fbf3 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Sun, 30 Nov 2014 16:40:53 +0000 Subject: [PATCH] On Biff5 files, include the sheet name. (Older formats are single sheet) git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1642563 13f79535-47bb-0310-9956-ffa450edef68 --- .../poi/hssf/extractor/OldExcelExtractor.java | 10 +++ .../poi/hssf/record/OldSheetRecord.java | 82 +++++++++++++++++++ .../poi/hssf/record/OldStringRecord.java | 3 +- .../hssf/extractor/TestOldExcelExtractor.java | 3 + 4 files changed, 96 insertions(+), 2 deletions(-) create mode 100644 src/java/org/apache/poi/hssf/record/OldSheetRecord.java diff --git a/src/java/org/apache/poi/hssf/extractor/OldExcelExtractor.java b/src/java/org/apache/poi/hssf/extractor/OldExcelExtractor.java index e8cd0f63d..c42e3adb6 100644 --- a/src/java/org/apache/poi/hssf/extractor/OldExcelExtractor.java +++ b/src/java/org/apache/poi/hssf/extractor/OldExcelExtractor.java @@ -30,6 +30,7 @@ import org.apache.poi.hssf.record.FormulaRecord; import org.apache.poi.hssf.record.NumberRecord; import org.apache.poi.hssf.record.OldFormulaRecord; import org.apache.poi.hssf.record.OldLabelRecord; +import org.apache.poi.hssf.record.OldSheetRecord; import org.apache.poi.hssf.record.OldStringRecord; import org.apache.poi.hssf.record.RKRecord; import org.apache.poi.hssf.record.RecordInputStream; @@ -140,6 +141,15 @@ public class OldExcelExtractor { ris.nextRecord(); switch (sid) { + // Biff 5+ only, no sheet names in older formats + case OldSheetRecord.sid: + OldSheetRecord shr = new OldSheetRecord(ris); + shr.setCodePage(codepage); + text.append("Sheet: "); + text.append(shr.getSheetname()); + text.append('\n'); + break; + // label - 5.63 - TODO Needs codepages case OldLabelRecord.biff2_sid: case OldLabelRecord.biff345_sid: diff --git a/src/java/org/apache/poi/hssf/record/OldSheetRecord.java b/src/java/org/apache/poi/hssf/record/OldSheetRecord.java new file mode 100644 index 000000000..92ffcf923 --- /dev/null +++ b/src/java/org/apache/poi/hssf/record/OldSheetRecord.java @@ -0,0 +1,82 @@ +/* ==================================================================== + 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.hssf.record; + +import org.apache.poi.util.HexDump; + +/** + * Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5

+ * Description: Defines a sheet within a workbook. Basically stores the sheet name + * and tells where the Beginning of file record is within the HSSF + * file. + */ +public final class OldSheetRecord { + public final static short sid = 0x0085; + + private int field_1_position_of_BOF; + private int field_2_visibility; + private int field_3_type; + private byte[] field_5_sheetname; + private CodepageRecord codepage; + + public OldSheetRecord(RecordInputStream in) { + field_1_position_of_BOF = in.readInt(); + field_2_visibility = in.readUByte(); + field_3_type = in.readUByte(); + int field_4_sheetname_length = in.readUByte(); + field_5_sheetname = new byte[field_4_sheetname_length]; + in.read(field_5_sheetname, 0, field_4_sheetname_length); + } + + public void setCodePage(CodepageRecord codepage) { + this.codepage = codepage; + } + + public short getSid() { + return sid; + } + + /** + * get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file + * + * @return offset in bytes + */ + public int getPositionOfBof() { + return field_1_position_of_BOF; + } + + /** + * get the sheetname for this sheet. (this appears in the tabs at the bottom) + * @return sheetname the name of the sheet + */ + public String getSheetname() { + return OldStringRecord.getString(field_5_sheetname, codepage); + } + + public String toString() { + StringBuffer buffer = new StringBuffer(); + + buffer.append("[BOUNDSHEET]\n"); + buffer.append(" .bof = ").append(HexDump.intToHex(getPositionOfBof())).append("\n"); + buffer.append(" .visibility = ").append(HexDump.shortToHex(field_2_visibility)).append("\n"); + buffer.append(" .type = ").append(HexDump.byteToHex(field_3_type)).append("\n"); + buffer.append(" .sheetname = ").append(getSheetname()).append("\n"); + buffer.append("[/BOUNDSHEET]\n"); + return buffer.toString(); + } +} diff --git a/src/java/org/apache/poi/hssf/record/OldStringRecord.java b/src/java/org/apache/poi/hssf/record/OldStringRecord.java index d4296ba63..0a5b49223 100644 --- a/src/java/org/apache/poi/hssf/record/OldStringRecord.java +++ b/src/java/org/apache/poi/hssf/record/OldStringRecord.java @@ -80,8 +80,7 @@ public final class OldStringRecord { try { return CodePageUtil.getStringFromCodePage(data, cp); } catch (UnsupportedEncodingException uee) { - // Hope the system default is ok... - return new String(data); + throw new IllegalArgumentException("Unsupported codepage requested", uee); } } diff --git a/src/testcases/org/apache/poi/hssf/extractor/TestOldExcelExtractor.java b/src/testcases/org/apache/poi/hssf/extractor/TestOldExcelExtractor.java index d57129265..f966cb10c 100644 --- a/src/testcases/org/apache/poi/hssf/extractor/TestOldExcelExtractor.java +++ b/src/testcases/org/apache/poi/hssf/extractor/TestOldExcelExtractor.java @@ -66,6 +66,9 @@ public final class TestOldExcelExtractor extends POITestCase { // Check we find a few numbers we expect in there assertContains(text, "15"); assertContains(text, "169"); + + // Check we got the sheet names (new formats only) + assertContains(text, "Sheet: Feuil3"); } }