Package org.apache.poi.hssf.record
Class BOFRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.BOFRecord
- All Implemented Interfaces:
Cloneable
Title: Beginning Of File (0x0809)
Description: Somewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject. Used in sheets and workbooks.
REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Author:
- Andrew C. Oliver, Jason Height (jheight at chariot dot net dot au)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
static final short
static final short
static final short
static final int
suggested default 0x10d3static final int
suggested default 0x07CC (1996)static final int
suggested default for a normal sheet (0x41)static final short
for BIFF8 files the BOF is 0x809.static final int
static final int
static final int
static final int
static final int
static final int
static final int
suggested default (0x0600 - BIFF8) -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an empty BOFRecord with no fields set. -
Method Summary
Modifier and TypeMethodDescriptionclone()
static BOFRecord
int
getBuild()
get the build that wrote this fileint
Year of the build that wrote this fileprotected int
int
get the history bit mask (not very useful)int
get the minimum version required to read this fileshort
getSid()
return the non static version of the id for this record.int
getType()
type of object this marksint
Version number - for BIFF8 should be 0x06void
Write the data content of this BIFF record.void
setBuild
(int build) build that wrote this filevoid
setBuildYear
(int year) Year of the build that wrote this filevoid
setHistoryBitMask
(int bitmask) set the history bit mask (not very useful)void
setRequiredVersion
(int version) set the minimum version required to read this filevoid
setType
(int type) type of object this marksvoid
setVersion
(int version) Version number - for BIFF8 should be 0x06toString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
biff2_sid
public static final short biff2_sid- See Also:
-
biff3_sid
public static final short biff3_sid- See Also:
-
biff4_sid
public static final short biff4_sid- See Also:
-
biff5_sid
public static final short biff5_sid- See Also:
-
VERSION
public static final int VERSIONsuggested default (0x0600 - BIFF8)- See Also:
-
BUILD
public static final int BUILDsuggested default 0x10d3- See Also:
-
BUILD_YEAR
public static final int BUILD_YEARsuggested default 0x07CC (1996)- See Also:
-
HISTORY_MASK
public static final int HISTORY_MASKsuggested default for a normal sheet (0x41)- See Also:
-
TYPE_WORKBOOK
public static final int TYPE_WORKBOOK- See Also:
-
TYPE_VB_MODULE
public static final int TYPE_VB_MODULE- See Also:
-
TYPE_WORKSHEET
public static final int TYPE_WORKSHEET- See Also:
-
TYPE_CHART
public static final int TYPE_CHART- See Also:
-
TYPE_EXCEL_4_MACRO
public static final int TYPE_EXCEL_4_MACRO- See Also:
-
TYPE_WORKSPACE_FILE
public static final int TYPE_WORKSPACE_FILE- See Also:
-
-
Constructor Details
-
BOFRecord
public BOFRecord()Constructs an empty BOFRecord with no fields set. -
BOFRecord
-
-
Method Details
-
createSheetBOF
-
setVersion
public void setVersion(int version) Version number - for BIFF8 should be 0x06- Parameters:
version
- version to be set- See Also:
-
setType
public void setType(int type) type of object this marks- Parameters:
type
- type to be set- See Also:
-
setBuild
public void setBuild(int build) build that wrote this file- Parameters:
build
- build number to set- See Also:
-
setBuildYear
public void setBuildYear(int 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 int getVersion()Version number - for BIFF8 should be 0x06- Returns:
- version number of the generator of this file
- See Also:
-
getType
public int getType()type of object this marks- Returns:
- type of object
- See Also:
-
getBuild
public int getBuild()get the build that wrote this file- Returns:
- short build number of the generator of this file
- See Also:
-
getBuildYear
public int 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:Record
get a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-