Returns much (but not all) of the textual content of the file, suitable for indexing by something like Apache Lucene, or used by Apache Tika, but not really intended for display to the user.

                     _______________________________
                    |          DConRef              |
            (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
                    |    ref    |cch|  stFile   | un|
                    +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
                                          |
                                 _________|_____________________
                                |DConFile / XLUnicodeStringNoCch|
                                +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
                         (bits) |h|   reserved  |      rgb      |
                                +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
             

• DConFile.h = 0x00 if the characters inrgb are single byte, and DConFile.h = 0x01 if they are double byte.
  If they are double byte, then
  
  • If it exists, the length of DConRef.un = 2. Otherwise it is 1.
  • The length of DConFile.rgb = (2 * DConRef.cch). Otherwise it is equal to DConRef.cch
  .
• DConRef.rgb starts with 0x01 if it is an external reference, and with 0x02 if it is a self-reference.

@see DConFile [MS-XLS s. 2.5.77] and VirtualPath [MS-XLS s. 2.5.69]

unused bits at the end, must be set to 0. Read constructor. @param data byte array containing a DConRef Record, including the header. Read Constructor. @param inStream RecordInputStream containing a DConRefRecord structure. @return raw path byte array. @return The first column of the range. @return The first row of the range. @return The last column of the range. @return The last row of the range. @return the link's path, with the special characters stripped/replaced. May be null. See MS-XLS 2.5.277 (VirtualPath) Checks if the data source in this reference record is external to this sheet or internal. @return true iff this is an external reference. The FtCf structure specifies the clipboard format of the picture-type Obj record Containing this FtCf. Subrecords are part of the OBJ class. Wether this record terminates the sub-record stream. There are two cases when this method must be overridden and return true - EndSubRecord (sid = 0x00) - LbsDataSubRecord (sid = 0x12) @return whether this record is the last in the sub-record stream Specifies the format of the picture is an enhanced metafile. Specifies the format of the picture is a bitmap. Specifies the picture is in an unspecified format that is neither and enhanced metafile nor a bitmap. Construct a new FtPioGrbitSubRecord and fill its data with the default values Convert this record to string. Used by BiffViewer and other utilities. Serialize the record data into the supplied array of bytes @param out the stream to serialize into @return id of this record. This structure appears as part of an Obj record that represents image display properties. A bit that specifies whether the picture's aspect ratio is preserved when rendered in different views (Normal view, Page Break Preview view, Page Layout view and printing). A bit that specifies whether the pictFmla field of the Obj record that Contains this FtPioGrbit specifies a DDE reference. A bit that specifies whether this object is expected to be updated on print to reflect the values in the cell associated with the object. A bit that specifies whether the picture is displayed as an icon. A bit that specifies whether this object is an ActiveX control. It MUST NOT be the case that both fCtl and fDde are equal to 1. A bit that specifies whether the object data are stored in an embedding storage (= 0) or in the controls stream (ctls) (= 1). A bit that specifies whether this is a camera picture. A bit that specifies whether this picture's size has been explicitly Set. 0 = picture size has been explicitly Set, 1 = has not been Set A bit that specifies whether the OLE server for the object is called to load the object's data automatically when the parent workbook is opened. Construct a new FtPioGrbitSubRecord and fill its data with the default values Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT @param bitmask @param enabled Convert this record to string. Used by BiffViewer and other utilities. Serialize the record data into the supplied array of bytes @param out the stream to serialize into @return id of this record. Base class for all old (Biff 2 - Biff 4) cell value records (implementors of {@link CellValueRecordInterface}). Subclasses are expected to manage the cell data values (of various types). Append specific debug info (used by {@link #ToString()} for the value Contained in this record. Trailing new-line should not be Appended (superclass does that). Get the index to the ExtendedFormat, for non-Biff2 @see NPOI.HSSF.Record.ExtendedFormatRecord @return index to the XF record Is this a Biff2 record, or newer? Gets the debug info BIFF record type name (used by {@link #ToString()}. Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in encoded form, along with the value if a number Get the calculated value of the formula @return calculated value Get the option flags @return bitmask @return the formula tokens. never null Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for strings stored directly in the cell, from the older file formats that didn't use {@link LabelSSTRecord} @param in the RecordInputstream to read the record from Not supported Get the number of characters this string Contains @return number of characters Get the String of the cell Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5
Description: Defines a sheet within a workbook. Basically stores the sheet name and tells where the Beginning of file record is within the HSSF file. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file @return offset in bytes Get the sheetname for this sheet. (this appears in the tabs at the bottom) @return sheetname the name of the sheet Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for formula string results. @param in the RecordInputstream to read the record from @return The string represented by this record.

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 ec primarily used to identify the source cell Containing the formula being Evaluated. may also be used to dynamically create reference evals. @return never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors). Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()
Returns the number of workdays given a starting and an ending date, considering an interval of holidays. A workday is any non saturday/sunday date.

Syntax
NETWORKDAYS(startDate, endDate, holidays)

@author jfaenomoto@gmail.com Constructor. @param anEvaluator an injected {@link ArgumentsEvaluator}. Evaluate for NETWORKDAYS. Given two dates and a optional date or interval of holidays, determines how many working days are there between those dates. @return {@link ValueEval} for the number of days between two dates. An exception thrown by implementors of {@link FormulaEvaluator} when attempting to evaluate a formula which requires a function that POI does not (yet) support. A calculator for workdays, considering dates as excel representations. @author jfaenomoto@gmail.com Constructor. Calculate how many workdays are there between a start and an end date, as excel representations, considering a range of holidays. @param start start date. @param end end date. @param holidays an array of holidays. @return number of workdays between start and end dates, including both dates. Calculate the workday past x workdays from a starting date, considering a range of holidays. @param start start date. @param workdays number of workdays to be past from starting date. @param holidays an array of holidays. @return date past x workdays. Calculates how many days of week past between a start and an end date. @param start start date. @param end end date. @param dayOfWeek a day of week as represented by {@link Calendar} constants. @return how many days of week past in this interval. Calculates how many holidays in a list are workdays, considering an interval of dates. @param start start date. @param end end date. @param holidays an array of holidays. @return number of holidays that occur in workdays, between start and end dates. @param aDate a given date. @return true if date is weekend, false otherwise. @param aDate a given date. @param holidays an array of holidays. @return true if date is a holiday, false otherwise. @param aDate a given date. @param holidays an array of holidays. @return 1 is not a workday, 0 otherwise. @param start start date. @param end end date. @param aDate a date to be analyzed. @return true if aDate is between start and end dates, false otherwise. Implementation of Excel 'Analysis ToolPak' function WORKDAY()
Returns the date past a number of workdays beginning at a start date, considering an interval of holidays. A workday is any non saturday/sunday date.

Syntax
WORKDAY(startDate, days, holidays)

@author jfaenomoto@gmail.com Evaluate for WORKDAY. Given a date, a number of days and a optional date or interval of holidays, determines which date it is past number of parametrized workdays. @return {@link ValueEval} with date as its value.

Some utils for Converting from and to any base

Syntax:
Bin2Dec (number)

Converts a binary number to decimal.

Number is the binary number you want to convert. Number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.

Remark If number is not a valid binary number, or if number contains more than 10 characters (10 bits), BIN2DEC returns the #NUM! error value. @author cedric dot walter @ gmail dot com Convenience base class for functions that must take exactly one argument. @author Josh Micich Implemented by all functions that can be called with one argument @author Josh Micich

Syntax:
CODE (text )

Returns a numeric code for the first character in a text string. The returned code corresponds to the character set used by your computer.

text The text for which you want the code of the first character. @author cedric dot walter @ gmail dot com Implementation for Excel COMPLEX () function.

Syntax:
COMPLEX (real_num,i_num,suffix )

Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.

All complex number functions accept "i" and "j" for suffix, but neither "I" nor "J". Using uppercase results in the #VALUE! error value. All functions that accept two or more complex numbers require that all suffixes match.

real_num The real coefficient of the complex number. If this argument is nonnumeric, this function returns the #VALUE! error value.

i_num The imaginary coefficient of the complex number. If this argument is nonnumeric, this function returns the #VALUE! error value.

suffix The suffix for the imaginary component of the complex number.

• If omitted, suffix is assumed to be "i".
• If suffix is neither "i" nor "j", COMPLEX returns the #VALUE! error value.

Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2])

