See OOO excelfileformat.pdf sec 4.4 'Page Settings Block' @author Josh Micich RecordAggregates are groups of of BIFF Records that are typically stored together and/or updated together. Workbook / Sheet records are typically stored in a sequential list, which does not provide much structure to coordinate updates. @author Josh Micich Common base class of {@link Record} and {@link RecordAggregate} @author Josh Micich called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. @param offset to begin writing at @param data byte array containing instance data @return number of bytes written gives the current serialized size of the record. Should include the sid and reclength (4 bytes). Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order that they should be written to file. Implementors may or may not return the actual {@link Record}s being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify those {@link Record}s after cloning Implementors may call non-mutating methods on Record r. @param r must not be null Creates a PageSettingsBlock with default settings @return true if the specified Record sid is one belonging to the 'Page Settings Block'. Sets a page break at the indicated column Removes a page break at the indicated column Creates the Header Record and sets it to nothing/0 length Creates the Footer Record and sets it to nothing/0 length Creates the HCenter Record and sets it to false (don't horizontally center) Creates the VCenter Record and sets it to false (don't horizontally center) Creates the PrintSetup Record and sets it to defaults and marks it invalid @see org.apache.poi.hssf.record.PrintSetupRecord @see org.apache.poi.hssf.record.Record @return record containing a PrintSetupRecord Gets the size of the margin in inches. @param margin which margin to Get @return the size of the margin Sets the size of the margin in inches. @param margin which margin to Get @param size the size of the margin Shifts all the page breaks in the range "count" number of rows/columns @param breaks The page record to be shifted @param start Starting "main" value to shift breaks @param stop Ending "main" value to shift breaks @param count number of units (rows/columns) to shift by Sets a page break at the indicated row @param row Removes a page break at the indicated row @param row Queries if the specified row has a page break @param row @return true if the specified row has a page break Queries if the specified column has a page break @return true if the specified column has a page break Shifts the horizontal page breaks for the indicated count @param startingRow @param endingRow @param count Shifts the vertical page breaks for the indicated count @param startingCol @param endingCol @param count Returns the HeaderRecord. @return HeaderRecord for the sheet. Returns the FooterRecord. @return FooterRecord for the sheet. Returns the PrintSetupRecord. @return PrintSetupRecord for the sheet. @return all the horizontal page breaks, never null @return the number of row page breaks @return all the column page breaks, never null @return the number of column page breaks HSSF wrapper for the {@link FormulaParser} and {@link FormulaRenderer} @author Josh Micich Convenience method for parsing cell formulas. see {@link #parse(String, HSSFWorkbook, int)} @param formulaType a constant from {@link FormulaType} @return the parsed formula tokens Static method to convert an array of {@link Ptg}s in RPN order to a human readable string format in infix mode. @param book used for defined names and 3D references @param ptgs must not be null @return a human readable String

For POI internal use only @author Josh Micich Utility class for helping convert RK numbers. @author Andrew C. Oliver (acoliver at apache dot org) @author Glen Stampoultzis (glens at apache.org) @author Rolf-J黵gen Moll @see org.apache.poi.hssf.record.MulRKRecord @see org.apache.poi.hssf.record.RKRecord Do the dirty work of decoding; made a private static method to facilitate testing the algorithm Holds information regarding a split plane or freeze plane for a sheet. Constant for active pane being the lower right Constant for active pane being the upper right Constant for active pane being the lower left Constant for active pane being the upper left Returns true if this Is a Freeze pane, false if it Is a split pane. Returns the vertical position of the split. @return 0 if there Is no vertical spilt, or for a freeze pane the number of columns in the TOP pane, or for a split plane the position of the split in 1/20th of a point. Returns the horizontal position of the split. @return 0 if there Is no horizontal spilt, or for a freeze pane the number of rows in the LEFT pane, or for a split plane the position of the split in 1/20th of a point. For a horizontal split returns the top row in the BOTTOM pane. @return 0 if there Is no horizontal split, or the top row of the bottom pane. For a vertical split returns the left column in the RIGHT pane. @return 0 if there Is no vertical split, or the left column in the RIGHT pane. Returns the active pane @see #PANE_LOWER_RIGHT @see #PANE_UPPER_RIGHT @see #PANE_LOWER_LEFT @see #PANE_UPPER_LEFT @return the active pane.

VLOOKUP Finds a row in a lookup table by the first column value and returns the value from another column.
Syntax:
VLOOKUP(lookup_value, table_array, col_index_num, range_lookup)

lookup_value The value to be found in the first column of the table array.
table_array An area reference for the lookup data.
col_index_num a 1 based index specifying which column value of the lookup data will be returned.
range_lookup If TRUE (default), VLOOKUP Finds the largest value less than or equal to the lookup_value. If FALSE, only exact Matches will be considered
@author Josh Micich @author Amol S. Deshmukh < amolweb at ya hoo dot com > Function serves as a marker interface.

0. RK_IEEE_NUMBER
1. RK_IEEE_NUMBER_TIMES_100
2. RK_INTEGER
3. RK_INTEGER_TIMES_100

Note - string values and empty cells are interpreted differently depending on isScalarProduct. For scalar products, if any term Is blank or a string, the error (#VALUE!) Is raised. For area (sum)products, if any term Is blank or a string, the result Is zero. @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > recursively Evaluate any RefEvals @param reval @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > Future value of an amount given the number of payments, rate, amount of individual payment, present value and bool value indicating whether payments are due at the beginning of period (false => payments are due at end of period) @param r rate @param n num of periods @param y pmt per period @param p future value @param t type (true=pmt at end of period, false=pmt at begining of period) Present value of an amount given the number of future payments, rate, amount of individual payment, future value and bool value indicating whether payments are due at the beginning of period (false => payments are due at end of period) @param r @param n @param y @param f @param t calculates the Net Present Value of a principal amount given the disCount rate and a sequence of cash flows (supplied as an array). If the amounts are income the value should be positive, else if they are payments and not income, the value should be negative. @param r @param cfs cashflow amounts @param r @param n @param p @param f @param t @param r @param y @param p @param f @param t @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > Returns an is StringValueEval or ErrorEval or BlankEval @param eval @param srcRow @param srcCol @author Amol S. Deshmukh < amolweb at ya hoo dot com > This class Is a marker class. It Is a special value for empty cells. Specifies a rectangular area of cells A1:A4 for instance. @author Jason Height (jheight at chariot dot net dot au) Title: FILESHARING Description: stores the encrypted Readonly for a workbook (Write protect) This functionality Is accessed from the options dialog box available when performing 'Save As'.

REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

@author Andrew C. Oliver (acoliver at apache dot org) Constructs a FileSharing record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Clone this record. Get the Readonly @return short representing if this Is Read only (1 = true) @returns password hashed with hashPassword() (very lame) @returns byte representing the Length of the username field @returns username of the user that Created the file Extended SST table info subrecord Contains the elements of "info" in the SST's array field @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre @see org.apache.poi.hssf.record.ExtSSTRecord Creates new ExtSSTInfoSubRecord * The dat record Is used to store options for the chart. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Glen Stampoultzis (glens at apache.org) Constructs a Dat record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Sets the horizontal border field value. has a horizontal border has a horizontal border @return the horizontal border field value. Sets the vertical border field value. has vertical border has vertical border @return the vertical border field value. Sets the border field value. data table has a border data table has a border @return the border field value. Sets the show series key field value. shows the series key shows the series key @return the show series key field value. Size of record (exluding 4 byte header) Get the options field for the Dat record. * The axis options record provides Unit information and other various tidbits about the axis. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Andrew C. Oliver(acoliver at apache.org) Constructs a AxisOptions record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Size of record (exluding 4 byte header) Get the minimum category field for the AxisOptions record. Get the maximum category field for the AxisOptions record. Get the major Unit value field for the AxisOptions record. Get the major Unit field for the AxisOptions record. Get the minor Unit value field for the AxisOptions record. Get the minor Unit field for the AxisOptions record. Get the base Unit field for the AxisOptions record. Get the crossing point field for the AxisOptions record. Get the options field for the AxisOptions record. use the default minimum category @return the default minimum field value. use the default maximum category @return the default maximum field value. use the default major Unit @return the default major field value. use the default minor Unit @return the default minor Unit field value. this Is a date axis @return the IsDate field value. use the default base Unit @return the default base field value. use the default crossing point @return the default cross field value. use default date Setttings for this axis @return the default date Settings field value.

• s Is zero
• n Is negative and s Is positive
• n Is positive and s Is negative

• s Is zero
• n Is negative and s Is positive
• n Is positive and s Is negative

• mod(3.4, 2) = 1.4
• mod(-3.4, 2) = 0.6
• mod(-3.4, -2) = -1.4
• mod(3.4, -2) = -0.6

In POI, the HSSFFormulaEvaluator Evaluates every cell in each reference argument before calling the function. This means that functions using fixed references do not need access to the rest of the workbook to execute. Hence the Evaluate() method on the common interface Function does not take a workbook parameter. This interface recognises the requirement of some functions to freely Create and Evaluate references beyond those passed in as arguments. @author Josh Micich @param args the pre-Evaluated arguments for this function. args Is never null, nor are any of its elements. @param srcCellRow zero based row index of the cell containing the currently evaluating formula @param srcCellCol zero based column index of the cell containing the currently evaluating formula @param workbook Is the workbook containing the formula/cell being Evaluated @param sheet Is the sheet containing the formula/cell being Evaluated @return never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors). Title: double Stream Flag Record Description: tells if this Is a double stream file. (always no for HSSF generated files) double Stream files contain both BIFF8 and BIFF7 workbooks. REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a DBCellRecord and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the DSF flag @return dsfflag (0-off,1-on) Title: Dimensions Record Description: provides the minumum and maximum bounds of a sheet. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a Dimensions record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the first row number for the sheet @return row - first row on the sheet Get the last row number for the sheet @return row - last row on the sheet Get the first column number for the sheet @return column - first column on the sheet Get the last col number for the sheet @return column - last column on the sheet Title: Calc Mode Record Description: Tells the gui whether to calculate formulas automatically, manually or automatically except for tables. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre @see org.apache.poi.hssf.record.CalcCountRecord manually calculate formulas (0) automatically calculate formulas (1) automatically calculate formulas except for tables (-1) Constructs a CalcModeRecord and Sets its fields appropriately @param in the RecordInputstream to Read the record from Set the calc mode flag for formulas @see #MANUAL @see #AUTOMATIC @see #AUTOMATIC_EXCEPT_TABLES @param calcmode one of the three flags above Get the calc mode flag for formulas @see #MANUAL @see #AUTOMATIC @see #AUTOMATIC_EXCEPT_TABLES @return calcmode one of the three flags above A dummy record for when we're missing a row, but still want to trigger something

• reference
• value
• array

The operand class chosen for each Token depends on the formula type and the Token's place in the formula. If POI Gets the operand class wrong, Excel may interpret the formula incorrectly. This condition Is typically manifested as a formula cell that displays as '#VALUE!', but resolves correctly when the user presses F2, enter.

The logic implemented here was partially inspired by the description in "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there seems To be inconsistent with observed Excel behaviour (These differences have not been fully investigated). The implementation in this class Has been heavily modified in order To satisfy concrete examples of how Excel performs the same logic (see TestRVA).

Hopefully, as Additional important test cases are identified and Added To the test suite, patterns might become more obvious in this code and allow for simplification. @author Josh Micich Traverses the supplied formula parse tree, calling Ptg.SetClass() for each non-base Token To Set its operand class. @param callerForceArrayFlag true if one of the current node's parents Is a function Ptg which Has been Changed from default 'V' To 'A' type (due To requirements on the function return value). Tests can implement this class To track the internal working of the {@link WorkbookEvaluator}.
For POI internal testing use only @author Josh Micich Internally, formula {@link ICacheEntry}s are stored in Sets which may Change ordering due To seemingly trivial Changes. This method Is provided To make the order of call-backs To {@link #onClearDependentCachedValue(ICacheEntry, int)} more deterministic. Should be implemented by any {@link Ptg} subclass that needs Has an extern sheet index
For POI internal use only @author Josh Micich @author Amol S. Deshmukh < amolweb at ya hoo dot com > HSSF wrapper for a sheet under evaluation @author Josh Micich Abstracts a sheet for the purpose of formula evaluation.
For POI internal use only @author Josh Micich @return null if there Is no cell at the specified coordinates Represents a from/to row/col square. This is a object primitive that can be used to represent row,col - row,col just as one would use String to represent a string of characters. Its really only useful for HSSF though. @author Andrew C. Oliver acoliver at apache dot org Creates a new instance of Region (0,0 - 0,0) Convert a List of CellRange objects to an array of regions @param List of CellRange objects @return regions Get the upper left hand corner column number @return column number for the upper left hand corner Get the upper left hand corner row number @return row number for the upper left hand corner Get the lower right hand corner column number @return column number for the lower right hand corner Get the lower right hand corner row number @return row number for the lower right hand corner

Common subclass of 8-bit and 16-bit versions @author Josh Micich max 65536 rows in BIFF8 max 256 columns in BIFF8 @return column number for the upper left hand corner @return row number for the upper left hand corner @return column number for the lower right hand corner @return row number for the lower right hand corner

See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream' @author Josh Micich Adds the specified new record in the correct place in sheet records list Find correct position to add new CFHeader record Finds the index where the sheet validations header record should be inserted @param records the records for this sheet + WINDOW2 o SCL o PANE oo SELECTION o STANDARDWIDTH oo MERGEDCELLS o LABELRANGES o PHONETICPR o Conditional Formatting Table o Hyperlink Table o Data Validity Table o SHEETLAYOUT o SHEETPROTECTION o RANGEPROTECTION + EOF DIMENSIONS record is always present @return true if the specified record ID terminates a sequence of Row block records It is assumed that at least one row or cell value record has been found prior to the current record @return true if the specified record id normally appears in the row blocks section of the sheet records

@author Josh Micich @return encoded size without the 'type' code byte

• {@link SharedFormulaRecord}s
• {@link ArrayRecord}s
• {@link TableRecord}s

This method may also be used for setting breakpoints to help diagnose issues regarding the abnormally-set 'shared formula' flags. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).

The method currently does nothing but do not delete it without finding a nice home for this comment. Note - does not return SharedFormulaRecords currently, because the corresponding formula records have been converted to 'unshared'. POI does not attempt to re-share formulas. On the other hand, there is no such conversion for array or table formulas, so this method returns the TABLE or ARRAY record (if it should be written after the specified formulaRecord. @return the TABLE or ARRAY record for this formula cell, if it is the first cell of a table or array region.

Every successful call to startEvaluate must be followed by a call to endEvaluate (recommended in a finally block) to enable proper tracking of which cells are being evaluated at any point in time.

Assuming a well behaved client, parameters to this method would not be required. However, they have been included to assert correct behaviour, and form more meaningful error messages. Stores the parameters that identify the evaluation of one cell.
@return human Readable string for debug purposes Title: VCenter record Description: tells whether to center the sheet between vertical margins REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a VCENTER record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get whether to center vertically or not @return vcenter or not Title: Selection Record Description: shows the user's selection on the sheet for Write Set num refs to 0 TODO : Fully implement reference subrecords. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @author Glen Stampoultzis (glens at apache.org)

This code is currently being used for translating formulas represented with Ptg tokens into human readable text form. In formula expressions, a sheet name always has a trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this method returns but it is worth noting the likely consumers of these formula text strings:

1. POI's own formula parser
2. Visual reading by human
3. VBA automation entry into Excel cell contents e.g. ActiveCell.Formula = "=c64!A1"
4. Manual entry into Excel cell contents
5. Some third party formula parser

For better or worse this implementation attempts to replicate Excel's formula renderer. Excel uses range checking on the apparent 'row' and 'column' components. Note however that the maximum sheet size varies across versions. @see org.apache.poi.hssf.util.CellReference @author andy @author Jason Height (jheight at chariot dot net dot au) one-based index to defined name record @param nameIndex zero-based index to name within workbook Creates new NamePtg @return zero based index to a defined name record in the LinkTable @author Glen Stampoultzis (glens at apache.org) Creates new function pointer from a byte array usually called while Reading an excel file. @author Amol S. Deshmukh < amolweb at ya hoo dot com > Constructs a new instance of the Accumulator used to calculated this function @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > This Is the default implementation of a Function class. The default behaviour Is to return a non-standard ErrorEval "ErrorEval.FUNCTION_NOT_IMPLEMENTED". This error should alert the user that the formula contained a function that Is not yet implemented. @author Amol S. Deshmukh < amolweb at ya hoo dot com > This Is the base class for all excel function evaluator classes that take variable number of operands, and where the order of operands does not matter Collects values from a single argument Returns a double array that contains values for the numeric cells from among the list of operands. Blanks and Blank equivalent cells are ignored. Error operands or cells containing operands of type that are considered invalid and would result in #VALUE! error in excel cause this function to return null. @return never null Ensures that a two dimensional array has all sub-arrays present and the same Length @return false if any sub-array Is missing, or Is of different Length Maximum number of operands accepted by this function. Subclasses may override to Change default value. @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Josh Micich This PTG implements the standard binomial divide "/" @author Andrew C. Oliver acoliver at apache dot org @author Jason Height (jheight at chariot dot net dot au) Title: File Pass Record Description: Indicates that the record after this record are encrypted. HSSF does not support encrypted excel workbooks and the presence of this record will cause Processing to be aborted. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Jason Height (jheight at chariot dot net dot au) @version 3.0-pre Constructs a FILEPASS record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from This class Is used to aggregate the MSODRAWING and OBJ record combinations. This Is necessary due to the bizare way in which these records are Serialized. What happens Is that you Get a combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records but the escher records are Serialized _across_ the MSODRAWING records. It Gets even worse when you start looking at TXO records. So what we do with this class Is aggregate lazily. That Is we don't aggregate the MSODRAWING -> OBJ records Unless we need to modify them. @author Glen Stampoultzis (glens at apache.org) Maps shape container objects to their OBJ records list of "tail" records that need to be Serialized after all drawing Group records Unused since this Is an aggregate record. Use CreateAggregate(). @see #CreateAggregate Calculates the string representation of this record. This Is simply a dump of all the records. Collapses the drawing records into an aggregate. Serializes this aggregate to a byte array. Since this Is an aggregate record it will effectively Serialize the aggregated records. @param offset The offset into the start of the array. @param data The byte array to Serialize to. @return The number of bytes Serialized. How many bytes do the raw escher records contain. @param records List of escher records @return the number of bytes Associates an escher record to an OBJ record or a TXO record. Converts the Records into UserModel objects on the bound HSSFPatriarch @return Returns the current sid. The number of bytes required to Serialize this record. A sub-record within the OBJ record which stores a reference to an object stored in a Separate entry within the OLE2 compound file. @author Daniel Noll either an area or a cell ref Formulas often have a single non-zero trailing byte. This is in a similar position to he pre-streamId padding It is unknown if the value is important (it seems to mirror a value a few bytes earlier) Constructs an EmbeddedObjectRef record and Sets its fields appropriately. @param in the record input stream. Size of record (exluding 4 byte header) Gets the stream ID containing the actual data. The data itself can be found under a top-level directory entry in the OLE2 filesystem under the name "MBDxxxxxxxx" where xxxxxxxx is this ID converted into hex (in big endian order, funnily enough.) @return the data stream ID. Possibly null Describes the formatting runs associated with a chart title. Title: Save External Links record (BookBool) Description: Contains a flag specifying whether the Gui should save externally linked values from other workbooks. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a BookBoolRecord and Sets its fields appropriately @param in the RecordInputstream to Read the record from Get the save ext links flag @return short 0/1 (off/on) * The axis line format record defines the axis type details. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Glen Stampoultzis (glens at apache.org) Constructs a AxisLineFormat record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Size of record (exluding 4 byte header) Get the axis type field for the AxisLineFormat record. @return One of AXIS_TYPE_AXIS_LINE AXIS_TYPE_MAJOR_GRID_LINE AXIS_TYPE_MINOR_GRID_LINE AXIS_TYPE_WALLS_OR_FLOOR Provides utilities to manage drawing Groups. @author Glen Stampoultzis (glens at apache.org) Allocates new shape id for the new drawing Group id. @return a new shape id. HSSFDataFormatter contains methods for Formatting the value stored in an HSSFCell. This can be useful for reports and GUI presentations when you need to display data exactly as it appears in Excel. Supported Formats include currency, SSN, percentages, decimals, dates, phone numbers, zip codes, etc. Internally, Formats will be implemented using subclasses of {@link FormatBase} such as {@link DecimalFormat} and {@link SimpleDateFormat}. Therefore the Formats used by this class must obey the same pattern rules as these FormatBase subclasses. This means that only legal number pattern characters ("0", "#", ".", "," etc.) may appear in number formats. Other characters can be inserted before or after the number pattern to form a prefix or suffix. For example the Excel pattern "$#,##0.00 "USD"_);($#,##0.00 "USD")" will be correctly Formatted as "$1,000.00 USD" or "($1,000.00 USD)". However the pattern "00-00-00" is incorrectly Formatted by DecimalFormat as "000000--". For Excel Formats that are not compatible with DecimalFormat, you can provide your own custom {@link FormatBase} implementation via HSSFDataFormatter.AddFormat(String,FormatBase). The following custom Formats are already provided by this class:

             
SSN "000-00-0000"
                 
Phone Number "(###) ###-####"
                 
Zip plus 4 "00000-0000"
             
             

• the cell's style is null
• the style's data FormatBase string is null or empty
• the FormatBase string cannot be recognized as either a number or date

Syntax
YEARFRAC(startDate, endDate, basis)

The basis optionally specifies the behaviour of YEARFRAC as follows:

Value	Days per Month	Days per Year
0 (default)	30	360
1	actual	actual
2	actual	360
3	actual	365
4	30	360

@param month 1-based Segregates the 'Row Blocks' section of a single sheet into plain row/cell records and shared formula records. @author Josh Micich Also collects any loose MergeCellRecords and puts them in the supplied mergedCellsTable Some unconventional apps place {@link MergeCellsRecord}s within the row block. They actually should be in the {@link MergedCellsTable} which is much later (see bug 45699). @return any loose MergeCellsRecords found @return a {@link RecordStream} containing all the non-{@link SharedFormulaRecord} non-{@link ArrayRecord} and non-{@link TableRecord} Records. Holds a collection of Sheet names and their associated reference numbers. @author Andrew C. Oliver (acoliver at apache dot org)

For POI internal use only @author Josh Micich Title: Write Access Record Description: Stores the username of that who owns the spReadsheet generator (on Unix the user's login, on Windoze its the name you typed when you installed the thing) REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a WriteAccess record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the username for the user that Created the report. HSSF uses the logged in user. On natively Created M$ Excel sheet this would be the name you typed in when you installed it in most cases. @return username of the user who Is logged in (probably "tomcat" or "apache") * Defines a series name * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Andrew C. Oliver (acoliver at apache.org) Constructs a SeriesText record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Size of record (exluding 4 byte header) Get the id field for the SeriesText record. Get the text Length field for the SeriesText record. Get the Undocumented field for the SeriesText record. Get the text field for the SeriesText record. * The series record describes the overall data for a series. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Glen Stampoultzis (glens at apache.org) Constructs a Series record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Size of record (exluding 4 byte header) Get the category data type field for the Series record. @return One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT Get the values data type field for the Series record. @return One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT Get the num categories field for the Series record. Get the num values field for the Series record. Get the bubble series type field for the Series record. @return One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT Get the num bubble values field for the Series record. Title: Print Setup Record Description: Stores print Setup options -- bogus for HSSF (and marked as such) REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a PrintSetup (SetUP) record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Title: Password Record Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption) REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a Password record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Clone this record. Get the password @return short representing the password String Stores a String value in a formula value stored in the format <Length 2 bytes>char[] @author Werner Froidevaux @author Jason Height (jheight at chariot dot net dot au) @author Bernard Chesnoy the Char (")used in formulas to delimit string literals NOTE: OO doc says 16bit Length, but BiffViewer says 8 Book says something totally different, so don't look there! Create a StringPtg from a stream Create a StringPtg from a string representation of the number Number format Is not Checked, it Is expected to be Validated in the Parser that calls this method. @param value : String representation of a floating point number @author Amol S. Deshmukh < amolweb at ya hoo dot com > Implementation of Excel function NA() @author Josh Micich @author andy @author Jason Height (jheight at chariot dot net dot au) Process the bytes into escher records. (Not done by default in case we break things, Unless you Set the "poi.deSerialize.escher" system property) Size of record (including 4 byte headers for all sections) Title: DBCell Record Description: Used by Excel and other MS apps to quickly Find rows in the sheets. REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height @version 2.0-pre Constructs a DBCellRecord and Sets its fields appropriately @param in the RecordInputstream to Read the record from return the cell offset in the array @param index of the cell offset to retrieve @return celloffset from the celloffset array @returns the size of the Group of DBCellRecords needed to encode the specified number of blocks and rows Gets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block. @return rowoffset to the start of the first cell in the next DBCell block Get the number of cell offsets in the celloffset array @return number of cell offsets Title: CRN Description: This record stores the contents of an external cell or cell range REFERENCE: 5.23 @author josh micich return the non static version of the id for this record. @author andy @author Jason Height (jheight at chariot dot net dot au) Creates a new instance of ValueRecordsAggregate @param rs record stream with all {@link SharedFormulaRecord} {@link ArrayRecord}, {@link TableRecord} {@link MergeCellsRecord} Records removed Handles UnknownRecords which appear within the row/cell records Returns the number of physical rows within a block Returns the physical row number of the first row in a block Returns the physical row number of the end row in a block Create a row record. @param row number @return RowRecord Created for the passed in row number @see org.apache.poi.hssf.record.RowRecord Returns the number of row blocks.

The row blocks are goupings of rows that contain the DBCell record after them

One important concept worth considering Is that of font size. One of the difficulties in Converting Graphics calls into escher Drawing calls Is that Excel does not have the concept of absolute pixel positions. It measures it's cell widths in 'Chars' and the cell heights in points. Unfortunately it's not defined exactly what a type of Char it's measuring. Presumably this Is due to the fact that the Excel will be using different fonts on different platforms or even within the same platform. Because of this constraint we've had to calculate the verticalPointsPerPixel. This the amount the font should be scaled by when you Issue commands such as DrawString(). A good way to calculate this Is to use the follow formula:

                  multipler = GroupHeightInPoints / heightOfGroup
             

The height of the Group Is calculated fairly simply by calculating the difference between the y coordinates of the bounding box of the shape. The height of the Group can be calculated by using a convenience called HSSFClientAnchor.GetAnchorHeightInPoints().

Syntax:
PMT(rate, nper, pv, fv, type)

Returns the constant repayment amount required for a loan assuming a constant interest rate.

rate the loan interest rate.
nper the number of loan repayments.
pv the present value of the future payments (or principle).
fv the future value (default zero) surplus cash at the end of the loan lifetime.
type whether payments are due at the beginning(1) or end(0 - default) of each payment period.
Implementation of Excel formula token '%'.

@author Josh Micich @author Amol S. Deshmukh < amolweb at ya hoo dot com > #VALUE! - Wrong type of operand #REF! - Illegal or deleted cell reference #NUM! - Value range overflow * The font index record indexes into the font table for the text record. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Glen Stampoultzis (glens at apache.org) Constructs a FontIndex record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Size of record (exluding 4 byte header) Get the font index field for the FontIndex record. Title: A sub Record for Extern Sheet Description: Defines a named range within a workbook. REFERENCE: @author Libin Roman (Vista Portal LDT. Developer) @version 1.0-pre a Constractor for making new sub record Constructs a Extern Sheet Sub Record record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Sets the Index to the sup book @param index sup book index Gets the index to sup book @return sup book index Sets the index to first sheet in supbook @param index index to first sheet Gets the index to first sheet from supbook @return index to first supbook Sets the index to last sheet in supbook @param index index to last sheet Gets the index to last sheet in supbook @return index to last supbook called by the class that Is responsible for writing this sucker. Subclasses should implement this so that their data Is passed back in a byte array. @param offset to begin writing at @param data byte array containing instance data @return number of bytes written returns the record size return the non static version of the id for this record. EXTERNALNAME

@author Josh Micich called by the class that Is responsible for writing this sucker. Subclasses should implement this so that their data Is passed back in a byte array. @param offset to begin writing at @param data byte array containing instance data @return number of bytes written Convenience Function to determine if the name Is a built-in name For OLE and DDE, links can be either 'automatic' or 'manual' only for OLE and DDE DDE links only. If true, this denotes the 'StdDocumentName' @return the standard String representation of this name Title: Delta Record Description: controls the accuracy of the calculations REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a Delta record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Set the maximum Change @param maxChange - maximum rounding error Get the maximum Change @return maxChange - maximum rounding error * The default data label text properties record identifies the text Charistics of the preceeding text record. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Glen Stampoultzis (glens at apache.org) Constructs a DefaultDataLabelTextProperties record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the category data type field for the DefaultDataLabelTextProperties record. @return One of CATEGORY_DATA_TYPE_SHOW_LABELS_CharISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CharISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CharISTIC Set the category data type field for the DefaultDataLabelTextProperties record. @param field_1_categoryDataType One of CATEGORY_DATA_TYPE_SHOW_LABELS_CharISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CharISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CharISTIC Size of record (exluding 4 byte header) XCT ?CRN Count REFERENCE: 5.114 @author Josh Micich return the non static version of the id for this record. Title: Codepage Record Description: the default CharSet. for the workbook REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre the likely correct value for CODEPAGE (at least for US versions). We could use some help with international versions (which we do not have access to documentation for) Constructs a CodepageRecord and Sets its fields appropriately @param in the RecordInputstream to Read the record from Get the codepage for this workbook @see #CODEPAGE @return codepage - the codepage to Set Title: Calc Count Record Description: Specifies the maximum times the gui should perform a formula recalculation. For instance: in the case a formula includes cells that are themselves a result of a formula and a value Changes. This Is essentially a failsafe against an infinate loop in the event the formulas are not independant. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre @see org.apache.poi.hssf.record.CalcModeRecord Constructs a CalcCountRecord and Sets its fields appropriately @param in the RecordInputstream to Read the record from Get the number of iterations to perform @return iterations * The number of axes used on a chart. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Glen Stampoultzis (glens at apache.org) Constructs a AxisUsed record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Size of record (exluding 4 byte header) Get the num axis field for the AxisUsed record. An ERFListener Is registered with the EventRecordFactory. An ERFListener listens for Records coming from the stream via the EventRecordFactory @see EventRecordFactory @author Andrew C. Oliver acoliver@apache.org Process a Record. This method Is called by the EventRecordFactory when a record Is returned. @return bool specifying whether the effort was a success. @author Amol S. Deshmukh < amolweb at ya hoo dot com > Coordinates several formula evaluators together so that formulas that involve external references can be evaluated. @param workbookNames the simple file names used to identify the workbooks in formulas with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1") @param evaluators all evaluators for the full set of workbooks required by the formulas. If cell Contains a formula, the formula Is Evaluated and returned, else the CellValue simply copies the appropriate cell value from the cell and also its cell type. This method should be preferred over EvaluateInCell() when the call should not modify the contents of the original cell. @param cell If cell contains a formula, the formula is evaluated and returned, else the CellValue simply copies the appropriate cell value from the cell and also its cell type. This method should be preferred over evaluateInCell() when the call should not modify the contents of the original cell. @param cell may be null signifying that the cell is not present (or blank) @return null if the supplied cell is null or blank Should be called whenever there are major changes (e.g. moving sheets) to input cells in the evaluated workbook. If performance is not critical, a single call to this method may be used instead of many specific calls to the notify~ methods. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class Should be called to tell the cell value cache that the specified (value or formula) cell has changed. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class Should be called to tell the cell value cache that the specified cell has just been deleted. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class If cell Contains formula, it Evaluates the formula, and saves the result of the formula. The cell remains as a formula cell. Else if cell does not contain formula, this method leaves the cell UnChanged. Note that the type of the formula result Is returned, so you know what kind of value Is also stored with the formula.

            int EvaluatedCellType = evaluator.EvaluateFormulaCell(cell);
            

            int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType;
            

The main data of all types of references Is stored in the Link Table inside the Workbook Globals Substream (4.2.5). The Link Table itself Is optional and occurs only, if there are any references in the document.

In BIFF8 the Link Table consists of

• zero or more EXTERNALBOOK Blocks

  each consisting of

  • exactly one EXTERNALBOOK (0x01AE) record
  • zero or more EXTERNALNAME (0x0023) records
  • zero or more CRN Blocks

    each consisting of

    • exactly one XCT (0x0059)record
    • zero or more CRN (0x005A) records (documentation says one or more)
• zero or one EXTERNSHEET (0x0017) record
• zero or more DEFINEDNAME (0x0018) records

For performance reasons, this class keeps a cache of all previously calculated intermediate cell values. Be sure To call {@link #ClearCache()} if any workbook cells are Changed between calls To evaluate~ methods on this class.
For POI internal use only @author Josh Micich also for debug use. Used in ToString methods Should be called whenever there are Changes To input cells in the evaluated workbook. Failure To call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class Should be called To tell the cell value cache that the specified (value or formula) cell Has Changed. Should be called To tell the cell value cache that the specified cell Has just been deleted. @return never null, never {@link BlankEval} Gets the value from a non-formula cell. @param cell may be null @return {@link BlankEval} if cell Is null or blank, never null Dereferences a single value from any AreaEval or RefEval evaluation result. If the supplied evaluationResult Is just a plain value, it Is returned as-is. @return a NumberEval, StringEval, BoolEval, BlankEval or ErrorEval. Never null. returns an appropriate Eval impl instance for the Ptg. The Ptg must be one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg, StringPtg, BoolPtg
special Note: OperationPtg subtypes cannot be passed here! Used by the lazy ref evals whenever they need To Get the value of a contained cell. @author Josh Micich Stores details about the current evaluation of a cell.
@param inputCell a cell directly used by the formula of this evaluation frame @return never null, (possibly empty) array of all cells directly used while evaluating the formula of this frame.

Treated in a similar way to SharedFormulaRecord @author Josh Micich

OFFSet returns an area reference that Is a specified number of rows and columns from a reference cell or area.

Syntax:
OFFSet(reference, rows, cols, height, width)

reference Is the base reference.
rows Is the number of rows up or down from the base reference.
cols Is the number of columns left or right from the base reference.
height (default same height as base reference) Is the row Count for the returned area reference.
width (default same width as base reference) Is the column Count for the returned area reference.
@author Josh Micich OFFSet's numeric arguments (2..5) have similar Processing rules Fractional values are silently truncated by Excel. Truncation Is toward negative infinity. Exceptions are used within this class to help simplify flow control when error conditions are enCountered A one dimensional base + offset. Represents either a row range or a column range. Two instances of this class toGether specify an area range. Moves the range by the specified translation amount.

This method also 'normalises' the range: Excel specifies that the width and height parameters (Length field here) cannot be negative. However, OFFSet() does produce sensible results in these cases. That behavior Is replicated here.

@param translationAmount may be zero negative or positive @return the equivalent LinearOffsetRange with a positive Length, moved by the specified translationAmount. Encapsulates either an area or cell reference which may be 2d or 3d. @author Amol S. Deshmukh < amolweb at ya hoo dot com > Log: LOG(number,[base]) @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > ArrayPtg - handles arrays The ArrayPtg Is a little weird, the size of the Ptg when parsing initially only includes the Ptg sid and the reserved bytes. The next Ptg in the expression then follows. It Is only after the "size" of all the Ptgs Is met, that the ArrayPtg data Is actually held after this. So Ptg.CreateParsedExpression keeps track of the number of ArrayPtg elements and need to Parse the data upto the FORMULA record size. @author Jason Height (jheight at chariot dot net dot au) The size of the plain tArray token written within the standard formula tokens (not including the data which comes after all formula tokens) @param values2d array values arranged in rows Read in the actual token (array) values. This occurs AFTER the last Ptg in the expression. See page 304-305 of Excel97-2007BinaryFileFormat(xls)Specification.pdf Note - (2D) array elements are stored column by column @return the index into the internal 1D array for the specified column and row This size includes the size of the array Ptg plus the Array Ptg Token value size End Of File record. Description: Marks the end of records belonging to a particular object in the HSSF File REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a EOFRecord record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Title: COLINFO Record

Description: Defines with width and formatting for a range of columns

REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

@author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a ColumnInfo record and Sets its fields appropriately @param in the RecordInputstream to Read the record from @return true if the format, options and column width match Get the first column this record defines formatting info for @return the first column index (0-based) Get the last column this record defines formatting info for @return the last column index (0-based) Get the columns' width in 1/256 of a Char width @return column width Get the columns' default format info @return the extended format index @see org.apache.poi.hssf.record.ExtendedFormatRecord Get the options bitfield - use the bitSetters instead @return the bitfield raw value Get whether or not these cells are hidden @return whether the cells are hidden. @see #SetOptions(short) Get the outline level for the cells @see #SetOptions(short) @return outline level for the cells Get whether the cells are collapsed @return wether the cells are collapsed @see #SetOptions(short) * The chart record Is used to define the location and size of a chart. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Glen Stampoultzis (glens at apache.org) Constructs a Chart record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the x field for the Chart record. Set the x field for the Chart record. Get the y field for the Chart record. Set the y field for the Chart record. Size of record (exluding 4 byte header) Get the width field for the Chart record. Get the height field for the Chart record. Border Formatting Block of the Conditional Formatting Rule Record. @author Dmitriy Kumshayev No border Thin border Medium border dash border dot border Thick border double-line border hair-line border Medium dashed border dash-dot border medium dash-dot border dash-dot-dot border medium dash-dot-dot border slanted dash-dot border Creates new FontFormatting Get the type of border to use for the left border of the cell @return border type @see #BORDER_NONE @see #BORDER_THIN @see #BORDER_MEDIUM @see #BORDER_DASHED @see #BORDER_DOTTED @see #BORDER_THICK @see #BORDER_DOUBLE @see #BORDER_HAIR @see #BORDER_MEDIUM_DASHED @see #BORDER_DASH_DOT @see #BORDER_MEDIUM_DASH_DOT @see #BORDER_DASH_DOT_DOT @see #BORDER_MEDIUM_DASH_DOT_DOT @see #BORDER_SLANTED_DASH_DOT Get the type of border to use for the right border of the cell @return border type @see #BORDER_NONE @see #BORDER_THIN @see #BORDER_MEDIUM @see #BORDER_DASHED @see #BORDER_DOTTED @see #BORDER_THICK @see #BORDER_DOUBLE @see #BORDER_HAIR @see #BORDER_MEDIUM_DASHED @see #BORDER_DASH_DOT @see #BORDER_MEDIUM_DASH_DOT @see #BORDER_DASH_DOT_DOT @see #BORDER_MEDIUM_DASH_DOT_DOT @see #BORDER_SLANTED_DASH_DOT Get the type of border to use for the top border of the cell @return border type @see #BORDER_NONE @see #BORDER_THIN @see #BORDER_MEDIUM @see #BORDER_DASHED @see #BORDER_DOTTED @see #BORDER_THICK @see #BORDER_DOUBLE @see #BORDER_HAIR @see #BORDER_MEDIUM_DASHED @see #BORDER_DASH_DOT @see #BORDER_MEDIUM_DASH_DOT @see #BORDER_DASH_DOT_DOT @see #BORDER_MEDIUM_DASH_DOT_DOT @see #BORDER_SLANTED_DASH_DOT Get the type of border to use for the bottom border of the cell @return border type @see #BORDER_NONE @see #BORDER_THIN @see #BORDER_MEDIUM @see #BORDER_DASHED @see #BORDER_DOTTED @see #BORDER_THICK @see #BORDER_DOUBLE @see #BORDER_HAIR @see #BORDER_MEDIUM_DASHED @see #BORDER_DASH_DOT @see #BORDER_MEDIUM_DASH_DOT @see #BORDER_DASH_DOT_DOT @see #BORDER_MEDIUM_DASH_DOT_DOT @see #BORDER_SLANTED_DASH_DOT Get the type of border to use for the diagonal border of the cell @return border type @see #BORDER_NONE @see #BORDER_THIN @see #BORDER_MEDIUM @see #BORDER_DASHED @see #BORDER_DOTTED @see #BORDER_THICK @see #BORDER_DOUBLE @see #BORDER_HAIR @see #BORDER_MEDIUM_DASHED @see #BORDER_DASH_DOT @see #BORDER_MEDIUM_DASH_DOT @see #BORDER_DASH_DOT_DOT @see #BORDER_MEDIUM_DASH_DOT_DOT @see #BORDER_SLANTED_DASH_DOT Get the color to use for the left border @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short) @param color The index of the color definition Get the color to use for the right border @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short) @param color The index of the color definition Get the color to use for the top border @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short) @param color The index of the color definition Get the color to use for the bottom border @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short) @param color The index of the color definition Get the color to use for the diagonal border @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short) @param color The index of the color definition @return true if forward diagonal Is on @return true if backward diagonal Is on Conditional Formatting Rule Record. @author Dmitriy Kumshayev Creates new CFRuleRecord Creates a new comparison operation rule Creates a new comparison operation rule Get the stack of the 1st expression as a list @return list of tokens (casts stack to a list and returns it!) this method can return null Is we are Unable to Create Ptgs from existing excel file callers should Check for null! @param ptgs may be null @return encoded size of the formula called by the class that Is responsible for writing this sucker. Subclasses should implement this so that their data Is passed back in a byte array. @param offset to begin writing at @param data byte array containing instance data @return number of bytes written get the stack of the 1st expression as a list @return list of tokens (casts stack to a list and returns it!) this method can return null is we are unable to create Ptgs from existing excel file callers should check for null! get the stack of the 2nd expression as a list @return list of tokens (casts stack to a list and returns it!) this method can return null is we are unable to create Ptgs from existing excel file callers should check for null! Get the option flags @return bit mask Event-based record factory. As opposed to RecordFactory this refactored version throws record events as it comes accross the records. I throws the "lazily" one record behind to ensure that ContinueRecords are Processed first. @author Andrew C. Oliver (acoliver@apache.org) - probably to blame for the bugs (so yank his chain on the list) @author Marc Johnson (mjohnson at apache dot org) - methods taken from RecordFactory @author Glen Stampoultzis (glens at apache.org) - methods taken from RecordFactory @author Csaba Nagy (ncsaba at yahoo dot com) Create an EventRecordFactory @param abortable specifies whether the return from the listener handler functions are obeyed. False means they are ignored. True means the event loop exits on error. sends the record event to all registered listeners. @param record the record to be thrown. @return false to abort. This aborts out of the event loop should the listener return false Create an array of records from an input stream @param in the InputStream from which the records will be obtained @exception RecordFormatException on error Processing the InputStream Low level model implementation of a Workbook. Provides creational methods for Settings and objects contained in the workbook object. This file Contains the low level binary records starting at the workbook's BOF and ending with the workbook's EOF. Use HSSFWorkbook for a high level representation. The structures of the highlevel API use references to this to perform most of their operations. Its probably Unwise to use these low level structures directly Unless you really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf before even attempting to use this. @author Luc Girardin (luc dot girardin at macrofocus dot com) @author Sergei Kozello (sergeikozello at mail.ru) @author Shawn Laubach (slaubach at apache dot org) (Data Formats) @author Andrew C. Oliver (acoliver at apache dot org) @author Brian Sanders (bsanders at risklabs dot com) - custom palette @author Dan Sherman (dsherman at Isisph.com) @author Glen Stampoultzis (glens at apache.org) @see org.apache.poi.hssf.usermodel.HSSFWorkbook @version 1.0-pre Excel silently truncates long sheet names to 31 chars. This constant is used to ensure uniqueness in the first 31 chars constant used to Set the "codepage" wherever "codepage" Is Set in records (which Is duplciated in more than one record) this Contains the Worksheet record objects this Contains a reference to the SSTRecord so that new stings can be Added to it. holds the "boundsheet" records (aka bundlesheet) so that they can have their reference to their "BOF" marker Creates new Workbook with no intitialization --useless right now @see #CreateWorkbook(List) 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. @param recs an array of Record objects @return Workbook object Creates an empty workbook object with three blank sheets and all the empty fields. Use this to Create a workbook from scratch. Retrieves the Builtin NameRecord that matches the name and index There shouldn't be too many names to make the sequential search too slow @param name byte representation of the builtin name to match @param sheetIndex Index to match @return null if no builtin NameRecord matches Removes the specified Builtin NameRecord that matches the name and index @param name byte representation of the builtin to match @param sheetIndex zero-based sheet reference 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) @param idx the index to look at (0 or greater but NOT 4) @return FontRecord located at the given index 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) @return FontRecord that was just Created Check if the cloned sheet has drawings. If yes, then allocate a new drawing group ID and re-generate shape IDs @param sheet the cloned sheet Sets the BOF for a given sheet @param sheetnum the number of the sheet to Set the positing of the bof for @param pos the actual bof position 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 @param sheetnum the sheet number (0 based) @param sheetname the name for the sheet Determines whether a workbook Contains the provided sheet name. @param name the name to test (case insensitive match) @param excludeSheetIdx the sheet to exclude from the Check or -1 to include all sheets in the Check. @return true if the sheet Contains the name, false otherwise. Sets the name for a given sheet forcing the encoding. This Is STILL A BAD IDEA. Poi now automatically detects Unicode @deprecated 3-Jan-06 Simply use SetSheetNam e(int sheetnum, String sheetname) @param sheetnum the sheet number (0 based) @param sheetname the name for the sheet Sets the order of appearance for a given sheet. @param sheetname the name of the sheet to reorder @param pos the position that we want to Insert the sheet into (0 based) Gets the name for a given sheet. @param sheetnum the sheet number (0 based) @return sheetname the name for the sheet Gets the hidden flag for a given sheet. @param sheetnum the sheet number (0 based) @return True if sheet Is hidden Gets the hidden flag for a given sheet. Note that a sheet could instead be set to be very hidden, which is different ({@link #isSheetVeryHidden(int)}) @param sheetnum the sheet number (0 based) @return True if sheet is hidden Hide or Unhide a sheet @param sheetnum The sheet number @param hidden True to mark the sheet as hidden, false otherwise Hide or unhide a sheet. 0 = not hidden 1 = hidden 2 = very hidden. @param sheetnum The sheet number @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden Get the sheet's index @param name sheet name @return sheet index or -1 if it was not found. if we're trying to Address one more sheet than we have, go ahead and Add it! if we're trying to Address >1 more than we have throw an exception! make the tabid record look like the current situation. Retrieves the index of the given font Returns the StyleRecord for the given xfIndex, or null if that ExtendedFormat doesn't have a Style set. Gets the ExtendedFormatRecord at the given 0-based index @param index of the Extended format record (0-based) @return ExtendedFormatRecord at the given index Creates a new Cell-type Extneded Format Record and Adds it to the end of ExtendedFormatRecords collection @return ExtendedFormatRecord that was Created 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) @param string the string to be Added to the SSTRecord @return index of the string within the SSTRecord given an index into the SST table, this function returns the corresponding String value @return String containing the SST String use this function to Add a Shared String Table to an existing sheet (say generated by a different java api) without an sst.... @see #CreateSST() @see org.apache.poi.hssf.record.SSTRecord Serializes all records int the worksheet section into a big byte array. Use this to Write the Workbook out. @param offset of the data to be written @param data array of bytes to Write this to Creates the BOF record @see org.apache.poi.hssf.record.BOFRecord @see org.apache.poi.hssf.record.Record @return record containing a BOFRecord Creates the InterfaceHdr record @see org.apache.poi.hssf.record.InterfaceHdrRecord @see org.apache.poi.hssf.record.Record @return record containing a InterfaceHdrRecord Creates an MMS record @see org.apache.poi.hssf.record.MMSRecord @see org.apache.poi.hssf.record.Record @return record containing a MMSRecord Creates the InterfaceEnd record @see org.apache.poi.hssf.record.InterfaceEndRecord @see org.apache.poi.hssf.record.Record @return record containing a InterfaceEndRecord Creates the WriteAccess record containing the logged in user's name @see org.apache.poi.hssf.record.WriteAccessRecord @see org.apache.poi.hssf.record.Record @return record containing a WriteAccessRecord Creates the Codepage record containing the constant stored in CODEPAGE @see org.apache.poi.hssf.record.CodepageRecord @see org.apache.poi.hssf.record.Record @return record containing a CodepageRecord Creates the DSF record containing a 0 since HSSF can't even Create Dual Stream Files @see org.apache.poi.hssf.record.DSFRecord @see org.apache.poi.hssf.record.Record @return record containing a DSFRecord 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. @see org.apache.poi.hssf.record.TabIdRecord @see org.apache.poi.hssf.record.Record @return record containing a TabIdRecord Creates the FnGroupCount record containing the Magic number constant of 14. @see org.apache.poi.hssf.record.FnGroupCountRecord @see org.apache.poi.hssf.record.Record @return record containing a FnGroupCountRecord Creates the WindowProtect record with protect Set to false. @see org.apache.poi.hssf.record.WindowProtectRecord @see org.apache.poi.hssf.record.Record @return record containing a WindowProtectRecord Creates the Protect record with protect Set to false. @see org.apache.poi.hssf.record.ProtectRecord @see org.apache.poi.hssf.record.Record @return record containing a ProtectRecord Creates the Password record with password Set to 0. @see org.apache.poi.hssf.record.PasswordRecord @see org.apache.poi.hssf.record.Record @return record containing a PasswordRecord Creates the ProtectionRev4 record with protect Set to false. @see org.apache.poi.hssf.record.ProtectionRev4Record @see org.apache.poi.hssf.record.Record @return record containing a ProtectionRev4Record Creates the PasswordRev4 record with password Set to 0. @see org.apache.poi.hssf.record.PasswordRev4Record @see org.apache.poi.hssf.record.Record @return record containing a PasswordRev4Record 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 @see org.apache.poi.hssf.record.WindowOneRecord @see org.apache.poi.hssf.record.Record @return record containing a WindowOneRecord Creates the Backup record with backup Set to 0. (loose the data, who cares) @see org.apache.poi.hssf.record.BackupRecord @see org.apache.poi.hssf.record.Record @return record containing a BackupRecord Creates the HideObj record with hide object Set to 0. (don't hide) @see org.apache.poi.hssf.record.HideObjRecord @see org.apache.poi.hssf.record.Record @return record containing a HideObjRecord Creates the DateWindow1904 record with windowing Set to 0. (don't window) @see org.apache.poi.hssf.record.DateWindow1904Record @see org.apache.poi.hssf.record.Record @return record containing a DateWindow1904Record Creates the Precision record with precision Set to true. (full precision) @see org.apache.poi.hssf.record.PrecisionRecord @see org.apache.poi.hssf.record.Record @return record containing a PrecisionRecord Creates the RefreshAll record with refreshAll Set to true. (refresh all calcs) @see org.apache.poi.hssf.record.RefreshAllRecord @see org.apache.poi.hssf.record.Record @return record containing a RefreshAllRecord Creates the BookBool record with saveLinkValues Set to 0. (don't save link values) @see org.apache.poi.hssf.record.BookBoolRecord @see org.apache.poi.hssf.record.Record @return record containing a BookBoolRecord 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 @see org.apache.poi.hssf.record.FontRecord @see org.apache.poi.hssf.record.Record @return record containing a FontRecord Creates a FormatRecord object @param id the number of the format record to Create (meaning its position in a file as M$ Excel would Create it.) @return record containing a FormatRecord @see org.apache.poi.hssf.record.FormatRecord @see org.apache.poi.hssf.record.Record Creates an ExtendedFormatRecord object @param id the number of the extended format record to Create (meaning its position in a file as MS Excel would Create it.) @return record containing an ExtendedFormatRecord @see org.apache.poi.hssf.record.ExtendedFormatRecord @see org.apache.poi.hssf.record.Record Creates an default cell type ExtendedFormatRecord object. @return ExtendedFormatRecord with intial defaults (cell-type) Creates a new StyleRecord, for the given Extended Format index, and adds it onto the end of the records collection Creates a StyleRecord object @param id the number of the style record to Create (meaning its position in a file as MS Excel would Create it. @return record containing a StyleRecord @see org.apache.poi.hssf.record.StyleRecord @see org.apache.poi.hssf.record.Record Creates a palette record initialized to the default palette @return a PaletteRecord instance populated with the default colors @see org.apache.poi.hssf.record.PaletteRecord Creates the UseSelFS object with the use natural language flag Set to 0 (false) @return record containing a UseSelFSRecord @see org.apache.poi.hssf.record.UseSelFSRecord @see org.apache.poi.hssf.record.Record 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. @param id either sheet 0,1 or 2. @return record containing a BoundSheetRecord @see org.apache.poi.hssf.record.BoundSheetRecord @see org.apache.poi.hssf.record.Record Creates the Country record with the default country Set to 1 and current country Set to 7 in case of russian locale ("ru_RU") and 1 otherwise @return record containing a CountryRecord @see org.apache.poi.hssf.record.CountryRecord @see org.apache.poi.hssf.record.Record Creates the SST record with no strings and the Unique/num string Set to 0 @return record containing a SSTRecord @see org.apache.poi.hssf.record.SSTRecord @see org.apache.poi.hssf.record.Record 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 @return record containing an ExtSSTRecord @see org.apache.poi.hssf.record.ExtSSTRecord @see org.apache.poi.hssf.record.Record Creates the EOF record @see org.apache.poi.hssf.record.EOFRecord @see org.apache.poi.hssf.record.Record @return record containing a EOFRecord Finds the sheet name by his extern sheet index @param num extern sheet index @return sheet name Finds the sheet index for a particular external sheet number. @param externSheetNumber The external sheet number to Convert @return The index to the sheet found. returns the extern sheet number for specific sheet number , if this sheet doesn't exist in extern sheet , Add it @param sheetNumber sheet number @return index to extern sheet Gets the name record @param index name index @return name record Creates new name @return new name record Creates new name @return new name record Generates a NameRecord to represent a built-in region @return a new NameRecord Unless the index Is invalid Removes the name @param namenum name index Returns a format index that matches the passed in format. It does not tie into HSSFDataFormat. @param format the format string @param CreateIfNotFound Creates a new format if format not found @return the format id of a format that matches or -1 if none found and CreateIfNotFound Creates a FormatRecord, Inserts it, and returns the index code. @param format the format string @return the index code of the format record. @see org.apache.poi.hssf.record.FormatRecord @see org.apache.poi.hssf.record.Record Returns the first occurance of a record matching a particular sid. Returns the index of a record matching a particular sid. @param sid The sid of the record to match @return The index of -1 if no match made. Returns the next occurance of a record matching a particular sid. Finds the primary drawing Group, if one alReady exists Creates a primary drawing Group record. If it alReady exists then it's modified. Removes the given font record from the file's list. This will make all subsequent font indicies drop by one, so you'll need to update those yourself! Removes the given ExtendedFormatRecord record from the file's list. This will make all subsequent font indicies drop by one, so you'll need to update those yourself! protect a workbook with a password (not encypted, just Sets Writeprotect flags and the password. @param password to Set Removes the Write protect flag @param reFindex Index to REF entry in EXTERNSHEET record in the Link Table @param definedNameIndex zero-based to DEFINEDNAME or EXTERNALNAME record @return the string representation of the defined or external name Gets the number of font records @return number of font records in the "font table" Returns the position of the backup record. returns the number of boundsheet objects contained in this workbook. @return number of BoundSheet records Get the number of ExtendedFormat records contained in this workbook. @return int count of ExtendedFormat records lazy initialization Note - creating the link table causes creation of 1 EXTERNALBOOK and 1 EXTERNALSHEET record Gets the total number of names @return number of names Returns the list of FormatRecords in the workbook. @return ArrayList of FormatRecords in the notebook Whether date windowing Is based on 1/2/1904 or 1/1/1900. Some versions of Excel (Mac) can save workbooks using 1904 date windowing. @return true if using 1904 date windowing Returns the custom palette in use for this workbook; if a custom palette record does not exist, then it Is Created. Is the workbook protected with a password (not encrypted)? This ptg indicates a data table. It only occurs in a FORMULA record, never in an ARRAY or NAME record. When ptgTbl occurs in a formula, it is the only token in the formula. This indicates that the cell containing the formula is an interior cell in a data table; the table description is found in a TABLE record. Rows and columns which contain input values to be substituted in the table do not contain ptgTbl. See page 811 of the june 08 binary docs. Common baseclass for tExp tTbl tParen tNlr tAttr tSheet tEndSheet The row number of the upper left corner The column number of the upper left corner Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc... @author Daniel Noll Underlying object record ultimately containing a reference to the object. Reference to the filesystem, required for retrieving the object data. Constructs object data by wrapping a lower level object record. @param record the low-level object record. @param poifs the filesystem, required for retrieving the object data. Gets the object data. Only call for ones that have data though. See {@link #hasDirectoryEntry()} @return the object data as an OLE2 directory. @ if there was an error Reading the data. Returns the data portion, for an ObjectData that doesn't have an associated POIFS Directory Entry Does this ObjectData have an associated POIFS Directory Entry? (Not all do, those that don't have a data portion) Finds the EmbeddedObjectRefSubRecord, or throws an Exception if there wasn't one Returns the OLE2 Class Name of the object

Excel lookup functions have complex behaviour in the case where the lookup array has mixed types, and/or Is Unordered. Contrary to suggestions in some Excel documentation, there does not appear to be a Universal ordering across types. The binary search algorithm used Changes behaviour when the Evaluated 'mid' value has a different type to the lookup value.

A simple int might have done the same job, but there Is risk in confusion with the well known Comparable.CompareTo() and Comparator.Compare() which both use a ubiquitous 3 value result encoding. Encapsulates some standard binary search functionality so the Unusual Excel behaviour can be clearly distinguished. @return -1 if the search range Is empty @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > Support for hyperbolic trig functions was Added as a part of Java distribution only in JDK1.5. This class uses custom naive implementation based on formulas at: http://www.math2.org/math/trig/hyperbolics.htm These formulas seem to agree with excel's implementation. @author Amol S. Deshmukh < amolweb at ya hoo dot com > Provides functionality for evaluating arguments to functions and operators. @author Josh Micich Retrieves a single value from a variety of different argument types according to standard Excel rules. Does not perform any type conversion. @param arg the Evaluated argument as passed to the function or operator. @param srcCellRow used when arg Is a single column AreaRef @param srcCellCol used when arg Is a single row AreaRef @return a NumberEval, StringEval, BoolEval or BlankEval. Never null or ErrorEval. @throws EvaluationException(#VALUE!) if srcCellRow or srcCellCol do not properly index into an AreaEval. If the actual value retrieved Is an ErrorEval, a corresponding EvaluationException Is thrown. @return possibly ErrorEval, and null Applies some conversion rules if the supplied value Is not alReady a number. Note - BlankEval Is not supported and must be handled by the caller. @param ev must be a NumberEval, StringEval or BoolEval @return actual, Parsed or interpreted double value (respectively). @throws EvaluationException(#VALUE!) only if a StringEval Is supplied and cannot be Parsed as a double (See Parsedouble() for allowable formats). @throws Exception if the supplied parameter Is not NumberEval, StringEval or BoolEval Converts a string to a double using standard rules that Excel would use.
Tolerates currency prefixes, commas, leading and trailing spaces.

Some examples:
" 123 " -> 123.0
".123" -> 0.123
These not supported yet:
" $ 1,000.00 " -> 1000.0
"$1.25E4" -> 12500.0
"5**2" -> 500
"250%" -> 2.5
@param text @return null if the specified text cannot be Parsed as a number @param ve must be a NumberEval, StringEval, BoolEval, or BlankEval @return the Converted string value. never null @return null to represent blank values @throws EvaluationException if ve is an ErrorEval, or if a string value cannot be converted @author Josh Micich Creates a NameEval representing a function name @author Daniel Noll (daniel at nuix dot com dot au) #NULL! - Intersection of two cell ranges Is empty #DIV/0! - Division by zero #VALUE! - Wrong type of operand #REF! - Illegal or deleted cell reference #NAME? - Wrong function or range name #NUM! - Value range overflow #N/A - Argument or function not available Creates new ErrPtg Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area) Description: Defined a area in Extern Sheet. REFERENCE: @author Patrick Luby @version 1.0-pre "Special Attributes" This seems to be a Misc Stuff and Junk record. One function it serves Is in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option Set) @author andy @author Jason Height (jheight at chariot dot net dot au) only used for tAttrChoose: table of offsets to starts of args only used for tAttrChoose: offset to the tFuncVar for CHOOSE() @param type a constant from SpaceType @param count the number of space Chars 00H = Spaces before the next token (not allowed before tParen token) 01H = Carriage returns before the next token (not allowed before tParen token) 02H = Spaces before opening parenthesis (only allowed before tParen token) 03H = Carriage returns before opening parenthesis (only allowed before tParen token) 04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens) 05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens) 06H = Spaces following the equality sign (only in macro sheets) Title: Extended Static String Table Description: This record Is used for a quick Lookup into the SST record. This record breaks the SST table into a Set of buckets. The offsets to these buckets within the SST record are kept as well as the position relative to the start of the SST record. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at apache dot org) @version 2.0-pre @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord Constructs a EOFRecord record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Given a number of strings (in the sst), returns the size of the extsst record Returns the size of this record Conditional Formatting Header record (CFHEADER) @author Dmitriy Kumshayev Creates new CFHeaderRecord @return byte array containing instance data Aggregate value records toGether. Things are easier to handle that way. @author andy @author Glen Stampoultzis (glens at apache.org) @author Jason Height (jheight at chariot dot net dot au) Creates a new instance of ValueRecordsAggregate Sometimes the shared formula flag "seems" to be erroneously Set, in which case there Is no call to SharedFormulaRecord.ConvertSharedFormulaRecord and hence the ParsedExpression field of this FormulaRecord will not Get updated.
As it turns out, this Is not a problem, because in these circumstances, the existing value for ParsedExpression Is perfectly OK.

This method may also be used for Setting breakpoints to help diagnose Issues regarding the abnormally-Set 'shared formula' flags. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).

The method currently does nothing but do not delete it without Finding a nice home for this comment. Tallies a count of the size of the cell records that are attached to the rows in the range specified. Returns true if the row has cells attached to it Serializes the cells that are allocated to a certain row range

Description: This record stores data validation Settings and a list of cell ranges which contain these Settings. The data validation Settings of a sheet are stored in a sequential list of DV records. This list Is followed by DVAL record(s) @author Dragos Buleandra (dragos.buleandra@trade2b.ro) @version 2.0-pre Option flags Title of the prompt box Title of the error box Text of the prompt box Text of the error box Not used - Excel seems to always write 0x3FE0 Formula data for first condition (RPN token array without size field) Not used - Excel seems to always write 0x0000 Formula data for second condition (RPN token array without size field) Cell range address list with all affected ranges Option flags field @see org.apache.poi.hssf.util.HSSFDataValidation utility class Constructs a DV record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from When entered via the UI, Excel translates empty string into "\0" While it is possible to encode the title/text as empty string (Excel doesn't exactly crash), the resulting tool-tip text / message box looks wrong. It is best to do the same as the Excel UI and encode 'not present' as "\0". Clones the object. Uses serialisation, as the contents are somewhat complex Get the condition data type @return the condition data type @see org.apache.poi.hssf.util.HSSFDataValidation utility class Get the condition error style @return the condition error style @see org.apache.poi.hssf.util.HSSFDataValidation utility class return true if in list validations the string list Is explicitly given in the formula, false otherwise @return true if in list validations the string list Is explicitly given in the formula, false otherwise @see org.apache.poi.hssf.util.HSSFDataValidation utility class return true if empty values are allowed in cells, false otherwise @return if empty values are allowed in cells, false otherwise @see org.apache.poi.hssf.util.HSSFDataValidation utility class return true if a prompt window should appear when cell Is selected, false otherwise @return if a prompt window should appear when cell Is selected, false otherwise @see org.apache.poi.hssf.util.HSSFDataValidation utility class return true if an error window should appear when an invalid value Is entered in the cell, false otherwise @return if an error window should appear when an invalid value Is entered in the cell, false otherwise @see org.apache.poi.hssf.util.HSSFDataValidation utility class Get the condition operator @return the condition operator @see org.apache.poi.hssf.util.HSSFDataValidation utility class Gets the option flags field. @return options - the option flags field Title: Beginning Of File Description: Somewhat of a misnomer, its used for the beginning of a Set of records that have a particular pupose 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 @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre for BIFF8 files the BOF Is 0x809. For earlier versions it was 0x09 or 0x(biffversion)09 suggested default for a normal sheet (0x41) suggested default (0x06 - BIFF8) suggested default 0x10d3 suggested default 0x07CC (1996) Constructs an empty BOFRecord with no fields Set. Constructs a BOFRecord and Sets its fields appropriately @param in the RecordInputstream to Read the record from Version number - for BIFF8 should be 0x06 @see #VERSION @param version version to be Set Set the history bit mask (not very useful) @see #HISTORY_MASK @param bitmask bitmask to Set for the history Set the minimum version required to Read this file @see #VERSION @param version version to Set type of object this marks @see #TYPE_WORKBOOK @see #TYPE_VB_MODULE @see #TYPE_WORKSHEET @see #TYPE_CHART @see #TYPE_EXCEL_4_MACRO @see #TYPE_WORKSPACE_FILE @return short type of object Get the build that wrote this file @see #BUILD @return short build number of the generator of this file Year of the build that wrote this file @see #BUILD_YEAR @return short build year of the generator of this file Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create a listener supporting this interface and register it with the HSSFRequest (associating it with Record SID's). @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory @see org.apache.poi.hssf.eventusermodel.HSSFRequest @see org.apache.poi.hssf.eventusermodel.HSSFUserException @author Carey Sublette (careysub@earthling.net) This method, inherited from HSSFListener Is implemented as a stub. It Is never called by HSSFEventFActory or HSSFRequest. Process an HSSF Record. Called when a record occurs in an HSSF file. Provides two options for halting the Processing of the HSSF file. The return value provides a means of non-error termination with a user-defined result code. A value of zero must be returned to continue Processing, any other value will halt Processing by HSSFEventFactory with the code being passed back by its abortable Process events methods. Error termination can be done by throwing the HSSFUserException. Note that HSSFEventFactory will not call the inherited Process @return result code of zero for continued Processing. @throws HSSFUserException User code can throw this to abort file Processing by HSSFEventFactory and return diagnostic information.

See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table' @author Josh Micich Creates an empty ConditionalFormattingTable @return index of the newly added CF header aggregate Internal POI use only @author Josh Micich

HLOOKUP Finds a column in a lookup table by the first row value and returns the value from another row.
Syntax:
HLOOKUP(lookup_value, table_array, row_index_num, range_lookup)

lookup_value The value to be found in the first column of the table array.
table_array An area reference for the lookup data.
row_index_num a 1 based index specifying which row value of the lookup data will be returned.
range_lookup If TRUE (default), HLOOKUP Finds the largest value less than or equal to the lookup_value. If FALSE, only exact Matches will be considered
@author Josh Micich Returns one column from an AreaEval @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > Specifies a rectangular area of cells A1:A4 for instance. @author Jason Height (jheight at chariot dot net dot au) Populates this fields data from the byte array passed in1. @param in the RecordInputstream to Read the record from Appends the string representation of this field to the supplied StringBuilder. @param str The string buffer to Append to. Converts this field to it's byte array form. @param offset The offset into the byte array to start writing to. @param data The data array to Write to. @return The number of bytes written. @return The size of this field in bytes. This operation Is not valid Until after the call to FillField() Class ChartFormatRecord @author Glen Stampoultzis (glens at apache.org) @version %I%, %G% Constructs a ChartFormatRecord record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from 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) @author Andrew C. Oliver (acoliver at apache dot org) @author Sergei Kozello (sergeikozello at mail.ru) @version 2.0-pre Constructs a BoundSheetRecord and Sets its fields appropriately @param in the RecordInputstream to Read the record from Converts a List of {@link BoundSheetRecord}s to an array and sorts by the position of their BOFs. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file @return offset in bytes Is the sheet very hidden? Different from (normal) hidden Get the sheetname for this sheet. (this appears in the tabs at the bottom) @return sheetname the name of the sheet Enumeration of various formula types.
For POI internal use only @author Josh Micich Allows the user to lookup the font metrics for a particular font without actually having the font on the system. The font details are Loaded as a resource from the POI jar file (or classpath) and should be contained in path "/font_metrics.properties". The font widths are for a 10 point version of the font. Use a multiplier for other sizes. @author Glen Stampoultzis (glens at apache.org) The font metrics property file we're using Our cache of font details we've alReady looked up Retrieves the fake font details for a given font. @param font the font to lookup. @return the fake font. DATATABLE (0x0236)

TableRecord - The record specifies a data table. This record Is preceded by a single Formula record that defines the first cell in the data table, which should only contain a single Ptg, {@link TblPtg}. See p536 of the June 08 binary docs @author Josh Micich Creates a list constraint Creates a number based data validation constraint. The text values entered for expr1 and expr2 can be either standard Excel formulas or formatted number values. If the expression starts with '=' it is parsed as a formula, otherwise it is parsed as a formatted number. @param validationType one of {@link ValidationType#ANY}, {@link ValidationType#DECIMAL}, {@link ValidationType#INTEGER}, {@link ValidationType#TEXT_LENGTH} @param comparisonOperator any constant from {@link OperatorType} enum @param expr1 date formula (when first char is '=') or formatted number value @param expr2 date formula (when first char is '=') or formatted number value Creates a time based data validation constraint. The text values entered for expr1 and expr2 can be either standard Excel formulas or formatted time values. If the expression starts with '=' it is parsed as a formula, otherwise it is parsed as a formatted time. To parse formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to Excel which uses the default time format from the OS. @param comparisonOperator constant from {@link OperatorType} enum @param expr1 date formula (when first char is '=') or formatted time value @param expr2 date formula (when first char is '=') or formatted time value Creates a date based data validation constraint. The text values entered for expr1 and expr2 can be either standard Excel formulas or formatted date values. If the expression starts with '=' it is parsed as a formula, otherwise it is parsed as a formatted date (Excel uses the same convention). To parse formatted dates, a date format needs to be specified. This is contrary to Excel which uses the default short date format from the OS. @param comparisonOperator constant from {@link OperatorType} enum @param expr1 date formula (when first char is '=') or formatted date value @param expr2 date formula (when first char is '=') or formatted date value @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD" otherwise any other valid argument for SimpleDateFormat can be used @see SimpleDateFormat Distinguishes formula expressions from simple value expressions. This logic is only required by a few factory methods in this class that Create data validation constraints from more or less the same parameters that would have been entered in the Excel UI. The data validation dialog box uses the convention that formulas begin with '='. Other methods in this class follow the POI convention (formulas and values are distinct), so the '=' convention is not used there. @param textExpr a formula or value expression @return all text after '=' if textExpr begins with '='. Otherwise null if textExpr does not begin with '=' @return null if numberStr is null @return null if timeStr is null @param dateFormat pass null for default YYYYMMDD @return null if timeStr is null @return both parsed formulas (for expression 1 and 2). @return The parsed token array representing the formula or value specified. Empty array if both formula and value are null @return data validation type of this constraint @see ValidationType Convenience method @return true if this constraint is a 'list' validation Convenience method @return true if this constraint is a 'list' validation with explicit values @return the operator used for this constraint @see OperatorType @return the formula for expression 1. May be null @return the formula for expression 2. May be null @return the numeric value for expression 1. May be null @return the numeric value for expression 2. May be null ValidationType enum 'Any value' type - value not restricted Integer ('Whole number') type Decimal type List type ( combo box type ) Date type Time type String length type Formula ( 'Custom' ) type Condition operator enum default value to supply when the operator type is not used Instances of this class keep track of multiple dependent cell evaluations due To recursive calls To {@link WorkbookEvaluator#evaluate(HSSFCell)} The main purpose of this class Is To detect an attempt To evaluate a cell that Is already being evaluated. In other words, it detects circular references in spreadsheet formulas. @author Josh Micich Notifies this evaluation tracker that the evaluation of the specified cell Is complete.

Every successful call To startEvaluate must be followed by a call To endEvaluate (recommended in a finally block) To enable proper tracking of which cells are being evaluated at any point in time.

Assuming a well behaved client, parameters To this method would not be required. However, they have been included To assert correct behaviour, and form more meaningful error messages. Title: SharedFormulaRecord Description: Primarily used as an excel optimization so that multiple similar formulas are not written out too many times. We should recognize this record and Serialize as Is since this Is used when Reading templates. Note: the documentation says that the SID Is BC where biffviewer reports 4BC. The hex dump shows that the two byte sid representation to be 'BC 04' that Is consistent with the other high byte record types. @author Danny Mui at apache dot org @param in the RecordInputstream to Read the record from spit the record out AS Is. no interperatation or identification print a sort of string representation ([SHARED FORMULA RECORD] id = x [/SHARED FORMULA RECORD]) Creates a non shared formula from the shared formula counter part Creates a non shared formula from the shared formula counter part * The series chart Group index record stores the index to the CHARTFORMAT record (0 based). * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Glen Stampoultzis (glens at apache.org) Constructs a SeriesChartGroupIndex record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Size of record (exluding 4 byte header) Get the chart Group index field for the SeriesChartGroupIndex record. The obj record Is used to hold various graphic objects and controls. @author Glen Stampoultzis (glens at apache.org) Constructs a OBJ record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Size of record (excluding 4 byte header) Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values. HSSF just Converts this into multiple NUMBER records. Read-ONLY SUPPORT! REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Creates new MulRKRecord Constructs a MulRK record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from returns the xf index for column (coffset = column - field_2_first_col) @return the XF index for the column returns the rk number for column (coffset = column - field_2_first_col) @return the value (decoded into a double) starting column (first cell this holds in the row) @return first column number ending column (last cell this holds in the row) @return first column number Get the number of columns this Contains (last-first +1) @return number of columns (last - first +1) * Defines a legend for a chart. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or * Remove the record in src/records/definitions. * @author Andrew C. Oliver (acoliver at apache.org) Constructs a Legend record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the x axis upper left field for the Legend record. Set the x axis upper left field for the Legend record. Get the y axis upper left field for the Legend record. Set the y axis upper left field for the Legend record. Size of record (exluding 4 byte header) Get the x size field for the Legend record. Get the y size field for the Legend record. Get the type field for the Legend record. @return One of TYPE_BOTTOM TYPE_CORNER TYPE_TOP TYPE_RIGHT TYPE_LEFT TYPE_UNDOCKED Get the spacing field for the Legend record. @return One of SPACING_CLOSE SPACING_MEDIUM SPACING_OPEN Get the options field for the Legend record. automatic positioning (1=docked) @return the auto position field value. excel 5 only (true) @return the auto series field value. position of legend on the x axis Is automatic @return the auto x positioning field value. position of legend on the y axis Is automatic @return the auto y positioning field value. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic. @return the vertical field value. 1 if chart Contains data table @return the data table field value. Number Stores a floating point value in a formula value stored in a 8 byte field using IEEE notation @author Avik Sengupta @author Jason Height (jheight at chariot dot net dot au) Create a NumberPtg from a byte array Read from disk Create a NumberPtg from a string representation of the number Number format is not checked, it is expected to be validated in the parser that calls this method. @param value : String representation of a floating point number @author andy @author Jason Height (jheight at chariot dot net dot au) @author Daniel Noll (daniel at nuix dot com dot au) Creates new MemErrPtg the sid for the less than operator as hex identifier for LESS THAN char Implementation of method from OperationsPtg @param operands a String array of operands @return String the Formula as a String Get the number of operands for the Less than operator @return int the number of operands @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author andy Title: Deleted Reference 3D Ptg Description: Defined a cell in extern sheet. REFERENCE: @author Patrick Luby @version 1.0-pre Creates new DeletedRef3DPtg