Home >> All >> org >> apache >> poi

•	org.apache.poi.contrib.* (10)	•	org.apache.poi.ddf.* (45)	•	org.apache.poi.dev.* (1)
•	org.apache.poi.generator.* (2)	•	org.apache.poi.hdf.* (72)	•	org.apache.poi.hpsf.* (29)
•	org.apache.poi.hssf.* (380)	•	org.apache.poi.poifs.* (84)	•	org.apache.poi.util.* (36)

Package Samples:

• org.apache.poi.hpsf.wellknown: Horrible PropertySet Format API reads things like Document Summary info from OLE 2 Compound document files.  
• org.apache.poi.hssf.record.formula: Record package contains class representations for XLS binary strutures.  
• org.apache.poi.contrib.metrics
• org.apache.poi.contrib.poibrowser
• org.apache.poi.hssf.contrib.view
• org.apache.poi.hssf.usermodel.contrib
• org.apache.poi.hpsf.examples
• org.apache.poi.hssf.usermodel.examples
• org.apache.poi.ddf
• org.apache.poi.dev
• org.apache.poi.hpsf
• org.apache.poi.hssf.dev
• org.apache.poi.hssf.eventmodel
• org.apache.poi.hssf.eventusermodel
• org.apache.poi.hssf.model
• org.apache.poi.hssf.record.aggregates
• org.apache.poi.hssf.record
• org.apache.poi.hssf.usermodel
• org.apache.poi.hssf.util
• org.apache.poi.poifs.common

Classes:

