public Workbook() 
{

}

Creates new Workbook with no intitialization --useless right now

Also see:

createWorkbook(Record[])

 public int addSSTString(String string) 
{
        return addSSTString(string, false);
}

Adds a string to the SST table and returns its index (if its a duplicate just returns its index and update the counts) ASSUMES compressed unicode (meaning 8bit)

 public int addSSTString(String string,
    boolean use16bits) 
{
        log.debug((new StringBuffer("insert to sst string='")).append(string)
            .append("' and use16bits= ").append(use16bits));
        if (sst == null)
        {
            insertSST();
        }
        return sst.addString(string, use16bits);
}

Adds a string to the SST table and returns its index (if its a duplicate just returns its index and update the counts)

 protected Record createBOF() 
{
        BOFRecord retval = new BOFRecord();
        retval.setVersion(( short ) 0x600);
        retval.setType(( short ) 5);
        retval.setBuild(( short ) 0x10d3);
//        retval.setBuild((short)0x0dbb);        
        retval.setBuildYear(( short ) 1996);
        retval.setHistoryBitMask(0x41);   // was c1 before verify
        retval.setRequiredVersion(0x6);
        return retval;
}

creates the BOF record

 protected Record createBackup() 
{
        BackupRecord retval = new BackupRecord();
        retval.setBackup(
            ( short ) 0);   // by default DONT save backups of files...just loose data
        return retval;
}

creates the Backup record with backup set to 0. (loose the data, who cares)

 protected Record createBookBool() 
{
        BookBoolRecord retval = new BookBoolRecord();
        retval.setSaveLinkValues(( short ) 0);
        return retval;
}

