loci.poi.hssf.record

Class BoolErrRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.poi.hssf.record.BoolErrRecord

All Implemented Interfaces:

Comparable, CellValueRecordInterface

public class BoolErrRecord
extends Record
implements CellValueRecordInterface, Comparable

Creates new BoolErrRecord.

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

Version:

2.0-pre

Author:

Michael P. Harhen, Jason Height (jheight at chariot dot net dot au)

Field Summary

Fields

Modifier and Type	Field and Description
private int	field_1_row
private short	field_2_column
private short	field_3_xf_index
private byte	field_4_bBoolErr
private byte	field_5_fError
static short	sid

Constructor Summary

Constructors

Constructor and Description
BoolErrRecord() Creates new BoolErrRecord
BoolErrRecord(RecordInputStream in) Constructs a BoolErr record and sets its fields appropriately.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
int	compareTo(Object obj)
boolean	equals(Object obj)
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
boolean	getBooleanValue() get the value for the cell
short	getColumn() get the column this cell defines within the row
byte	getErrorValue() get the error value for the cell
int	getRecordSize() gives the current serialized size of the record.
int	getRow() get the row this cell occurs on
short	getSid() return the non static version of the id for this record.
short	getXFIndex() get the index to the ExtendedFormat
boolean	isAfter(CellValueRecordInterface i) returns whether this cell is after the passed in cell
boolean	isBefore(CellValueRecordInterface i) returns whether this cell is before the passed in cell
boolean	isBoolean() Indicates whether the call holds a boolean value
boolean	isEqual(CellValueRecordInterface i) returns whether this cell represents the same cell (NOT VALUE)
boolean	isError() Indicates whether the call holds an error value
boolean	isInValueSection() DBCELL, ROW, VALUES all say yes
boolean	isValue() tells whether this type of record contains a value
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setColumn(short col) set the column this cell defines within the row
void	setError(boolean val) manually indicate this is an error rather than a boolean
void	setRow(int row) set the row this cell occurs on
void	setValue(boolean value) set the boolean value for the cell
void	setValue(byte value) set the error value for the cell
void	setXFIndex(short xf) set the index to the ExtendedFormat
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

serialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

field_1_row

private int field_1_row

field_2_column

private short field_2_column

field_3_xf_index

private short field_3_xf_index

field_4_bBoolErr

private byte field_4_bBoolErr

field_5_fError

private byte field_5_fError

Constructor Detail

BoolErrRecord

public BoolErrRecord()

Creates new BoolErrRecord

BoolErrRecord

public BoolErrRecord(RecordInputStream in)

Constructs a BoolErr record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

Method Detail

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

setRow

public void setRow(int row)

Description copied from interface: CellValueRecordInterface

set the row this cell occurs on

Specified by:

setRow in interface CellValueRecordInterface

Parameters:

row - the row this cell occurs within

setColumn

public void setColumn(short col)

Description copied from interface: CellValueRecordInterface

set the column this cell defines within the row

Specified by:

setColumn in interface CellValueRecordInterface

Parameters:

col - the column this cell defines

setXFIndex

public void setXFIndex(short xf)

set the index to the ExtendedFormat

Specified by:

setXFIndex in interface CellValueRecordInterface

Parameters:

xf - index to the XF record

See Also:

ExtendedFormatRecord

setValue

public void setValue(boolean value)

set the boolean value for the cell

Parameters:

value - representing the boolean value

setValue

public void setValue(byte value)

set the error value for the cell

Parameters:

value - error representing the error value this value can only be 0,7,15,23,29,36 or 42 see bugzilla bug 16560 for an explanation

getRow

public int getRow()

Description copied from interface: CellValueRecordInterface

get the row this cell occurs on

Specified by:

getRow in interface CellValueRecordInterface

Returns:

the row

getColumn

public short getColumn()

Description copied from interface: CellValueRecordInterface

get the column this cell defines within the row

Specified by:

getColumn in interface CellValueRecordInterface

Returns:

the column

getXFIndex

public short getXFIndex()

get the index to the ExtendedFormat

Specified by:

getXFIndex in interface CellValueRecordInterface

Returns:

index to the XF record

See Also:

ExtendedFormatRecord

getBooleanValue

public boolean getBooleanValue()

get the value for the cell

Returns:

boolean representing the boolean value

getErrorValue

public byte getErrorValue()

get the error value for the cell

Returns:

byte representing the error value

isBoolean

public boolean isBoolean()

Indicates whether the call holds a boolean value

Returns:

boolean true if the cell holds a boolean value

setError

public void setError(boolean val)

manually indicate this is an error rather than a boolean

isError

public boolean isError()

Indicates whether the call holds an error value

Returns:

boolean true if the cell holds an error value

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)

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:

byte array containing instance data

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

validateSid

protected void validateSid(short id)

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

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

isBefore

public boolean isBefore(CellValueRecordInterface i)

Description copied from interface: CellValueRecordInterface

returns whether this cell is before the passed in cell

Specified by:

isBefore in interface CellValueRecordInterface

Parameters:

i - another cell interface record to compare

Returns:

true if the cells is before, or false if not

isAfter

public boolean isAfter(CellValueRecordInterface i)

Description copied from interface: CellValueRecordInterface

returns whether this cell is after the passed in cell

Specified by:

isAfter in interface CellValueRecordInterface

Parameters:

i - record to compare

Returns:

true if the cell is after, false if not

isEqual

public boolean isEqual(CellValueRecordInterface i)

Description copied from interface: CellValueRecordInterface

returns whether this cell represents the same cell (NOT VALUE)

Specified by:

isEqual in interface CellValueRecordInterface

Parameters:

i - record to compare

Returns:

true if the cells are the same cell (positionally), false if not.

isInValueSection

public boolean isInValueSection()

Description copied from class: Record

DBCELL, ROW, VALUES all say yes

Overrides:

isInValueSection in class Record

isValue

public boolean isValue()

Description copied from class: Record

tells whether this type of record contains a value

Overrides:

isValue in class Record

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Object clone()

Specified by:

clone in interface CellValueRecordInterface

Overrides:

clone in class Record