Uses of Class
org.apache.poi.hssf.record.Record

Packages that use Record

Package	Description
org.apache.poi.hssf.eventmodel
org.apache.poi.hssf.eventusermodel	HSSF eventmodel Package provides an event-based API for reading HSSF files.
org.apache.poi.hssf.eventusermodel.dummyrecord
org.apache.poi.hssf.model	Provides low level API structures for reading, writing, modifying XLS files.
org.apache.poi.hssf.record	Record package contains class representations for XLS binary strutures.
org.apache.poi.hssf.record.aggregates	The record aggregates are not real "records" but collections of records that act as a single record.
org.apache.poi.hssf.record.chart
org.apache.poi.hssf.record.cont
org.apache.poi.hssf.record.pivottable
org.apache.poi.hssf.usermodel	The usermodel package maps HSSF low level structures to familiar workbook/sheet model

Uses of Record in org.apache.poi.hssf.eventmodel

Methods in org.apache.poi.hssf.eventmodel with parameters of type Record

Modifier and Type	Method and Description
boolean	ERFListener.processRecord(Record rec) Process a Record.

Uses of Record in org.apache.poi.hssf.eventusermodel

Methods in org.apache.poi.hssf.eventusermodel with parameters of type Record

Modifier and Type	Method and Description
abstract short	AbortableHSSFListener.abortableProcessRecord(Record record) Process an HSSF Record.
void	HSSFListener.processRecord(Record record) process an HSSF Record.
void	FormatTrackingHSSFListener.processRecord(Record record) Process this record ourselves, and then pass it on to our child listener
void	AbortableHSSFListener.processRecord(Record record) This method, inherited from HSSFListener is implemented as a stub.
void	EventWorkbookBuilder.SheetRecordCollectingListener.processRecord(Record record) Process this record ourselves, and then pass it on to our child listener
void	MissingRecordAwareHSSFListener.processRecord(Record record)
protected short	HSSFRequest.processRecord(Record rec) Called by HSSFEventFactory, passes the Record to each listener associated with a record.sid.
void	FormatTrackingHSSFListener.processRecordInternally(Record record) Process the record ourselves, but do not pass it on to the child Listener.
void	EventWorkbookBuilder.SheetRecordCollectingListener.processRecordInternally(Record record) Process the record ourselves, but do not pass it on to the child Listener.

Uses of Record in org.apache.poi.hssf.eventusermodel.dummyrecord

Subclasses of Record in org.apache.poi.hssf.eventusermodel.dummyrecord

Modifier and Type	Class and Description
class	LastCellOfRowDummyRecord A dummy record to indicate that we've now had the last cell record for this row.
class	MissingCellDummyRecord A dummy record for when we're missing a cell in a row, but still want to trigger something
class	MissingRowDummyRecord A dummy record for when we're missing a row, but still want to trigger something

Uses of Record in org.apache.poi.hssf.model

Methods in org.apache.poi.hssf.model that return Record

Modifier and Type	Method and Description
Record	InternalWorkbook.findFirstRecordBySid(short sid) Returns the first occurance of a record matching a particular sid.
Record	InternalSheet.findFirstRecordBySid(short sid) Returns the first occurrence of a record matching a particular sid.
Record	InternalWorkbook.findNextRecordBySid(short sid, int pos) Returns the next occurance of a record matching a particular sid.
Record	WorkbookRecordList.get(int i)
Record	RecordStream.getNext()
Record	RecordStream.peekNextRecord()

Methods in org.apache.poi.hssf.model that return types with arguments of type Record

Modifier and Type	Method and Description
java.util.List<Record>	InternalWorkbook.getRecords()
java.util.List<Record>	WorkbookRecordList.getRecords()
java.lang.Class<? extends Record>	RecordStream.peekNextClass()

Methods in org.apache.poi.hssf.model with parameters of type Record

Modifier and Type	Method and Description
void	WorkbookRecordList.add(int pos, Record r)

Method parameters in org.apache.poi.hssf.model with type arguments of type Record

Modifier and Type	Method and Description
static InternalWorkbook	InternalWorkbook.createWorkbook(java.util.List<Record> recs) read support for low level API.
void	WorkbookRecordList.setRecords(java.util.List<Record> records)

Constructor parameters in org.apache.poi.hssf.model with type arguments of type Record

Constructor and Description
RecordStream(java.util.List<Record> records, int startIx)
RecordStream(java.util.List<Record> inputList, int startIndex, int endIx) Creates a RecordStream bounded by startIndex and endIndex

Uses of Record in org.apache.poi.hssf.record

Subclasses of Record in org.apache.poi.hssf.record

Modifier and Type	Class and Description
class	AbstractEscherHolderRecord The escher container record is used to hold escher records.
class	ArrayRecord ARRAY (0x0221)
class	AutoFilterInfoRecord The AutoFilterInfo record specifies the number of columns that have AutoFilter enabled and indicates the beginning of the collection of AutoFilter records.
class	BackupRecord Boolean specifying whether the GUI should store a backup of the file.
class	BlankRecord Represents a column in a row with no value but with styling.
class	BOFRecord Somewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject.
class	BookBoolRecord Contains a flag specifying whether the Gui should save externally linked values from other workbooks.
class	BoolErrRecord Creates new BoolErrRecord.
class	BottomMarginRecord Record for the bottom margin.
class	BoundSheetRecord Defines a sheet within a workbook.
class	CalcCountRecord Specifies the maximum times the gui should perform a formula recalculation.
class	CalcModeRecord Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.
class	CellRecord Base class for all cell value records (implementors of CellValueRecordInterface).
class	CFHeader12Record Conditional Formatting Header v12 record CFHEADER12 (0x0879), for conditional formattings introduced in Excel 2007 and newer.
class	CFHeaderBase Parent of Conditional Formatting Header records, CFHeaderRecord and CFHeader12Record.
class	CFHeaderRecord Conditional Formatting Header record CFHEADER (0x01B0).
class	CFRule12Record Conditional Formatting v12 Rule Record (0x087A).
class	CFRuleBase Conditional Formatting Rules.
class	CFRuleRecord Conditional Formatting Rule Record (0x01B1).
class	CodepageRecord The default characterset.
class	ColumnInfoRecord Defines with width and formatting for a range of columns
class	ContinueRecord Helper class used primarily for SST Records
class	CountryRecord Country Record (aka WIN.INI country) - used for localization
class	CRNCountRecord XCT - CRN Count
class	CRNRecord This record stores the contents of an external cell or cell range
class	DateWindow1904Record Flag specifying whether 1904 date windowing is used.
class	DBCellRecord Used by Excel and other MS apps to quickly find rows in the sheets.
class	DConRefRecord DConRef records specify a range in a workbook (internal or external) that serves as a data source for pivot tables or data consolidation.
class	DefaultColWidthRecord Specifies the default width for columns that have no specific width set.
class	DefaultRowHeightRecord Row height for rows with undefined or not explicitly defined heights.
class	DeltaRecord Controls the accuracy of the calculations
class	DimensionsRecord Provides the minumum and maximum bounds of a sheet.
class	DrawingGroupRecord
class	DrawingRecord
class	DrawingRecordForBiffViewer This is purely for the biff viewer.
class	DrawingSelectionRecord MsoDrawingSelection (0x00ED)
class	DSFRecord Tells if this is a double stream file.
class	DVALRecord This record is the list header of all data validation records (0x01BE) in the current sheet.
class	DVRecord This record stores data validation settings and a list of cell ranges which contain these settings.
class	EOFRecord Marks the end of records belonging to a particular object in the HSSF File
class	EscherAggregate This class is used to aggregate the MSODRAWING and OBJ record combinations.
class	ExtendedFormatRecord Probably one of the more complex records.
class	ExternalNameRecord EXTERNALNAME (0x0023)
class	ExternSheetRecord EXTERNSHEET (0x0017)
class	ExtSSTRecord Extended Static String Table (0x00FF)
class	FeatHdrRecord Title: FeatHdr (Feature Header) Record
class	FeatRecord Title: Feat (Feature) Record
class	FilePassRecord File Pass Record (0x002F)
class	FileSharingRecord Stores the encrypted readonly for a workbook (write protect).
class	FnGroupCountRecord umber of built in function groups in the current version of the Spreadsheet (probably only used on Windows)
class	FontRecord Describes a font in the workbook
class	FooterRecord Specifies the footer for a sheet
class	FormatRecord Describes a number format -- those goofy strings like $(#,###)
class	FormulaRecord Formula Record (0x0006).
class	GridsetRecord Flag denoting whether the user specified that gridlines are used when printing.
class	GutsRecord Row/column gutter sizes
class	HCenterRecord Whether to center between horizontal margins
class	HeaderFooterBase Common header/footer base class
class	HeaderFooterRecord The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.
class	HeaderRecord Specifies a header for a sheet
class	HideObjRecord Flag defines whether to hide placeholders and object
class	HorizontalPageBreakRecord HorizontalPageBreak (0x001B) record that stores page breaks at rows
class	HyperlinkRecord The HyperlinkRecord (0x01B8) wraps an HLINK-record from the Excel-97 format.
class	IndexRecord Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells
class	InterfaceEndRecord Shows where the Interface Records ends (MMS)
class	InterfaceHdrRecord Defines the beginning of Interface records (MMS)
class	IterationRecord Tells whether to iterate over formula calculations or not.
class	LabelRecord Label Record (0x0204) - read only support for strings stored directly in the cell...
class	LabelSSTRecord Refers to a string in the shared string table and is a column value.
class	LeftMarginRecord Record for the left margin.
class	MergeCellsRecord Optional record defining a square area of cells to "merged" into one cell.
class	MMSRecord defines how many add menu and del menu options are stored in the file.
class	MulBlankRecord Represents a set of columns in a row with no value but with styling.
class	MulRKRecord Used to store multiple RK numbers on a row.
class	NameCommentRecord Defines a comment associated with a specified name.
class	NameRecord Defines a named range within a workbook.
class	NoteRecord NOTE: Comment Associated with a Cell (0x001C)
class	NumberRecord NUMBER (0x0203) Contains a numeric cell value.
class	ObjectProtectRecord Protect embedded object with the lamest "security" ever invented.
class	ObjRecord OBJRECORD (0x005D)
class	PageBreakRecord Record that contains the functionality page breaks (horizontal and vertical)
class	PaletteRecord Supports custom palettes.
class	PaneRecord Describes the frozen and unfrozen panes.
class	PasswordRecord Stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
class	PasswordRev4Record Protection Revision 4 password Record (0x01BC)
class	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!)
class	PrintGridlinesRecord Whether to print the gridlines when you enjoy the spreadsheet on paper.
class	PrintHeadersRecord Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.
class	PrintSetupRecord Stores print setup options -- bogus for HSSF (and marked as such)
class	ProtectionRev4Record Describes whether this is a protected shared/tracked workbook
class	ProtectRecord Defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
class	RecalcIdRecord This record contains an ID that marks when a worksheet was last recalculated.
class	RefModeRecord Describes which reference mode to use
class	RefreshAllRecord Flag whether to refresh all external data when loading a sheet.
class	RightMarginRecord Record for the right margin.
class	RKRecord An internal 32 bit number with the two most significant bits storing the type.
class	RowRecord Stores the row information for the sheet.
class	SaveRecalcRecord Defines whether to recalculate before saving (set to true)
class	ScenarioProtectRecord I have no idea what a Scenario is or why on would want to protect it with the lamest "security" ever invented.
class	SCLRecord Specifies the window's zoom magnification.
class	SelectionRecord Shows the user's selection on the sheet for write set num refs to 0
class	SharedFormulaRecord Primarily used as an excel optimization so that multiple similar formulas are not written out too many times.
class	SharedValueRecordBase Common base class for SharedFormulaRecord, ArrayRecord and TableRecord which are have similarities.
class	SSTRecord Static String Table Record (0x00FC)
class	StandardRecord Subclasses of this class (the majority of BIFF records) are non-continuable.
class	StringRecord STRING (0x0207)
class	StyleRecord Describes a builtin to the gui or user defined style
class	SupBookRecord A External Workbook Description (Supplemental Book).
class	TabIdRecord Contains an array of sheet id's.
class	TableRecord The record specifies a data table.
class	TableStylesRecord TABLESTYLES (0x088E)
class	TextObjectRecord The TXO record (0x01B6) is used to define the properties of a text box.
class	TopMarginRecord Record for the top margin.
class	UncalcedRecord If this record occurs in the Worksheet Substream, it indicates that the formulas have not been recalculated before the document was saved.
class	UnknownRecord Unknown record just tells you the sid so you can figure out what records you are missing.
class	UserSViewBegin The UserSViewBegin record specifies settings for a custom view associated with the sheet.
class	UserSViewEnd The UserSViewEnd record marks the end of the settings for a custom view associated with the sheet
class	UseSelFSRecord Tells the GUI if this was written by something that can use "natural language" formulas.
class	VCenterRecord Tells whether to center the sheet between vertical margins
class	VerticalPageBreakRecord VerticalPageBreak (0x001A) record that stores page breaks at columns
class	WindowOneRecord Stores the attributes of the workbook window.
class	WindowProtectRecord Flags whether workbook windows are protected
class	WindowTwoRecord Sheet window settings
class	WriteAccessRecord Title: Write Access Record (0x005C)
class	WriteProtectRecord Indicated that the sheet/workbook is write protected.
class	WSBoolRecord Stores workbook settings (aka its a big "everything we didn't put somewhere else")