• PropertySet: Represents a property set in the Horrible Property Set Format (HPSF). These are usually metadata of a Microsoft Office document. An application that wants to access these metadata should create an instance of this class or one of its subclasses by calling the factory method PropertySetFactory.create(java.io.InputStream) 55 and then retrieve the information its needs by calling appropriate methods. PropertySetFactory.create(java.io.InputStream) 55 does its work by calling one of the constructors PropertySet(InputStream) 55 or PropertySet(byte[]) 55 . If the constructor's argument is not in the Horrible ...
• BinaryTree: Red-Black tree-based implementation of Map. This class guarantees that the map will be in both ascending key order and ascending value order, sorted according to the natural order for the key's and value's classes. This Map is intended for applications that need to be able to look up a key-value pairing by either key or value, and need to do so with equal efficiency. While that goal could be accomplished by taking a pair of TreeMaps and redirecting requests to the appropriate TreeMap (e.g., containsKey would be directed to the TreeMap that maps values to keys, containsValue would be directed to ...
• SpecialPropertySet: Abstract superclass for the convenience classes SummaryInformation and DocumentSummaryInformation . The motivation behind this class is quite nasty if you look behind the scenes, but it serves the application programmer well by providing him with the easy-to-use SummaryInformation and DocumentSummaryInformation classes. When parsing the data a property set stream consists of (possibly coming from an java.io.InputStream ) we want to read and process each byte only once. Since we don't know in advance which kind of property set we have, we can expect only the most general PropertySet . Creating a ...
• TreeReaderListener: Organizes document information in a tree model in order to be e.g. displayed in a Swing JTree . An instance of this class is created with a root tree node ( javax.swing.tree.MutableTreeNode ) and registered as a org.apache.poi.poifs.eventfilesystem.POIFSReaderListener with a org.apache.poi.poifs.eventfilesystem.POIFSReader . While the latter processes a POI filesystem it calls this class' processPOIFSReaderEvent(org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent) 55 for each document it has been registered for. This method appends the document it processes at the appropriate position into the ...
• Property: A property in a Section of a PropertySet . The property's ID gives the property a meaning in the context of its Section . Each Section spans its own name space of property IDs. The property's type determines how its value is interpreted. For example, if the type is Variant.VT_LPSTR 55 (byte string), the value consists of a DWord telling how many bytes the string contains. The bytes follow immediately, including any null bytes that terminate the string. The type Variant.VT_I4 55 denotes a four-byte integer value, Variant.VT_FILETIME 55 some date and time (of a file). FIXME: Reading is not implemented ...
• HSSFDataFormat: Utility to identify builin formats. Now can handle user defined data formats also. The following is a list of the formats as returned by this class. 0, "General" 1, "0" 2, "0.00" 3, "#,##0" 4, "#,##0.00" 5, "($#,##0_);($#,##0)" 6, "($#,##0_);[Red]($#,##0)" 7, "($#,##0.00);($#,##0.00)" 8, "($#,##0.00_);[Red]($#,##0.00)" 9, "0%" 0xa, "0.00%" 0xb, "0.00E+00" 0xc, "# ?/?" 0xd, "# ??/??" 0xe, "m/d/yy" 0xf, "d-mmm-yy" 0x10, "d-mmm" 0x11, "mmm-yy" 0x12, "h:mm AM/PM" 0x13, "h:mm:ss AM/PM" 0x14, "h:mm" 0x15, "h:mm:ss" 0x16, "m/d/yy h:mm" // 0x17 - 0x24 reserved for international and undocumented 0x25, "(#,##0_);(#,##0)" ...
• EscherGraphics: Translates Graphics calls into escher calls. The translation is lossy so many features are not supported and some just aren't implemented yet. If in doubt test the specific calls you wish to make. Graphics calls are always performed into an EscherGroup so one will need to be created. Important: One important concept worth considering is that of font size. One of the difficulties in converting Graphics calls into escher drawing calls is that Excel does not have the concept of absolute pixel positions. It measures it's cell widths in 'characters' and the cell heights in points. Unfortunately it's ...
• EscherGraphics2d: Translates Graphics2d calls into escher calls. The translation is lossy so many features are not supported and some just aren't implemented yet. If in doubt test the specific calls you wish to make. Graphics calls are always drawn into an EscherGroup so one will need to be created. Important: One important concept worth considering is that of font size. One of the difficulties in converting Graphics calls into escher drawing calls is that Excel does not have the concept of absolute pixel positions. It measures it's cell widths in 'characters' and the cell heights in points. Unfortunately it's not ...
• ExtendableTreeCellRenderer: This is a javax.swing.tree.TreeCellRenderer implementation which is able to render arbitrary objects. The ExtendableTreeCellRenderer does not do the rendering itself but instead dispatches to class-specific renderers. A class/renderer pair must be registered using the register(java.lang.Class, javax.swing.tree.TreeCellRenderer) 55 method. If a class has no registered renderer, the renderer of its closest superclass is used. Since the ExtendableTreeCellRenderer always has a default renderer for the java.lang.Object class, rendering is always possible. The default java.lang.Object renderer can be ...
• SectionIDMap: Maps section format IDs to PropertyIDMap s. It is initialized with two well-known section format IDs: those of the \005SummaryInformation stream and the \005DocumentSummaryInformation stream. If you have a section format ID you can use it as a key to query this map. If you get a PropertyIDMap returned your section is well-known and you can query the PropertyIDMap for PID strings. If you get back null you are on your own. This java.util.Map expects the byte arrays of section format IDs as keys. A key maps to a PropertyIDMap describing the property IDs in sections with the specified section format ...
• PropertyIDMap: This is a dictionary which maps property ID values to property ID strings. The methods getSummaryInformationProperties() 55 and getDocumentSummaryInformationProperties() 55 return singleton PropertyIDMap s. An application that wants to extend these maps should treat them as unmodifiable, copy them and modifiy the copies. FIXME: Make the singletons unmodifiable. However, since this requires to use a java.util.HashMap delegate instead of extending java.util.HashMap and thus requires a lot of stupid typing. I won't do that for the time being.
• FormattedDiskPage: Represents an FKP data structure. This data structure is used to store the grpprls of the paragraph and character properties of the document. A grpprl is a list of sprms(decompression operations) to perform on a parent style. The style properties for paragraph and character runs are stored in fkps. There are PAP fkps for paragraph properties and CHP fkps for character run properties. The first part of the fkp for both CHP and PAP fkps consists of an array of 4 byte int offsets in the main stream for that Paragraph's or Character run's text. The ending offset is the next value in the array. For ...
• CHPFormattedDiskPage: Represents a CHP fkp. The style properties for paragraph and character runs are stored in fkps. There are PAP fkps for paragraph properties and CHP fkps for character run properties. The first part of the fkp for both CHP and PAP fkps consists of an array of 4 byte int offsets that represent a Paragraph's or Character run's text offset in the main stream. The ending offset is the next value in the array. For example, if an fkp has X number of Paragraph's stored in it then there are (x + 1) 4 byte ints in the beginning array. The number X is determined by the last byte in a 512 byte fkp. CHP and ...
• PAPFormattedDiskPage: Represents a PAP FKP. The style properties for paragraph and character runs are stored in fkps. There are PAP fkps for paragraph properties and CHP fkps for character run properties. The first part of the fkp for both CHP and PAP fkps consists of an array of 4 byte int offsets in the main stream for that Paragraph's or Character run's text. The ending offset is the next value in the array. For example, if an fkp has X number of Paragraph's stored in it then there are (x + 1) 4 byte ints in the beginning array. The number X is determined by the last byte in a 512 byte fkp. CHP and PAP fkps also ...
• 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
• Workbook: Low level model implementation of a Workbook. Provides creational methods for settings and objects contained in the workbook object. This file contains the low level binary records starting at the workbook's BOF and ending with the workbook's EOF. Use HSSFWorkbook for a high level representation. The structures of the highlevel API use references to this to perform most of their operations. Its probably unwise to use these low level structures directly unless you really know what you're doing. I recommend you read the Microsoft Excel 97 Developer's Kit (Microsoft Press) and the documentation at ...
• ShortList: 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 sup ...
• IntList: 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
• HSSFPrintSetup: Used to modify the print setup. Paper size constants have been added for the ones I have access to. They follow as: public static final short LETTER_PAPERSIZE = 1; public static final short LEGAL_PAPERSIZE = 5; public static final short EXECUTIVE_PAPERSIZE = 7; public static final short A4_PAPERSIZE = 9; public static final short A5_PAPERSIZE = 11; public static final short ENVELOPE_10_PAPERSIZE = 20; public static final short ENVELOPE_DL_PAPERSIZE = 27; public static final short ENVELOPE_CS_PAPERSIZE = 28; public static final short ENVELOPE_MONARCH_PAPERSIZE = 37;
• NoSingleSectionException: 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 . The constructors of this class are analogous to those of its superclass and documented there.
• Sheet: 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. Use HSSFSheet for a high level representation. The structures of the highlevel API use references to this to perform most of their operations. Its probably unwise to use these low level structures directly unless you really know what you're doing. I recommend you read the Microsoft Excel 97 Developer's Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf before even attempting ...
• HSSFCell: High level representation of a cell in a row of a spreadsheet. Cells can be numeric, formula-based or string-based (text). The cell type specifies this. String cells cannot conatin numbers and numeric cells cannot contain strings (at least according to our model). Client apps should do the conversions themselves. Formula cells are treated like string cells, simply containing a formula string. They'll be rendered differently. Cells should have their number (0 based) before being added to a row. Only cells that have values should be added. NOTE: the alpha won't be implementing formulas
• 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.
• HSSFColor: Intends to provide support for the very evil index to triplet issue and will likely replace the color contants interface for HSSF 2.0. This class contains static inner class members for representing colors. Each color has an index (for the standard palette in Excel (tm) ), native (RGB) triplet and string triplet. The string triplet is as the color would be represented by Gnumeric. Having (string) this here is a bit of a collusion of function between HSSF and the HSSFSerializer but I think its a reasonable one in this case.

Home | Contact Us | Privacy Policy | Terms of Service