org.apache.poi.hssf.record
Class IndexRecord

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.apache.poi.hssf.record.IndexRecord

public class IndexRecord

extends Record

Title: Index Record

Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells

NOT USED IN THIS RELEASE REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org)

Field Summary

static int	DBCELL_CAPACITY
int	field_1_zero
int	field_2_first_row
int	field_3_last_row_add1
int	field_4_zero
IntList	field_5_dbcells
static short	sid

Constructor Summary

IndexRecord()

IndexRecord(short id, short size, byte[] data)
Constructs an Index record and sets its fields appropriately.

IndexRecord(short id, short size, byte[] data, int offset)
Constructs an Index record and sets its fields appropriately.

Method Summary

void	addDbcell(int cell)
protected void	fillFields(byte[] data, short size, int offset) called by the constructor, should set class level fields.
int	getDbcellAt(int cellnum)
int	getFirstRow()
int	getLastRowAdd1()
int	getNumDbcells()
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setDbcell(int cell, int value)
void	setFirstRow(int row)
void	setLastRowAdd1(int row)
java.lang.String	toString() get a string representation of the record (for biffview/debugging)
protected void	validateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Methods inherited from class org.apache.poi.hssf.record.Record

fillFields, isInValueSection, isValue, processContinueRecord, serialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

DBCELL_CAPACITY

public static final int DBCELL_CAPACITY

field_1_zero

public int field_1_zero

field_2_first_row

public int field_2_first_row

field_3_last_row_add1

public int field_3_last_row_add1

field_4_zero

public int field_4_zero

field_5_dbcells

public IntList field_5_dbcells

Constructor Detail

IndexRecord

public IndexRecord()

IndexRecord

public IndexRecord(short id,
                   short size,
                   byte[] data)

Constructs an Index record and sets its fields appropriately.

Parameters:

id - id must be 0x208 or an exception will be throw upon validation

size - the size of the data area of the record

data - data of the record (should not contain sid/len)

IndexRecord

public IndexRecord(short id,
                   short size,
                   byte[] data,
                   int offset)

Constructs an Index record and sets its fields appropriately.

Parameters:

id - id must be 0x208 or an exception will be throw upon validation

size - the size of the data area of the record

data - data of the record (should not contain sid/len)

offset - of record data

Method Detail

validateSid

protected void validateSid(short id)

Description copied from class: Record

called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Overrides:

validateSid in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

id - alleged id for this record

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)

Description copied from class: Record

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Overrides:

fillFields in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

data - raw data

size - size of data

offset - of the record's data (provided a big array of the file)

setFirstRow

public void setFirstRow(int row)

setLastRowAdd1

public void setLastRowAdd1(int row)

addDbcell

public void addDbcell(int cell)

setDbcell

public void setDbcell(int cell,
                      int value)

getFirstRow

public int getFirstRow()

getLastRowAdd1

public int getLastRowAdd1()

getNumDbcells

public int getNumDbcells()

getDbcellAt

public int getDbcellAt(int cellnum)

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)

Description copied from class: Record

called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Overrides:

serialize in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getRecordSize

public int getRecordSize()

Description copied from class: Record

gives the current serialized size of the record.

Overrides:

getRecordSize in class Record

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Overrides:

getSid in class Record