Methods in org.apache.poi.hssf.record that return Record

Modifier and Type	Method and Description
Record	Record.cloneViaReserialise() Clone the current record, via a call to serialize it, and another to create a new record from the bytes.
abstract Record	Record.copy()
static Record	InterfaceEndRecord.create(RecordInputStream in)
static Record[]	RecordFactory.createRecord(RecordInputStream in) create a record, if there are MUL records than multiple records are returned digested into the non-mul form.
static Record	RecordFactory.createSingleRecord(RecordInputStream in)
Record	RecordFactoryInputStream.nextRecord()

Methods in org.apache.poi.hssf.record that return types with arguments of type Record

Modifier and Type	Method and Description
static java.util.List<Record>	RecordFactory.createRecords(java.io.InputStream in) Create an array of records from an input stream
static java.lang.Class<? extends Record>	RecordFactory.getRecordClass(int sid) Debug / diagnosis method
java.util.Map<EscherRecord,Record>	EscherAggregate.getShapeToObjMapping()

Methods in org.apache.poi.hssf.record with parameters of type Record

Modifier and Type	Method and Description
void	EscherAggregate.associateShapeToObjRecord(EscherRecord r, Record objRecord) Associates an escher record to an OBJ record or a TXO record.

Constructors in org.apache.poi.hssf.record with parameters of type Record

