loci.poi.hssf.record

Class RefModeRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.poi.hssf.record.RefModeRecord

public class RefModeRecord
extends Record

Title: RefMode Record

Description: Describes which reference mode to use

REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)

Field Summary

Fields

Modifier and Type	Field and Description
private short	field_1_mode
static short	sid
static short	USE_A1_MODE
static short	USE_R1C1_MODE

Constructor Summary

Constructors

Constructor and Description
RefModeRecord()
RefModeRecord(RecordInputStream in) Constructs a RefMode record and sets its fields appropriately.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
short	getMode() get the reference mode to use (HSSF uses/assumes A1)
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	setMode(short mode) set the reference mode to use (HSSF uses/assumes A1)
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

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

USE_A1_MODE

public static final short USE_A1_MODE

See Also:

Constant Field Values

USE_R1C1_MODE

public static final short USE_R1C1_MODE

See Also:

Constant Field Values

field_1_mode

private short field_1_mode

Constructor Detail

RefModeRecord

public RefModeRecord()

RefModeRecord

public RefModeRecord(RecordInputStream in)

Constructs a RefMode 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

setMode

public void setMode(short mode)

set the reference mode to use (HSSF uses/assumes A1)

Parameters:

mode - the mode to use

See Also:

USE_A1_MODE, USE_R1C1_MODE

getMode

public short getMode()

get the reference mode to use (HSSF uses/assumes A1)

Returns:

mode to use

See Also:

USE_A1_MODE, USE_R1C1_MODE

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

clone

public Object clone()

Overrides:

clone in class Record