creates the BookBool record with saveLinkValues set to 0. (don't save link values)

 protected Record createBoundSheet(int id) 
{
   // 1,2,3 sheets
        BoundSheetRecord retval = new BoundSheetRecord();
        switch (id)
        {
            case 0 :
                retval.setPositionOfBof(0x0);   // should be set later
                retval.setOptionFlags(( short ) 0);
                retval.setSheetnameLength(( byte ) 0x6);
                retval.setCompressedUnicodeFlag(( byte ) 0);
                retval.setSheetname("Sheet1");
                break;
            case 1 :
                retval.setPositionOfBof(0x0);   // should be set later
                retval.setOptionFlags(( short ) 0);
                retval.setSheetnameLength(( byte ) 0x6);
                retval.setCompressedUnicodeFlag(( byte ) 0);
                retval.setSheetname("Sheet2");
                break;
            case 2 :
                retval.setPositionOfBof(0x0);   // should be set later
                retval.setOptionFlags(( short ) 0);
                retval.setSheetnameLength(( byte ) 0x6);
                retval.setCompressedUnicodeFlag(( byte ) 0);
                retval.setSheetname("Sheet3");
                break;
        }
        return retval;
}

create a "bound sheet" or "bundlesheet" (depending who you ask) record Always sets the sheet's bof to 0. You'll need to set that yourself.

 public ExtendedFormatRecord createCellXF() 
{
        ExtendedFormatRecord xf = createExtendedFormat();
        ++xfpos;
        ++bspos;
        records.add(xfpos, xf);
        numxfs++;
        return xf;
}

creates a new Cell-type Extneded Format Record and adds it to the end of ExtendedFormatRecords collection

 protected Record createCodepage() 
{
        CodepageRecord retval = new CodepageRecord();
        retval.setCodepage(CODEPAGE);
        return retval;
}

creates the Codepage record containing the constant stored in CODEPAGE

 protected Record createCountry() 
{
   // what a novel idea, create your own!
        CountryRecord retval = new CountryRecord();
        retval.setDefaultCountry(( short ) 1);
        retval.setCurrentCountry(( short ) 1);
        return retval;
}

Creates the Country record with the default and current country set to 1

 protected Record createDSF() 
{
        DSFRecord retval = new DSFRecord();
        retval.setDsf(
            ( short ) 0);   // we don't even support double stream files
        return retval;
}

creates the DSF record containing a 0 since HSSF can't even create Dual Stream Files

 protected Record createDateWindow1904() 
{
        DateWindow1904Record retval = new DateWindow1904Record();
        retval.setWindowing(
            ( short ) 0);   // don't EVER use 1904 date windowing...tick tock..
        return retval;
}

creates the DateWindow1904 record with windowing set to 0. (don't window)

 protected Record createEOF() 
{
        return new EOFRecord();
}

creates the EOF record

 protected ExtendedFormatRecord createExtendedFormat() 
{
        ExtendedFormatRecord retval = new ExtendedFormatRecord();
        retval.setFontIndex(( short ) 0);
        retval.setFormatIndex(( short ) 0x0);
        retval.setCellOptions(( short ) 0x1);
        retval.setAlignmentOptions(( short ) 0x20);
        retval.setIndentionOptions(( short ) 0);
        retval.setBorderOptions(( short ) 0);
        retval.setPaletteOptions(( short ) 0);
        retval.setAdtlPaletteOptions(( short ) 0);
        retval.setFillPaletteOptions(( short ) 0x20c0);
        return retval;
}

creates an default cell type ExtendedFormatRecord object.

 protected Record createExtendedFormat(int id) 
{
   // we'll need multiple editions
        ExtendedFormatRecord retval = new ExtendedFormatRecord();
        switch (id)
        {
            case 0 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 1 :
                retval.setFontIndex(( short ) 1);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 2 :
                retval.setFontIndex(( short ) 1);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 3 :
                retval.setFontIndex(( short ) 2);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 4 :
                retval.setFontIndex(( short ) 2);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 5 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 6 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 7 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 8 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 9 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 10 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 11 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 12 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 13 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 14 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff400);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            // cell records
            case 15 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0);
                retval.setCellOptions(( short ) 0x1);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0x0);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            // style
            case 16 :
                retval.setFontIndex(( short ) 1);
                retval.setFormatIndex(( short ) 0x2b);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff800);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 17 :
                retval.setFontIndex(( short ) 1);
                retval.setFormatIndex(( short ) 0x29);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff800);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 18 :
                retval.setFontIndex(( short ) 1);
                retval.setFormatIndex(( short ) 0x2c);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff800);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 19 :
                retval.setFontIndex(( short ) 1);
                retval.setFormatIndex(( short ) 0x2a);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff800);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 20 :
                retval.setFontIndex(( short ) 1);
                retval.setFormatIndex(( short ) 0x9);
                retval.setCellOptions(( short ) 0xfffffff5);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0xfffff800);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            // unused from this point down
            case 21 :
                retval.setFontIndex(( short ) 5);
                retval.setFormatIndex(( short ) 0x0);
                retval.setCellOptions(( short ) 0x1);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0x800);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 22 :
                retval.setFontIndex(( short ) 6);
                retval.setFormatIndex(( short ) 0x0);
                retval.setCellOptions(( short ) 0x1);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0x5c00);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 23 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0x31);
                retval.setCellOptions(( short ) 0x1);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0x5c00);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 24 :
                retval.setFontIndex(( short ) 0);
                retval.setFormatIndex(( short ) 0x8);
                retval.setCellOptions(( short ) 0x1);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0x5c00);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
            case 25 :
                retval.setFontIndex(( short ) 6);
                retval.setFormatIndex(( short ) 0x8);
                retval.setCellOptions(( short ) 0x1);
                retval.setAlignmentOptions(( short ) 0x20);
                retval.setIndentionOptions(( short ) 0x5c00);
                retval.setBorderOptions(( short ) 0);
                retval.setPaletteOptions(( short ) 0);
                retval.setAdtlPaletteOptions(( short ) 0);
                retval.setFillPaletteOptions(( short ) 0x20c0);
                break;
        }
        return retval;
}

Creates an ExtendedFormatRecord object

 protected Record createExtendedSST() 
{
        ExtSSTRecord retval = new ExtSSTRecord();
        retval.setNumStringsPerBucket(( short ) 0x8);
        return retval;
}

Creates the ExtendedSST record with numstrings per bucket set to 0x8. HSSF doesn't yet know what to do with this thing, but we create it with nothing in it hardly just to make Excel happy and our sheets look like Excel's

 protected Record createFnGroupCount() 
{
        FnGroupCountRecord retval = new FnGroupCountRecord();
        retval.setCount(( short ) 14);
        return retval;
}

creates the FnGroupCount record containing the Magic number constant of 14.

 protected Record createFont() 
{
        FontRecord retval = new FontRecord();
        retval.setFontHeight(( short ) 0xc8);
        retval.setAttributes(( short ) 0x0);
        retval.setColorPaletteIndex(( short ) 0x7fff);
        retval.setBoldWeight(( short ) 0x190);
        retval.setFontNameLength(( byte ) 5);
        retval.setFontName("Arial");
        return retval;
}

creates a Font record with the following magic values:

fontheight = 0xc8