Constructor and Description
Record(Record other)

Uses of Record in org.apache.poi.hssf.record.aggregates

Methods in org.apache.poi.hssf.record.aggregates with parameters of type Record

Modifier and Type	Method and Description
void	RecordAggregate.RecordVisitor.visitRecord(Record r) Implementors may call non-mutating methods on Record r.
void	RecordAggregate.PositionTrackingVisitor.visitRecord(Record r)

Uses of Record in org.apache.poi.hssf.record.chart

Subclasses of Record in org.apache.poi.hssf.record.chart

Modifier and Type	Class and Description
class	AreaFormatRecord The area format record is used to define the colours and patterns for an area.
class	AreaRecord The area record is used to define a area chart.
class	AxisLineFormatRecord The axis line format record defines the axis type details.
class	AxisOptionsRecord The axis options record provides unit information and other various tidbits about the axis.
class	AxisParentRecord The axis size and location
class	AxisRecord The axis record defines the type of an axis.
class	AxisUsedRecord The number of axes used on a chart.
class	BarRecord The bar record is used to define a bar chart.
class	BeginRecord The begin record defines the start of a block of records for a (graphing data object.
class	CategorySeriesAxisRecord This record refers to a category or series axis and is used to specify label/tickmark frequency.
class	CatLabRecord CATLAB - Category Labels (0x0856)
class	ChartEndBlockRecord ENDBLOCK - Chart Future Record Type End Block (0x0853)
class	ChartEndObjectRecord ENDOBJECT - Chart Future Record Type End Object (0x0855)
class	ChartFormatRecord Class ChartFormatRecord (0x1014)
class	ChartFRTInfoRecord CHARTFRTINFO - Chart Future Record Type Info (0x0850)
class	ChartRecord CHART (0x1002)
class	ChartStartBlockRecord STARTBLOCK - Chart Future Record Type Start Block (0x0852)
class	ChartStartObjectRecord STARTOBJECT - Chart Future Record Type Start Object (0x0854)
class	ChartTitleFormatRecord CHARTTITLEFORMAT (0x1050)
class	DataFormatRecord The data format record is used to index into a series.
class	DataLabelExtensionRecord DATALABEXT - Chart Data Label Extension (0x086A)
class	DatRecord The dat record is used to store options for the chart.
class	DefaultDataLabelTextPropertiesRecord The default data label text properties record identifies the text characteristics of the preceding text record.
class	EndRecord The end record defines the end of a block of records for a (Graphing) data object.
class	FontBasisRecord The font basis record stores various font metrics.
class	FontIndexRecord The font index record indexes into the font table for the text record.
class	FrameRecord The frame record indicates whether there is a border around the displayed text of a chart.
class	LegendRecord Defines a legend for a chart.
class	LineFormatRecord Describes a line format record.
class	LinkedDataRecord Describes a linked data record.
class	NumberFormatIndexRecord The number format index record indexes format table.
class	ObjectLinkRecord Links text to an object on the chart or identifies it as the title.
class	PlotAreaRecord preceeds and identifies a frame as belonging to the plot area.
class	PlotGrowthRecord The plot growth record specifies the scaling factors used when a font is scaled.
class	SeriesChartGroupIndexRecord The series chart group index record stores the index to the CHARTFORMAT record (0 based).
class	SeriesIndexRecord links a series to its position in the series list.
class	SeriesLabelsRecord The series label record defines the type of label associated with the data format record.
class	SeriesListRecord SERIESLIST (0x1016)
class	SeriesRecord The series record describes the overall data for a series.
class	SeriesTextRecord SERIESTEXT (0x100D)
class	SeriesToChartGroupRecord Indicates the chart-group index for a series.
class	SheetPropertiesRecord Describes a chart sheet properties record.
class	TextRecord The text record is used to define text stored on a chart.
class	TickRecord The Tick record defines how tick marks and label positioning/formatting
class	UnitsRecord The units record describes units.
class	ValueRangeRecord The value range record defines the range of the value axis.

Uses of Record in org.apache.poi.hssf.record.cont

Subclasses of Record in org.apache.poi.hssf.record.cont

Modifier and Type	Class and Description
class	ContinuableRecord Common superclass of all records that can produce ContinueRecords while being serialized.

Uses of Record in org.apache.poi.hssf.record.pivottable

Subclasses of Record in org.apache.poi.hssf.record.pivottable

Modifier and Type	Class and Description
class	DataItemRecord SXDI - Data Item (0x00C5)
class	ExtendedPivotTableViewFieldsRecord SXVDEX - Extended PivotTable View Fields (0x0100)
class	PageItemRecord SXPI - Page Item (0x00B6)
class	StreamIDRecord SXIDSTM - Stream ID (0x00D5)
class	ViewDefinitionRecord SXVIEW - View Definition (0x00B0)
class	ViewFieldsRecord SXVD - View Fields (0x00B1)
class	ViewSourceRecord SXVS - View Source (0x00E3)

Uses of Record in org.apache.poi.hssf.usermodel

Method parameters in org.apache.poi.hssf.usermodel with type arguments of type Record

Modifier and Type	Method and Description
protected void	HSSFSheet.insertChartRecords(java.util.List<Record> records)