|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.record.Record | +--org.apache.poi.hssf.record.BoundSheetRecord
Title: Bound Sheet Record (aka BundleSheet)
Description: Defines a sheet within a workbook. Basically stores the sheetname and tells where the Beginning of file record is within the HSSF file.
REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
static short |
sid
|
Constructor Summary | |
BoundSheetRecord()
|
|
BoundSheetRecord(short id,
short size,
byte[] data)
Constructs a BoundSheetRecord and sets its fields appropriately |
|
BoundSheetRecord(short id,
short size,
byte[] data,
int offset)
Constructs a BoundSheetRecord and sets its fields appropriately |
Method Summary | |
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
byte |
getCompressedUnicodeFlag()
get whether or not to interperate the Sheetname as compressed unicode (8/16 bit) (This is undocumented but can be found as Q187919 on the Microsoft(tm) Support site) |
short |
getOptionFlags()
get the option flags (unimportant for HSSF supported sheets) |
int |
getPositionOfBof()
get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file |
int |
getRecordSize()
gives the current serialized size of the record. |
java.lang.String |
getSheetname()
get the sheetname for this sheet. |
byte |
getSheetnameLength()
get the length of the sheetname in characters |
short |
getSid()
return the non static version of the id for this record. |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setCompressedUnicodeFlag(byte flag)
set whether or not to interperate the Sheetname as compressed unicode (8/16 bit) (This is undocumented but can be found as Q187919 on the Microsoft(tm) Support site) |
void |
setOptionFlags(short flags)
set the option flags (unimportant for HSSF supported sheets) |
void |
setPositionOfBof(int pos)
set the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file |
void |
setSheetname(java.lang.String sheetname)
Set the sheetname for this sheet. |
void |
setSheetnameLength(byte len)
Set the length of the sheetname in characters |
java.lang.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 org.apache.poi.hssf.record.Record |
fillFields, isInValueSection, isValue, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public BoundSheetRecord()
public BoundSheetRecord(short id, short size, byte[] data)
id
- id must be 0x85 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)public BoundSheetRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x85 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record's dataMethod Detail |
protected void validateSid(short id)
Record
validateSid
in class Record
org.apache.poi.hssf.record.Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
org.apache.poi.hssf.record.Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public void setPositionOfBof(int pos)
pos
- offset in bytespublic void setOptionFlags(short flags)
flags
- to setpublic void setSheetnameLength(byte len)
len
- number of characters in the sheet namesetSheetname(String)
public void setCompressedUnicodeFlag(byte flag)
flag
- (0/1) 0- compressed, 1 - uncompressed (16-bit)public void setSheetname(java.lang.String sheetname)
sheetname
- the name of the sheetpublic int getPositionOfBof()
public short getOptionFlags()
public byte getSheetnameLength()
getSheetname()
public byte getCompressedUnicodeFlag()
public java.lang.String getSheetname()
public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
Record
serialize
in class Record
org.apache.poi.hssf.record.Record
offset
- to begin writing atdata
- byte array containing instance datapublic int getRecordSize()
Record
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |