Package org.apache.poi.hssf.record

Record package contains class representations for XLS binary strutures. Its very low level.

See Also:

org.apache.poi.hssf.eventmodel, RecordFactory

Interface Summary

Interface	Description
BiffHeaderInput
CellValueRecordInterface	The cell value record interface is implemented by all classes of type Record that contain cell values.
CFRuleBase.ComparisonOperator
HSSFRecordTypes.RecordConstructor<T extends Record>
Margin	The margin interface is a parent used to define left, right, top and bottom margins.
SubRecord.SubRecordTypes.RecordConstructor<T extends SubRecord>

Class Summary

Class	Description
AbstractEscherHolderRecord	The escher container record is used to hold escher records.
ArrayRecord	ARRAY (0x0221)
AutoFilterInfoRecord	The AutoFilterInfo record specifies the number of columns that have AutoFilter enabled and indicates the beginning of the collection of AutoFilter records.
BackupRecord	Boolean specifying whether the GUI should store a backup of the file.
BlankRecord	Represents a column in a row with no value but with styling.
BOFRecord	Somewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject.
BookBoolRecord	Contains a flag specifying whether the Gui should save externally linked values from other workbooks.
BookExtRecord	[MS-XLS].pdf 2.4.23 BookExt page 203 properties of a workbook file
BoolErrRecord	Creates new BoolErrRecord.
BottomMarginRecord	Record for the bottom margin.
BoundSheetRecord	Defines a sheet within a workbook.
CalcCountRecord	Specifies the maximum times the gui should perform a formula recalculation.
CalcModeRecord	Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.
CellRecord	Base class for all cell value records (implementors of CellValueRecordInterface).
CFHeader12Record	Conditional Formatting Header v12 record CFHEADER12 (0x0879), for conditional formattings introduced in Excel 2007 and newer.
CFHeaderBase	Parent of Conditional Formatting Header records, CFHeaderRecord and CFHeader12Record.
CFHeaderRecord	Conditional Formatting Header record CFHEADER (0x01B0).
CFRule12Record	Conditional Formatting v12 Rule Record (0x087A).
CFRuleBase	Conditional Formatting Rules.
CFRuleRecord	Conditional Formatting Rule Record (0x01B1).
CodepageRecord	The default characterset.
ColumnInfoRecord	Defines with width and formatting for a range of columns
CommonObjectDataSubRecord	The common object data record is used to store all common preferences for an excel object.
Compat12Record	[MS-XLS].pdf 2.4.54 Compat12 page 231 whether to check for compatibility with earlier application versions when saving the workbook.
CompressPicturesRecord	[MS-XLS].pdf 2.4.55 CompressPictures page 231 Recomendation for picture compression when saving.
ContinueRecord	Helper class used primarily for SST Records
CountryRecord	Country Record (aka WIN.INI country) - used for localization
CRNCountRecord	XCT - CRN Count
CRNRecord	This record stores the contents of an external cell or cell range
DateWindow1904Record	Flag specifying whether 1904 date windowing is used.
DBCellRecord	Used by Excel and other MS apps to quickly find rows in the sheets.
DConRefRecord	DConRef records specify a range in a workbook (internal or external) that serves as a data source for pivot tables or data consolidation.
DefaultColWidthRecord	Specifies the default width for columns that have no specific width set.
DefaultRowHeightRecord	Row height for rows with undefined or not explicitly defined heights.
DeltaRecord	Controls the accuracy of the calculations
DimensionsRecord	Provides the minumum and maximum bounds of a sheet.
DrawingGroupRecord	Specifies a group of drawing objects.
DrawingRecord
DrawingRecordForBiffViewer	This is purely for the biff viewer.
DrawingSelectionRecord	MsoDrawingSelection (0x00ED)
DSFRecord	Tells if this is a double stream file.
DVALRecord	This record is the list header of all data validation records (0x01BE) in the current sheet.
DVRecord	This record stores data validation settings and a list of cell ranges which contain these settings.
EmbeddedObjectRefSubRecord	ftPictFmla (0x0009)
EndSubRecord	ftEnd (0x0000)
EnhancedProtection
EOFRecord	Marks the end of records belonging to a particular object in the HSSF File
EscherAggregate	This class is used to aggregate the MSODRAWING and OBJ record combinations.
ExtendedFormatRecord	Probably one of the more complex records.
ExternalNameRecord	EXTERNALNAME (0x0023)
ExternSheetRecord	EXTERNSHEET (0x0017)
ExtSSTRecord	Extended Static String Table (0x00FF)
ExtSSTRecord.InfoSubRecord
FeatHdrRecord	Title: FeatHdr (Feature Header) Record
FeatRecord	Title: Feat (Feature) Record
FilePassRecord	File Pass Record (0x002F)
FileSharingRecord	Stores the encrypted readonly for a workbook (write protect).
FnGroupCountRecord	umber of built in function groups in the current version of the Spreadsheet (probably only used on Windows)
FontRecord	Describes a font in the workbook
FooterRecord	Specifies the footer for a sheet
ForceFullCalculationRecord	[MS-XLS].pdf 2.4.125 ForceFullCalculation page 298 Value of the forced calculation mode for this workbook.
FormatRecord	Describes a number format -- those goofy strings like $(#,###)
FormulaRecord	Formula Record (0x0006).
FormulaSpecialCachedValue	Manages the cached formula result values of other types besides numeric.
FtCblsSubRecord	This structure appears as part of an Obj record that represents a checkbox or radio button.
FtCfSubRecord	The FtCf structure specifies the clipboard format of the picture-type Obj record containing this FtCf.
FtPioGrbitSubRecord	This structure appears as part of an Obj record that represents image display properties.
FullColorExt	2.5.155 FullColorExt.
GridsetRecord	Flag denoting whether the user specified that gridlines are used when printing.
GroupMarkerSubRecord	ftGmo (0x0006)
GutsRecord	Row/column gutter sizes
HCenterRecord	Whether to center between horizontal margins
HeaderFooterBase	Common header/footer base class
HeaderFooterRecord	The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.
HeaderRecord	Specifies a header for a sheet
HideObjRecord	Flag defines whether to hide placeholders and object
HorizontalPageBreakRecord	HorizontalPageBreak (0x001B) record that stores page breaks at rows
HyperlinkRecord	The HyperlinkRecord (0x01B8) wraps an HLINK-record from the Excel-97 format.
IndexRecord	Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells
InterfaceEndRecord	Shows where the Interface Records ends (MMS)
InterfaceHdrRecord	Defines the beginning of Interface records (MMS)
IterationRecord	Tells whether to iterate over formula calculations or not.
LabelRecord	Label Record (0x0204) - read only support for strings stored directly in the cell...
LabelSSTRecord	Refers to a string in the shared string table and is a column value.
LbsDataSubRecord	This structure specifies the properties of a list or drop-down list embedded object in a sheet.
LbsDataSubRecord.LbsDropData	This structure specifies properties of the dropdown list control
LeftMarginRecord	Record for the left margin.
MergeCellsRecord	Optional record defining a square area of cells to "merged" into one cell.
MMSRecord	defines how many add menu and del menu options are stored in the file.
MTRSettingsRecord	[MS-XLS].pdf 2.4.173 MTRSettings page 343 Multithreaded calculation settings.
MulBlankRecord	Represents a set of columns in a row with no value but with styling.
MulRKRecord	Used to store multiple RK numbers on a row.
NameCommentRecord	Defines a comment associated with a specified name.
NameRecord	Defines a named range within a workbook.
NoteRecord	NOTE: Comment Associated with a Cell (0x001C)
NoteStructureSubRecord	ftNts (0x000D)
NumberRecord	NUMBER (0x0203) Contains a numeric cell value.
ObjectProtectRecord	Protect embedded object with the lamest "security" ever invented.
ObjRecord	OBJRECORD (0x005D)
OldCellRecord	Base class for all old (Biff 2 - Biff 4) cell value records (implementors of CellValueRecordInterface).
OldFormulaRecord	Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in encoded form, along with the value if a number
OldLabelRecord	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 LabelSSTRecord
OldSheetRecord	Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5
OldStringRecord	Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for formula string results.
PageBreakRecord	Record that contains the functionality page breaks (horizontal and vertical)
PageBreakRecord.Break	Since both records store 2byte integers (short), no point in differentiating it in the records.
PaletteRecord	Supports custom palettes.
PaneRecord	Describes the frozen and unfrozen panes.
PasswordRecord	Stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
PasswordRev4Record	Protection Revision 4 password Record (0x01BC)
PLVRecord	[MS-XLS].pdf 2.4.200 PLV page 360 Page Layout View for a sheet.
PrecisionRecord	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!)
PrintGridlinesRecord	Whether to print the gridlines when you enjoy the spreadsheet on paper.
PrintHeadersRecord	Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.
PrintSetupRecord	Stores print setup options -- bogus for HSSF (and marked as such)
ProtectionRev4Record	Describes whether this is a protected shared/tracked workbook
ProtectRecord	Defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
RecalcIdRecord	This record contains an ID that marks when a worksheet was last recalculated.
Record	All HSSF Records inherit from this class.
RecordBase	Common base class of Record and RecordAggregate
RecordFactory	Title: Record Factory
RecordFactoryInputStream	A stream based way to get at complete records, with as low a memory footprint as possible.
RecordInputStream	Title: Record Input Stream Description: Wraps a stream and provides helper methods for the construction of records.
RefModeRecord	Describes which reference mode to use
RefreshAllRecord	Flag whether to refresh all external data when loading a sheet.
RightMarginRecord	Record for the right margin.
RKRecord	An internal 32 bit number with the two most significant bits storing the type.
RowRecord	Stores the row information for the sheet.
SaveRecalcRecord	Defines whether to recalculate before saving (set to true)
ScenarioProtectRecord	I have no idea what a Scenario is or why on would want to protect it with the lamest "security" ever invented.
SCLRecord	Specifies the window's zoom magnification.
SelectionRecord	Shows the user's selection on the sheet for write set num refs to 0
SharedFormulaRecord	Primarily used as an excel optimization so that multiple similar formulas are not written out too many times.
SharedValueRecordBase	Common base class for SharedFormulaRecord, ArrayRecord and TableRecord which are have similarities.
SSTRecord	Static String Table Record (0x00FC)
StandardRecord	Subclasses of this class (the majority of BIFF records) are non-continuable.
StringRecord	STRING (0x0207)
StyleExtRecord	The StyleExt record follow the Style record
StyleRecord	Describes a builtin to the gui or user defined style
SubRecord	Subrecords are part of the OBJ class.
SupBookRecord	A External Workbook Description (Supplemental Book).
TabIdRecord	Contains an array of sheet id's.
TableRecord	The record specifies a data table.
TableStylesRecord	TABLESTYLES (0x088E)
TextObjectRecord	The TXO record (0x01B6) is used to define the properties of a text box.
ThemeRecord	The theme used in this workbook.
TopMarginRecord	Record for the top margin.
UncalcedRecord	If this record occurs in the Worksheet Substream, it indicates that the formulas have not been recalculated before the document was saved.
UnknownRecord	Unknown record just tells you the sid so you can figure out what records you are missing.
UserSViewBegin	The UserSViewBegin record specifies settings for a custom view associated with the sheet.
UserSViewEnd	The UserSViewEnd record marks the end of the settings for a custom view associated with the sheet
UseSelFSRecord	Tells the GUI if this was written by something that can use "natural language" formulas.
VCenterRecord	Tells whether to center the sheet between vertical margins
VerticalPageBreakRecord	VerticalPageBreak (0x001A) record that stores page breaks at columns
WindowOneRecord	Stores the attributes of the workbook window.
WindowProtectRecord	Flags whether workbook windows are protected
WindowTwoRecord	Sheet window settings
WriteAccessRecord	Title: Write Access Record (0x005C)
WriteProtectRecord	Indicated that the sheet/workbook is write protected.
WSBoolRecord	Stores workbook settings (aka its a big "everything we didn't put somewhere else")
XFCrcRecord	Title: XFCRC Record
XFExtRecord	2.4.355 XFEXT [MS-XLS].pdf, page 609.

Enum Summary

Enum	Description
HSSFRecordTypes
SubRecord.SubRecordTypes

Exception Summary

Exception	Description
RecordInputStream.LeftoverDataException	For use in BiffViewer which may construct Records that don't completely read all available data.