Syntax:
Bin2Dec (number,[places] )

Converts a decimal number to binary.

The DEC2BIN function syntax has the following arguments:

• Number Required. The decimal integer you want to Convert. If number is negative, valid place values are ignored and DEC2BIN returns a 10-character (10-bit) binary number in which the most significant bit is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
• Places Optional. The number of characters to use. If places is omitted, DEC2BIN uses the minimum number of characters necessary. Places is useful for pAdding the return value with leading 0s (zeros).

Remarks

• If number < -512 or if number > 511, DEC2BIN returns the #NUM! error value.
• If number is nonnumeric, DEC2BIN returns the #VALUE! error value.
• If DEC2BIN requires more than places characters, it returns the #NUM! error value.
• If places is not an integer, it is tRuncated.
• If places is nonnumeric, DEC2BIN returns the #VALUE! error value.
• If places is zero or negative, DEC2BIN returns the #NUM! error value.

Syntax:
DEC2HEX (number,places )

Converts a decimal number to hexadecimal. The decimal integer you want to Convert. If number is negative, places is ignored and this function returns a 10-character (40-bit) hexadecimal number in which the most significant bit is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.

• If number < -549,755,813,888 or if number > 549,755,813,887, this function returns the #NUM! error value.
• If number is nonnumeric, this function returns the #VALUE! error value.

places

• If this argument is omitted, this function uses the minimum number of characters necessary.
• If this function requires more than places characters, it returns the #NUM! error value.
• If this argument is nonnumeric, this function returns the #VALUE! error value.
• If this argument is negative, this function returns the #NUM! error value.
• If this argument Contains a decimal value, this function ignores the numbers to the right side of the decimal point.

Syntax:
DELTA (number1,number2 )

Tests whether two values are Equal. Returns 1 if number1 = number2; returns 0 otherwise. Use this function to filter a Set of values. For example, by summing several DELTA functions you calculate the count of equal pairs. This function is also known as the Kronecker Delta function.

• If number1 is nonnumeric, DELTA returns the #VALUE! error value.
• If number2 is nonnumeric, DELTA returns the #VALUE! error value.

EOMONTH() returns the date of the last day of a month..

Syntax:
EOMONTH(start_date,months)

start_date is the starting date of the calculation months is the number of months to be Added to start_date, to give a new date. For this new date, EOMONTH returns the date of the last day of the month. months may be positive (in the future), zero or negative (in the past). Implementation for the ERROR.TYPE() Excel function.

Syntax:
ERROR.TYPE(errorValue)

Returns a number corresponding to the error type of the supplied argument.

errorValue	Return Value
#NULL!	1
#DIV/0!	2
#VALUE!	3
#REF!	4
#NAME?	5
#NUM!	6
#N/A!	7
everything else	#N/A!

Note - the results of ERROR.TYPE() are different to the constants defined in ErrorConstants.

Syntax:
FACTDOUBLE (number)

Returns the double factorial of a number.

Number is the value for which to return the double factorial. If number is not an integer, it is truncated.

Remarks

• If number is nonnumeric, FACTDOUBLE returns the #VALUE! error value.
• If number is negative, FACTDOUBLE returns the #NUM! error value.

Syntax:
HEX2DEC (number)

Converts a hexadecimal number to decimal.

Number is the hexadecimal number you want to Convert. Number cannot contain more than 10 characters (40 bits). The most significant bit of number is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation. Remark If number is not a valid hexadecimal number, HEX2DEC returns the #NUM! error value. @author cedric dot walter @ gmail dot com Implementation of Excel HYPERLINK function.