attributes = 0x0

color palette index = 0x7fff

bold weight = 0x190

Font Name Length = 5

Font Name = Arial

 protected Record createFormat(int id) 
{
   // we'll need multiple editions for
        FormatRecord retval = new FormatRecord();   // the differnt formats
        switch (id)
        {
            case 0 :
                retval.setIndexCode(( short ) 5);
                retval.setFormatStringLength(( byte ) 0x17);
                retval.setFormatString("\"$\"#,##0_);\\(\"$\"#,##0\\)");
                break;
            case 1 :
                retval.setIndexCode(( short ) 6);
                retval.setFormatStringLength(( byte ) 0x1c);
                retval.setFormatString("\"$\"#,##0_);[Red]\\(\"$\"#,##0\\)");
                break;
            case 2 :
                retval.setIndexCode(( short ) 7);
                retval.setFormatStringLength(( byte ) 0x1d);
                retval.setFormatString("\"$\"#,##0.00_);\\(\"$\"#,##0.00\\)");
                break;
            case 3 :
                retval.setIndexCode(( short ) 8);
                retval.setFormatStringLength(( byte ) 0x22);
                retval.setFormatString(
                    "\"$\"#,##0.00_);[Red]\\(\"$\"#,##0.00\\)");
                break;
            case 4 :
                retval.setIndexCode(( short ) 0x2a);
                retval.setFormatStringLength(( byte ) 0x32);
                retval.setFormatString(
                    "_(\"$\"* #,##0_);_(\"$\"* \\(#,##0\\);_(\"$\"* \"-\"_);_(@_)");
                break;
            case 5 :
                retval.setIndexCode(( short ) 0x29);
                retval.setFormatStringLength(( byte ) 0x29);
                retval.setFormatString(
                    "_(* #,##0_);_(* \\(#,##0\\);_(* \"-\"_);_(@_)");
                break;
            case 6 :
                retval.setIndexCode(( short ) 0x2c);
                retval.setFormatStringLength(( byte ) 0x3a);
                retval.setFormatString(
                    "_(\"$\"* #,##0.00_);_(\"$\"* \\(#,##0.00\\);_(\"$\"* \"-\"??_);_(@_)");
                break;
            case 7 :
                retval.setIndexCode(( short ) 0x2b);
                retval.setFormatStringLength(( byte ) 0x31);
                retval.setFormatString(
                    "_(* #,##0.00_);_(* \\(#,##0.00\\);_(* \"-\"??_);_(@_)");
                break;
        }
        return retval;
}

Creates a FormatRecord object

 protected Record createHideObj() 
{
        HideObjRecord retval = new HideObjRecord();
        retval.setHideObj(( short ) 0);   // by default set hide object off
        return retval;
}

