loci.poi.hssf.record

Class FnGroupCountRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.poi.hssf.record.FnGroupCountRecord

public class FnGroupCountRecord
extends Record

Title: Function Group Count Record

Description: Number of built in function groups in the current version of the Spreadsheet (probably only used on Windoze)

REFERENCE: PG 315 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

Fields

Modifier and Type	Field and Description
static short	COUNT suggested default (14 dec)
static short	sid

Constructor Summary

Constructors

Constructor and Description
FnGroupCountRecord()
FnGroupCountRecord(RecordInputStream in) Constructs a FnGroupCount record and sets its fields appropriately.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
short	getCount() get the number of built-in functions
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	setCount(short count) set the number of built-in functions
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 loci.poi.hssf.record.Record

clone, 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

COUNT

public static final short COUNT

suggested default (14 dec)

See Also:

Constant Field Values

Constructor Detail

FnGroupCountRecord

public FnGroupCountRecord()

FnGroupCountRecord

public FnGroupCountRecord(RecordInputStream in)

Constructs a FnGroupCount record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

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(RecordInputStream in)

Description copied from class: Record

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

Specified by:

fillFields in class Record

Parameters:

in - the RecordInputstream to read the record from

setCount

public void setCount(short count)

set the number of built-in functions

Parameters:

count - - number of functions

getCount

public short getCount()

get the number of built-in functions

Returns:

number of built-in functions

toString

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

Specified by:

serialize in class 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. 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