In Excel this function has special behaviour - it causes the displayed cell value to behave like a hyperlink in the GUI. From an evaluation perspective however, it is very simple.

Syntax:
HYPERLINK(link_location, friendly_name)

link_location The URL of the hyperlink
friendly_name (optional) the value to display

Returns last argument. Leaves type unchanged (does not convert to {@link org.apache.poi.ss.formula.eval.StringEval}). @author Wayne Clingingsmith Implementation for Excel IMAGINARY() function.

Syntax:
IMAGINARY (Inumber)

Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.

Inumber is a complex number for which you want the imaginary coefficient.

Remarks

• Use COMPLEX to convert real and imaginary coefficients into a complex number.

Syntax:
ImReal (Inumber)

Returns the real coefficient of a complex number in x + yi or x + yj text format.

Inumber A complex number for which you want the real coefficient.

Remarks

• If inumber is not in the form x + yi or x + yj, this function returns the #NUM! error value.
• Use COMPLEX to convert real and imaginary coefficients into a complex number.

Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values
(http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html) Syntax:
INTERCEPT(arrayX, arrayY)

@author Johan Karlsteen @author Amol S. Deshmukh < amolweb at yahoo dot com > Base class for linear regression functions. Calculates the linear regression line that is used to predict y values from x values
(http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html) Syntax:
INTERCEPT(arrayX, arrayY)

or SLOPE(arrayX, arrayY)

@author Johan Karlsteen Represents a single row or column within an AreaEval. Calculates Modified internal rate of return. Syntax is MIRR(cash_flow_values, finance_rate, reinvest_rate)

Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost of the investment and the interest received on reinvestment of cash.

• Values must contain at least one positive value and one negative value to calculate the modified internal rate of return. Otherwise, MIRR returns the #DIV/0! error value.
• If an array or reference argument Contains text, logical values, or empty cells, those values are ignored; however, cells with the value zero are included.

Implementation for Excel Oct2Dec() function.

Converts an octal number to decimal.

Syntax:
Oct2Dec (number )

Number is the octal number you want to Convert. Number may not contain more than 10 octal characters (30 bits). The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation..

If number is not a valid octal number, OCT2DEC returns the #NUM! error value. @author cedric dot walter @ gmail dot com Compute the interest portion of a payment. @author Mike Argyriou micharg@gmail.com

Implementation for Excel QUOTIENT () function.

Syntax:
QUOTIENT(Numerator,Denominator)

Numerator is the dividend. Denominator is the divisor. Returns the integer portion of a division. Use this function when you want to discard the remainder of a division.

Syntax:
REPT (text,number_times )

Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string. text : text The text that you want to repeat. number_times: A positive number specifying the number of times to repeat text. If number_times is 0 (zero), REPT returns "" (empty text). If this argument contains a decimal value, this function ignores the numbers to the right side of the decimal point. The result of the REPT function cannot be longer than 32,767 characters, or REPT returns #VALUE!. @author cedric dot walter @ gmail dot com Implementation for Excel WeekNum() function.

Syntax:
WeekNum (Serial_num,Return_type)

Returns a number that indicates where the week falls numerically within a year.

Serial_num is a date within the week. Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. Return_type is a number that determines on which day the week begins. The default is 1. 1 Week begins on Sunday. Weekdays are numbered 1 through 7. 2 Week begins on Monday. Weekdays are numbered 1 through 7. @author cedric dot walter @ gmail dot com Classic conversion. @param number @return Use conversion rule to factor some parts and make them more concise @param result @param form @return Implementation of Excel function SLOPE()

Calculates the SLOPE of the linear regression line that is used to predict y values from x values
(http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html) Syntax:
SLOPE(arrayX, arrayY)

@author Johan Karlsteen Implementation for the Excel function SUMIFS

Syntax :
SUMIFS ( sum_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)

• sum_range Required. One or more cells to sum, including numbers or names, ranges, or cell references that contain numbers. Blank and text values are ignored.
• criteria1_range Required. The first range in which to evaluate the associated criteria.
• criteria1 Required. The criteria in the form of a number, expression, cell reference, or text that define which cells in the criteria_range1 argument will be added
• criteria_range2, criteria2, ... Optional. Additional ranges and their associated criteria. Up to 127 range/criteria pairs are allowed.

Syntax:
WeekNum (Serial_num,Return_type)

Returns a number that indicates where the week falls numerically within a year.

Serial_num is a date within the week. Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. Return_type is a number that determines on which day the week begins. The default is 1. 1 Week begins on Sunday. Weekdays are numbered 1 through 7. 2 Week begins on Monday. Weekdays are numbered 1 through 7. @author cedric dot walter @ gmail dot com

Title: XSSF Area 3D Reference (Sheet + Area)

Description: Defined an area in an external or different sheet.

REFERENCE:

This is XSSF only, as it stores the sheet / book references in String form. The HSSF equivalent using indexes is {@link Area3DPtg}

This is XSSF only, as it stores the sheet / book references in String form. The HSSF equivalent using indexes is {@link NameXPtg}

Title: XSSF 3D Reference

Description: Defines a cell in an external or different sheet.

REFERENCE:

This is XSSF only, as it stores the sheet / book references in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}

See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook (BIFF5-BIFF8)' @author Josh Micich Creates an empty WorksheetProtectionBlock @return true if the specified Record sid is one belonging to the 'Page Settings Block'. This method Reads {@link WorksheetProtectionBlock} records from the supplied RecordStream until the first non-WorksheetProtectionBlock record is encountered. As each record is Read, it is incorporated into this WorksheetProtectionBlock.

As per the OOO documentation, the protection block records can be expected to be written toGether (with no intervening records), but earlier versions of POI (prior to Jun 2009) didn't do this. Workbooks with sheet protection Created by those earlier POI versions seemed to be valid (Excel opens them OK). So PO allows continues to support Reading of files with non continuous worksheet protection blocks.

