org.apache.poi.hssf.record
Class SupBookRecord

java.lang.Object
  extended byorg.apache.poi.hssf.record.Record
      extended byorg.apache.poi.hssf.record.SupBookRecord

public class SupBookRecord
extends Record

Title: Sup Book

Description: A Extrenal Workbook Deciption (Sup Book) Its only a dummy record for making new ExternSheet Record

REFERENCE:

Author:
Libin Roman (Vista Portal LDT. Developer), Andrew C. Oliver (acoliver@apache.org)

Field Summary
static short sid
           
 
Constructor Summary
SupBookRecord()
           
SupBookRecord(short id, short size, byte[] data)
          Constructs a Extern Sheet record and sets its fields appropriately.
SupBookRecord(short id, short size, byte[] data, int offset)
          Constructs a Extern Sheet record and sets its fields appropriately.
 
Method Summary
protected  void fillFields(byte[] data, short size, int offset)
          called by the constructor, should set class level fields.
 short getFlag()
           
 short getNumberOfSheets()
           
 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 setFlag(short flag)
           
 void setNumberOfSheets(short number)
           
 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
clone, fillFields, isInValueSection, isValue, processContinueRecord, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

SupBookRecord

public SupBookRecord()

SupBookRecord

public SupBookRecord(short id,
                     short size,
                     byte[] data)
Constructs a Extern Sheet record and sets its fields appropriately.

Parameters:
id - id must be 0x16 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)

SupBookRecord

public SupBookRecord(short id,
                     short size,
                     byte[] data,
                     int offset)
Constructs a Extern Sheet record and sets its fields appropriately.

Parameters:
id - id must be 0x1ae 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 the record's 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.

Specified by:
validateSid in class Record
Parameters:
id - alleged id for this record

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Specified by:
fillFields in class Record
Parameters:
data - raw data
size - size of data
offset - of the record's data (provided a big array of the file)

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)
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.

Specified by:
serialize in class Record
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

setNumberOfSheets

public void setNumberOfSheets(short number)

getNumberOfSheets

public short getNumberOfSheets()

setFlag

public void setFlag(short flag)

getFlag

public short getFlag()

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

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.

Specified by:
getSid in class Record


Copyright © 2003 Apache Software Foundation.