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

Refactoring row-blocks record reading logic in Sheet

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@700203 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Josh Micich 2008-09-29 18:43:53 +00:00
parent 799cc2760a
commit 655f100a6c
19 changed files with 309 additions and 680 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/java/org/apache/poi/hssf/model/RowBlocksReader.java
View File

@ -39,30 +39,28 @@ public final class RowBlocksReader {
private final List _plainRecords;
private final SharedValueManager _sfm;
private final MergeCellsRecord[] _mergedCellsRecords;
private final int _totalNumberOfRecords;
/**
* Also collects any loose MergeCellRecords and puts them in the supplied
* mergedCellsTable
*/
public RowBlocksReader(List recs, int startIx) {
public RowBlocksReader(RecordStream rs) {
List plainRecords = new ArrayList();
List shFrmRecords = new ArrayList();
List arrayRecords = new ArrayList();
List tableRecords = new ArrayList();
List mergeCellRecords = new ArrayList();
int endIx = -1;
for (int i = startIx; i < recs.size(); i++) {
Record rec = (Record) recs.get(i);
if (RecordOrderer.isEndOfRowBlock(rec.getSid())) {
while(!RecordOrderer.isEndOfRowBlock(rs.peekNextSid())) {
// End of row/cell records for the current sheet
// Note - It is important that this code does not inadvertently any sheet
// Note - It is important that this code does not inadvertently add any sheet
// records from a subsequent sheet. For example, if SharedFormulaRecords
// are taken from the wrong sheet, this could cause bug 44449.
endIx = i;
break;
if (!rs.hasNext()) {
throw new RuntimeException("Failed to find end of row/cell records");
}
Record rec = rs.getNext();
List dest;
switch (rec.getSid()) {
case MergeCellsRecord.sid: dest = mergeCellRecords; break;
@ -73,9 +71,6 @@ public final class RowBlocksReader {
}
dest.add(rec);
}
if (endIx < 0) {
throw new RuntimeException("Failed to find end of row/cell records");
}
SharedFormulaRecord[] sharedFormulaRecs = new SharedFormulaRecord[shFrmRecords.size()];
ArrayRecord[] arrayRecs = new ArrayRecord[arrayRecords.size()];
TableRecord[] tableRecs = new TableRecord[tableRecords.size()];
@ -87,7 +82,6 @@ public final class RowBlocksReader {
_sfm = SharedValueManager.create(sharedFormulaRecs, arrayRecs, tableRecs);
_mergedCellsRecords = new MergeCellsRecord[mergeCellRecords.size()];
mergeCellRecords.toArray(_mergedCellsRecords);
_totalNumberOfRecords = endIx - startIx;
}
/**
@ -99,10 +93,6 @@ public final class RowBlocksReader {
return _mergedCellsRecords;
}
public int getTotalNumberOfRecords() {
return _totalNumberOfRecords;
}
public SharedValueManager getSharedFormulaManager() {
return _sfm;
}

276
src/java/org/apache/poi/hssf/model/Sheet.java
View File

@ -58,7 +58,6 @@ import org.apache.poi.hssf.record.SelectionRecord;
import org.apache.poi.hssf.record.UncalcedRecord;
import org.apache.poi.hssf.record.WSBoolRecord;
import org.apache.poi.hssf.record.WindowTwoRecord;
import org.apache.poi.hssf.record.aggregates.CFRecordsAggregate;
import org.apache.poi.hssf.record.aggregates.ColumnInfoRecordsAggregate;
import org.apache.poi.hssf.record.aggregates.ConditionalFormattingTable;
import org.apache.poi.hssf.record.aggregates.DataValidityTable;
@ -105,7 +104,6 @@ public final class Sheet implements Model {
private static POILogger log = POILogFactory.getLogger(Sheet.class);
protected ArrayList records = null;
protected int dimsloc = -1; // TODO - remove dimsloc
protected PrintGridlinesRecord printGridlines = null;
protected GridsetRecord gridset = null;
private GutsRecord _gutsRecord;
@ -128,11 +126,10 @@ public final class Sheet implements Model {
/** the DimensionsRecord is always present */
private DimensionsRecord _dimensions;
/** always present */
protected RowRecordsAggregate _rowsAggregate;
protected final RowRecordsAggregate _rowsAggregate;
private DataValidityTable _dataValidityTable= null;
private ConditionalFormattingTable condFormatting;
protected int eofLoc = 0;
private Iterator rowRecIterator = null;
/** Add an UncalcedRecord if not true indicating formulas have not been calculated */
@ -143,14 +140,6 @@ public final class Sheet implements Model {
public static final byte PANE_LOWER_LEFT = (byte)2;
public static final byte PANE_UPPER_LEFT = (byte)3;
/**
* Creates new Sheet with no initialization --useless at this point
* @see #createSheet(List,int,int)
*/
public Sheet() {
_mergedCellsTable = new MergedCellsTable();
}
/**
* read support (offset used as starting point for search) for low level
* API. Pass in an array of Record objects, the sheet number (0 based) and
@ -168,178 +157,170 @@ public final class Sheet implements Model {
* @see org.apache.poi.hssf.model.Workbook
* @see org.apache.poi.hssf.record.Record
*/
public static Sheet createSheet(List inRecs, int sheetnum, int offset)
{
if (log.check( POILogger.DEBUG ))
log.logFormatted(POILogger.DEBUG,
"Sheet createSheet (existing file) with %",
new Integer(inRecs.size()));
Sheet retval = new Sheet();
ArrayList records = new ArrayList(inRecs.size() / 5);
public static Sheet createSheet(RecordStream rs) {
return new Sheet(rs);
}
private Sheet(RecordStream rs) {
_mergedCellsTable = new MergedCellsTable();
RowRecordsAggregate rra = null;
records = new ArrayList(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;
for (int k = offset; k < inRecs.size(); k++) {
Record rec = ( Record ) inRecs.get(k);
if ( rec.getSid() == IndexRecord.sid ) {
// ignore INDEX record because it is only needed by Excel,
// and POI always re-calculates its contents
while (rs.hasNext()) {
int recSid = rs.peekNextSid();
if ( recSid == CFHeaderRecord.sid ) {
condFormatting = new ConditionalFormattingTable(rs);
records.add(condFormatting);
continue;
}
if ( rec.getSid() == CFHeaderRecord.sid ) {
RecordStream rs = new RecordStream(inRecs, k);
retval.condFormatting = new ConditionalFormattingTable(rs);
k += rs.getCountRead()-1;
records.add(retval.condFormatting);
if (recSid == ColumnInfoRecord.sid) {
_columnInfos = new ColumnInfoRecordsAggregate(rs);
records.add(_columnInfos);
continue;
}
if ( recSid == DVALRecord.sid) {
_dataValidityTable = new DataValidityTable(rs);
records.add(_dataValidityTable);
continue;
}
if (rec.getSid() == ColumnInfoRecord.sid) {
RecordStream rs = new RecordStream(inRecs, k);
retval._columnInfos = new ColumnInfoRecordsAggregate(rs);
k += rs.getCountRead()-1;
records.add(retval._columnInfos);
continue;
}
if ( rec.getSid() == DVALRecord.sid) {
RecordStream rs = new RecordStream(inRecs, k);
retval._dataValidityTable = new DataValidityTable(rs);
k += rs.getCountRead() - 1; // TODO - convert this method result to be zero based
records.add(retval._dataValidityTable);
continue;
}
// TODO construct RowRecordsAggregate from RecordStream
if ((rec.getSid() == RowRecord.sid || rec.isValue()) && bofEofNestingLevel == 1 ) {
if (RecordOrderer.isRowBlockRecord(recSid) && bofEofNestingLevel == 1 ) {
//only add the aggregate once
if (retval._rowsAggregate != null) {
if (rra != null) {
throw new RuntimeException("row/cell records found in the wrong place");
}
RowBlocksReader rbr = new RowBlocksReader(inRecs, k);
retval._mergedCellsTable.addRecords(rbr.getLooseMergedCells());
retval._rowsAggregate = new RowRecordsAggregate(rbr.getPlainRecordStream(), rbr.getSharedFormulaManager());
records.add(retval._rowsAggregate); //only add the aggregate once
k += rbr.getTotalNumberOfRecords() - 1;
RowBlocksReader rbr = new RowBlocksReader(rs);
_mergedCellsTable.addRecords(rbr.getLooseMergedCells());
rra = new RowRecordsAggregate(rbr.getPlainRecordStream(), rbr.getSharedFormulaManager());
records.add(rra); //only add the aggregate once
continue;
}
if (PageSettingsBlock.isComponentRecord(rec.getSid())) {
RecordStream rs = new RecordStream(inRecs, k);
if (PageSettingsBlock.isComponentRecord(recSid)) {
PageSettingsBlock psb = new PageSettingsBlock(rs);
if (bofEofNestingLevel == 1) {
if (retval._psBlock == null) {
retval._psBlock = psb;
if (_psBlock == null) {
_psBlock = psb;
} else {
// more than one 'Page Settings Block' at nesting level 1 ?
// apparently this happens in about 15 test sample files
}
}
records.add(psb);
k += rs.getCountRead()-1;
continue;
}
if (rec.getSid() == MergeCellsRecord.sid) {
if (recSid == MergeCellsRecord.sid) {
// when the MergedCellsTable is found in the right place, we expect those records to be contiguous
RecordStream rs = new RecordStream(inRecs, k);
retval._mergedCellsTable.read(rs);
k += rs.getCountRead()-1;
continue;
}
if (rec.getSid() == UncalcedRecord.sid) {
// don't add UncalcedRecord to the list
retval._isUncalced = true; // this flag is enough
_mergedCellsTable.read(rs);
continue;
}
if (rec.getSid() == BOFRecord.sid)
Record rec = rs.getNext();
if ( recSid == IndexRecord.sid ) {
// ignore INDEX record because it is only needed by Excel,
// and POI always re-calculates its contents
continue;
}
if (recSid == UncalcedRecord.sid) {
// don't add UncalcedRecord to the list
_isUncalced = true; // this flag is enough
continue;
}
if (recSid == BOFRecord.sid)
{
bofEofNestingLevel++;
if (log.check( POILogger.DEBUG ))
log.log(POILogger.DEBUG, "Hit BOF record. Nesting increased to " + bofEofNestingLevel);
}
else if (rec.getSid() == EOFRecord.sid)
else if (recSid == EOFRecord.sid)
{
--bofEofNestingLevel;
if (log.check( POILogger.DEBUG ))
log.log(POILogger.DEBUG, "Hit EOF record. Nesting decreased to " + bofEofNestingLevel);
if (bofEofNestingLevel == 0) {
records.add(rec);
retval.eofLoc = k;
break;
}
}
else if (rec.getSid() == DimensionsRecord.sid)
else if (recSid == DimensionsRecord.sid)
{
// Make a columns aggregate if one hasn't ready been created.
if (retval._columnInfos == null)
if (_columnInfos == null)
{
retval._columnInfos = new ColumnInfoRecordsAggregate();
records.add(retval._columnInfos);
_columnInfos = new ColumnInfoRecordsAggregate();
records.add(_columnInfos);
}
retval._dimensions = ( DimensionsRecord ) rec;
retval.dimsloc = records.size();
_dimensions = ( DimensionsRecord ) rec;
dimsloc = records.size();
}
else if (rec.getSid() == DefaultColWidthRecord.sid)
else if (recSid == DefaultColWidthRecord.sid)
{
retval.defaultcolwidth = ( DefaultColWidthRecord ) rec;
defaultcolwidth = ( DefaultColWidthRecord ) rec;
}
else if (rec.getSid() == DefaultRowHeightRecord.sid)
else if (recSid == DefaultRowHeightRecord.sid)
{
retval.defaultrowheight = ( DefaultRowHeightRecord ) rec;
defaultrowheight = ( DefaultRowHeightRecord ) rec;
}
else if ( rec.getSid() == PrintGridlinesRecord.sid )
else if ( recSid == PrintGridlinesRecord.sid )
{
retval.printGridlines = (PrintGridlinesRecord) rec;
printGridlines = (PrintGridlinesRecord) rec;
}
else if ( rec.getSid() == GridsetRecord.sid )
else if ( recSid == GridsetRecord.sid )
{
retval.gridset = (GridsetRecord) rec;
gridset = (GridsetRecord) rec;
}
else if ( rec.getSid() == SelectionRecord.sid )
else if ( recSid == SelectionRecord.sid )
{
retval.selection = (SelectionRecord) rec;
selection = (SelectionRecord) rec;
}
else if ( rec.getSid() == WindowTwoRecord.sid )
else if ( recSid == WindowTwoRecord.sid )
{
retval.windowTwo = (WindowTwoRecord) rec;
windowTwo = (WindowTwoRecord) rec;
}
else if ( rec.getSid() == ProtectRecord.sid )
else if ( recSid == ProtectRecord.sid )
{
retval.protect = (ProtectRecord) rec;
protect = (ProtectRecord) rec;
}
else if ( rec.getSid() == ObjectProtectRecord.sid )
else if ( recSid == ObjectProtectRecord.sid )
{
retval.objprotect = (ObjectProtectRecord) rec;
objprotect = (ObjectProtectRecord) rec;
}
else if ( rec.getSid() == ScenarioProtectRecord.sid )
else if ( recSid == ScenarioProtectRecord.sid )
{
retval.scenprotect = (ScenarioProtectRecord) rec;
scenprotect = (ScenarioProtectRecord) rec;
}
else if ( rec.getSid() == PasswordRecord.sid )
else if ( recSid == PasswordRecord.sid )
{
retval.password = (PasswordRecord) rec;
password = (PasswordRecord) rec;
}
records.add(rec);
}
if (retval._dimensions == null) {
if (_dimensions == null) {
throw new RuntimeException("DimensionsRecord was not found");
}
if (retval.windowTwo == null) {
if (windowTwo == null) {
throw new RuntimeException("WINDOW2 was not found");
}
if (retval._rowsAggregate == null) {
retval._rowsAggregate = new RowRecordsAggregate();
records.add(retval.dimsloc + 1, retval._rowsAggregate);
if (rra == null) {
rra = new RowRecordsAggregate();
records.add(dimsloc + 1, rra);
}
_rowsAggregate = rra;
// put merged cells table in the right place (regardless of where the first MergedCellsRecord was found */
RecordOrderer.addNewSheetRecord(records, retval._mergedCellsTable);
retval.records = records;
RecordOrderer.addNewSheetRecord(records, _mergedCellsTable);
if (log.check( POILogger.DEBUG ))
log.log(POILogger.DEBUG, "sheet createSheet (existing file) exited");
return retval;
}
private static final class RecordCloner implements RecordVisitor {
@ -362,7 +343,7 @@ public final class Sheet implements Model {
* belongs to a sheet.
*/
public Sheet cloneSheet() {
ArrayList clonedRecords = new ArrayList(this.records.size());
List clonedRecords = new ArrayList(this.records.size());
for (int i = 0; i < this.records.size(); i++) {
RecordBase rb = (RecordBase) this.records.get(i);
if (rb instanceof RecordAggregate) {
@ -372,25 +353,7 @@ public final class Sheet implements Model {
Record rec = (Record) ((Record) rb).clone();
clonedRecords.add(rec);
}
return createSheet(clonedRecords, 0, 0);
}
/**
* read support (offset = 0) Same as createSheet(Record[] recs, int, int)
* only the record offset is assumed to be 0.
*
* @param records array containing those records in the sheet in sequence (normally obtained from RecordFactory)
* @param sheetnum integer specifying the sheet's number (0,1 or 2 in this release)
* @return Sheet object
*/
public static Sheet createSheet(List records, int sheetnum)
{
if (log.check( POILogger.DEBUG ))
log.log(POILogger.DEBUG,
"Sheet createSheet (exisiting file) assumed offset 0");
return createSheet(records, sheetnum, 0);
return createSheet(new RecordStream(clonedRecords, 0));
}
/**
@ -400,19 +363,18 @@ public final class Sheet implements Model {
*
* @return Sheet object with all values set to defaults
*/
public static Sheet createSheet()
{
// TODO - convert this method to a constructor
public static Sheet createSheet() {
return new Sheet();
}
private Sheet() {
_mergedCellsTable = new MergedCellsTable();
records = new ArrayList(32);
if (log.check( POILogger.DEBUG ))
log.log(POILogger.DEBUG, "Sheet createsheet from scratch called");
Sheet retval = new Sheet();
ArrayList records = new ArrayList(30);
records.add(createBOF());
// records.add(retval.createIndex());
records.add(createCalcMode());
records.add(createCalcCount() );
records.add(createRefMode() );
@ -420,46 +382,42 @@ public final class Sheet implements Model {
records.add(createDelta() );
records.add(createSaveRecalc() );
records.add(createPrintHeaders() );
retval.printGridlines = createPrintGridlines();
records.add( retval.printGridlines );
retval.gridset = createGridset();
records.add( retval.gridset );
retval._gutsRecord = createGuts();
records.add( retval._gutsRecord );
retval.defaultrowheight = createDefaultRowHeight();
records.add( retval.defaultrowheight );
records.add( retval.createWSBool() );
printGridlines = createPrintGridlines();
records.add( printGridlines );
gridset = createGridset();
records.add( gridset );
_gutsRecord = createGuts();
records.add( _gutsRecord );
defaultrowheight = createDefaultRowHeight();
records.add( defaultrowheight );
records.add( createWSBool() );
// 'Page Settings Block'
retval._psBlock = new PageSettingsBlock();
records.add(retval._psBlock);
_psBlock = new PageSettingsBlock();
records.add(_psBlock);
// 'Worksheet Protection Block' (after 'Page Settings Block' and before DEFCOLWIDTH)
// PROTECT record normally goes here, don't add yet since the flag is initially false
retval.defaultcolwidth = createDefaultColWidth();
records.add( retval.defaultcolwidth);
defaultcolwidth = createDefaultColWidth();
records.add( defaultcolwidth);
ColumnInfoRecordsAggregate columns = new ColumnInfoRecordsAggregate();
records.add( columns );
retval._columnInfos = columns;
retval._dimensions = createDimensions();
records.add(retval._dimensions);
retval.dimsloc = records.size()-1;
retval._rowsAggregate = new RowRecordsAggregate();
records.add(retval._rowsAggregate);
_columnInfos = columns;
_dimensions = createDimensions();
records.add(_dimensions);
_rowsAggregate = new RowRecordsAggregate();
records.add(_rowsAggregate);
// 'Sheet View Settings'
records.add(retval.windowTwo = retval.createWindowTwo());
retval.selection = createSelection();
records.add(retval.selection);
records.add(windowTwo = createWindowTwo());
selection = createSelection();
records.add(selection);
records.add(retval._mergedCellsTable); // MCT comes after 'Sheet View Settings'
records.add(_mergedCellsTable); // MCT comes after 'Sheet View Settings'
records.add(EOFRecord.instance);
retval.records = records;
if (log.check( POILogger.DEBUG ))
log.log(POILogger.DEBUG, "Sheet createsheet from scratch exit");
return retval;
}
public RowRecordsAggregate getRowsAggregate() {
@ -1359,11 +1317,6 @@ public final class Sheet implements Model {
windowTwo.setSelected(sel);
}
public int getEofLoc()
{
return eofLoc;
}
/**
* Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
* @param colSplit Horizonatal position of split.
@ -1680,7 +1633,6 @@ public final class Sheet implements Model {
if (_psBlock == null) {
_psBlock = new PageSettingsBlock();
RecordOrderer.addNewSheetRecord(records, _psBlock);
dimsloc++;
}
return _psBlock;
}

63
src/java/org/apache/poi/hssf/record/BlankRecord.java
View File

@ -1,4 +1,3 @@
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@ -16,18 +15,13 @@
limitations under the License.
==================================================================== */
/*
* BlankRecord.java
*
* Created on December 10, 2001, 12:07 PM
*/
package org.apache.poi.hssf.record;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
/**
* Title: Blank cell record <P>
* Title: Blank cell record (0x0201) <P>
* Description: Represents a column in a row with no value but with styling.<P>
* REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Andrew C. Oliver (acoliver at apache dot org)
@ -35,13 +29,12 @@ import org.apache.poi.util.LittleEndian;
* @version 2.0-pre
*/
public final class BlankRecord extends Record implements CellValueRecordInterface {
public final static short sid = 0x201;
public final static short sid = 0x0201;
private int field_1_row;
private short field_2_col;
private short field_3_xf;
/** Creates a new instance of BlankRecord */
public BlankRecord()
{
}
@ -50,7 +43,6 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
* Constructs a BlankRecord and sets its fields appropriately
* @param in the RecordInputstream to read the record from
*/
public BlankRecord(RecordInputStream in)
{
super(in);
@ -58,7 +50,6 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
protected void fillFields(RecordInputStream in)
{
//field_1_row = LittleEndian.getShort(data, 0 + offset);
field_1_row = in.readUShort();
field_2_col = in.readShort();
field_3_xf = in.readShort();
@ -70,7 +61,6 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
*
* @param id alleged id for this record
*/
protected void validateSid(short id)
{
if (id != sid)
@ -83,8 +73,6 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
* set the row this cell occurs on
* @param row the row this cell occurs within
*/
//public void setRow(short row)
public void setRow(int row)
{
field_1_row = row;
@ -95,8 +83,6 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
*
* @return the row
*/
//public short getRow()
public int getRow()
{
return field_1_row;
@ -107,7 +93,6 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
*
* @return the column
*/
public short getColumn()
{
return field_2_col;
@ -119,7 +104,6 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
* @param xf - the 0-based index of the extended format
* @see org.apache.poi.hssf.record.ExtendedFormatRecord
*/
public void setXFIndex(short xf)
{
field_3_xf = xf;
@ -130,7 +114,6 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
*
* @return extended format index
*/
public short getXFIndex()
{
return field_3_xf;
@ -147,20 +130,9 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
field_2_col = col;
}
public boolean isInValueSection()
{
return true;
}
public boolean isValue()
{
return true;
}
/**
* return the non static version of the id for this record.
*/
public short getSid()
{
return sid;
@ -168,17 +140,14 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
public String toString()
{
StringBuffer buffer = new StringBuffer();
StringBuffer sb = new StringBuffer();
buffer.append("[BLANK]\n");
buffer.append("row = ").append(Integer.toHexString(getRow()))
.append("\n");
buffer.append("col = ").append(Integer.toHexString(getColumn()))
.append("\n");
buffer.append("xf = ")
.append(Integer.toHexString(getXFIndex())).append("\n");
buffer.append("[/BLANK]\n");
return buffer.toString();
sb.append("[BLANK]\n");
sb.append(" row= ").append(HexDump.shortToHex(getRow())).append("\n");
sb.append(" col= ").append(HexDump.shortToHex(getColumn())).append("\n");
sb.append(" xf = ").append(HexDump.shortToHex(getXFIndex())).append("\n");
sb.append("[/BLANK]\n");
return sb.toString();
}
/**
@ -188,15 +157,13 @@ public final class BlankRecord extends Record implements CellValueRecordInterfac
*
* @return byte array containing instance data
*/
public int serialize(int offset, byte [] data)
{
LittleEndian.putShort(data, 0 + offset, sid);
LittleEndian.putShort(data, 2 + offset, ( short ) 6);
//LittleEndian.putShort(data, 4 + offset, getRow());
LittleEndian.putShort(data, 4 + offset, ( short ) getRow());
LittleEndian.putShort(data, 6 + offset, getColumn());
LittleEndian.putShort(data, 8 + offset, getXFIndex());
LittleEndian.putUShort(data, 0 + offset, sid);
LittleEndian.putUShort(data, 2 + offset, 6);
LittleEndian.putUShort(data, 4 + offset, getRow());
LittleEndian.putUShort(data, 6 + offset, getColumn());
LittleEndian.putUShort(data, 8 + offset, getXFIndex());
return getRecordSize();
}

79
src/java/org/apache/poi/hssf/record/BoolErrRecord.java
View File

@ -1,4 +1,3 @@
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@ -16,25 +15,20 @@
limitations under the License.
==================================================================== */
/*
* BoolErrRecord.java
*
* Created on January 19, 2002, 9:30 AM
*/
package org.apache.poi.hssf.record;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
/**
* Creates new BoolErrRecord. <P>
* Creates new BoolErrRecord. (0x0205) <P>
* REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Michael P. Harhen
* @author Jason Height (jheight at chariot dot net dot au)
* @version 2.0-pre
*/
public final class BoolErrRecord extends Record implements CellValueRecordInterface {
public final static short sid = 0x205;
public final static short sid = 0x0205;
private int field_1_row;
private short field_2_column;
private short field_3_xf_index;
@ -42,7 +36,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
private byte field_5_fError;
/** Creates new BoolErrRecord */
public BoolErrRecord()
{
}
@ -52,7 +45,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
*
* @param in the RecordInputstream to read the record from
*/
public BoolErrRecord(RecordInputStream in)
{
super(in);
@ -61,7 +53,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
/**
* @param in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in)
{
//field_1_row = LittleEndian.getShort(data, 0 + offset);
@ -72,7 +63,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
field_5_fError = in.readByte();
}
//public void setRow(short row)
public void setRow(int row)
{
field_1_row = row;
@ -88,7 +78,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
* @see org.apache.poi.hssf.record.ExtendedFormatRecord
* @param xf index to the XF record
*/
public void setXFIndex(short xf)
{
field_3_xf_index = xf;
@ -99,7 +88,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
*
* @param value representing the boolean value
*/
public void setValue(boolean value)
{
field_4_bBoolErr = value ? ( byte ) 1
@ -114,7 +102,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
* this value can only be 0,7,15,23,29,36 or 42
* see bugzilla bug 16560 for an explanation
*/
public void setValue(byte value)
{
if ( (value==0)||(value==7)||(value==15)||(value==23)||(value==29)||(value==36)||(value==42)) {
@ -125,7 +112,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
}
}
//public short getRow()
public int getRow()
{
return field_1_row;
@ -141,7 +127,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
* @see org.apache.poi.hssf.record.ExtendedFormatRecord
* @return index to the XF record
*/
public short getXFIndex()
{
return field_3_xf_index;
@ -152,7 +137,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
*
* @return boolean representing the boolean value
*/
public boolean getBooleanValue()
{
return (field_4_bBoolErr != 0);
@ -163,7 +147,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
*
* @return byte representing the error value
*/
public byte getErrorValue()
{
return field_4_bBoolErr;
@ -174,7 +157,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
*
* @return boolean true if the cell holds a boolean value
*/
public boolean isBoolean()
{
return (field_5_fError == ( byte ) 0);
@ -195,32 +177,24 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
public boolean isError()
{
return (field_5_fError != ( byte ) 0);
return field_5_fError != 0;
}
public String toString()
{
StringBuffer buffer = new StringBuffer();
StringBuffer sb = new StringBuffer();
buffer.append("[BOOLERR]\n");
buffer.append(" .row = ")
.append(Integer.toHexString(getRow())).append("\n");
buffer.append(" .col = ")
.append(Integer.toHexString(getColumn())).append("\n");
buffer.append(" .xfindex = ")
.append(Integer.toHexString(getXFIndex())).append("\n");
if (isBoolean())
{
buffer.append(" .booleanValue = ").append(getBooleanValue())
.append("\n");
sb.append("[BOOLERR]\n");
sb.append(" .row = ").append(HexDump.shortToHex(getRow())).append("\n");
sb.append(" .col = ").append(HexDump.shortToHex(getColumn())).append("\n");
sb.append(" .xfindex= ").append(HexDump.shortToHex(getXFIndex())).append("\n");
if (isBoolean()) {
sb.append(" .booleanValue = ").append(getBooleanValue()).append("\n");
} else {
sb.append(" .errorValue = ").append(getErrorValue()).append("\n");
}
else
{
buffer.append(" .errorValue = ").append(getErrorValue())
.append("\n");
}
buffer.append("[/BOOLERR]\n");
return buffer.toString();
sb.append("[/BOOLERR]\n");
return sb.toString();
}
/**
@ -230,15 +204,13 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
*
* @return byte array containing instance data
*/
public int serialize(int offset, byte [] data)
{
LittleEndian.putShort(data, 0 + offset, sid);
LittleEndian.putShort(data, 2 + offset, ( short ) 8);
//LittleEndian.putShort(data, 4 + offset, getRow());
LittleEndian.putShort(data, 4 + offset, ( short ) getRow());
LittleEndian.putShort(data, 6 + offset, getColumn());
LittleEndian.putShort(data, 8 + offset, getXFIndex());
LittleEndian.putUShort(data, 0 + offset, sid);
LittleEndian.putUShort(data, 2 + offset, 8);
LittleEndian.putUShort(data, 4 + offset, getRow());
LittleEndian.putUShort(data, 6 + offset, getColumn());
LittleEndian.putUShort(data, 8 + offset, getXFIndex());
data[ 10 + offset ] = field_4_bBoolErr;
data[ 11 + offset ] = field_5_fError;
return getRecordSize();
@ -255,7 +227,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
*
* @param id alleged id for this record
*/
protected void validateSid(short id)
{
if (id != BoolErrRecord.sid)
@ -269,16 +240,6 @@ public final class BoolErrRecord extends Record implements CellValueRecordInterf
return sid;
}
public boolean isInValueSection()
{
return true;
}
public boolean isValue()
{
return true;
}
public Object clone() {
BoolErrRecord rec = new BoolErrRecord();
rec.field_1_row = field_1_row;

4
src/java/org/apache/poi/hssf/record/DBCellRecord.java
View File

@ -182,10 +182,6 @@ public final class DBCellRecord extends Record {
return sid;
}
public boolean isInValueSection()
{
return true;
}
public Object clone() {
// TODO - make immutable.
// this should be safe because only the instantiating code mutates these objects

8
src/java/org/apache/poi/hssf/record/FormulaRecord.java
View File

@ -406,14 +406,6 @@ public final class FormulaRecord extends Record implements CellValueRecordInterf
return 4 + getDataSize();
}
public boolean isInValueSection() {
return true;
}
public boolean isValue() {
return true;
}
public String toString() {
StringBuffer sb = new StringBuffer();

59
src/java/org/apache/poi/hssf/record/LabelRecord.java
View File

@ -17,8 +17,10 @@
package org.apache.poi.hssf.record;
import org.apache.poi.util.HexDump;
/**
* Label Record - read only support for strings stored directly in the cell.. Don't
* Label Record (0x0204) - read only support for strings stored directly in the cell.. Don't
* use this (except to read), use LabelSST instead <P>
* REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Andrew C. Oliver (acoliver at apache dot org)
@ -27,7 +29,7 @@ package org.apache.poi.hssf.record;
* @see org.apache.poi.hssf.record.LabelSSTRecord
*/
public final class LabelRecord extends Record implements CellValueRecordInterface {
public final static short sid = 0x204;
public final static short sid = 0x0204;
private int field_1_row;
private short field_2_column;
@ -37,7 +39,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
private String field_6_value;
/** Creates new LabelRecord */
public LabelRecord()
{
}
@ -47,7 +48,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
*
* @param in the RecordInputstream to read the record from
*/
public LabelRecord(RecordInputStream in)
{
super(in);
@ -59,7 +59,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
*
* @param id alleged id for this record
*/
protected void validateSid(short id)
{
if (id != sid)
@ -71,7 +70,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
/**
* @param in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in)
{
field_1_row = in.readUShort();
@ -92,11 +90,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
/*
* READ ONLY ACCESS... THIS IS FOR COMPATIBILITY ONLY...USE LABELSST! public
* void setRow(short row) { field_1_row = row; }
*
* public void setColumn(short col) { field_2_column = col; }
*
* public void setXFIndex(short index) { field_3_xf_index = index; }
*/
public int getRow()
{
@ -117,7 +110,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
* get the number of characters this string contains
* @return number of characters
*/
public short getStringLength()
{
return field_4_string_len;
@ -127,7 +119,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
* is this uncompressed unicode (16bit)? Or just 8-bit compressed?
* @return isUnicode - True for 16bit- false for 8bit
*/
public boolean isUnCompressedUnicode()
{
return (field_5_unicode_flag == 1);
@ -139,7 +130,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
* @return the text string
* @see #getStringLength()
*/
public String getValue()
{
return field_6_value;
@ -148,7 +138,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
/**
* THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
*/
public int serialize(int offset, byte [] data)
{
throw new RecordFormatException(
@ -162,38 +151,21 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
public String toString()
{
StringBuffer buffer = new StringBuffer();
buffer.append("[LABEL]\n");
buffer.append(" .row = ")
.append(Integer.toHexString(getRow())).append("\n");
buffer.append(" .column = ")
.append(Integer.toHexString(getColumn())).append("\n");
buffer.append(" .xfindex = ")
.append(Integer.toHexString(getXFIndex())).append("\n");
buffer.append(" .string_len = ")
.append(Integer.toHexString(field_4_string_len)).append("\n");
buffer.append(" .unicode_flag = ")
.append(Integer.toHexString(field_5_unicode_flag)).append("\n");
buffer.append(" .value = ")
.append(getValue()).append("\n");
buffer.append("[/LABEL]\n");
return buffer.toString();
}
public boolean isInValueSection()
{
return true;
}
public boolean isValue()
{
return true;
StringBuffer sb = new StringBuffer();
sb.append("[LABEL]\n");
sb.append(" .row = ").append(HexDump.shortToHex(getRow())).append("\n");
sb.append(" .column = ").append(HexDump.shortToHex(getColumn())).append("\n");
sb.append(" .xfindex = ").append(HexDump.shortToHex(getXFIndex())).append("\n");
sb.append(" .string_len= ").append(HexDump.shortToHex(field_4_string_len)).append("\n");
sb.append(" .unicode_flag= ").append(HexDump.byteToHex(field_5_unicode_flag)).append("\n");
sb.append(" .value = ").append(getValue()).append("\n");
sb.append("[/LABEL]\n");
return sb.toString();
}
/**
* NO-OP!
*/
public void setColumn(short col)
{
}
@ -201,8 +173,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
/**
* NO-OP!
*/
//public void setRow(short row)
public void setRow(int row)
{
}
@ -210,7 +180,6 @@ public final class LabelRecord extends Record implements CellValueRecordInterfac
/**
* no op!
*/
public void setXFIndex(short xf)
{
}

58
src/java/org/apache/poi/hssf/record/LabelSSTRecord.java
View File

@ -17,6 +17,7 @@
package org.apache.poi.hssf.record;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
/**
@ -31,8 +32,8 @@ import org.apache.poi.util.LittleEndian;
public final class LabelSSTRecord extends Record implements CellValueRecordInterface {
public final static short sid = 0xfd;
private int field_1_row;
private short field_2_column;
private short field_3_xf_index;
private int field_2_column;
private int field_3_xf_index;
private int field_4_sst_index;
public LabelSSTRecord()
@ -43,7 +44,6 @@ public final class LabelSSTRecord extends Record implements CellValueRecordInter
* Constructs an LabelSST record and sets its fields appropriately.
* @param in the RecordInputstream to read the record from
*/
public LabelSSTRecord(RecordInputStream in)
{
super(in);
@ -60,14 +60,12 @@ public final class LabelSSTRecord extends Record implements CellValueRecordInter
protected void fillFields(RecordInputStream in)
{
//field_1_row = LittleEndian.getShort(data, 0 + offset);
field_1_row = in.readUShort();
field_2_column = in.readShort();
field_3_xf_index = in.readShort();
field_2_column = in.readUShort();
field_3_xf_index = in.readUShort();
field_4_sst_index = in.readInt();
}
//public void setRow(short row)
public void setRow(int row)
{
field_1_row = row;
@ -102,7 +100,6 @@ public final class LabelSSTRecord extends Record implements CellValueRecordInter
field_4_sst_index = index;
}
//public short getRow()
public int getRow()
{
return field_1_row;
@ -110,7 +107,7 @@ public final class LabelSSTRecord extends Record implements CellValueRecordInter
public short getColumn()
{
return field_2_column;
return (short)field_2_column;
}
/**
@ -122,7 +119,7 @@ public final class LabelSSTRecord extends Record implements CellValueRecordInter
public short getXFIndex()
{
return field_3_xf_index;
return (short)field_3_xf_index;
}
/**
@ -139,29 +136,24 @@ public final class LabelSSTRecord extends Record implements CellValueRecordInter
public String toString()
{
StringBuffer buffer = new StringBuffer();
StringBuffer sb = new StringBuffer();
buffer.append("[LABELSST]\n");
buffer.append(" .row = ")
.append(Integer.toHexString(getRow())).append("\n");
buffer.append(" .column = ")
.append(Integer.toHexString(getColumn())).append("\n");
buffer.append(" .xfindex = ")
.append(Integer.toHexString(getXFIndex())).append("\n");
buffer.append(" .sstindex = ")
.append(Integer.toHexString(getSSTIndex())).append("\n");
buffer.append("[/LABELSST]\n");
return buffer.toString();
sb.append("[LABELSST]\n");
sb.append(" .row = ").append(HexDump.shortToHex(getRow())).append("\n");
sb.append(" .column = ").append(HexDump.shortToHex(getColumn())).append("\n");
sb.append(" .xfindex = ").append(HexDump.shortToHex(getXFIndex())).append("\n");
sb.append(" .sstindex= ").append(HexDump.intToHex(getSSTIndex())).append("\n");
sb.append("[/LABELSST]\n");
return sb.toString();
}
public int serialize(int offset, byte [] data)
{
LittleEndian.putShort(data, 0 + offset, sid);
LittleEndian.putShort(data, 2 + offset, ( short ) 10);
//LittleEndian.putShort(data, 4 + offset, getRow());
LittleEndian.putShort(data, 4 + offset, ( short )getRow());
LittleEndian.putShort(data, 6 + offset, getColumn());
LittleEndian.putShort(data, 8 + offset, getXFIndex());
LittleEndian.putUShort(data, 0 + offset, sid);
LittleEndian.putUShort(data, 2 + offset, 10);
LittleEndian.putUShort(data, 4 + offset, getRow());
LittleEndian.putUShort(data, 6 + offset, getColumn());
LittleEndian.putUShort(data, 8 + offset, getXFIndex());
LittleEndian.putInt(data, 10 + offset, getSSTIndex());
return getRecordSize();
}
@ -176,16 +168,6 @@ public final class LabelSSTRecord extends Record implements CellValueRecordInter
return sid;
}
public boolean isInValueSection()
{
return true;
}
public boolean isValue()
{
return true;
}
public Object clone() {
LabelSSTRecord rec = new LabelSSTRecord();
rec.field_1_row = field_1_row;

68
src/java/org/apache/poi/hssf/record/NumberRecord.java
View File

@ -17,21 +17,22 @@
package org.apache.poi.hssf.record;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.hssf.record.Record;
/**
* Contains a numeric cell value. <P>
* NUMBER (0x0203) Contains a numeric cell value. <P>
* REFERENCE: PG 334 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Jason Height (jheight at chariot dot net dot au)
* @version 2.0-pre
*/
public final class NumberRecord extends Record implements CellValueRecordInterface {
public static final short sid = 0x203;
public static final short sid = 0x0203;
private int field_1_row;
private short field_2_col;
private short field_3_xf;
private int field_2_col;
private int field_3_xf;
private double field_4_value;
/** Creates new NumberRecord */
@ -44,7 +45,6 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
*
* @param in the RecordInputstream to read the record from
*/
public NumberRecord(RecordInputStream in)
{
super(in);
@ -53,17 +53,14 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
/**
* @param in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in)
{
//field_1_row = LittleEndian.getShort(data, 0 + offset);
field_1_row = in.readUShort();
field_2_col = in.readShort();
field_3_xf = in.readShort();
field_2_col = in.readUShort();
field_3_xf = in.readUShort();
field_4_value = in.readDouble();
}
//public void setRow(short row)
public void setRow(int row)
{
field_1_row = row;
@ -79,7 +76,6 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
* @see org.apache.poi.hssf.record.ExtendedFormatRecord
* @param xf index to the XF record
*/
public void setXFIndex(short xf)
{
field_3_xf = xf;
@ -90,13 +86,11 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
*
* @param value double representing the value
*/
public void setValue(double value)
{
field_4_value = value;
}
//public short getRow()
public int getRow()
{
return field_1_row;
@ -104,7 +98,7 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
public short getColumn()
{
return field_2_col;
return (short)field_2_col;
}
/**
@ -112,10 +106,9 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
* @see org.apache.poi.hssf.record.ExtendedFormatRecord
* @return index to the XF record
*/
public short getXFIndex()
{
return field_3_xf;
return (short)field_3_xf;
}
/**
@ -123,7 +116,6 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
*
* @return double representing the value
*/
public double getValue()
{
return field_4_value;
@ -131,19 +123,15 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
public String toString()
{
StringBuffer buffer = new StringBuffer();
StringBuffer sb = new StringBuffer();
buffer.append("[NUMBER]\n");
buffer.append(" .row = ")
.append(Integer.toHexString(getRow())).append("\n");
buffer.append(" .col = ")
.append(Integer.toHexString(getColumn())).append("\n");
buffer.append(" .xfindex = ")
.append(Integer.toHexString(getXFIndex())).append("\n");
buffer.append(" .value = ").append(getValue())
.append("\n");
buffer.append("[/NUMBER]\n");
return buffer.toString();
sb.append("[NUMBER]\n");
sb.append(" .row = ").append(HexDump.shortToHex(getRow())).append("\n");
sb.append(" .col = ").append(HexDump.shortToHex(getColumn())).append("\n");
sb.append(" .xfindex= ").append(HexDump.shortToHex(getXFIndex())).append("\n");
sb.append(" .value = ").append(getValue()).append("\n");
sb.append("[/NUMBER]\n");
return sb.toString();
}
/**
@ -153,15 +141,13 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
*
* @return byte array containing instance data
*/
public int serialize(int offset, byte [] data)
{
LittleEndian.putShort(data, 0 + offset, sid);
LittleEndian.putShort(data, 2 + offset, ( short ) 14);
//LittleEndian.putShort(data, 4 + offset, getRow());
LittleEndian.putShort(data, 4 + offset, ( short ) getRow());
LittleEndian.putShort(data, 6 + offset, getColumn());
LittleEndian.putShort(data, 8 + offset, getXFIndex());
LittleEndian.putUShort(data, 0 + offset, sid);
LittleEndian.putUShort(data, 2 + offset, 14);
LittleEndian.putUShort(data, 4 + offset, getRow());
LittleEndian.putUShort(data, 6 + offset, getColumn());
LittleEndian.putUShort(data, 8 + offset, getXFIndex());
LittleEndian.putDouble(data, 10 + offset, getValue());
return getRecordSize();
}
@ -191,16 +177,6 @@ public final class NumberRecord extends Record implements CellValueRecordInterfa
return sid;
}
public boolean isInValueSection()
{
return true;
}
public boolean isValue()
{
return true;
}
public Object clone() {
NumberRecord rec = new NumberRecord();
rec.field_1_row = field_1_row;

59
src/java/org/apache/poi/hssf/record/RKRecord.java
View File

@ -18,9 +18,10 @@
package org.apache.poi.hssf.record;
import org.apache.poi.hssf.util.RKUtil;
import org.apache.poi.util.HexDump;
/**
* Title: RK Record
* Title: RK Record (0x027E)
* Description: An internal 32 bit number with the two most significant bits
* storing the type. This is part of a bizarre scheme to save disk
* space and memory (gee look at all the other whole records that
@ -37,14 +38,14 @@ import org.apache.poi.hssf.util.RKUtil;
* @see org.apache.poi.hssf.record.NumberRecord
*/
public final class RKRecord extends Record implements CellValueRecordInterface {
public final static short sid = 0x27e;
public final static short sid = 0x027E;
public final static short RK_IEEE_NUMBER = 0;
public final static short RK_IEEE_NUMBER_TIMES_100 = 1;
public final static short RK_INTEGER = 2;
public final static short RK_INTEGER_TIMES_100 = 3;
private int field_1_row;
private short field_2_col;
private short field_3_xf_index;
private int field_2_col;
private int field_3_xf_index;
private int field_4_rk_number;
public RKRecord()
@ -55,7 +56,6 @@ public final class RKRecord extends Record implements CellValueRecordInterface {
* Constructs a RK record and sets its fields appropriately.
* @param in the RecordInputstream to read the record from
*/
public RKRecord(RecordInputStream in)
{
super(in);
@ -71,14 +71,12 @@ public final class RKRecord extends Record implements CellValueRecordInterface {
protected void fillFields(RecordInputStream in)
{
//field_1_row = LittleEndian.getShort(data, 0 + offset);
field_1_row = in.readUShort();
field_2_col = in.readShort();
field_3_xf_index = in.readShort();
field_2_col = in.readUShort();
field_3_xf_index = in.readUShort();
field_4_rk_number = in.readInt();
}
//public short getRow()
public int getRow()
{
return field_1_row;
@ -86,12 +84,12 @@ public final class RKRecord extends Record implements CellValueRecordInterface {
public short getColumn()
{
return field_2_col;
return (short) field_2_col;
}
public short getXFIndex()
{
return field_3_xf_index;
return (short) field_3_xf_index;
}
public int getRKField()
@ -110,7 +108,6 @@ public final class RKRecord extends Record implements CellValueRecordInterface {
* <LI>RK_INTEGER_TIMES_100</LI>
* </OL>
*/
public short getRKType()
{
return ( short ) (field_4_rk_number & 3);
@ -133,7 +130,6 @@ public final class RKRecord extends Record implements CellValueRecordInterface {
* @return the value as a proper double (hey, it <B>could</B>
* happen)
*/
public double getRKNumber()
{
return RKUtil.decodeNumber(field_4_rk_number);
@ -142,23 +138,17 @@ public final class RKRecord extends Record implements CellValueRecordInterface {
public String toString()
{
StringBuffer buffer = new StringBuffer();
StringBuffer sb = new StringBuffer();
buffer.append("[RK]\n");
buffer.append(" .row = ")
.append(Integer.toHexString(getRow())).append("\n");
buffer.append(" .col = ")
.append(Integer.toHexString(getColumn())).append("\n");
buffer.append(" .xfindex = ")
.append(Integer.toHexString(getXFIndex())).append("\n");
buffer.append(" .rknumber = ")
.append(Integer.toHexString(getRKField())).append("\n");
buffer.append(" .rktype = ")
.append(Integer.toHexString(getRKType())).append("\n");
buffer.append(" .rknumber = ").append(getRKNumber())
.append("\n");
buffer.append("[/RK]\n");
return buffer.toString();
sb.append("[RK]\n");
sb.append(" .row = ").append(HexDump.shortToHex(getRow())).append("\n");
sb.append(" .col = ").append(HexDump.shortToHex(getColumn())).append("\n");
sb.append(" .xfindex = ").append(HexDump.shortToHex(getXFIndex())).append("\n");
sb.append(" .rknumber = ").append(HexDump.intToHex(getRKField())).append("\n");
sb.append(" .rktype = ").append(HexDump.byteToHex(getRKType())).append("\n");
sb.append(" .rknumber= ").append(getRKNumber()).append("\n");
sb.append("[/RK]\n");
return sb.toString();
}
// temporarily just constructs a new number record and returns its value
@ -209,21 +199,10 @@ public final class RKRecord extends Record implements CellValueRecordInterface {
return sid;
}
public boolean isInValueSection()
{
return true;
}
public boolean isValue()
{
return true;
}
public void setColumn(short col)
{
}
//public void setRow(short row)
public void setRow(int row)
{
}

18
src/java/org/apache/poi/hssf/record/Record.java
View File

@ -98,24 +98,6 @@ public abstract class Record extends RecordBase {
return serialize().length;
}
/**
* tells whether this type of record contains a value
*/
public boolean isValue()
{
return false;
}
/**
* DBCELL, ROW, VALUES all say yes
*/
public boolean isInValueSection()
{
return false;
}
/**
* get a string representation of the record (for biffview/debugging)
*/

127
src/java/org/apache/poi/hssf/record/RowRecord.java
View File

@ -19,6 +19,7 @@ package org.apache.poi.hssf.record;
import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
/**
@ -29,7 +30,7 @@ import org.apache.poi.util.LittleEndian;
* @author Jason Height (jheight at chariot dot net dot au)
* @version 2.0-pre
*/
public final class RowRecord extends Record implements Comparable {
public final class RowRecord extends Record {
public final static short sid = 0x0208;
public static final int ENCODED_SIZE = 20;
@ -77,7 +78,6 @@ public final class RowRecord extends Record implements Comparable {
* Constructs a Row record and sets its fields appropriately.
* @param in the RecordInputstream to read the record from
*/
public RowRecord(RecordInputStream in)
{
super(in);
@ -107,8 +107,6 @@ public final class RowRecord extends Record implements Comparable {
* set the logical row number for this row (0 based index)
* @param row - the row number
*/
//public void setRowNumber(short row)
public void setRowNumber(int row)
{
field_1_row_number = row;
@ -118,7 +116,6 @@ public final class RowRecord extends Record implements Comparable {
* set the logical col number for the first cell this row (0 based index)
* @param col - the col number
*/
public void setFirstCol(short col)
{
field_2_first_col = col;
@ -128,7 +125,6 @@ public final class RowRecord extends Record implements Comparable {
* set the logical col number for the last cell this row (0 based index)
* @param col - the col number
*/
public void setLastCol(short col)
{
field_3_last_col = col;
@ -138,7 +134,6 @@ public final class RowRecord extends Record implements Comparable {
* set the height of the row
* @param height of the row
*/
public void setHeight(short height)
{
field_4_height = height;
@ -148,31 +143,17 @@ public final class RowRecord extends Record implements Comparable {
* set whether to optimize or not (set to 0)
* @param optimize (set to 0)
*/
public void setOptimize(short optimize)
{
field_5_optimize = optimize;
}
/**
* sets the option bitmask. (use the individual bit setters that refer to this
* method)
* @param options - the bitmask
*/
public void setOptionFlags(short options)
{
field_7_option_flags = options | OPTION_BITS_ALWAYS_SET;
}
// option bitfields
/**
* set the outline level of this row
* @param ol - the outline level
* @see #setOptionFlags(short)
*/
public void setOutlineLevel(short ol)
{
field_7_option_flags = outlineLevel.setValue(field_7_option_flags, ol);
@ -181,9 +162,7 @@ public final class RowRecord extends Record implements Comparable {
/**
* set whether or not to collapse this row
* @param c - collapse or not
* @see #setOptionFlags(short)
*/
public void setColapsed(boolean c)
{
field_7_option_flags = colapsed.setBoolean(field_7_option_flags, c);
@ -192,9 +171,7 @@ public final class RowRecord extends Record implements Comparable {
/**
* set whether or not to display this row with 0 height
* @param z height is zero or not.
* @see #setOptionFlags(short)
*/
public void setZeroHeight(boolean z)
{
field_7_option_flags = zeroHeight.setBoolean(field_7_option_flags, z);
@ -203,9 +180,7 @@ public final class RowRecord extends Record implements Comparable {
/**
* set whether the font and row height are not compatible
* @param f true if they aren't compatible (damn not logic)
* @see #setOptionFlags(short)
*/
public void setBadFontHeight(boolean f)
{
field_7_option_flags = badFontHeight.setBoolean(field_7_option_flags, f);
@ -214,9 +189,7 @@ public final class RowRecord extends Record implements Comparable {
/**
* set whether the row has been formatted (even if its got all blank cells)
* @param f formatted or not
* @see #setOptionFlags(short)
*/
public void setFormatted(boolean f)
{
field_7_option_flags = formatted.setBoolean(field_7_option_flags, f);
@ -229,7 +202,6 @@ public final class RowRecord extends Record implements Comparable {
* @see org.apache.poi.hssf.record.ExtendedFormatRecord
* @param index to the XF record
*/
public void setXFIndex(short index)
{
field_8_xf_index = index;
@ -239,8 +211,6 @@ public final class RowRecord extends Record implements Comparable {
* get the logical row number for this row (0 based index)
* @return row - the row number
*/
//public short getRowNumber()
public int getRowNumber()
{
return field_1_row_number;
@ -250,7 +220,6 @@ public final class RowRecord extends Record implements Comparable {
* get the logical col number for the first cell this row (0 based index)
* @return col - the col number
*/
public short getFirstCol()
{
return field_2_first_col;
@ -260,7 +229,6 @@ public final class RowRecord extends Record implements Comparable {
* get the logical col number for the last cell this row plus one (0 based index)
* @return col - the last col number + 1
*/
public short getLastCol()
{
return field_3_last_col;
@ -270,7 +238,6 @@ public final class RowRecord extends Record implements Comparable {
* get the height of the row
* @return height of the row
*/
public short getHeight()
{
return field_4_height;
@ -280,7 +247,6 @@ public final class RowRecord extends Record implements Comparable {
* get whether to optimize or not (set to 0)
* @return optimize (set to 0)
*/
public short getOptimize()
{
return field_5_optimize;
@ -291,7 +257,6 @@ public final class RowRecord extends Record implements Comparable {
* method)
* @return options - the bitmask
*/
public short getOptionFlags()
{
return (short)field_7_option_flags;
@ -304,7 +269,6 @@ public final class RowRecord extends Record implements Comparable {
* @return ol - the outline level
* @see #getOptionFlags()
*/
public short getOutlineLevel()
{
return (short)outlineLevel.getValue(field_7_option_flags);
@ -315,7 +279,6 @@ public final class RowRecord extends Record implements Comparable {
* @return c - colapse or not
* @see #getOptionFlags()
*/
public boolean getColapsed()
{
return (colapsed.isSet(field_7_option_flags));
@ -326,7 +289,6 @@ public final class RowRecord extends Record implements Comparable {
* @return - z height is zero or not.
* @see #getOptionFlags()
*/
public boolean getZeroHeight()
{
return zeroHeight.isSet(field_7_option_flags);
@ -367,44 +329,27 @@ public final class RowRecord extends Record implements Comparable {
return field_8_xf_index;
}
public boolean isInValueSection()
{
return true;
}
public String toString()
{
StringBuffer buffer = new StringBuffer();
StringBuffer sb = new StringBuffer();
buffer.append("[ROW]\n");
buffer.append(" .rownumber = ")
.append(Integer.toHexString(getRowNumber())).append("\n");
buffer.append(" .firstcol = ")
.append(Integer.toHexString(getFirstCol())).append("\n");
buffer.append(" .lastcol = ")
.append(Integer.toHexString(getLastCol())).append("\n");
buffer.append(" .height = ")
.append(Integer.toHexString(getHeight())).append("\n");
buffer.append(" .optimize = ")
.append(Integer.toHexString(getOptimize())).append("\n");
buffer.append(" .reserved = ")
.append(Integer.toHexString(field_6_reserved)).append("\n");
buffer.append(" .optionflags = ")
.append(Integer.toHexString(getOptionFlags())).append("\n");
buffer.append(" .outlinelvl = ")
.append(Integer.toHexString(getOutlineLevel())).append("\n");
buffer.append(" .colapsed = ").append(getColapsed())
sb.append("[ROW]\n");
sb.append(" .rownumber = ").append(Integer.toHexString(getRowNumber()))
.append("\n");
buffer.append(" .zeroheight = ").append(getZeroHeight())
.append("\n");
buffer.append(" .badfontheig= ").append(getBadFontHeight())
.append("\n");
buffer.append(" .formatted = ").append(getFormatted())
.append("\n");
buffer.append(" .xfindex = ")
.append(Integer.toHexString(getXFIndex())).append("\n");
buffer.append("[/ROW]\n");
return buffer.toString();
sb.append(" .firstcol = ").append(HexDump.shortToHex(getFirstCol())).append("\n");
sb.append(" .lastcol = ").append(HexDump.shortToHex(getLastCol())).append("\n");
sb.append(" .height = ").append(HexDump.shortToHex(getHeight())).append("\n");
sb.append(" .optimize = ").append(HexDump.shortToHex(getOptimize())).append("\n");
sb.append(" .reserved = ").append(HexDump.shortToHex(field_6_reserved)).append("\n");
sb.append(" .optionflags = ").append(HexDump.shortToHex(getOptionFlags())).append("\n");
sb.append(" .outlinelvl = ").append(Integer.toHexString(getOutlineLevel())).append("\n");
sb.append(" .colapsed = ").append(getColapsed()).append("\n");
sb.append(" .zeroheight = ").append(getZeroHeight()).append("\n");
sb.append(" .badfontheig= ").append(getBadFontHeight()).append("\n");
sb.append(" .formatted = ").append(getFormatted()).append("\n");
sb.append(" .xfindex = ").append(Integer.toHexString(getXFIndex())).append("\n");
sb.append("[/ROW]\n");
return sb.toString();
}
public int serialize(int offset, byte [] data)
@ -433,40 +378,6 @@ public final class RowRecord extends Record implements Comparable {
return sid;
}
public int compareTo(Object obj)
{
RowRecord loc = ( RowRecord ) obj;
if (this.getRowNumber() == loc.getRowNumber())
{
return 0;
}
if (this.getRowNumber() < loc.getRowNumber())
{
return -1;
}
if (this.getRowNumber() > loc.getRowNumber())
{
return 1;
}
return -1;
}
public boolean equals(Object obj)
{
if (!(obj instanceof RowRecord))
{
return false;
}
RowRecord loc = ( RowRecord ) obj;
if (this.getRowNumber() == loc.getRowNumber())
{
return true;
}
return false;
}
public Object clone() {
RowRecord rec = new RowRecord(field_1_row_number);
rec.field_2_first_col = field_2_first_col;

16
src/java/org/apache/poi/hssf/record/SharedValueRecordBase.java
View File

@ -115,20 +115,4 @@ public abstract class SharedValueRecordBase extends Record {
CellRangeAddress8Bit r = getRange();
return r.getFirstRow() == rowIx && r.getFirstColumn() == colIx;
}
/**
* Mirroring formula records so it is registered in the
* ValueRecordsAggregate
*/
public final boolean isInValueSection() {
return true;
}
/**
* Register it in the ValueRecordsAggregate so it can go into the
* FormulaRecordAggregate
*/
public final boolean isValue() {
return true;
}
}

25
src/java/org/apache/poi/hssf/record/StringRecord.java
View File

@ -1,4 +1,3 @@
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@ -16,21 +15,18 @@
limitations under the License.
==================================================================== */
package org.apache.poi.hssf.record;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.StringUtil;
/**
* Supports the STRING record structure.
* Supports the STRING record structure. (0x0207)
*
* @author Glen Stampoultzis (glens at apache.org)
*/
public class StringRecord
extends Record
{
public final static short sid = 0x207;
public class StringRecord extends Record {
public final static short sid = 0x0207;
private int field_1_string_length;
private byte field_2_unicode_flag;
private String field_3_string;
@ -73,7 +69,7 @@ public class StringRecord
field_1_string_length = in.readShort();
field_2_unicode_flag = in.readByte();
byte[] data = in.readRemainder();
//Why isnt this using the in.readString methods???
//Why isn't this using the in.readString methods???
if (isUnCompressedUnicode())
{
field_3_string = StringUtil.getFromUnicodeLE(data, 0, field_1_string_length );
@ -92,11 +88,6 @@ public class StringRecord
}
}
public boolean isInValueSection()
{
return true;
}
private int getStringByteLength()
{
return isUnCompressedUnicode() ? field_1_string_length * 2 : field_1_string_length;
@ -130,8 +121,8 @@ public class StringRecord
*/
public int serialize( int offset, byte[] data )
{
LittleEndian.putShort(data, 0 + offset, sid);
LittleEndian.putShort(data, 2 + offset, ( short ) (3 + getStringByteLength()));
LittleEndian.putUShort(data, 0 + offset, sid);
LittleEndian.putUShort(data, 2 + offset, 3 + getStringByteLength());
LittleEndian.putUShort(data, 4 + offset, field_1_string_length);
data[6 + offset] = field_2_unicode_flag;
if (isUnCompressedUnicode())
@ -180,8 +171,6 @@ public class StringRecord
setCompressedFlag(StringUtil.hasMultibyte(string) ? (byte)1 : (byte)0);
}
public String toString()
{
StringBuffer buffer = new StringBuffer();
@ -199,7 +188,5 @@ public class StringRecord
rec.field_2_unicode_flag= this.field_2_unicode_flag;
rec.field_3_string = this.field_3_string;
return rec;
}
}

2
src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java
View File

@ -83,7 +83,7 @@ public final class RowRecordsAggregate extends RecordAggregate {
// might need to keep track of where exactly these belong
continue;
}
if (!rec.isValue()) {
if (!(rec instanceof CellValueRecordInterface)) {
throw new RuntimeException("Unexpected record type (" + rec.getClass().getName() + ")");
}
_valuesAgg.construct((CellValueRecordInterface)rec, rs, svm);

8
src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
View File

@ -33,6 +33,7 @@ import org.apache.poi.ddf.EscherBSERecord;
import org.apache.poi.ddf.EscherBitmapBlip;
import org.apache.poi.ddf.EscherBlipRecord;
import org.apache.poi.ddf.EscherRecord;
import org.apache.poi.hssf.model.RecordStream;
import org.apache.poi.hssf.model.Sheet;
import org.apache.poi.hssf.model.Workbook;
import org.apache.poi.hssf.record.AbstractEscherHolderRecord;
@ -276,10 +277,9 @@ public class HSSFWorkbook extends POIDocument
// convert all LabelRecord records to LabelSSTRecord
convertLabelRecords(records, recOffset);
while (recOffset < records.size()) {
Sheet sheet = Sheet.createSheet(records, sheetNum++, recOffset );
recOffset = sheet.getEofLoc()+1; // TODO - use better technique to keep track of the used records
RecordStream rs = new RecordStream(records, recOffset);
while (rs.hasNext()) {
Sheet sheet = Sheet.createSheet(rs);
_sheets.add(new HSSFSheet(this, sheet));
}

13
src/testcases/org/apache/poi/hssf/model/TestSheet.java
View File

@ -56,6 +56,11 @@ import org.apache.poi.hssf.util.CellRangeAddress;
* @author Glen Stampoultzis (glens at apache.org)
*/
public final class TestSheet extends TestCase {
private static Sheet createSheet(List inRecs) {
return Sheet.createSheet(new RecordStream(inRecs, 0));
}
public void testCreateSheet() {
// Check we're adding row and cell aggregates
List records = new ArrayList();
@ -63,7 +68,7 @@ public final class TestSheet extends TestCase {
records.add( new DimensionsRecord() );
records.add(createWindow2Record());
records.add(EOFRecord.instance);
Sheet sheet = Sheet.createSheet( records, 0, 0 );
Sheet sheet = createSheet(records);
int pos = 0;
assertTrue( sheet.records.get(pos++) instanceof BOFRecord );
@ -187,7 +192,7 @@ public final class TestSheet extends TestCase {
records.add(EOFRecord.instance);
records.add(merged);
Sheet sheet = Sheet.createSheet(records, 0);
Sheet sheet = createSheet(records);
sheet.records.remove(0);
//stub object to throw off list INDEX operations
@ -222,7 +227,7 @@ public final class TestSheet extends TestCase {
records.add(createWindow2Record());
records.add(EOFRecord.instance);
Sheet sheet = Sheet.createSheet(records, 0);
Sheet sheet = createSheet(records);
assertNotNull("Row [2] was skipped", sheet.getRow(2));
}
@ -446,7 +451,7 @@ public final class TestSheet extends TestCase {
records.add(new DimensionsRecord());
records.add(createWindow2Record());
records.add(EOFRecord.instance);
Sheet sheet = Sheet.createSheet(records, 0, 0);
Sheet sheet = createSheet(records);
// 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

4
src/testcases/org/apache/poi/hssf/record/TestExternalNameRecord.java
View File

@ -82,11 +82,9 @@ public final class TestExternalNameRecord extends TestCase {
assertTrue(enr.isAutomaticLink());
assertFalse(enr.isBuiltInName());
assertFalse(enr.isIconifiedPictureLink());
assertFalse(enr.isInValueSection());
assertFalse(enr.isOLELink());
assertFalse(enr.isPicureLink());
assertTrue(enr.isStdDocumentNameIdentifier());
assertFalse(enr.isValue());
TestcaseRecordInputStream.confirmRecordEncoding(0x0023, dataAutoDocName, enr.serialize());
}
@ -98,11 +96,9 @@ public final class TestExternalNameRecord extends TestCase {
assertFalse(enr.isAutomaticLink());
assertFalse(enr.isBuiltInName());
assertFalse(enr.isIconifiedPictureLink());
assertFalse(enr.isInValueSection());
assertFalse(enr.isOLELink());
assertFalse(enr.isPicureLink());
assertFalse(enr.isStdDocumentNameIdentifier());
assertFalse(enr.isValue());
TestcaseRecordInputStream.confirmRecordEncoding(0x0023, dataPlainName, enr.serialize());
}

2
src/testcases/org/apache/poi/hssf/record/aggregates/TestValueRecordsAggregate.java
View File

@ -65,7 +65,7 @@ public final class TestValueRecordsAggregate extends TestCase {
}
private void constructValueRecord(List records) {
RowBlocksReader rbr = new RowBlocksReader(records, 0);
RowBlocksReader rbr = new RowBlocksReader(new RecordStream(records, 0));
SharedValueManager sfrh = rbr.getSharedFormulaManager();
RecordStream rs = rbr.getPlainRecordStream();
while(rs.hasNext()) {