Note - when POI Writes out this WorksheetProtectionBlock, the records will always be written in one consolidated block (in the standard ordering) regardless of how scattered the records were when they were originally Read.

Description: Unicode String - just standard fields that are in several records. It is considered more desirable then repeating it in all of them.

This is often called a XLUnicodeRichExtendedString in MS documentation.

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

REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214 Our handling of Equals is inconsistent with CompareTo. The trouble is because we don't truely understand rich text fields yet it's difficult to make a sound comparison. @param o The object to Compare. @return true if the object is actually Equal. construct a unicode string record and fill its fields, ID is ignored @param in the RecordInputstream to read the record from Adds a font run to the formatted string. If a font run exists at the current charcter location, then it is Replaced with the font run to be Added. Swaps all use in the string of one font index for use of a different font index. Normally only called when fonts have been Removed / re-ordered unlike the real records we return the same as "getString()" rather than debug info @see #getDebugInfo() @return String value of the record return a character representation of the fields of this record @return String of output for biffviewer etc. Serialises out the String. There are special rules about where we can and can't split onto Continue records. get the number of characters in the string, as an un-wrapped int @return number of characters Get the option flags which among other things return if this is a 16-bit or 8 bit string @return optionflags bitmask @return the actual string this Contains as a java String object Returns our size, excluding our 4 byte header A decorated {@link RecordInputStream} that can read primitive data types (short, int, long, etc.) spanned across a {@link ContinueRecord } boundary.

Most records construct themselves from {@link RecordInputStream}. This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary, however, it is not always so.

