* 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)
* @author Andrew C. Oliver (acoliver at apache dot org) * @author Sergei Kozello (sergeikozello at mail.ru) * @version 2.0-pre */ public class BoundSheetRecord extends Record { public final static short sid = 0x85; private int field_1_position_of_BOF; private short field_2_option_flags; private byte field_3_sheetname_length; private byte field_4_compressed_unicode_flag; // not documented private String field_5_sheetname; public BoundSheetRecord() { } /** * Constructs a BoundSheetRecord and sets its fields appropriately * * @param id id must be 0x85 or an exception will be throw upon validation * @param size the size of the data area of the record * @param data data of the record (should not contain sid/len) */ public BoundSheetRecord(short id, short size, byte[] data) { super(id, size, data); } /** * Constructs a BoundSheetRecord and sets its fields appropriately * * @param id id must be 0x85 or an exception will be throw upon validation * @param size the size of the data area of the record * @param data data of the record (should not contain sid/len) * @param offset of the record's data */ public BoundSheetRecord(short id, short size, byte[] data, int offset) { super(id, size, data, offset); } protected void validateSid(short id) { if (id != sid) { throw new RecordFormatException("NOT A Bound Sheet RECORD"); } } /** * UTF8: * sid + len + bof + flags + len(str) + unicode + str * 2 + 2 + 4 + 2 + 1 + 1 + len(str) * * UNICODE: * sid + len + bof + flags + len(str) + unicode + str * 2 + 2 + 4 + 2 + 1 + 1 + 2 * len(str) * */ protected void fillFields(byte[] data, short size, int offset) { field_1_position_of_BOF = LittleEndian.getInt(data, 0 + offset); // bof field_2_option_flags = LittleEndian.getShort(data, 4 + offset); // flags field_3_sheetname_length = data[6 + offset]; // len(str) field_4_compressed_unicode_flag = data[7 + offset]; // unicode int nameLength = LittleEndian.ubyteToInt(field_3_sheetname_length); if ((field_4_compressed_unicode_flag & 0x01) == 1) { field_5_sheetname = StringUtil.getFromUnicodeHigh(data, 8 + offset, nameLength); } else { field_5_sheetname = new String(data, 8 + offset, nameLength); } } /** * set the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file * * @param pos offset in bytes */ public void setPositionOfBof(int pos) { field_1_position_of_BOF = pos; } /** * set the option flags (unimportant for HSSF supported sheets) * * @param flags to set */ public void setOptionFlags(short flags) { field_2_option_flags = flags; } /** * Set the length of the sheetname in characters * * @param len number of characters in the sheet name * @see #setSheetname(String) */ public void setSheetnameLength(byte len) { field_3_sheetname_length = len; } /** * 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) * @param flag (0/1) 0- compressed, 1 - uncompressed (16-bit) */ public void setCompressedUnicodeFlag(byte flag) { // field_4_compressed_unicode_flag = flag; } /** * Set the sheetname for this sheet. (this appears in the tabs at the bottom) * @param sheetname the name of the sheet */ public void setSheetname(String sheetname) { field_5_sheetname = sheetname; field_4_compressed_unicode_flag = (byte) 1; } /** * get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file * * @return offset in bytes */ public int getPositionOfBof() { return field_1_position_of_BOF; } /** * get the option flags (unimportant for HSSF supported sheets) * * @return flags to set */ public short getOptionFlags() { return field_2_option_flags; } /** * get the length of the sheetname in characters * * @return number of characters in the sheet name * @see #getSheetname() */ public byte getSheetnameLength() { return field_3_sheetname_length; } /** * get the length of the raw sheetname in characters * the length depends on the unicode flag * * @return number of characters in the raw sheet name */ public byte getRawSheetnameLength() { return (byte) (((field_4_compressed_unicode_flag & 0x01) == 1) ? 2 * field_3_sheetname_length : field_3_sheetname_length); } /** * 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) * @return flag (0/1) 0- compressed, 1 - uncompressed (16-bit) */ public byte getCompressedUnicodeFlag() { return field_4_compressed_unicode_flag; } /** * get the sheetname for this sheet. (this appears in the tabs at the bottom) * @return sheetname the name of the sheet */ public String getSheetname() { return field_5_sheetname; } public String toString() { StringBuffer buffer = new StringBuffer(); buffer.append("[BOUNDSHEET]\n"); buffer .append(" .bof = ") .append(Integer.toHexString(getPositionOfBof())) .append("\n"); buffer .append(" .optionflags = ") .append(Integer.toHexString(getOptionFlags())) .append("\n"); buffer .append(" .sheetname length= ") .append(Integer.toHexString(getSheetnameLength())) .append("\n"); buffer .append(" .unicodeflag = ") .append(Integer.toHexString(getCompressedUnicodeFlag())) .append("\n"); buffer.append(" .sheetname = ").append(getSheetname()).append( "\n"); buffer.append("[/BOUNDSHEET]\n"); return buffer.toString(); } public int serialize(int offset, byte[] data) { LittleEndian.putShort(data, 0 + offset, sid); LittleEndian.putShort( data, 2 + offset, (short) (8 + getRawSheetnameLength())); LittleEndian.putInt(data, 4 + offset, getPositionOfBof()); LittleEndian.putShort(data, 8 + offset, getOptionFlags()); data[10 + offset] = (byte) (getSheetnameLength()); data[11 + offset] = getCompressedUnicodeFlag(); if ((field_4_compressed_unicode_flag & 0x01) == 1) StringUtil.putUncompressedUnicode( getSheetname(), data, 12 + offset); else StringUtil.putCompressedUnicode(getSheetname(), data, 12 + offset); return getRecordSize(); } public int getRecordSize() { // Includes sid length + size length return 12 + getRawSheetnameLength(); } public short getSid() { return this.sid; } }