Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Home >> All >> org >> apache >> poi >> hssf >> [ record Javadoc ]

•org.apache.poi.hssf.record.aggregates.* (7)•org.apache.poi.hssf.record.formula.* (39)

• org.apache.poi.hssf.record: Javadoc index of package org.apache.poi.hssf.record.


Package Samples:

• org.apache.poi.hssf.record.formula: Record package contains class representations for XLS binary strutures.  
• org.apache.poi.hssf.record.aggregates

Classes:

• RecalcIdRecord: Title: Recalc Id Record Description: This record contains an ID that marks when a worksheet was last recalculated. It's an optimization Excel uses to determine if it needs to recalculate the spreadsheet when it's opened. So far, only the two values 0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00 (do not recalculate) and 0xC1 0x01 0x00 0x00 0x60 0x69 0x01 0x00 have been seen. If the field isNeeded is set to false (default), then this record is swallowed during the serialization process REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html
• RKRecord: Title: RK Record Description: An internal 32 bit number with the two most significant bits storing the type. This is part of a bizarre scheme to save disk space and memory (gee look at all the other whole records that are in the file just "cause"..,far better to waste processor cycles on this then leave on of those "valuable" records out). We support this in READ-ONLY mode. HSSF converts these to NUMBER records REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• EscherAggregate: 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.
• ExtendedFormatRecord: Title: Extended Format Record Description: Probably one of the more complex records. There are two breeds: Style and Cell. It should be noted that fields in the extended format record are somewhat arbitrary. Almost all of the fields are bit-level, but we name them as best as possible by functional group. In some places this is better than others. REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• SharedFormulaRecord: 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.
• CalcCountRecord: 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)
• SeriesToChartGroupRecord: Indicates the chart-group index for a series. The order probably defines the mapping. So the 0th record probably means the 0th series. The only field in this of course defines which chart group the 0th series (for instance) would map to. Confusing? Well thats because it is. (p 522 BCG) NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
• ExtSSTRecord: 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)
• TextObjectBaseRecord: The TXO record is used to define the properties of a text box. It is followed by two continue records unless there is no actual text. The first continue record contains the text data and the next continue record contains the formatting runs. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
• ProtectRecord: Title: Protect Record Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION) (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it) (after all terrorists will all use US-legal encrypton right??) REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• MulBlankRecord: Title: Mulitple Blank cell record Description: Represents a set of columns in a row with no value but with styling. In this release we have read-only support for this record type. The RecordFactory converts this to a set of BlankRecord objects. REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• IterationRecord: Title: Iteration Record Description: Tells whether to iterate over forumla calculations or not (if a formula is dependant upon another formula's result) (odd feature for something that can only have 32 elements in a formula!) REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• UnicodeString: Title: Unicode String Description: Unicode String record. We implement these as a record, although they are really just standard fields that are in several records. It is considered more desirable then repeating it in all of them. REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• UnknownRecord: 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.
• BoundSheetRecord: 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)
• WriteAccessRecord: 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)
• WindowOneRecord: 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)
• ParenthesisPtg: While formula tokens are stored in RPN order and thus do not need parenthesis for precedence reasons, Parenthesis tokens ARE written to ensure that user entered parenthesis are displayed as-is on reading back Avik Sengupta Andrew C. Oliver (acoliver at apache dot org)
• PrecisionRecord: Title: Precision Record Description: defines whether to store with full precision or what's displayed by the gui (meaning have really screwed up and skewed figures or only think you do!) REFERENCE: PG 372 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• BOFRecord: 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)
• CountryRecord: Title: Country Record (aka WIN.INI country) Description: used for localization. Currently HSSF always sets this to 1 and it seems to work fine even in Germany. (es geht's auch fuer Deutschland) REFERENCE: PG 298 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• ProtectionRev4Record: Title: Protection Revision 4 Record Description: describes whether this is a protected shared/tracked workbook ( HSSF does not support encryption because we don't feel like going to jail ) REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• DSFRecord: 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)
• SCLRecord: Specifies the window's zoom magnification. If this record isn't present then the windows zoom is 100%. see p384 Excel Dev Kit NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
• IndexRecord: Title: Index Record Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells NOT USED IN THIS RELEASE REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Home | Contact Us | Privacy Policy | Terms of Service