{@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a "Not enough data (1) to read requested (2) bytes" exception. The ContinuableRecordInput class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.

YK: For now (March 2011) this class is only used to read @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString.

• 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

• The other object is not a {@link Section}.
• The format IDs of the two sections are not equal.
• The sections have a different number of properties. However, properties with ID 1 (codepage) are not counted.
• The other object is not a {@link Section}.
• The properties have different values. The order of the properties is irrelevant.

Creates the most specific {@link PropertySet} from an entry in the specified POIFS Directory. This is preferrably a {@link DocumentSummaryInformation} or a {@link SummaryInformation}. If the specified entry does not contain a property Set stream, an exception is thrown. If no entry is found with the given name, an exception is thrown.

• {@link Thumbnail#CFTAG_WINDOWS}
• {@link Thumbnail#CFTAG_MACINTOSH}
• {@link Thumbnail#CFTAG_NODATA}
• {@link Thumbnail#CFTAG_FMTID}

typedef struct tagCLIPDATA {
             // cbSize is the size of the buffer pointed To
             // by pClipData, plus sizeof(ulClipFmt)
             ULONG              cbSize;
             long               ulClipFmt;
             BYTE*              pClipData;
             } CLIPDATA;

Turns a codepage number into the equivalent character encoding's name.

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

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

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 Manages the all the records associated with a 'Custom View Settings' sub-stream.
Includes the Initial USERSVIEWBEGIN(0x01AA) and USERSVIEWEND(0x01AB). @author Josh Micich All the records between BOF and EOF

See OOO excelfileformat.pdf sec 4.4 'Page Settings Block' @author Josh Micich 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 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

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

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 ARRAY (0x0221)

Treated in a similar way to SharedFormulaRecord @author Josh Micich Common base class for {@link SharedFormulaRecord}, {@link ArrayRecord} and {@link TableRecord} which are have similarities. @author Josh Micich reads only the range (1 {@link CellRangeAddress8Bit}) from the stream @return true if (rowIx, colIx) is within the range ({@link #Range}) of this shared value object. @return true if (rowIx, colIx) describes the first cell in this shared value object's range ({@link #Range})

Description: the default characterset. for the workbook

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

Use {@link CodePageUtil} to turn these values into Java code pages to encode/decode strings.

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) Class POIFSWriterEvent @author Marc Johnson (mjohnson at apache dot org) @version %I%, %G% namespace scoped constructor @param stream the DocumentOutputStream, freshly opened @param path the path of the document @param documentName the name of the document @param limit the limit, in bytes, that can be written to the stream @return the DocumentOutputStream, freshly opened @return the document's path @return the document's name @return the limit on writing, in bytes

Creates a POIFSFileSystem from a File. This uses less memory than creating from an InputStream.

Note that with this constructor, you will need to call {@link #close()} when you're done to have the underlying file closed, as the file is kept open during normal operation to read the data out.

Creates a POIFSFileSystem from an open FileChannel. This uses * less memory than creating from an InputStream. The stream will * be used in read-only mode.

Note that with this constructor, you will need to call {@link #close()} * when you're done to have the underlying Channel closed, as the channel is * kept open during normal operation to read the data out.

Creates a POIFSFileSystem from an open FileChannel. This uses less memory than creating from an InputStream.

Note that with this constructor, you will need to call {@link #close()} when you're done to have the underlying Channel closed, as the channel is kept open during normal operation to read the data out.

Some streams are usable After reaching EOF (typically those that return true for markSupported()). In the unlikely case that the caller has such a stream and needs to use it After this constructor completes, a work around is to wrap the stream in order to trap the close() call. A convenience method ( CreateNonClosingInputStream()) has been provided for this purpose:

             InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
             HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
             is.Reset();
             doSomethingElse(is);
             

             MemoryStream bais = ...
             HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() !
             bais.Reset(); // no problem
             doSomethingElse(bais);
             

For a date, this is "mm/d/y". Objects of this class represent a single part of a cell format expression. Each cell can have up to four of these for positive, zero, negative, and text values.

Each format part can contain a color, a condition, and will always contain a format specification. For example "[Red][>=10]#" has a color ([Red]), a condition (>=10) and a format specification (#).

This class also Contains patterns for matching the subparts of format specification. These are used internally, but are made public in case other code has use for them. @author Ken Arnold, Industrious Media LLC Pattern for the color part of a cell format part. Pattern for the condition part of a cell format part. Pattern for the format specification part of a cell format part. Pattern for an entire cell single part. Within {@link #FORMAT_PAT}, the group number for the matched color. Within {@link #FORMAT_PAT}, the group number for the operator in the condition. Within {@link #FORMAT_PAT}, the group number for the value in the condition. Within {@link #FORMAT_PAT}, the group number for the format specification. Create an object to represent a format part. @param desc The string to Parse. Returns true if this format part applies to the given value. If the value is a number and this is part has a condition, returns true only if the number passes the condition. Otherwise, this allways return true. @param valueObject The value to Evaluate. @return true if this format part applies to the given value. Returns the number of the first group that is the same as the marker string. The search starts with group 1. @param pat The pattern to use. @param str The string to match against the pattern. @param marker The marker value to find the group of. @return The matching group number. @throws ArgumentException No group matches the marker. Returns the color specification from the matcher, or null if there is none. @param m The matcher for the format part. @return The color specification or null. Returns the condition specification from the matcher, or null if there is none. @param m The matcher for the format part. @return The condition specification or null. Returns the CellFormatType object implied by the format specification for the format part. @param matcher The matcher for the format part. @return The CellFormatType. Returns the formatter object implied by the format specification for the format part. @param matcher The matcher for the format part. @return The formatter. Returns the type of format. @param fdesc The format specification @return The type of format. Returns a version of the original string that has any special characters quoted (or escaped) as appropriate for the cell format type. The format type object is queried to see what is special. @param repl The original string. @param type The format type representation object. @return A version of the string with any special characters Replaced. @see CellFormatType#isSpecial(char) Apply this format part to the given value. This returns a {@link CellFormatResult} object with the results. @param value The value to apply this format part to. @return A {@link CellFormatResult} object Containing the results of Applying the format to the value. Apply this format part to the given value, Applying the result to the given label. @param label The label @param value The value to apply this format part to. @return true if the Expands a character. This is only partly done, because we don't have the correct info. In Excel, this would be expanded to fill the rest of the cell, but we don't know, in general, what the "rest of the cell" is1. @param part The character to be repeated is the second character in this string. @return The character repeated three times. Returns the string from the group, or "" if the group is null. @param m The matcher. @param g The group number. @return The group or "". Returns the CellFormatType object implied by the format specification for the format part. @return The CellFormatType. Returns true if this format part has a condition. @return true if this format part has a condition. This class : printing out an elapsed time format. @author Ken Arnold, Industrious Media LLC Creates a elapsed time formatter. @param pattern The pattern to Parse. {@inheritDoc} {@inheritDoc}

For a date, this is "mm/d/y". Format a value according to the standard Excel behavior. This "standard" is not explicitly documented by Microsoft, so the behavior is determined by experimentation; see the tests. An Excel format has up to four parts, Separated by semicolons. Each part specifies what to do with particular kinds of values, depending on the number of parts given: - One part (example: [Green]#.##) If the value is a number, display according to this one part (example: green text, with up to two decimal points). If the value is text, display it as is. - Two parts (example: [Green]#.##;[Red]#.##) If the value is a positive number or zero, display according to the first part (example: green text, with up to two decimal points); if it is a negative number, display according to the second part (example: red text, with up to two decimal points). If the value is text, display it as is. - Three parts (example: [Green]#.##;[Black]#.##;[Red]#.##) If the value is a positive number, display according to the first part (example: green text, with up to two decimal points); if it is zero, display according to the second part (example: black text, with up to two decimal points); if it is a negative number, display according to the third part (example: red text, with up to two decimal points). If the value is text, display it as is. - Four parts (example: [Green]#.##;[Black]#.##;[Red]#.##;[@]) If the value is a positive number, display according to the first part (example: green text, with up to two decimal points); if it is zero, display according to the second part (example: black text, with up to two decimal points); if it is a negative number, display according to the third part (example: red text, with up to two decimal points). If the value is text, display according to the fourth part (example: text in the cell's usual color, with the text value surround by brackets). In Addition to these, there is a general format that is used when no format is specified. This formatting is presented by the {@link #GENERAL_FORMAT} object. @author Ken Arnold, Industrious Media LLC Maps a format string to its Parsed version for efficiencies sake. Returns a {@link CellFormat} that applies the given format. Two calls with the same format may or may not return the same object. @param format The format. @return A {@link CellFormat} that applies the given format. Creates a new object. @param format The format. Returns the result of Applying the format to the given value. If the value is a number (a type of {@link Number} object), the correct number format type is chosen; otherwise it is considered a text object. @param value The value @return The result, in a {@link CellFormatResult}. Returns the result of applying the format to the given date. @param date The date. @param numericValue The numeric value for the date. @return The result, in a {@link CellFormatResult}. Fetches the appropriate value from the cell, and returns the result of Applying it to the appropriate format. For formula cells, the computed value is what is used. @param c The cell. @return The result, in a {@link CellFormatResult}. Uses the result of Applying this format to the value, Setting the text and color of a label before returning the result. @param label The label to apply to. @param value The value to Process. @return The result, in a {@link CellFormatResult}. Uses the result of applying this format to the given date, setting the text and color of a label before returning the result. @param label The label to apply to. @param date The date. @param numericValue The numeric value for the date. @return The result, in a {@link CellFormatResult}. Fetches the appropriate value from the cell, and uses the result, Setting the text and color of a label before returning the result. @param label The label to apply to. @param c The cell. @return The result, in a {@link CellFormatResult}. Returns the {@link CellFormatPart} that applies to the value. Result depends on how many parts the cell format has, the cell value and any conditions. The value must be a {@link Number}. @param value The value. @return The {@link CellFormatPart} that applies to the value. Returns the ultimate cell type, following the results of formulas. If the cell is a {@link Cell#CELL_TYPE_FORMULA}, this returns the result of {@link Cell#getCachedFormulaResultType()}. Otherwise this returns the result of {@link Cell#getCellType()}. @param cell The cell. @return The ultimate type of this cell. Returns true if the other object is a {@link CellFormat} object with the same format. @param obj The other object. @return true if the two objects are Equal. Returns a hash code for the format. @return A hash code for the format. Format a value as it would be were no format specified. This is also used when the format specified is General. This object represents a condition in a cell format. @author Ken Arnold, Industrious Media LLC Returns an instance of a condition object. @param opString The operator as a string. One of "<", "<=", ">", ">=", "=", "==", "!=", or "<>". @param constStr The constant (such as "12"). @return A condition object for the given condition. Returns true if the given value passes the constraint's test. @param value The value to compare against. @return true if the given value passes the constraint's test. This object Contains the result of Applying a cell format or cell format part to a value. @author Ken Arnold, Industrious Media LLC @see CellFormatPart#Apply(Object) @see CellFormat#Apply(Object) Creates a new format result object. @param applies The value for {@link #applies}. @param text The value for {@link #text}. @param textColor The value for {@link #textColor}. This is true if no condition was given that applied to the value, or if the condition is satisfied. If a condition is relevant, and when applied the value fails the test, this is false. The resulting text. This will never be null. The color the format Sets, or null if the format Sets no color. This will always be null if {@link #applies} is false. The different kinds of formats that the formatter understands. @author Ken Arnold, Industrious Media LLC The general (default) format; also used for "General". A numeric format. A date format. An elapsed time format. A text format. Returns true if the format is special and needs to be quoted. @param ch The character to test. @return true if the format is special and needs to be quoted. Returns a new formatter of the appropriate type, for the given pattern. The pattern must be appropriate for the type. @param pattern The pattern to use. @return A new formatter of the appropriate type, for the given pattern. A formatter for the default "General" cell format. @author Ken Arnold, Industrious Media LLC Creates a new general formatter. The general style is not quite the same as any other, or any combination of others. @param toAppendTo The buffer to append to. @param value The value to format. Equivalent to {@link #formatValue(StringBuilder,Object)}. {@inheritDoc}. This class : printing out a value using a number format. @author Ken Arnold, Industrious Media LLC Creates a new cell number formatter. @param format The format to Parse. {@inheritDoc} {@inheritDoc}

For a number, this is "#" for integer values, and "#.#" for floating-point values.

For text, this is just printing the text. Implementation of Excel 'Analysis ToolPak' function EDATE()
Adds a specified number of months to the specified date.

Syntax
EDATE(date, number)

@author Tomas Herceg To support Constant Values (2.5.7) as required by the CRN record. This class is also used for two dimensional arrays which are encoded by EXTERNALNAME (5.39) records and Array tokens.

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

• byte optionFlags
• encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)

• The value of the 'is16bitEncoded' flag is determined by the actual character data of text
• The string options flag is never separated (by a {@link ContinueRecord}) from the first chunk of character data it refers to.
• The 'ushort Length' field is assumed to have been explicitly written earlier. Hence, there may be an intervening {@link ContinueRecord}

• ushort Length
• byte optionFlags
• ushort numberOfRichTextRuns (optional)
• ushort extendedDataSize (optional)
• encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)

• The value of the 'is16bitEncoded' flag is determined by the actual character data of text
• The string header fields are never separated (by a {@link ContinueRecord}) from the first chunk of character data (i.e. the first character is always encoded in the same record as the string header).

Cloning of drawing records must be executed through HSSFPatriarch, because all id's must be changed @return cloned drawing records This Is purely for the biff viewer. During normal operations we don't want to be seeing this. 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 Title: DATAVALIDATIONS Record Description: used in data validation ; This record Is the list header of all data validation records (0x01BE) in the current sheet. @author Dragos Buleandra (dragos.buleandra@trade2b.ro) Options of the DVAL Horizontal position of the dialog Vertical position of the dialog Object ID of the drop down arrow object for list boxes ; in our case this will be always FFFF , Until MSODrawingGroup and MSODrawing records are implemented Number of following DV Records Constructs a DVAL record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from @return the field_1_options @return the Horizontal position of the dialog @return the the Vertical position of the dialog Get Object ID of the drop down arrow object for list boxes Get number of following DV records Title: DATAVALIDATION Record (0x01BE)

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 drop down arrow should be suppressed when list validation is used, false otherwise 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 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 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. At first document contains 4 types of records which belong to drawing layer. There are can be such sequence of record:

DrawingRecord ContinueRecord ... ContinueRecord ObjRecord | TextObjectRecord ..... ContinueRecord ... ContinueRecord ObjRecord | TextObjectRecord NoteRecord ... NoteRecord

To work with shapes we have to read data from Drawing and Continue records into single array of bytes and build escher(office art) records tree from this array. Each shape in drawing layer matches corresponding ObjRecord Each textbox matches corresponding TextObjectRecord

ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)

EscherAggrefate contains also NoteRecords NoteRecords must be serial @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 Calculates the string representation of this record. This Is simply a dump of all the records. Calculates the xml representation of this record. This is simply a dump of all the records. @param tab - string which must be added before each line (used by default '\t') @return xml representation of the all aggregated records @param sid - record sid we want to check if it belongs to drawing layer @return true if record is instance of DrawingRecord or ContinueRecord or ObjRecord or TextObjRecord Collapses the drawing records into an aggregate. read Drawing, Obj, TxtObj, Note and Continue records into single byte array, create Escher tree from byte array, create map <EscherRecord, Record> @param records - list of all records inside sheet @param locFirstDrawingRecord - location of the first DrawingRecord inside sheet @return new EscherAggregate create from all aggregated records which belong to drawing layer 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. @param drawingData - escher records saved into single byte array @param writtenEscherBytes - count of bytes already saved into drawing records (we should know it to decide create drawing or continue record) @param pos current position of data array @param data - array of bytes where drawing records must be serialized @param i - number of shape, saved into data array @return offset of data array after serialization How many bytes do the raw escher records contain. @param records List of escher records @return the number of bytes @param records list of records to look into @param loc - location of the record which sid must be returned @return sid of the record with selected location create base tree with such structure: EscherDgContainer -EscherSpgrContainer --EscherSpContainer ---EscherSpRecord ---EscherSpgrRecord ---EscherSpRecord -EscherDgRecord id of DgRecord and SpRecord are empty and must be set later by HSSFPatriarch Unused since this Is an aggregate record. Use CreateAggregate(). @see #CreateAggregate Converts the Records into UserModel objects on the bound HSSFPatriarch

@author Josh Micich 'rgoper' / 'Last received results of the DDE link' (seems to be only applicable to DDE links)
Logically this is a 2-D array, which has been flattened into 1-D array here. (logical) number of columns in the {@link #_ddeValues} array (logical) number of rows in the {@link #_ddeValues} array 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 index to External Book Block (which starts with a EXTERNALBOOK record) a Constructor for making new sub record @param in the RecordInputstream to Read the record from 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 Title: Extern Sheet Description: A List of Inndexes to SupBook REFERENCE: @author Libin Roman (Vista Portal LDT. Developer) @version 1.0-pre Constructs a Extern Sheet record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Add a zero-based reference to a {@link org.apache.poi.hssf.record.SupBookRecord}.

If the type of the SupBook record is same-sheet referencing, Add-In referencing, DDE data source referencing, or OLE data source referencing, then no scope is specified and this value MUST be -2. Otherwise, the scope must be set as follows:

1. -2 Workbook-level reference that applies to the entire workbook.
2. -1 Sheet-level reference.
3. >=0 Sheet-level reference. This specifies the first sheet in the reference.

   If the SupBook type is unused or external workbook referencing, then this value specifies the zero-based index of an external sheet name, see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}. This referenced string specifies the name of the first sheet within the external workbook that is in scope. This sheet MUST be a worksheet or macro sheet.

   If the supporting link type is self-referencing, then this value specifies the zero-based index of a {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet.

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 username of the user that Created the file Title: Function Group Count Record Description: Number of built in function Groups in the current version of the SpReadsheet (probably only used on Windoze) REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre suggested default (14 dec) Constructs a FnGroupCount record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the number of built-in functions @return number of built-in functions Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4) Description: An element in the Font Table REFERENCE: PG 315 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 Font record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Clones all the font style information from another FontRecord, onto this one. This will then hold all the same font style options. Does this FontRecord have all the same font properties as the supplied FontRecord? Note that {@link #equals(Object)} will check for exact objects, while this will check for exact contents, because normally the font record's position makes a big difference too. Only returns two for the same exact object - creating a second FontRecord with the same properties won't be considered equal, as the record's position in the record stream matters. Set the font to be italics or not @param italics - whether the font Is italics or not @see #SetAttributes(short) Set the font to be stricken out or not @param strike - whether the font Is stricken out or not @see #SetAttributes(short) whether to use the mac outline font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea) @param mac - whether to do that mac font outline thing or not @see #SetAttributes(short) whether to use the mac shado font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea) @param mac - whether to do that mac font shadow thing or not @see #SetAttributes(short) Set the type of Underlining for the font Set the font family (TODO) @param f family Set the Char Set @param charSet - CharSet Set the name of the font @param fn - name of the font (i.e. "Arial") Gets the height of the font in 1/20th point Units @return fontheight (in points/20) Get the font attributes (see individual bit Getters that reference this method) @return attribute - the bitmask Get the font's color palette index @return cpi - font color index Get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default Is 0x190 for normal and 0x2bc for bold @return bw - a number between 100-1000 for the fonts "boldness" Get the type of base or subscript for the font @return base or subscript option Title: Footer Record Description: Specifies the footer for a sheet REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02 @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Common header/footer base class @author Josh Micich get the length of the footer string @return length of the footer string

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

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 TABLESTYLES (0x088E)
@author Patrick Cheng expect tRef, tRef3D, tArea, tArea3D or tName Not clear if needed . Excel seems to be OK if this byte is not present. Value is often the same as the earlier firstColumn byte. Get the text orientation field for the TextObjectBase record. @return a TextOrientation @return the Horizontal text alignment field value. @return the Vertical text alignment field value. Text has been locked @return the text locked field value. Record for the top margin. NOTE: This source was automatically generated. @author Shawn Laubach (slaubach at apache dot org) Constructs a TopMargin record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the margin field for the TopMargin record. Title: Uncalced Record If this record occurs in the Worksheet Substream, it indicates that the formulas have not been recalculated before the document was saved. @author Olivier Leprince Default constructor Read constructor Title: Unknown Record (for debugging) Description: Unknown record just tells you the sid so you can figure out what records you are missing. Also helps us Read/modify sheets we don't know all the records to. (HSSF leaves these alone!) Company: SuperLink Software, Inc. @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) @param id id of the record -not Validated, just stored for serialization @param data the data construct an Unknown record. No fields are interperated and the record will be Serialized in its original form more or less @param in the RecordInputstream to Read the record from spit the record out AS IS. no interpretation or identification print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD]) These BIFF record types are known but still uninterpreted by POI @return the documented name of this BIFF record type, null if unknown to POI @return true if the unknown record id has been observed in POI unit tests Unlike the other Record.Clone methods this Is a shallow Clone The UserSViewBegin record specifies Settings for a custom view associated with the sheet. This record also marks the start of custom view records, which save custom view Settings. Records between {@link UserSViewBegin} and {@link UserSViewEnd} contain Settings for the custom view, not Settings for the sheet itself. @author Yegor Kozlov construct an UserSViewBegin record. No fields are interpreted and the record will be Serialized in its original form more or less @param in the RecordInputstream to read the record from spit the record out AS IS. no interpretation or identification @return Globally unique identifier for the custom view The UserSViewEnd record marks the end of the Settings for a custom view associated with the sheet @author Yegor Kozlov construct an UserSViewEnd record. No fields are interpreted and the record will be Serialized in its original form more or less @param in the RecordInputstream to read the record from spit the record out AS IS. no interpretation or identification Title: Use Natural Language Formulas Flag Description: Tells the GUI if this was written by something that can use "natural language" formulas. HSSF can't. REFERENCE: PG 420 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 UseSelFS record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from 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 VerticalPageBreak record that stores page breaks at columns This class Is just used so that SID Compares work properly in the RecordFactory @see PageBreakRecord @author Danny Mui (dmui at apache dot org) @param in the RecordInputstream to Read the record from Title: Window1 Record Description: Stores the attributes of the workbook window. This Is basically so the gui knows how big to make the window holding the spReadsheet document. REFERENCE: PG 421 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 WindowOne record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the horizontal position of the window (in 1/20ths of a point) @return h - horizontal location Get the vertical position of the window (in 1/20ths of a point) @return v - vertical location Get the width of the window @return width Get the height of the window @return height Get the options bitmask (see bit Setters) @return o - the bitmask Get whether the window Is hidden or not @return Ishidden or not Get whether the window has been iconized or not @return iconize or not Get whether to Display the horizontal scrollbar or not @return Display or not Get whether to Display the vertical scrollbar or not @return Display or not Get whether to Display the tabs or not @return Display or not @return the index of the currently Displayed sheet deprecated May 2008 @deprecated - Misleading name - use GetActiveSheetIndex() @return the first visible sheet in the worksheet tab-bar. I.E. the scroll position of the tab-bar. deprecated May 2008 @deprecated - Misleading name - use GetFirstVisibleTab() Get the number of selected tabs @return number of tabs ratio of the width of the tabs to the horizontal scrollbar @return ratio Title: Window Protect Record Description: flags whether workbook windows are protected 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 WindowProtect record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Is this window protected or not @return protected or not Title: Window Two Record Description: sheet window Settings REFERENCE: PG 422 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 WindowTwo record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the options bitmask or just use the bit Setters. @return options Get whether the window should Display formulas @return formulas or not Get whether the window should Display gridlines @return gridlines or not Get whether the window should Display row and column headings @return headings or not Get whether the window should freeze panes @return freeze panes or not Get whether the window should Display zero values @return zeros or not Get whether the window should Display a default header @return header or not Is this arabic? @return arabic or not Get whether the outline symbols are displaed @return symbols or not freeze Unsplit panes or not @return freeze or not sheet tab Is selected @return selected or not Is the sheet currently Displayed in the window @return Displayed or not deprecated May 2008 @deprecated use IsActive() was the sheet saved in page break view @return pagebreaksaved or not Get the top row visible in the window @return toprow Get the leftmost column Displayed in the window @return leftmost Get the palette index for the header color @return color zoom magification in page break view @return zoom Get the zoom magnification in normal view @return zoom Get the reserved bits - why would you do this? @return reserved stuff -probably garbage 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 this record is always padded to a constant length 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") Title: Write Protect Record Description: Indicated that the sheet/workbook Is Write protected. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @version 3.0-pre Constructs a WriteAccess record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Title: WSBool Record. Description: stores workbook Settings (aka its a big "everything we didn't put somewhere else") REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Glen Stampoultzis (gstamp@iprimus.com.au) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a WSBool record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get first byte (see bit Getters)

A class describing attributes of the Big Block Size

For POI internal use only @author Josh Micich corresponding cell from master workbook Represents a sheet being used for forked Evaluation. Initially, objects of this class contain only the cells from the master workbook. By calling {@link #getOrCreateUpdatableCell(int, int)}, the master cell object is logically Replaced with a {@link ForkedEvaluationCell} instance, which will be used in all subsequent Evaluations. @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 Only cells which have been split are Put in this map. (This has been done to conserve memory). Represents a workbook being used for forked Evaluation. Most operations are delegated to the shared master workbook, except those that potentially involve cell values that may have been updated After a call to {@link #getOrCreateUpdatableCell(String, int, int)}. @author Josh Micich Abstracts a workbook for the purpose of formula evaluation.
For POI internal use only @author Josh Micich @return -1 if the specified sheet is from a different book HSSF Only - fetch the external-style sheet details

Return will have no workbook set if it's actually in our own workbook

Return will have no workbook set if it's actually in our own workbook

Syntax:
ISERR(value)

value The value to be tested

Returns the logical value TRUE if value refers to any error value except '#N/A'; otherwise, it returns FALSE. @author Amol S. Deshmukh < amolweb at ya hoo dot com > @param arg any {@link ValueEval}, potentially {@link BlankEval} or {@link ErrorEval}. Encapsulates logic to convert shared formulaa into non shared equivalent Creates a non shared formula from the shared formula counterpart, i.e. Converts the shared formula into the equivalent {@link org.apache.poi.ss.formula.ptg.Ptg} array that it would have, were it not shared. @param ptgs parsed tokens of the shared formula @param formulaRow @param formulaColumn

Format class that handles Excel style fractions, such as "# #/#" and "#/###"

As of this writing, this is still not 100% accurate, but it does a reasonable job of trying to mimic Excel's fraction calculations. It does not currently maintain Excel's spacing.

This class relies on a method lifted nearly verbatim from org.apache.math.fraction. If further uses for Commons Math are found, we will consider Adding it as a dependency. For now, we have in-lined the one method to keep things simple.

References:

• Continued Fraction equations (11) and (22)-(26)

                  // returns "[$-0411]dd MMMM, yyyy;@" where the [$-0411] prefix tells Excel to use the Japanese locale
                  String excelFormatPattern = DateFormatConverter.convert(Locale.JAPANESE, "dd MMMM, yyyy");
            
                  CellStyle cellStyle = workbook.createCellStyle();
            
                  DataFormat poiFormat = workbook.createDataFormat();
                  cellStyle.setDataFormat(poiFormat.getFormat(excelFormatPattern));
                  cell.setCellValue(new Date());
                  cell.setCellStyle(cellStyle);  // formats date as '2012\u5e743\u670817\u65e5'
            
              

Creates a {@link ClassID} from a human-readable representation of the Class ID in standard format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".