jxl.read.biff
Class BOFRecord

java.lang.Object
  |
  +--jxl.biff.RecordData
        |
        +--jxl.read.biff.BOFRecord

public class BOFRecord

extends RecordData

A Beginning Of File record, found at the commencement of all substreams within a biff8 file

Field Summary

private static int	Biff7 The code used for biff8 files
private static int	Biff8 The code used for biff8 files
private static int	Chart The code used for charts
private static int	MacroSheet The code used for macro sheets
private int	substreamType The type of this substream
private int	version The biff version of this substream
private static int	WorkbookGlobals The code used for workbook globals
private static int	Worksheet The code used for worksheets

Fields inherited from class jxl.biff.RecordData

code, record

Constructor Summary

(package private)

BOFRecord(Record t) Constructs this object from the raw data

Method Summary

(package private) int	getLength() Gets the length of the data portion of this record Used to adjust when reading sheets which contain just a chart
boolean	isBiff7() Interrogates this object to see if it is a biff7 substream
boolean	isBiff8() Interrogates this object to see if it is a biff8 substream
boolean	isChart() Interrogates the substream to see if it is a chart
boolean	isMacroSheet() Interrogates the substream to see if it is the commencement of a worksheet
(package private) boolean	isWorkbookGlobals() Interrogates this substream to see if it represents the commencement of the workbook globals substream
boolean	isWorksheet() Interrogates the substream to see if it is the commencement of a worksheet

Methods inherited from class jxl.biff.RecordData

getCode, getRecord

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

Biff8

private static final int Biff8

The code used for biff8 files

Biff7

private static final int Biff7

The code used for biff8 files

WorkbookGlobals

private static final int WorkbookGlobals

The code used for workbook globals

Worksheet

private static final int Worksheet

The code used for worksheets

Chart

private static final int Chart

The code used for charts

MacroSheet

private static final int MacroSheet

The code used for macro sheets

version

private int version

The biff version of this substream

substreamType

private int substreamType

The type of this substream

Constructor Detail

BOFRecord

BOFRecord(Record t)

Constructs this object from the raw data

Parameters:

t - the raw data

Method Detail

isBiff8

public boolean isBiff8()

Interrogates this object to see if it is a biff8 substream

Returns:

TRUE if this substream is biff8, false otherwise

isBiff7

public boolean isBiff7()

Interrogates this object to see if it is a biff7 substream

Returns:

TRUE if this substream is biff7, false otherwise

isWorkbookGlobals

boolean isWorkbookGlobals()

Interrogates this substream to see if it represents the commencement of the workbook globals substream

Returns:

TRUE if this is the commencement of a workbook globals substream, FALSE otherwise

isWorksheet

public boolean isWorksheet()

Interrogates the substream to see if it is the commencement of a worksheet

Returns:

TRUE if this substream is the beginning of a worksheet, FALSE otherwise

isMacroSheet

public boolean isMacroSheet()

Interrogates the substream to see if it is the commencement of a worksheet

Returns:

TRUE if this substream is the beginning of a worksheet, FALSE otherwise

isChart

public boolean isChart()

Interrogates the substream to see if it is a chart

Returns:

TRUE if this substream is the beginning of a worksheet, FALSE otherwise

getLength

int getLength()

Gets the length of the data portion of this record Used to adjust when reading sheets which contain just a chart

Returns:

the length of the data portion of this record