<!-- Don't forget to update status.xml too! -->

<release version="3.1-beta2" date="2008-05-??">

<action dev="POI-DEVELOPERS" type="fix">44675 - Parameter operand classes (function metadata) required to encode SUM() etc properly. Added parse validation for number of parameters</action>

<action dev="POI-DEVELOPERS" type="fix">44921 - allow Ptg.writeBytes() to be called on relative ref Ptgs (RefN* and AreaN*)</action>

<action dev="POI-DEVELOPERS" type="fix">44914 - Fix/suppress warning message "WARN. Unread n bytes of record 0xNN"</action>

<!-- Don't forget to update changes.xml too! -->

<changes>

<release version="3.1-beta2" date="2008-05-??">

<action dev="POI-DEVELOPERS" type="fix">44675 - Parameter operand classes (function metadata) required to encode SUM() etc properly. Added parse validation for number of parameters</action>

<action dev="POI-DEVELOPERS" type="fix">44921 - allow Ptg.writeBytes() to be called on relative ref Ptgs (RefN* and AreaN*)</action>

<action dev="POI-DEVELOPERS" type="fix">44914 - Fix/suppress warning message "WARN. Unread n bytes of record 0xNN"</action>

public HSSFWorkbook(POIFSFileSystem fs, boolean preserveNodes)

throws IOException

{

}

/**

* given a POI POIFSFileSystem object, and a specific directory

* within it, read in its Workbook and populate the high and

public HSSFWorkbook(DirectoryNode directory, POIFSFileSystem fs, boolean preserveNodes)

throws IOException

{

this.preserveNodes = preserveNodes;

// If we're not preserving nodes, don't track the

// POIFS any more

if(! preserveNodes) {

sheets = new ArrayList(INITIAL_CAPACITY);

names = new ArrayList(INITIAL_CAPACITY);

// Grab the data from the workbook stream, however

InputStream stream = directory.createDocumentInputStream(workbookName);

EventRecordFactory factory = new EventRecordFactory();

int sheetNum = 0;

// convert all LabelRecord records to LabelSSTRecord

while (recOffset < records.size())

{

Sheet sheet = Sheet.createSheet(records, sheetNum++, recOffset );

// none currently

}

/**

* This is basically a kludge to deal with the now obsolete Label records. If

* you have to read in a sheet that contains Label records, be aware that the rest

* @see org.apache.poi.hssf.record.LabelSSTRecord

* @see org.apache.poi.hssf.record.SSTRecord

*/

private void convertLabelRecords(List records, int offset)

{

if (log.check( POILogger.DEBUG ))

if (log.check( POILogger.DEBUG ))

log.log(POILogger.DEBUG, "convertLabelRecords exit");

}

/**

* sets the order of appearance for a given sheet.

sheets.add(pos,sheets.remove(getSheetIndex(sheetname)));

workbook.setSheetOrder(sheetname, pos);

}

/**

* sets the tab whose data is actually seen when the sheet is opened.

* This may be different from the "selected sheet" since excel seems to

public void setSelectedTab(short index) {

workbook.getWindowOne().setSelectedTab(index);

}

/**

* gets the tab whose data is actually seen when the sheet is opened.

* This may be different from the "selected sheet" since excel seems to

public short getSelectedTab() {

return workbook.getWindowOne().getSelectedTab();

}

/**

* sets the first tab that is displayed in the list of tabs

* in excel.

public void setDisplayedTab(short index) {

workbook.getWindowOne().setDisplayedTab(index);

}

/**

* sets the first tab that is displayed in the list of tabs

* in excel.

/**

* Will throw IllegalArgumentException if the name is greater than 31 chars

* or contains /\?*[]

* @param sheet number (0 based)

{

throw new RuntimeException("Sheet out of bounds");

}

workbook.setSheetName( sheet, name);

}

/**

* set the sheet name forcing the encoding. Forcing the encoding IS A BAD IDEA!!!

* @deprecated 3-Jan-2006 POI now automatically detects unicode and sets the encoding

* @throws IllegalArgumentException if the name is greater than 31 chars

* or contains /\?*[]

* @param sheet number (0 based)

public void setSheetName( int sheet, String name, short encoding )

{

if (workbook.doesContainsSheetName( name, sheet ))

/**

* Hide or unhide a sheet

* @param sheetnum The sheet number

* @param hidden True to mark the sheet as hidden, false otherwise

*/

}

workbook.setSheetHidden(sheet,hidden);

}

/*

* get the sheet's index

* @param name sheet name

*/

public int getSheetIndex(HSSFSheet sheet)

{

/**

* Returns the external sheet index of the sheet

* with the given internal index, creating one

* if needed.

* named range things.

*/

public short getExternalSheetIndex(int internalSheetIndex) {

}

/**

sheets.add(clonedSheet);

int i=1;

while (true) {

workbook.setSheetName(sheets.size()-1, name);

break;

}

return clonedSheet;

}

}

return retval;

}

public SheetReferences getSheetReferences() {

}

/**

{

return index;

}

index++;

}

// For tracking what we've written out, used if we're

// going to be preserving nodes

List excepts = new ArrayList(1);

// Write out the Workbook stream

fs.createDocument(new ByteArrayInputStream(bytes), "Workbook");

// Write out our HPFS properties, if we have them

writeProperties(fs, excepts);

if (preserveNodes) {

excepts.add("Workbook");

excepts.add("WORKBOOK");

copyNodes(this.filesystem,fs,excepts);

}

fs.writeFilesystem(stream);

return result;

}

/**

* TODO - make this less cryptic / move elsewhere

* @param refIndex Index to REF entry in EXTERNSHEET record in the Link Table

* @return the string representation of the defined or external name

*/

public String resolveNameXText(int refIndex, int definedNameIndex) {

}

//adding one here because 0 indicates a global named region; doesnt make sense for print areas

/**

* Delete the printarea for the sheet specified

* @param sheetIndex Zero-based sheet index (0 = First Sheet)

*/

public void removePrintArea(int sheetIndex) {

}

/** creates a new named range and add it to the model

/** gets the named range index by his name

* <i>Note:</i>Excel named ranges are case-insensitive and

* this method performs a case-insensitive search.

* @param name named range name

* @return named range index

*/

* @see org.apache.poi.hssf.record.Record

*/

public HSSFDataFormat createDataFormat() {

}

/** remove the named range by his name

* Is the workbook protected with a password (not encrypted)?

*/

public boolean isWriteProtected() {

}

/**

* protect a workbook with a password (not encypted, just sets writeprotect

* flags and the password.