Package loci.poi.hssf.record
Class BOFRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.BOFRecord
Title: Beginning Of File
Description: Somewhat of a misnomer, its used for the beginning of a set of records that have a particular pupose or subject. Used in sheets and workbooks.
REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver, Jason Height (jheight at chariot dot net dot au)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortsuggested default 0x10d3static final shortsuggested default 0x07CC (1996)static final shortsuggested default for a normal sheet (0x41)static final shortfor BIFF8 files the BOF is 0x809.static final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortsuggested default (0x06 - BIFF8) -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an empty BOFRecord with no fields set.Constructs a BOFRecord and sets its fields appropriately -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortgetBuild()get the build that wrote this fileshortYear of the build that wrote this fileintget the history bit mask (not very useful)intgives the current serialized size of the record.intget the minimum version required to read this fileshortgetSid()return the non static version of the id for this record.shortgetType()type of object this marksshortVersion number - for BIFF8 should be 0x06intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetBuild(short build) build that wrote this filevoidsetBuildYear(short year) Year of the build that wrote this filevoidsetHistoryBitMask(int bitmask) set the history bit mask (not very useful)voidsetRequiredVersion(int version) set the minimum version required to read this filevoidsetType(short type) type of object this marksvoidsetVersion(short version) Version number - for BIFF8 should be 0x06toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(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
-
Field Details
-
sid
public static final short sidfor BIFF8 files the BOF is 0x809. For earlier versions it was 0x09 or 0x(biffversion)09- See Also:
-
VERSION
public static final short VERSIONsuggested default (0x06 - BIFF8)- See Also:
-
BUILD
public static final short BUILDsuggested default 0x10d3- See Also:
-
BUILD_YEAR
public static final short BUILD_YEARsuggested default 0x07CC (1996)- See Also:
-
HISTORY_MASK
public static final short HISTORY_MASKsuggested default for a normal sheet (0x41)- See Also:
-
TYPE_WORKBOOK
public static final short TYPE_WORKBOOK- See Also:
-
TYPE_VB_MODULE
public static final short TYPE_VB_MODULE- See Also:
-
TYPE_WORKSHEET
public static final short TYPE_WORKSHEET- See Also:
-
TYPE_CHART
public static final short TYPE_CHART- See Also:
-
TYPE_EXCEL_4_MACRO
public static final short TYPE_EXCEL_4_MACRO- See Also:
-
TYPE_WORKSPACE_FILE
public static final short TYPE_WORKSPACE_FILE- See Also:
-
-
Constructor Details
-
BOFRecord
public BOFRecord()Constructs an empty BOFRecord with no fields set. -
BOFRecord
Constructs a BOFRecord and sets its fields appropriately- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
setVersion
public void setVersion(short version) Version number - for BIFF8 should be 0x06- Parameters:
version- version to be set- See Also:
-
setType
public void setType(short type) type of object this marks- Parameters:
type- type to be set- See Also:
-
setBuild
public void setBuild(short build) build that wrote this file- Parameters:
build- build number to set- See Also:
-
setBuildYear
public void setBuildYear(short year) Year of the build that wrote this file- Parameters:
year- build year to set- See Also:
-
setHistoryBitMask
public void setHistoryBitMask(int bitmask) set the history bit mask (not very useful)- Parameters:
bitmask- bitmask to set for the history- See Also:
-
setRequiredVersion
public void setRequiredVersion(int version) set the minimum version required to read this file- Parameters:
version- version to set- See Also:
-
getVersion
public short getVersion()Version number - for BIFF8 should be 0x06- Returns:
- short version number of the generator of this file
- See Also:
-
getType
public short getType()type of object this marks- Returns:
- short type of object
- See Also:
-
getBuild
public short getBuild()get the build that wrote this file- Returns:
- short build number of the generator of this file
- See Also:
-
getBuildYear
public short getBuildYear()Year of the build that wrote this file- Returns:
- short build year of the generator of this file
- See Also:
-
getHistoryBitMask
public int getHistoryBitMask()get the history bit mask (not very useful)- Returns:
- int bitmask showing the history of the file (who cares!)
- See Also:
-
getRequiredVersion
public int getRequiredVersion()get the minimum version required to read this file- Returns:
- int least version that can read the file
- See Also:
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-