org.apache.poi.hssf.record
Class SupBookRecord

java.lang.Object
  org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.SupBookRecord

public final class SupBookRecord
extends Record

Title: Sup Book (EXTERNALBOOK)

Description: A External Workbook Description (Suplemental Book) Its only a dummy record for making new ExternSheet Record

REFERENCE: 5.38

Author:

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

Field Summary

static short

sid

Constructor Summary

SupBookRecord(RecordInputStream in)
Constructs a Extern Sheet record and sets its fields appropriately.

SupBookRecord(UnicodeString url, UnicodeString[] sheetNames)

Method Summary

static SupBookRecord	createAddInFunctions()
static SupBookRecord	createExternalReferences(UnicodeString url, UnicodeString[] sheetNames)
static SupBookRecord	createInternalReferences(short numberOfSheets)
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
short	getNumberOfSheets()
int	getRecordSize() gives the current serialized size of the record.
UnicodeString[]	getSheetNames()
short	getSid() return the non static version of the id for this record.
UnicodeString	getURL()
boolean	isAddInFunctions()
boolean	isExternalReferences()
boolean	isInternalReferences()
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
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, cloneViaReserialise, isInValueSection, isValue, 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(UnicodeString url,
                     UnicodeString[] sheetNames)

SupBookRecord

public SupBookRecord(RecordInputStream in)

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)

Method Detail

createInternalReferences

public static SupBookRecord createInternalReferences(short numberOfSheets)

createAddInFunctions

public static SupBookRecord createAddInFunctions()

createExternalReferences

public static SupBookRecord createExternalReferences(UnicodeString url,
                                                     UnicodeString[] sheetNames)

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

isExternalReferences

public boolean isExternalReferences()

isInternalReferences

public boolean isInternalReferences()

isAddInFunctions

public boolean isAddInFunctions()

fillFields

protected void fillFields(RecordInputStream in)

called by the constructor, should set class level fields. Should throw runtime exception for bad/incomplete 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()

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

getURL

public UnicodeString getURL()

getSheetNames

public UnicodeString[] getSheetNames()