org.apache.poi.hssf.record
Class BoolErrRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.BoolErrRecord
All Implemented Interfaces:
CellValueRecordInterface

public final class BoolErrRecord
extends Record
implements CellValueRecordInterface

Creates new BoolErrRecord. (0x0205)

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
static short sid
           
 
Constructor Summary
BoolErrRecord()
          Creates new BoolErrRecord
BoolErrRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 boolean getBooleanValue()
          get the value for the cell
 short getColumn()
           
 byte getErrorValue()
          get the error value for the cell
 int getRecordSize()
          gives the current serialized size of the record.
 int getRow()
           
 short getSid()
          return the non static version of the id for this record.
 short getXFIndex()
          get the index to the ExtendedFormat
 boolean isBoolean()
          Indicates whether the call holds a boolean value
 boolean isError()
          Indicates whether the call holds an error value
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setColumn(short col)
           
 void setError(boolean val)
          manually indicate this is an error rather than a boolean
 void setRow(int row)
           
 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
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, 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

BoolErrRecord

public BoolErrRecord()
Creates new BoolErrRecord


BoolErrRecord

public BoolErrRecord(RecordInputStream in)
Parameters:
in - the RecordInputstream to read the record from
Method Detail

setRow

public void setRow(int row)
Specified by:
setRow in interface CellValueRecordInterface
Parameters:
row - the row this cell occurs within

setColumn

public void setColumn(short col)
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()
Specified by:
getRow in interface CellValueRecordInterface
Returns:
the row this cell occurs on

getColumn

public short getColumn()
Specified by:
getColumn in interface CellValueRecordInterface
Returns:
the column this cell defines within the row

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 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 RecordBase
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

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 java.lang.Object clone()
Overrides:
clone in class Record


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.