All Classes and Interfaces
Class
Description
Interface for use with the HSSFRequest and HSSFEventFactory.
The escher container record is used to hold escher records.
This class provides the base functionality for Excel sheet functions
There are two kinds of function Ptgs - tFunc and tFuncVar
Therefore, this class will have ONLY two subclasses
An abstract shape is the lowlevel model for a shape.
Addition operator PTG the "+" binomial operator.
Title: Area 3D Ptg - 3D referecnce (Sheet + Area)
Specifies a rectangular area of cells A1:A4 for instance.
AreaErr - handles deleted cell area references.
The area format record is used to define the colours and patterns for an area.
Specifies a rectangular area of cells A1:A4 for instance.
Specifies a rectangular area of cells A1:A4 for instance.
Specifies a rectangular area of cells A1:A4 for instance.
Specifies a rectangular area of cells A1:A4 for instance.
The area record is used to define a area chart.
Specifies a rectangular area of cells A1:A4 for instance.
ArrayPtg - handles arrays
The ArrayPtg is a little wierd, the size of the Ptg when parsing initially only
includes the Ptg sid and the reserved bytes.
ArrayPtgA - handles arrays
ArrayPtg - handles arrays
The ArrayPtg is a little wierd, the size of the Ptg when parsing initially only
includes the Ptg sid and the reserved bytes.
Utility classes for dealing with arrays.
"Special Attributes"
This seems to be a Misc Stuff and Junk record.
The axis line format record defines the axis type details.
The axis options record provides unit information and other various tidbits about the axis.
The axis size and location
NOTE: This source is automatically generated please do not modify this file.
The axis record defines the type of an axis.
The number of axes used on a chart.
Title: Backup Record
The bar record is used to define a bar chart.
A block of block allocation table entries.
This interface defines behaviors for objects managed by the Block
Allocation Table (BAT).
The begin record defines the start of a block of records for a (grpahing
data object.
Utillity for reading in BIFF8 records and displaying data from them.
Red-Black tree-based implementation of Map.
Manage operations dealing with bit-mapped fields.
Returns immutable Btfield instances.
Title: Blank cell record
This class manages and creates the Block Allocation Table, which is
basically a set of linked lists of block indices.
This class manages and creates the Block Allocation Table, which is
basically a set of linked lists of block indices.
Implementation of a BlockingInputStream to provide data to
RawDataBlock that expects data in 512 byte chunks.
Interface for lists of blocks that are mapped by block allocation
tables
An interface for persisting block storage of POIFS components.
Title: Beginning Of File
Title: Save External Links record (BookBool)
Creates new BoolErrRecord.
Boolean (boolean)
Stores a (java) boolean value in a formula.
Record for the bottom margin.
Title: Bound Sheet Record (aka BundleSheet)
representation of a byte (8-bit) field at a fixed location within a
byte array
Title: Calc Count Record
Description: Specifies the maximum times the gui should perform a formula
recalculation.
Title: Calc Mode Record
This record refers to a category or series axis and is used to specify label/tickmark frequency.
The cell value record interface is implemented by all classes of type Record that
contain cell values.
Class ChartFormatRecord
The chart record is used to define the location and size of a chart.
This interface defines methods for finding and setting sibling
Property instances
Represents a class ID (16 bytes).
Title: Codepage Record
Title: ColumnInfo Record
Represents a cell comment.
The common object data record is used to store all common preferences for an excel object.
A logger class that strives to make it as easy as possible for
developers to write log calls, while simultaneously making those
calls as cheap as possible by performing lazy evaluation of the log
message.
Defines constants of general use.
Title: Continue Record - Helper class used primarily for SST Records
$Id: ConvertAnchor.java 562536 2007-08-03 18:09:41Z yegor $
Title: Country Record (aka WIN.INI country)
Maintains the instances of
CustomProperty that belong to a
DocumentSummaryInformation.This class represents custum properties in the document summary
information stream.
The data format record is used to index into a series.
Title: Date Window 1904 Flag record
The dat record is used to store options for the chart.
Title: DBCell Record
Description: Used by Excel and other MS apps to quickly find rows in the sheets.
Title: Default Column Width Record
The default data label text properties record identifies the text characteristics of the preceeding text record.
Generates escher records when provided the byte array containing those records.
Title: Default Row Height Record
Description: Row height for rows with undefined or not explicitly defined
heights.
Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
Title: Deleted Reference 3D Ptg
Title: Delta Record
Title: Dimensions Record
This interface defines methods specific to Directory objects
managed by a Filesystem instance.
Simple implementation of DirectoryEntry
Directory property
This PTG implements the standard binomial divide "/"
A block of document data.
Class DocumentDescriptor
This interface defines methods specific to Document objects
managed by a Filesystem instance.
This class provides methods to read a DocumentEntry managed by a
Filesystem instance.
Simple implementation of DocumentEntry
This class provides a wrapper over an OutputStream so that Document
writers can't accidently go over their size limits
Trivial extension of Property for POIFSDocuments
Convenience class representing a DocumentSummary Information stream in a
Microsoft Office document.
A List of double's; as full an implementation of the java.util.List
interface as possible, with an eye toward minimal creation of
objects
the mimicry of List is as follows:
if possible, operations designated 'optional' in the List
interface are attempted
wherever the List interface refers to an Object, substitute
double
wherever the List interface refers to a Collection or List,
substitute DoubleList
the mimicry is not perfect, however:
operations involving Iterators or ListIterators are not
supported
remove(Object) becomes removeValue to distinguish it from
remove(int index)
subList is not supported
Provides an interface for interacting with 2d arrays of doubles.
Dump out the aggregated escher records
Provides utilities to manage drawing groups.
Provides utilities to manage drawing groups.
This is purely for the biff viewer.
Title: Double Stream Flag Record
A sub-record within the OBJ record which stores a reference to an object
stored in a separate entry within the OLE2 compound file.
The end record defines the end of a block of records for a (Graphing)
data object.
The end data record is used to denote the end of the subrecords.
This interface provides access to an object managed by a Filesystem
instance.
Abstract implementation of Entry
Extending classes should override isDocument() or isDirectory(), as
appropriate
Extending classes must override isDeleteOK()
End Of File record.
An ERFListener is registered with the EventRecordFactory.
This class is used to aggregate the MSODRAWING and OBJ record
combinations.
Escher array properties are the most wierd construction ever invented
with all sorts of special cases.
The blip record is used to hold details about large binary objects that occur in escher such
as JPEG, GIF, PICT and WMF files.
Represents a boolean property.
The BSE record is related closely to the
EscherBlipRecord and stores
extra information about the blip.The escher child achor record is used to specify the position of a shape under an
existing group.
The escher client anchor specifies which rows and cells the shape is bound to as well as
the offsets within those cells.
The EscherClientDataRecord is used to store client specific data about the position of a
shape within a container.
A complex property differs from a simple property in that the data can not fit inside a 32 bit
integer.
Escher container records store other escher records as children.
This record defines the drawing groups used for a particular sheet.
This record simply holds the number of shapes in the drawing group and the
last shape id used for this drawing group.
Used to dump the contents of escher records to a PrintStream.
Translates Graphics calls into escher calls.
Translates Graphics2d calls into escher calls.
The opt record is used to store property values for a shape.
Provides a list of all known escher properties including the description and
type.
This is the abstract base class for all escher properties.
Generates a property given a reference into the byte array storing that property.
This class stores the type and description of an escher property.
The base abstract record from which all escher records are defined.
The escher record factory interface allows for the creation of escher
records from a pointer into a data array.
A color property.
Interface for listening to escher serialization events.
Defines the constants for the various possible shape paths.
A simple property is of fixed length and as a property number in addition
to a 32-bit value.
The spgr record defines information about a shape group.
A list of the most recently used colours for the drawings contained in
this document.
Together the the EscherOptRecord this record defines some of the basic
properties of a shape.
Holds data from the parent application.
Event-based record factory.
A text extractor for Excel files.
Title: Extended Format Record
Description: Probably one of the more complex records.
Title: Extern Sheet
Title: A sub Record for Extern Sheet
Extended SST table info subrecord
Title: Extended Static String Table
Title: File Pass Record
Title: FileSharing
behavior of a field at a fixed location within a byte array
Title: Function Group Count Record
The font basis record stores various font metrics.
Stores width and height details about a font.
The font index record indexes into the font table for the text record.
Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)
Title: Footer Record
Title: Format Record
This class parses a formula string into a List of tokens in RPN order.
Formula Record.
The formula record aggregate is used to join together the formula record and it's
(optional) string record and (optional) Shared Formula Record (template reads, excel optimization).
FormulaViewer - finds formulas in a BIFF8 file and attempts to read them/display
data from them.
The frame record indicates whether there is a border around the displayed text of a chart.
PTG class to implement greater or equal to
Greater than operator PTG ">"
Title: Gridset Record.
The group marker record is used as a position holder for groups.
Title: Guts Record
Title: HCenter record
Constants used in reading/writing the Header block
The block containing the archive header
The block containing the archive header
Title: Header Record
dump data in hexadecimal format; derived from a HexDump utility I
wrote in June 2001.
Utilities to read hex from files.
Title: Hide Object Record
HorizontalPageBreak record that stores page breaks at rows
This exception is the superclass of all other checked exceptions thrown
in this package.
This exception is the superclass of all other unchecked
exceptions thrown in this package.
File for HSSF testing/examples
THIS IS NOT THE MAIN HSSF FILE!! This is a util for testing functionality.
An anchor is what specifics the position of a shape within a client object
or within another containing shape.
High level representation of a cell in a row of a spreadsheet.
High level representation of the style of a cell in a sheet of a workbook.
A client anchor is attached to an excel worksheet.
Intends to provide support for the very evil index to triplet issue and
will likely replace the color contants interface for HSSF 2.0.
Class AQUA
Special Default/Normal/Automatic color.
Class BLACK
Class BLUE
Class BLUE_GREY
Class BRIGHT_GREEN
Class BROWN
Class CORAL
Class CORNFLOWER_BLUE
Class DARK_BLUE
Class DARK_GREEN
Class DARK_RED
Class DARK_TEAL
Class DARK_YELLOW
Class GOLD
Class GREEN
Class GREY_25_PERCENT
Class GREY_40_PERCENT
Class GREY_50_PERCENT
Class GREY_80_PERCENT
Class INDIGO
Class LAVENDER
Class LEMON_CHIFFON
Class LIGHT_BLUE
Class LIGHT_CORNFLOWER_BLUE
Class LIGHT_GREEN
Class LIGHT_ORANGE
Class LIGHT_TURQUOISE
Class LIGHT_YELLOW
Class LIME
Class MAROON
Class OLIVE_GREEN
Class ORANGE
Class ORCHID
Class PALE_BLUE
Class PINK
Class PLUM
Class RED
Class ROSE
Class ROYAL_BLUE
Class SEA_GREEN
Class SKY_BLUE
Class TAN
Class TEAL
Class TURQUOISE
Class VIOLET
Class WHITE
Class YELLOW
Represents a cell comment - a sticky note associated with a cell.
Utility to identify builtin formats.
Contains methods for dealing with Excel dates.
contains constants representing Excel error codes.
Low level event based HSSF reader.
Represents a Font used in a workbook.
Class to read and manipulate the footer.
Class to read and manipulate the header.
Interface for use with the HSSFRequest and HSSFEventFactory.
Title: High Level Represantion of Named Range
Represents binary object (i.e.
Represents a workbook color palette.
The patriarch is the toplevel container for shapes in a sheet.
Represents a escher picture.
Represents binary data stored in the file.
Used to modify the print setup.
An HSSFRequest object should be constructed registering an instance or multiple
instances of HSSFListener with each Record.sid you wish to listen for.
Rich text unicode string.
High level representation of a row of a spreadsheet.
An abstract shape.
An interface that indicates whether a class can contain children.
A shape group may contain other shapes.
High level representation of a worksheet.
Represents a simple shape such as a line, rectangle or oval.
A textbox is a shape that may hold a rich text string.
This exception is provided as a way for API users to throw
exceptions from their event handling code.
High level representation of a workbook.
This exception is thrown when there is an illegal value set in a
PropertySet.This exception is thrown if HPSF encounters a variant type that is illegal
in the current context.
Title: Index Record
representation of an integer (32-bit) field at a fixed location
within a byte array
Title: Interface End Record
Title: Interface Header Record
A List of int's; as full an implementation of the java.util.List
interface as possible, with an eye toward minimal creation of
objects
the mimicry of List is as follows:
if possible, operations designated 'optional' in the List
interface are attempted
wherever the List interface refers to an Object, substitute
int
wherever the List interface refers to a Collection or List,
substitute IntList
the mimicry is not perfect, however:
operations involving Iterators or ListIterators are not
supported
remove(Object) becomes removeValue to distinguish it from
remove(int index)
subList is not supported
Provides an interface for interacting with 2d arrays of integers.
A List of objects that are indexed AND keyed by an int; also allows for getting
the index of a value in the list
Integer (short intger)
Stores a (java) short value in a formula
Title: Iteration Record
Label Record - read only support for strings stored directly in the cell..
Title: Label SST Record
Record for the left margin.
Defines a legend for a chart.
Ptg class to implement less than or equal
Less than operator PTG "<".
Describes a line format record.
Represents a line shape and creates all the line specific low level records.
Not implemented yet.
Describes a linked data record.
Provides an interface for interacting with 2d arrays of objects.
An interface for blocks managed by a list that works with a
BlockAllocationTable to keep block sequences straight
a utility class for handling little-endian numbers, which the 80x86 world is
replete with.
Exception to handle buffer underruns
a repository for constants shared by classes within this package
representation of a long (16-bit) field at a fixed location within
a byte array
The margin interface is a parent used to define left, right, top and bottom margins.
This exception is thrown if an
InputStream does
not support the InputStream.mark(int) operation.Title: Merged Cells Record
Description: Optional record defining a square area of cells to "merged" into one cell.
Description: Optional record defining a square area of cells to "merged" into one cell.
Missing Function Arguments
Avik Sengupta <avik at apache.org>
This exception is thrown if one of the
PropertySet's
convenience methods does not find a required Section.Title: MMS Record
enclosing_type describe the purpose here
ModelFactory creates workbook and sheet models based upon
events thrown by them there events from the EventRecordFactory.
ModelFactoryListener is registered with the
ModelFactory.
Title: Mulitple Blank cell record
Used to store multiple RK numbers on a row.
Implements the standard mathmatical multiplication - *
Adds writing capability to the
Property class.Adds writing support to the
PropertySet class.Adds writing capability to the
Section class.Title: Name Record (aka Named Range)
This exception is thrown if a
MutablePropertySet is to be written
but does not have a formatID set (see MutableSection.setFormatID(ClassID) or
MutableSection.setFormatID(byte[]).This exception is thrown if a format error in a property set stream is
detected or when the input data do not constitute a property set stream.
This exception is thrown if one of the
PropertySet's
convenience methods that require a single Section is called
and the PropertySet does not contain exactly one Section.Ptg class to implement not equal
NOTE: Comment Associated with a Cell (1Ch)
Represents a NoteStructure (0xD) sub record.
Ignores all serialization events.
A logger class that strives to make it as easy as possible for
developers to write log calls, while simultaneously making those
calls as cheap as possible by performing lazy evaluation of the log
message.
The number format index record indexes format table.
Number
Stores a floating point value in a formula
value stored in a 8 byte field using IEEE notation
Contains a numeric cell value.
Links text to an object on the chart or identifies it as the title.
Title: Object Protect Record
The obj record is used to hold various graphic objects and controls.
This exception is thrown when we try to open a file that's actually
an Office 2007+ XML file, rather than an OLE2 file (which is what
POI works with)
defines a Ptg that is an operation instead of an operand
Record that contains the functionality page breaks (horizontal and vertical)
PaletteRecord - Supports custom palettes.
Holds information regarding a split plane or freeze plane for a sheet.
Describes the frozen and unfozen panes.
Behavior for parent (directory) properties
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 <lists@aviksengupta.com>
Andrew C.
Title: Password Record
Title: Protection Revision 4 password Record
Percent PTG.
Represents a picture shape and creates all specific low level records.
preceeds and identifies a frame as belonging to the plot area.
The plot growth record specifies the scaling factors used when a font is scaled.
This holds the common functionality for all POI
Document classes.
A repository for constants shared by POI classes.
This class manages a document in the POIFS filesystem.
Class POIFSDocumentPath
This is the main class of the POIFS system; it manages the entire
life cycle of the filesystem.
An event-driven reader for POIFS file systems.
Class POIFSReaderEvent
Interface POIFSReaderListener
Interface for a drill-down viewable object.
This class contains methods used to inspect POIFSViewable objects
A simple viewer for POIFS files
Class POIFSWriterEvent
Interface POIFSWriterListener
Provides logging without clients having to mess with
configuration/initialization.
A logger interface that strives to make it as easy as possible for
developers to write log calls, while simultaneously making those
calls as cheap as possible by performing lazy evaluation of the log
message.
Common Parent for Text Extractors
of POI Documents.
Title: Precision Record
Title: Print Gridlines Record
Title: Print Headers Record
Title: Print Setup Record
A property in a
Section of a PropertySet.This abstract base class is the ancestor of all classes
implementing POIFS Property behavior.
A block of Property instances
Interface PropertyConstants
This is a dictionary which maps property ID values to property
ID strings.
Represents a property set in the Horrible Property Set Format
(HPSF).
Factory class to create instances of
SummaryInformation,
DocumentSummaryInformation and PropertySet.This class embodies the Property Table for the filesystem; this is
basically the dsirectory for all of the documents in the
filesystem.
Title: Protection Revision 4 Record
Title: Protect Record
Title: Range Address
A big block created from an InputStream, holding the raw data
A list of RawDataBlocks instances, and methods to manage the list
This exception is thrown when HPSF tries to read a (yet) unsupported
variant type.
Title: Recalc Id Record
Title: Record
Description: All HSSF Records inherit from this class.
Deprecated.
Title: Record Format Exception
Description: Used by records to indicate invalid format/data.
Description of the Class
Title: Record Input Stream
Title: Reference 3D Ptg
RefNAPtg
ReferencePtg - handles references (such as A1, A2, IA4)
RefError - handles deleted cell reference
Title: RefMode Record
RefNAPtg
RefNPtg
RefNVPtg
Title: Refresh All Record
RefVPtg
Represents a from/to row/col square.
Record for the right margin.
Title: RK Record
Description: An internal 32 bit number with the two most significant bits
storing the type.
Utility class for helping convert RK numbers.
Root property
Title: Row Record
Title: Save Recalc Record
Title: Scenario Protect Record
Specifies the window's zoom magnification.
Represents a section in a
PropertySet.Maps section format IDs to
PropertyIDMaps.Title: Selection Record
The series chart group index record stores the index to the CHARTFORMAT record (0 based).
links a series to its position in the series list.
The series label record defines the type of label associated with the data format record.
The series list record defines the series displayed as an overlay to the main chart record.
The series record describes the overall data for a series.
Defines a series name
NOTE: This source is automatically generated please do not modify this file.
Indicates the chart-group index for a series.
Title: SharedFormulaRecord
Description: Primarily used as an excel optimization so that multiple similar formulas
are not written out too many times.
Low level model implementation of a Sheet (one workbook contains many sheets)
This file contains the low level binary records starting at the sheets BOF and
ending with the sheets EOF.
Describes a chart sheet properties record.
Holds a collection of Sheet names and their associated
reference numbers.
representation of a short (16-bit) field at a fixed location within
a byte array
A List of short's; as full an implementation of the java.util.List
interface as possible, with an eye toward minimal creation of
objects
the mimicry of List is as follows:
if possible, operations designated 'optional' in the List
interface are attempted
wherever the List interface refers to an Object, substitute
short
wherever the List interface refers to a Collection or List,
substitute ShortList
the mimicry is not perfect, however:
operations involving Iterators or ListIterators are not
supported
remove(Object) becomes removeValue to distinguish it from
remove(short index)
subList is not supported
This class implements reading the small document block list from an
existing file
This class implements storage for writing the small blocks used by
small documents.
Storage for documents that are too small to use regular
DocumentBlocks for their data
A list of SmallDocumentBlocks instances, and methods to manage the list
Abstract superclass for the convenience classes
SummaryInformation and DocumentSummaryInformation.Title: Static String Table Record
Number
Stores a String value in a formula value stored in the format <length 2 bytes>char[]
Supports the STRING record structure.
Title: String Utility Description: Collection of string handling utilities
Title: Style Record
Subrecords are part of the OBJ class.
Convenience class representing a Summary Information stream in a
Microsoft Office document.
Title: Sup Book
A logger class that strives to make it as easy as possible for
developers to write log calls, while simultaneously making those
calls as cheap as possible by performing lazy evaluation of the log
message.
Title: Sheet Tab Index Array Record
Interface for creating temporary files.
Represents an textbox shape and converts between the highlevel records
and lowlevel records for an oval.
The TXO record is used to define the properties of a text box.
The text record is used to define text stored on a chart.
Class to manipulate data in the Clipboard Variant (
VT_CF) format.The Tick record defines how tick marks and label positioning/formatting
NOTE: This source is automatically generated please do not modify this file.
Record for the top margin.
Class for writing little-endian data and more.
Unary Plus operator
does not have any effect on the operand
Unary Plus operator
does not have any effect on the operand
This exception is thrown if a certain type of property set is
expected (e.g.
Title: Unicode String
Returns the size of this record, given the ammount of record space
remaining, it will also include the size of writing a continue record.
The units record describes units.
This record is used whenever a escher record is encountered that
we do not explicitly support.
Title: Unknown Record (for debugging)
This exception is thrown if HPSF encounters a variant type that isn't
supported yet.
Title: Use Natural Language Formulas Flag
Provides various static utility methods.
The value range record defines the range of the value axis.
Aggregate value records together.
The Variant types as defined by Microsoft's COM.
Supports reading and writing of variant data.
This exception is thrown if HPSF encounters a problem with a variant type.
Title: VCenter record
VerticalPageBreak record that stores page breaks at columns
Title: Window1 Record
Title: Window Protect Record
Title: Window Two Record
Low level model implementation of a Workbook.
Title: Write Access Record
Title: Write Protect Record
This exception is thrown when trying to write a (yet) unsupported variant
type.
Title: WSBool Record.
EventRecordFactoryinstead