*
* @see org.apache.poi.hssf.model.Workbook
* @see org.apache.poi.hssf.usermodel.HSSFSheet
- * @version 1.0-pre
*/
public final class Sheet implements Model {
public static final short LeftMargin = 0;
private static POILogger log = POILogFactory.getLogger(Sheet.class);
- protected ArrayList records = null;
+ private List<RecordBase> records;
protected PrintGridlinesRecord printGridlines = null;
protected GridsetRecord gridset = null;
private GutsRecord _gutsRecord;
_mergedCellsTable = new MergedCellsTable();
RowRecordsAggregate rra = null;
- records = new ArrayList(128);
+ records = new ArrayList<RecordBase>(128);
// TODO - take chart streams off into separate java objects
int bofEofNestingLevel = 0; // nesting level can only get to 2 (when charts are present)
int dimsloc = -1;
records.add(rec);
}
- if (_dimensions == null) {
- throw new RuntimeException("DimensionsRecord was not found");
- }
if (windowTwo == null) {
throw new RuntimeException("WINDOW2 was not found");
}
+ if (_dimensions == null) {
+ // Excel seems to always write the DIMENSION record, but tolerates when it is not present
+ // in all cases Excel (2007) adds the missing DIMENSION record
+ if (rra == null) {
+ // bug 46206 alludes to files which skip the DIMENSION record
+ // when there are no row/cell records.
+ // Not clear which application wrote these files.
+ rra = new RowRecordsAggregate();
+ } else {
+ log.log(POILogger.WARN, "DIMENSION record not found even though row/cells present");
+ // Not sure if any tools write files like this, but Excel reads them OK
+ }
+ dimsloc = findFirstRecordLocBySid(WindowTwoRecord.sid);
+ _dimensions = rra.createDimensions();
+ records.add(dimsloc, _dimensions);
+ }
if (rra == null) {
rra = new RowRecordsAggregate();
records.add(dimsloc + 1, rra);
private static final class RecordCloner implements RecordVisitor {
- private final List _destList;
+ private final List<RecordBase> _destList;
- public RecordCloner(List destList) {
+ public RecordCloner(List<RecordBase> destList) {
_destList = destList;
}
public void visitRecord(Record r) {
- _destList.add(r.clone());
+ _destList.add((RecordBase)r.clone());
}
}
* belongs to a sheet.
*/
public Sheet cloneSheet() {
- List clonedRecords = new ArrayList(this.records.size());
- for (int i = 0; i < this.records.size(); i++) {
- RecordBase rb = (RecordBase) this.records.get(i);
+ List<RecordBase> clonedRecords = new ArrayList<RecordBase>(records.size());
+ for (int i = 0; i < records.size(); i++) {
+ RecordBase rb = records.get(i);
if (rb instanceof RecordAggregate) {
((RecordAggregate) rb).visitContainedRecords(new RecordCloner(clonedRecords));
continue;
}
private Sheet() {
_mergedCellsTable = new MergedCellsTable();
- records = new ArrayList(32);
+ records = new ArrayList<RecordBase>(32);
if (log.check( POILogger.DEBUG ))
log.log(POILogger.DEBUG, "Sheet createsheet from scratch called");
boolean haveSerializedIndex = false;
- for (int k = 0; k < records.size(); k++)
- {
- RecordBase record = (RecordBase) records.get(k);
+ for (int k = 0; k < records.size(); k++) {
+ RecordBase record = records.get(k);
if (record instanceof RecordAggregate) {
RecordAggregate agg = (RecordAggregate) record;
int result = 0;
// start just after BOF record (INDEX is not present in this list)
for (int j = bofRecordIndex + 1; j < records.size(); j++) {
- RecordBase tmpRec = (RecordBase) records.get(j);
+ RecordBase tmpRec = records.get(j);
if (tmpRec instanceof RowRecordsAggregate) {
break;
}
}
}
- public List getRecords()
+ public List<RecordBase> getRecords()
{
return records;
}
}
else
{
- List records = getRecords();
+ List<RecordBase> records = getRecords();
EscherAggregate r = EscherAggregate.createAggregate( records, loc, drawingManager );
int startloc = loc;
while ( loc + 1 < records.size()
import org.apache.poi.hssf.record.GutsRecord;
import org.apache.poi.hssf.record.IndexRecord;
import org.apache.poi.hssf.record.MergeCellsRecord;
+import org.apache.poi.hssf.record.NumberRecord;
import org.apache.poi.hssf.record.Record;
import org.apache.poi.hssf.record.RowRecord;
import org.apache.poi.hssf.record.StringRecord;
import org.apache.poi.hssf.record.UncalcedRecord;
import org.apache.poi.hssf.record.WindowTwoRecord;
-import org.apache.poi.hssf.record.aggregates.ColumnInfoRecordsAggregate;
-import org.apache.poi.hssf.record.aggregates.MergedCellsTable;
import org.apache.poi.hssf.record.aggregates.PageSettingsBlock;
-import org.apache.poi.hssf.record.aggregates.RowRecordsAggregate;
import org.apache.poi.hssf.record.aggregates.RecordAggregate.RecordVisitor;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
-import org.apache.poi.hssf.util.CellRangeAddress;
+import org.apache.poi.hssf.usermodel.RecordInspector.RecordCollector;
+import org.apache.poi.ss.util.CellRangeAddress;
/**
* Unit test for the Sheet class.
private static Sheet createSheet(List inRecs) {
return Sheet.createSheet(new RecordStream(inRecs, 0));
}
-
-
+
+ private static Record[] getSheetRecords(Sheet s, int offset) {
+ RecordCollector rc = new RecordCollector();
+ s.visitContainedRecords(rc, offset);
+ return rc.getRecords();
+ }
+
public void testCreateSheet() {
// Check we're adding row and cell aggregates
- List records = new ArrayList();
+ List<Record> records = new ArrayList<Record>();
records.add( new BOFRecord() );
records.add( new DimensionsRecord() );
records.add(createWindow2Record());
records.add(EOFRecord.instance);
Sheet sheet = createSheet(records);
+ Record[] outRecs = getSheetRecords(sheet, 0);
int pos = 0;
- assertTrue( sheet.records.get(pos++) instanceof BOFRecord );
- assertTrue( sheet.records.get(pos++) instanceof ColumnInfoRecordsAggregate );
- assertTrue( sheet.records.get(pos++) instanceof DimensionsRecord );
- assertTrue( sheet.records.get(pos++) instanceof RowRecordsAggregate );
- assertTrue( sheet.records.get(pos++) instanceof WindowTwoRecord );
- assertTrue( sheet.records.get(pos++) instanceof MergedCellsTable );
- assertTrue( sheet.records.get(pos++) instanceof EOFRecord );
+ assertTrue(outRecs[pos++] instanceof BOFRecord );
+ assertTrue(outRecs[pos++] instanceof IndexRecord );
+ assertTrue(outRecs[pos++] instanceof DimensionsRecord );
+ assertTrue(outRecs[pos++] instanceof WindowTwoRecord );
+ assertTrue(outRecs[pos++] instanceof EOFRecord );
}
private static Record createWindow2Record() {
return _count;
}
}
-
+
public void testAddMergedRegion() {
Sheet sheet = Sheet.createSheet();
int regionsToAdd = 4096;
int recordsExpected = regionsToAdd/1027;
if ((regionsToAdd % 1027) != 0)
recordsExpected++;
- assertTrue("The " + regionsToAdd + " merged regions should have been spread out over "
+ assertTrue("The " + regionsToAdd + " merged regions should have been spread out over "
+ recordsExpected + " records, not " + recordsAdded, recordsAdded == recordsExpected);
// Check we can't add one with invalid date
try {
//assert they have been deleted
assertEquals("Num of regions", regionsToAdd - n - 1, sheet.getNumMergedRegions());
}
-
- // merge records are removed from within the MergedCellsTable,
- // so the sheet record count should not change
+
+ // merge records are removed from within the MergedCellsTable,
+ // so the sheet record count should not change
assertEquals("Sheet Records", nSheetRecords, sheet.getRecords().size());
}
*
*/
public void testMovingMergedRegion() {
- List records = new ArrayList();
+ List<Record> records = new ArrayList<Record>();
CellRangeAddress[] cras = {
new CellRangeAddress(0, 1, 0, 2),
records.add(merged);
Sheet sheet = createSheet(records);
- sheet.records.remove(0);
+ sheet.getRecords().remove(0); // TODO - what does this line do?
//stub object to throw off list INDEX operations
sheet.removeMergedRegion(0);
*
*/
public void testRowAggregation() {
- List records = new ArrayList();
+ List<Record> records = new ArrayList<Record>();
records.add(Sheet.createBOF());
records.add(new DimensionsRecord());
records.add(new RowRecord(1));
FormulaRecord formulaRecord = new FormulaRecord();
formulaRecord.setCachedResultTypeString();
- records.add(formulaRecord);
+ records.add(formulaRecord);
records.add(new StringRecord());
records.add(new RowRecord(2));
records.add(createWindow2Record());
byte[] buf = new byte[estimatedSize];
int serializedSize = r.serialize(0, buf);
if (estimatedSize != serializedSize) {
- throw new AssertionFailedError("serialized size mismatch for record ("
+ throw new AssertionFailedError("serialized size mismatch for record ("
+ r.getClass().getName() + ")");
}
_totalSize += estimatedSize;
*/
public void testUncalcSize_bug45066() {
- List records = new ArrayList();
+ List<Record> records = new ArrayList<Record>();
records.add(new BOFRecord());
records.add(new UncalcedRecord());
records.add(new DimensionsRecord());
records.add(createWindow2Record());
records.add(EOFRecord.instance);
Sheet sheet = createSheet(records);
-
- // The original bug was due to different logic for collecting records for sizing and
+
+ // The original bug was due to different logic for collecting records for sizing and
// serialization. The code has since been refactored into a single method for visiting
// all contained records. Now this test is much less interesting
SizeCheckingRecordVisitor scrv = new SizeCheckingRecordVisitor();
if (false) {
// make sure that RRA and VRA are in the right place
// (Aug 2008) since the VRA is now part of the RRA, there is much less chance that
- // they could get out of order. Still, one could write serialize the sheet here,
+ // they could get out of order. Still, one could write serialize the sheet here,
// and read back with EventRecordFactory to make sure...
}
assertEquals(242, dbCellRecordPos);
}
}
}
-
+
/**
* Checks for bug introduced around r682282-r683880 that caused a second GUTS records
* which in turn got the dimensions record out of alignment
*/
public void testGutsRecord_bug45640() {
-
+
Sheet sheet = Sheet.createSheet();
sheet.addRow(new RowRecord(0));
sheet.addRow(new RowRecord(1));
}
assertEquals(1, count);
}
-
+
public void testMisplacedMergedCellsRecords_bug45699() {
HSSFWorkbook wb = HSSFTestDataSamples.openSampleWorkbook("ex45698-22488.xls");
-
+
HSSFSheet sheet = wb.getSheetAt(0);
HSSFRow row = sheet.getRow(3);
HSSFCell cell = row.getCell(4);
throw e;
}
}
+
+ /**
+ * Some apps seem to write files with missing DIMENSION records.
+ * Excel(2007) tolerates this, so POI should too.
+ */
+ public void testMissingDims() {
+
+ int rowIx = 5;
+ int colIx = 6;
+ NumberRecord nr = new NumberRecord();
+ nr.setRow(rowIx);
+ nr.setColumn((short) colIx);
+ nr.setValue(3.0);
+
+ List<Record> inRecs = new ArrayList<Record>();
+ inRecs.add(new BOFRecord());
+ inRecs.add(new RowRecord(rowIx));
+ inRecs.add(nr);
+ inRecs.add(createWindow2Record());
+ inRecs.add(EOFRecord.instance);
+ Sheet sheet;
+ try {
+ sheet = createSheet(inRecs);
+ } catch (RuntimeException e) {
+ if (e.getMessage().equals("DimensionsRecord was not found")) {
+ throw new AssertionFailedError("Identified bug 46206");
+ }
+ throw e;
+ }
+
+ RecordCollector rv = new RecordCollector();
+ sheet.visitContainedRecords(rv, rowIx);
+ Record[] outRecs = rv.getRecords();
+ assertEquals(8, outRecs.length);
+ DimensionsRecord dims = (DimensionsRecord) outRecs[5];
+ assertEquals(rowIx, dims.getFirstRow());
+ assertEquals(rowIx, dims.getLastRow());
+ assertEquals(colIx, dims.getFirstCol());
+ assertEquals(colIx, dims.getLastCol());
+ }
}
projects / poi.git / commitdiff