creates the HideObj record with hide object set to 0. (don't hide)

 protected Record createInterfaceEnd() 
{
        return new InterfaceEndRecord();
}

creates the InterfaceEnd record

 protected Record createInterfaceHdr() 
{
        InterfaceHdrRecord retval = new InterfaceHdrRecord();
        retval.setCodepage(CODEPAGE);
        return retval;
}

creates the InterfaceHdr record

 protected Record createMMS() 
{
        MMSRecord retval = new MMSRecord();
        retval.setAddMenuCount(( byte ) 0);
        retval.setDelMenuCount(( byte ) 0);
        return retval;
}

creates an MMS record

 public FontRecord createNewFont() 
{
        FontRecord rec = ( FontRecord ) createFont();
        ++fontpos;
        ++bspos;
        ++xfpos;
        records.add(fontpos, rec);
        numfonts++;
        return rec;
}

creates a new font record and adds it to the "font table". This causes the boundsheets to move down one, extended formats to move down (so this function moves those pointers as well)

 protected Record createPassword() 
{
        PasswordRecord retval = new PasswordRecord();
        retval.setPassword(( short ) 0);   // no password by default!
        return retval;
}

creates the Password record with password set to 0.

 protected Record createPasswordRev4() 
{
        PasswordRev4Record retval = new PasswordRev4Record();
        retval.setPassword(( short ) 0);   // no password by default!
        return retval;
}

creates the PasswordRev4 record with password set to 0.

 protected Record createPrecision() 
{
        PrecisionRecord retval = new PrecisionRecord();
        retval.setFullPrecision(
            true);   // always use real numbers in calculations!
        return retval;
}

creates the Precision record with precision set to true. (full precision)

 protected Record createProtect() 
{
        ProtectRecord retval = new ProtectRecord();
        retval.setProtect(
            false);   // by default even when we support it we won't
        return retval;   // want it to be protected
}

creates the Protect record with protect set to false.

 protected Record createProtectionRev4() 
{
        ProtectionRev4Record retval = new ProtectionRev4Record();
        retval.setProtect(false);
        return retval;
}

creates the ProtectionRev4 record with protect set to false.

 protected Record createRefreshAll() 
{
        RefreshAllRecord retval = new RefreshAllRecord();
        retval.setRefreshAll(true);   // by default refresh the calculations on
        return retval;   // startup  -- differs from sample but seems
}

creates the RefreshAll record with refreshAll set to true. (refresh all calcs)

 protected Record createSST() 
{
        return new SSTRecord();
}

Creates the SST record with no strings and the unique/num string set to 0

 protected Record createStyle(int id) 
{
   // we'll need multiple editions
        StyleRecord retval = new StyleRecord();
        switch (id)
        {
            case 0 :
                retval.setIndex(( short ) 0xffff8010);
                retval.setBuiltin(( byte ) 3);
                retval.setOutlineStyleLevel(( byte ) 0xffffffff);
                break;
            case 1 :
                retval.setIndex(( short ) 0xffff8011);
                retval.setBuiltin(( byte ) 6);
                retval.setOutlineStyleLevel(( byte ) 0xffffffff);
                break;
            case 2 :
                retval.setIndex(( short ) 0xffff8012);
                retval.setBuiltin(( byte ) 4);
                retval.setOutlineStyleLevel(( byte ) 0xffffffff);
                break;
            case 3 :
                retval.setIndex(( short ) 0xffff8013);
                retval.setBuiltin(( byte ) 7);
                retval.setOutlineStyleLevel(( byte ) 0xffffffff);
                break;
            case 4 :
                retval.setIndex(( short ) 0xffff8000);
                retval.setBuiltin(( byte ) 0);
                retval.setOutlineStyleLevel(( byte ) 0xffffffff);
                break;
            case 5 :
                retval.setIndex(( short ) 0xffff8014);
                retval.setBuiltin(( byte ) 5);
                retval.setOutlineStyleLevel(( byte ) 0xffffffff);
                break;
        }
        return retval;
}

Creates a StyleRecord object

 protected Record createTabId() 
{
        TabIdRecord retval     = new TabIdRecord();
        short[]     tabidarray =
        {
            0
        };
        retval.setTabIdArray(tabidarray);
        return retval;
}

creates the TabId record containing an array of 0,1,2. This release of HSSF always has the default three sheets, no less, no more.

 protected Record createUseSelFS() 
{
        UseSelFSRecord retval = new UseSelFSRecord();
        retval.setFlag(( short ) 0);
        return retval;
}

Creates the UseSelFS object with the use natural language flag set to 0 (false)

 protected Record createWindowOne() 
{
        WindowOneRecord retval = new WindowOneRecord();
        retval.setHorizontalHold(( short ) 0x168);
        retval.setVerticalHold(( short ) 0x10e);
        retval.setWidth(( short ) 0x3a5c);
        retval.setHeight(( short ) 0x23be);
        retval.setOptions(( short ) 0x38);
        retval.setSelectedTab(( short ) 0x0);
        retval.setDisplayedTab(( short ) 0x0);
        retval.setNumSelectedTabs(( short ) 1);
        retval.setTabWidthRatio(( short ) 0x258);
        return retval;
}

creates the WindowOne record with the following magic values:

horizontal hold - 0x168

vertical hold - 0x10e

width - 0x3a5c

height - 0x23be

options - 0x38

selected tab - 0

displayed tab - 0

num selected tab- 0

tab width ratio - 0x258

 protected Record createWindowProtect() 
{
        WindowProtectRecord retval = new WindowProtectRecord();
        retval.setProtect(
            false);   // by default even when we support it we won't
        return retval;   // want it to be protected
}

creates the WindowProtect record with protect set to false.

 public static Workbook createWorkbook() 
{
        log.debug("creating new workbook from scratch");
        Workbook  retval  = new Workbook();
        ArrayList records = new ArrayList(30);
        records.add(retval.createBOF());
        records.add(retval.createInterfaceHdr());
        records.add(retval.createMMS());
        records.add(retval.createInterfaceEnd());
        records.add(retval.createWriteAccess());
        records.add(retval.createCodepage());
        records.add(retval.createDSF());
        records.add(retval.createTabId());
        retval.tabpos = records.size() - 1;
        records.add(retval.createFnGroupCount());
        records.add(retval.createWindowProtect());
        records.add(retval.createProtect());
        records.add(retval.createPassword());
        records.add(retval.createProtectionRev4());
        records.add(retval.createPasswordRev4());
        records.add(retval.createWindowOne());
        records.add(retval.createBackup());
        records.add(retval.createHideObj());
        records.add(retval.createDateWindow1904());
        records.add(retval.createPrecision());
        records.add(retval.createRefreshAll());
        records.add(retval.createBookBool());
        records.add(retval.createFont());
        records.add(retval.createFont());
        records.add(retval.createFont());
        records.add(retval.createFont());
        retval.fontpos  = records.size() - 1;   // last font record postion
        retval.numfonts = 4;
        records.add(retval.createFormat(0));
        records.add(retval.createFormat(1));
        records.add(retval.createFormat(2));
        records.add(retval.createFormat(3));
        records.add(retval.createFormat(4));
        records.add(retval.createFormat(5));
        records.add(retval.createFormat(6));
        records.add(retval.createFormat(7));
        for (int k = 0; k <  21; k++)
        {
            records.add(retval.createExtendedFormat(k));
            retval.numxfs++;
        }
        retval.xfpos = records.size() - 1;
        for (int k = 0; k <  6; k++)
        {
            records.add(retval.createStyle(k));
        }
        records.add(retval.createUseSelFS());
        for (int k = 0; k <  1; k++)
        {   // now just do 1
            BoundSheetRecord bsr =
                ( BoundSheetRecord ) retval.createBoundSheet(k);
            records.add(bsr);
            retval.boundsheets.add(bsr);
            retval.bspos = records.size() - 1;
        }
        records.add(retval.createCountry());
        retval.sst = ( SSTRecord ) retval.createSST();
        records.add(retval.sst);
        records.add(retval.createExtendedSST());
        // TODO
        records.add(retval.createEOF());
        retval.records = records;
        log.debug("exit create new workbook from scratch");
        return retval;
}

Creates an empty workbook object with three blank sheets and all the empty fields. Use this to create a workbook from scratch.

 public static Workbook createWorkbook(Record[] recs) 
{
        log.debug(
            (new StringBuffer(
                "Workbook (readfile) created with reclen=")).append(
                    recs.length));
        Workbook  retval  = new Workbook();
        ArrayList records = new ArrayList(recs.length / 3);
        for (int k = 0; k <  recs.length; k++)
        {
            Record rec = recs[ k ];
            if (rec.getSid() == EOFRecord.sid)
            {
                records.add(rec);
                log.debug((new StringBuffer("found workbook eof record at"))
                    .append(k));
                break;
            }
            switch (rec.getSid())
            {
                case BoundSheetRecord.sid :
                    log.debug((new StringBuffer("found boundsheet record at"))
                        .append(k));
                    retval.boundsheets.add(rec);
                    retval.bspos = k;
                    break;
                case SSTRecord.sid :
                    log.debug((new StringBuffer("found sst record at"))
                        .append(k));
                    retval.sst = ( SSTRecord ) rec;
                    break;
                case FontRecord.sid :
                    log.debug((new StringBuffer("found font record at"))
                        .append(k));
                    retval.fontpos = k;
                    retval.numfonts++;
                    break;
                case ExtendedFormatRecord.sid :
                    log.debug((new StringBuffer("found XF record at"))
                        .append(k));
                    retval.xfpos = k;
                    retval.numxfs++;
                    break;
                case TabIdRecord.sid :
                    log.debug((new StringBuffer("found tabid record at"))
                        .append(k));
                    retval.tabpos = k;
                    break;
                default :
            }
            records.add(rec);
        }
        retval.records = records;
        log.debug("exit create workbook from existing file function");
        return retval;
}

read support for low level API. Pass in an array of Record objects, A Workbook object is constructed and passed back with all of its initialization set to the passed in records and references to those records held. Unlike Sheet workbook does not use an offset (its assumed to be 0) since its first in a file. If you need an offset then construct a new array with a 0 offset or write your own ;-p.

 protected Record createWriteAccess() 
{
        WriteAccessRecord retval = new WriteAccessRecord();
        retval.setUsername(System.getProperty("user.name"));
        return retval;
}

creates the WriteAccess record containing the logged in user's name

 public ExtendedFormatRecord getExFormatAt(int index) 
{
        int xfptr = xfpos - (numxfs - 1);
        xfptr += index;
        ExtendedFormatRecord retval =
            ( ExtendedFormatRecord ) records.get(xfptr);
        return retval;
}

gets the ExtendedFormatRecord at the given 0-based index

 public FontRecord getFontRecordAt(int idx) 
{
        int index = idx;
        if (index  > 4)
        {
            index -= 1;   // adjust for "There is no 4"
        }
        if (index  > (numfonts - 1))
        {
            throw new ArrayIndexOutOfBoundsException(
                "There are only " + numfonts
                + " font records, you asked for " + idx);
        }
        FontRecord retval =
            ( FontRecord ) records.get((fontpos - (numfonts - 1)) + index);
        return retval;
}

gets the font record at the given index in the font table. Remember "There is No Four" (someone at M$ must have gone to Rocky Horror one too many times)

 public int getNumExFormats() 
{
        log.debug((new StringBuffer("getXF=")).append(boundsheets.size()));
        return numxfs;
}

get the number of ExtendedFormat records contained in this workbook.

 public int getNumRecords() 
{
        return records.size();
}

 public int getNumSheets() 
{
        log.debug((new StringBuffer("getNumSheets="))
            .append(boundsheets.size()));
        return boundsheets.size();
}

returns the number of boundsheet objects contained in this workbook.

 public int getNumberOfFontRecords() 
{
        return numfonts;
}

gets the number of font records

 public String getSSTString(int str) 
{
        if (sst == null)
        {
            insertSST();
        }
        String retval = sst.getString(str);
        log.debug((new StringBuffer("Returning SST for index=")).append(str)
            .append(" String= ").append(retval));
        return retval;
}

given an index into the SST table, this function returns the corresponding String value

 public String getSheetName(int sheetnum) 
{
        return (( BoundSheetRecord ) boundsheets.get(sheetnum))
            .getSheetname();
}

gets the name for a given sheet.

 public  void insertSST() 
{
        log.debug("creating new SST via insertSST!");
        sst = ( SSTRecord ) createSST();
        records.add(records.size() - 1, createExtendedSST());
        records.add(records.size() - 2, sst);
}

use this function to add a Shared String Table to an existing sheet (say generated by a different java api) without an sst....

 public  void removeSheet(int sheetnum) 
{
        if (boundsheets.size()  > sheetnum)
        {
            records.remove(bspos - (boundsheets.size() - 1) + sheetnum);
            bspos--;
            boundsheets.remove(sheetnum);
            fixTabIdRecord();
        }
}

 public byte[] serialize() 
{
        log.debug("Serializing Workbook!");
        byte[]    retval    = null;
        ArrayList bytes     = new ArrayList(4096);
        int       arraysize = 0;
        int       pos       = 0;
        for (int k = 0; k <  records.size(); k++)
        {
            bytes.add((( Record ) records.get(k)).serialize());
            // byte[] temp = (byte[])bytes.get(bytes.size() -1 );
            // try {
            // util.HexDump.dump(temp, (long)0,(OutputStream)System.out,0);
            // } catch (Exception e) {
            // e.printStackTrace();
            // }
        }
        for (int k = 0; k <  bytes.size(); k++)
        {
            arraysize += (( byte [] ) bytes.get(k)).length;
        }
        retval = new byte[ arraysize ];
        for (int k = 0; k <  bytes.size(); k++)
        {
            byte[] rec = (( byte [] ) bytes.get(k));
            System.arraycopy(rec, 0, retval, pos, rec.length);
            pos += rec.length;
        }
        log.debug("Exiting serialize workbook");
        return retval;
}

Serializes all records int the worksheet section into a big byte array. Use this to write the Workbook out.

 public  void setSheetBof(int sheetnum,
    int pos) 
{
        log.debug((new StringBuffer("setting bof for sheetnum ="))
            .append(sheetnum).append(" at pos=").append(pos));
        checkSheets(sheetnum);
        (( BoundSheetRecord ) boundsheets.get(sheetnum))
            .setPositionOfBof(pos);
}

Sets the BOF for a given sheet

 public  void setSheetName(int sheetnum,
    String sheetname) 
{
        checkSheets(sheetnum);
        (( BoundSheetRecord ) boundsheets.get(sheetnum))
            .setSheetname(sheetname);
        (( BoundSheetRecord ) boundsheets.get(sheetnum))
            .setSheetnameLength(( byte ) sheetname.length());
}

sets the name for a given sheet. If the boundsheet record doesn't exist and its only one more than we have, go ahead and create it. If its > 1 more than we have, except