diff --git a/build/jakarta-poi/docs/changes.html b/build/jakarta-poi/docs/changes.html deleted file mode 100644 index 2f3a0c53dd..0000000000 --- a/build/jakarta-poi/docs/changes.html +++ /dev/null @@ -1,431 +0,0 @@ - - - - -History of Changes - - - - - - - - - - - - - -
www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
- - - - -
-
-		 -
-About -
-Index -
-History -
-Future -
-Download -
-1.0 Vision -
-2.0 Vision -
-Who we are -
-Changes -
-FAQ -
-
-Sub-Projects -
-Overview -
-POIFS -
-HSSF -
-HDF -
-HPSF -
-POI-Utils -
-
-References -
-In The News -
-Live Sites -
-XLS spec [PDF] -
-Apache Cocoon -
-Resolutions -
-
-Get Involved -
-Contributing -
-Bug Database -
-CVS -
-Mail Lists -
-		 -
-		 -History of Changes - - - - - - -
- - - - - - -
- - - - - - -
History of Changes
-
-
- -

- -

- -
- - - - - - - -
1.5-dev (03-April-2002)
-
- - -
  • -New project build.(NKB)
    • - -
  • -New project documentation system based on Cocoon.(NKB)
    • - -
  • -Package rename(POI-DEVELOPERS)
    • - -
  • -Various bug fixes(POI-DEVELOPERS)
    • - -
  • -Early stages of HSF development (not ready for development)(POI-DEVELOPERS)
    • - -
  • -Initial low level record support for charting (not complete)(POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    - - - - - - - -
    1.1.0 ()
    -
    - - -
  • -Created new event model(POI-DEVELOPERS)
    • - -
  • -Optimizations made to HSSF including aggregate records for - values, rows, etc.(POI-DEVELOPERS)
    • - -
  • -predictive sizing, offset based writing (instead of lots of - array copies)(POI-DEVELOPERS)
    • - -
  • -minor re-factoring and bug fixes.(POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    - - - - - - - -
    1.0.0 (???)
    -
    - - -
  • -Minor documentation updates.(POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    - - - - - - - -
    0.14.0 (???)
    -
    - - -
  • -Added DataFormat helper class and exposed set and get format - on HSSFCellStyle(POI-DEVELOPERS)
    • - -
  • -Fixed column width apis (unit wise) and various javadoc on - the subject(POI-DEVELOPERS)
    • - -
  • -Fix for Dimensions record (again)... (one of these days I'll - write a unit test for this ;-p).(POI-DEVELOPERS)
    • - -
  • -Some optimization on sheet creation.(POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    - - - - - - - -
    0.13.0 (???)
    -
    - - - - -
    -
    -
    -
    - - - - - - - -
    0.12.0 (???)
    -
    - - -
  • -Added MulBlank, Blank, ColInfo(POI-DEVELOPERS)
    • - -
  • -Added log4j facility and removed all sys.out type logging(POI-DEVELOPERS)
    • - -
  • -Added support for adding font's, styles and corresponding - high level api for styling cells(POI-DEVELOPERS)
    • - -
  • -added support for changing row height, cell width and default - row height/cell width.(POI-DEVELOPERS)
    • - -
  • -Added fixes for internationalization (UTF-16 should work now - from HSSFCell.setStringValue, etc when the encoding is set)(POI-DEVELOPERS)
    • - -
  • -added support for adding/removing and naming sheets.(POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    - - - - - - - -
    0.11.0 (???)
    -
    - - -
  • -Bugfix release. We were throwing an exception when reading - RKRecord objects.(POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    - - - - - - - -
    0.10.0 (???)
    -
    - - -
  • -Got continuation records to work (read/write)(POI-DEVELOPERS)
    • - -
  • -Added various pre-support for formulas(POI-DEVELOPERS)
    • - -
  • -Massive API reorganization, repackaging.(POI-DEVELOPERS)
    • - -
  • -BiffViewer class added for validating HSSF & POI and/or - HSSF Output.(POI-DEVELOPERS)
    • - -
  • -Better API support for modification.(POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    - - - - - - - -
    0.7 (and interim releases) (???)
    -
    - - -
  • -Added encoding flag to high and low level api to use utf-16 - when needed (HSSFCell.setEncoding())(POI-DEVELOPERS)
    • - -
  • -added read only support for Label records (which are - reinterpreted as LabelSST when written)(POI-DEVELOPERS)
    • - -
  • -Broken continuation record implementation (oops)(POI-DEVELOPERS)
    • - -
  • -BiffViewer class added for validating HSSF & POI and/or - HSSF Output.(POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    - - - - - - - -
    0.6 (release) (???)
    -
    - - -
  • -Support for read/write and modify.(POI-DEVELOPERS)
    • - -
  • -Read only support for MulRK records (converted to Number when - writing) - (POI-DEVELOPERS)
    • - -     -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/contrib.html b/build/jakarta-poi/docs/contrib.html deleted file mode 100644 index a71f5ddc75..0000000000 --- a/build/jakarta-poi/docs/contrib.html +++ /dev/null @@ -1,532 +0,0 @@ - - - - -Contribution to POI - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -Contribution to POI - - - - - - -
    - - - - - - -
    - - - - - - -
    Contribution to POI
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Introduction
    -
    - - -

    - The POI Project is an Open Source - volunteer project released under a very open license. - This means there are many ways to contribute to the project - either - with direct participation (coding, documenting, answering questions, - proposing ideas, reporting bugs, suggesting bug fixes, etc. ...) or by resource - donations (money, time, publicity, hardware, software, conference - presentations, speeches, etc. ...). -

    - -

    - To begin with, we suggest you subscribe to the - POI mailing lists - (follow the link for information on how to subscribe and to access the mail - list archives). Listen in for a while, to hear how others make contributions. -

    - - -

    You can get your local working copy of the - latest and - greatest code (which you find in the jakarta-poi module in - the CVS code repository. Review the todo list and choose a task - (or perhaps you have noticed something that needs patching). Make the changes, do the testing, - generate a patch, and post to the dev mailing list. (Do not worry - the process is easy and - explained below.) -

    - - -

    - Document writers are usually the most wanted people so if - you like to help but you're not familiar with the innermost technical details, don't worry: - we have work for you! And we'll be very available to you for any questions! -

    - - -
    -
    -
    -
    - - - - - - - -
    Help Wanted Here
    -
    - -

    - The rest of this document is mainly about - contributing new or improved code and/or documentation, but we would also be glad to have - extra help in any of the following areas: -

    - -
      - -
    • Answering questions on the users mailing list - there is often a problem of - having too many questioners and not enough experts to respond to all the questions.
      • - -
    • Testing POI (especially its less-frequently-used features) on various configurations - and reporting back.
      • - -
    • Debugging - producing reproducible test cases and/or finding causes of bugs. Some known bugs are informally listed on - To Do, and some are recorded in Bugzilla - (see explanation below).
      • - -
    • Specifying/analyzing/designing new features - and beyond. (If you wish to get involved - with this, please join the general POI mailing list - , install and try out POI - and read some of the mail archives. - You should have a strong "fluency" in Java and a basic understanding of - the POI architecture - don't just say "it should have XYZ" without reading anything first - - because chances are, someone's already thought of that feature!)
      • - -
    • Packaging easy-to-install packages (such as RPMs) for the myriad of possible configurations out - there. (The project does not maintain anything but the basic .zip and - .tar.gz packages, but anyone is welcome to build their own specific packages and - announce them on the general POI list)
      • - -
    • ... and there is just one other thing - don't forget to tell everyone who asks, how great POI is! ;-) - The more people that know about and start to use POI, the larger the pool of - potential contributors there will be. -
      • - -
    - - -
    -
    -
    -
    - - - - - - - -
    CVS Usage Precis
    -
    - -

    An overview of how to use CVS to participate in POI development. - Do not be afraid - you cannot accidently destroy the actual code repository, - because you are working with a local copy as an anonymous user. - You do not have the system permissions to change anything. You can only - update your local repository and compare your revisions with the real - repository. -

    - - -

    - (Further general CVS usage information is at - www.cvshome.org and your local - info cvs pages or man cvs pages or user - documentation.) -

    - - -

    - Let us lead by example. We will show you how to establish your local - repository, how to keep it up-to-date, and how to generate the differences - to create a patch. (The commands are for Linux.) -

    - -
    -
    -
    -
    - - - - - - - -
    CVS Committer with Secure Shell access
    -
    - -

    After a developer has consistently provided contributions (code, - documentation and discussion), then the rest of the dev community - may vote to grant this developer commit access to CVS. -

    - - -

    You will need secure access to the repository to be able to commit - patches. Here are some resources that help to get your machine configured - to use the repository over SSH. -

    - - -
      - -
    • -The CVS Book -
      • - -
    • -www.cvshome.org -
      • - -
    • - - - See the bottom of the page for links to tips for UNIX and Windows. - Even if you are on UNIX, the Windows page will also help.
      • - -
    - -
    -
    -
    -
    - - - - - - - -
    Procedure for Raising Development Issues
    -
    - -

    - There are two methods for discussing development and submitting patches. - So that everyone can be productive, it is important to know which method - is appropriate for a certain situation and how to go about it without - confusion. This section explains when to use the - developer mailing list - and the bug database. -

    - - -

    - Research your topic thoroughly before beginning to discuss a new - development issue. Search and browse through the email archives - your - issue may have been discussed before. Prepare your post clearly and - concisely. -

    - - -

    - Most issues will be discovered, resolved, and then patched quickly - via the developer mailing list. Larger issues, and ones that - are not yet fully understood or are hard to solve, are destined for - Bugzilla. -

    - - -

    - Experienced developers use Bugzilla directly, as they are very sure - when they have found a bug and when not. However, less experienced users - should first discuss it on the user or developer mailing list (as - appropriate). Impatient people frequently enter everything into Bugzilla - without caring if it is a bug in POI or their own - installation/configuration mistake - please, do not do this. -

    - - -

    - As a rule-of-thumb, discuss an issue on the developers - mailing list first to work out any details. - After it is confirmed to be worthwhile, and you are clear about it, - then submit the bug description or patch via Bug Tracking. -

    - - -

    - If you do not get any answer on your first attempt, post - your issue again until you get a reply. (But, please, not every hour - allow a few - days for the list to deal with it.) Do not be impatient - remember that - the whole world is busy, not just you. Bear in mind that other countries - will have holidays at different times to your country and that they are - in different time zones. You might also consider re-writing your initial - posting - perhaps it was not clear enough - and the readers' eyes glazed over. -

    - -
    -
    -
    -
    - - - - - - - -
    Contribution Notes and Tips
    -
    - -

    - This is a collection of tips for contributing to the project in a manner - that is productive for all parties. -

    - - -
      - -
    • - Every contribution is worthwhile. Even if the ensuing discussion - proves it to be off-beam, then it may jog ideas for other people. -
      • - -
    • - Use sensible and concise email subject headings. Search engines, and - humans trying to browse a voluminous list, will respond favorably to a - descriptive title. -
      • - -
    • Start new threads with new Subjects for new topics, rather than - re-using the previous Subject line. -
      • - -
    • Keep each topic focussed. If some new topic arises, start a new - discussion. This leaves the original topic to continue un-cluttered. -
      • - -
    • Whenever you decide to start a new topic, then start with a fresh - new email message window. Do not use the "Reply to" button, - because threaded mail-readers get confused (they use the - In-reply-to header). Otherwise, your new topic will get - lost in the previous thread and go un-answered. -
      • - -
    • - Prepend your email subject line with a marker when that is appropriate, - e.g. [Patch], [Proposal], - [RT] (Random Thought, these quickly blossom into research - topics :-), [STATUS] (development status of a certain - feature). -
      • - -
    • - When making changes to XML documentation, or any XML document for that - matter, use a - validating parser - (one that is tried and true is - SP/nsgmls). - This procedure will detect errors without having to go through the whole - build docs process to find them. Do not expect POI - or the build system to detect the validation errors for you - they can - do it, but that is not their purpose. (Anyway, nsgmls validation error - messages are more informative.). Andy wishes it to be known he uses - jEdit. For - his XML editing. (That is when he's not hacking it in 'vi' the true editor - and light of the text editing world!). -
      • - -
    • - Remember that most people are participating in development on a - volunteer basis and in their "spare time". These enthusiasts will attempt - to respond to issues. It may take a little while to get your answers. -
      • - -
    • - Research your topic thoroughly before beginning to discuss a new - development issue. Search and browse through the email archives - your - issue may have been discussed before. Do not just perceive a problem and - then rush out with a question - instead, delve. -
      • - -
    • - Try to at least offer a partial solution and not just a problem statement. -
      • - -
    • - Take the time to clearly explain your issue and write a concise email - message. Less confusion facilitates fast and complete resolution. -
      • - -
    • - Do not bother to send an email reply that simply says "thanks". - When the issue is resolved, that is the finish - end of thread. - Reduce clutter. -
      • - -
    • - You would usually do any development work against the HEAD branch of CVS. -
      • - -
    • - When sending a patch, you usually do not need to worry about which CVS - branch it should be applied to. The maintainers of the repository will - decide. -
      • - -
    • - If an issue starts to get bogged down in list discussion, then it may - be appropriate to go into private off-list discussion with a few interested - other people. Spare the list from the gory details. Report a summary back - to the list to finalize the thread. -
      • - -
    • - Become familiar with the mailing lists. As you browse and search, you will - see the way other people do things. Follow the leading examples. -
      • - -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/faq.html b/build/jakarta-poi/docs/faq.html deleted file mode 100644 index 5a45e2d2a0..0000000000 --- a/build/jakarta-poi/docs/faq.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - -Frequently Asked Questions - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -Frequently Asked Questions - - - - - - -
    - - - - - - -
    - - - - - - -
    Frequently Asked Questions
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Questions
    -
    -
      -
    • - - What is the HSSF "eventmodel"? - -
      • -
    • - - Why can't read the document I created using Star Office 5.1? - -
      • -
    -
    -
    -
    -
    - - - - - - - -
    Answers
    -
    - -
    - - - - - - - -
    - What is the HSSF "eventmodel"? -
    -
    - - - -

    - The HSSF eventmodel package is a new API for reading XLS files more efficiently. It does - require more knowledge on the part of the user, but reduces memory consumption by more than - tenfold. It is based on the AWT event model in combination with SAX. If you need read-only - access to a given XLS file, this is the best way to do it. -

    - - - -
    -
    -
    - -
    - - - - - - - -
    - Why can't read the document I created using Star Office 5.1? -
    -
    - - - -

    - Star Office 5.1 writes some records using the older BIFF standard. This causes some problems - with POI which supports only BIFF8. -

    - - - -
    -
    -
    -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hdf/images/built-with-cocoon.gif b/build/jakarta-poi/docs/hdf/images/built-with-cocoon.gif deleted file mode 100644 index 0b38f7857b..0000000000 Binary files a/build/jakarta-poi/docs/hdf/images/built-with-cocoon.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hdf/images/cocoon2-small.jpg b/build/jakarta-poi/docs/hdf/images/cocoon2-small.jpg deleted file mode 100644 index e8f6dd8c8c..0000000000 Binary files a/build/jakarta-poi/docs/hdf/images/cocoon2-small.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/hdf/images/header.gif b/build/jakarta-poi/docs/hdf/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/hdf/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hdf/images/jakarta-logo.gif b/build/jakarta-poi/docs/hdf/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/hdf/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hdf/images/krysalis-compatible.jpg b/build/jakarta-poi/docs/hdf/images/krysalis-compatible.jpg deleted file mode 100644 index 077f8a1179..0000000000 Binary files a/build/jakarta-poi/docs/hdf/images/krysalis-compatible.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/hdf/index.html b/build/jakarta-poi/docs/hdf/index.html deleted file mode 100644 index 296b279a0b..0000000000 --- a/build/jakarta-poi/docs/hdf/index.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - -HDF - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -    		 -
    -    		 -HDF - - - - - - -
    - - - - - - -
    - - - - - - -
    HDF
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Overview
    -
    - - -

    HDF will be the name of OUR port of the Microsoft Word 97(-2002) file format to - pure Java.

    - -

    HDF is still in early development. If you want to help us, you can - follow development on the poi-dev mailing list.

    - - - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/historyandfuture.html b/build/jakarta-poi/docs/historyandfuture.html deleted file mode 100644 index fca0fe3d27..0000000000 --- a/build/jakarta-poi/docs/historyandfuture.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -

    - -

    -     -
    - - - - - - - -
    Brief Project History
    -
    - - -

    The POI project was dreamed up back around April 2001, when - Andy Oliver landed a short term contract to do Java-based - reporting to Excel. He'd done this project a few times before - and knew right where to look for the tools he needed. - Ironically, the API he used to use had skyrocketed from around - $300 ($US) to around $10K ($US). He figured it would take two - people around six months to write an Excel port so he - recommended the client fork out the $10K. -

    - - -

    Around June 2001, Andy started thinking how great it would - be to have an open source Java tool to do this and, while he - had some spare time, he started on the project and learned - about OLE 2 Compound Document Format. After hitting some real - stumpers he realized he'd need help. He posted a message to - his local Java User's Group (JUG) and asked if anyone else - would be interested. He lucked out and the most talented Java - programmer he'd ever met, Marc Johnson, joined the project. He - ran rings around Andy at porting OLE 2 CDF and rewrote his - skeletal code into a more sophisticated library. It took Marc - a few iterations to get something they were happy with. -

    - - -

    While Marc worked on that, Andy ported XLS to Java, based - on Marc's library. Several users wrote in asking to read XLS - (not just write as had originally been planned) and one user - had special requests for a different use for POIFS. Before - long, the project scope had tripled. POI 1.0 was released a - month later than planned, but with far more features. Marc - quickly wrote the serializer framework and HSSF Serializer in - record time and Andy banged out more documentation and worked - on making people aware of the project -

    - - -

    Shortly before the release, POI was fortunate to come into - contact with Nicola -Ken- Barrozzi who gave them samples for - the HSSF Serializer and help uncover its unfortunate bugs - (which were promptly fixed). More recently, Ken ported most - of the POI project documentation to XML from Andy's crappy - HTML docs he wrote with Star Office. -

    - - -

    Around the same time as the release, Glen Stampoultzis -joined the project. Glen was ticked off at Andy's flippant attitude -towards adding graphing to HSSF. Glen got so ticked off he decided to -grab a hammer and do it himself. Glen has already become an integral -part of the POI development community; his contributions to HSSF have -already started making waves. -

    - - -

    Somewhere in there we decided to finally submit the project - to The Apache - Cocoon Project, only to discover the project had - outgrown fitting nicely into just Cocoon long ago. - Furthermore, Andy started eyeing other projects he'd like to - see POI functionality added to. So it was decided to donate - the Serializers and Generators to Cocoon, other POI - integration components to other projects, and the POI APIs - would become part of Jakarta. It was a bumpy road but it - looks like everything turned out since you're reading this! -

    - - -
    -
    -
    -
    - - - - - - - -
    What's next for POI
    -
    - -

    First we'll tackle this from a project standpoint: Well, we - made an offer to Microsoft and Actuate (tongue in cheek - ... well mostly) that we'd quit the project and retire if - they'd simply write us each a really large check. I've yet to - get a phone call or email so I'm assuming they're not going to - pay us to go away. -

    - -

    Next, we've got some work to do here at Jakarta to finish - integrating POI into the community. Furthermore, we're - still transitioning the Serializer to Cocoon. -

    - -

    HSSF, during the 2.0 cycle, will undergo a few - optimizations. We'll also be adding new features like a full - implementation of Formulas and custom text formats. We're - hoping to be able to generate smaller files by adding - write-support for RK, MulRK and MulBlank records. I'm also - going to work on a Cocoon 2 Generator. Currently, reading is - not very efficient in HSSF. This is mainly because in order to - write or modify, one needs to be able to update upstream - pointers to downstream data. To do this you have to have - everything between in memory. A Generator would allow SAX - events to be processed instead. (This will be based on the low - level structures). One of the great things about this is that, - you'll not only have a more efficient way to read the file, - you'll have a great way to use spreadsheets as XML data - sources. -

    - -

    The HSSF Serializer, will further separate into a general - framework for creating serializers for other formats and the - HSSF Serializer specific implementation. (This is largely - already true). We'll also be adding support for features - already supported by HSSF (styles, fonts, text formats). We're - hoping to add support for formulas during this cycle. -

    - -

    We're beginning to expand our scope yet again. If we could - do all of this for XLS files, what about Doc files or PPT - files? We're thinking that our next component (HDF - Horrible - Document Format) should follow the same pattern. We're hoping - that new blood will join the team and allow us to tackle this - even faster (in part because POIFS is already finished). But - maybe what we need most is you!

    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hpsf/how-to.html b/build/jakarta-poi/docs/hpsf/how-to.html deleted file mode 100644 index 12655dd39a..0000000000 --- a/build/jakarta-poi/docs/hpsf/how-to.html +++ /dev/null @@ -1,622 +0,0 @@ - - - - -HPSF HOW-TO - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HPSF -
    -Overview -
    -How To -
    -Internals -
    -To Do -
    -    		 -
    -    		 -HPSF HOW-TO - - - - - - -
    - - - - - - -
    - - - - - - -
    HPSF HOW-TO
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    How To Use the HPSF APIs
    -
    - - -

    This HOW-TO is organized in three section. You should read them - sequentially because the later sections build upon the earlier ones.

    - - -
      - -
    1. - -

      The first section explains how to read - the most important standard properties of a Microsoft Office - document. Standard properties are things like title, author, creation - date etc. It is quite likely that you will find here what you need and - don't have to read the other sections.

      - -
      2. - - -
    2. - -

      The second section goes a small step - further and focusses on reading additional standard properties. It also - talks about exceptions that may be thrown when dealing with HPSF and - shows how you can read properties of embedded objects.

      - -
      3. - - -
    3. - -

      The third section tells how to read - non-standard properties. Non-standard properties are application-specific - name/value/type triples.

      - -
      4. - -
    - - - - -
    - - - - - - - -
    Reading Standard Properties
    -
    - - -This section explains how to read - the most important standard properties of a Microsoft Office - document. Standard properties are things like title, author, creation - date etc. Chances are that you will find here what you need and - don't have to read the other sections. - - -

    The first thing you should understand is that properties are stored in - separate documents inside the POI filesystem. (If you don't know what a - POI filesystem is, read its documentation.) A document in a POI - filesystem is also called a stream.

    - - -

    The following example shows how to read a POI filesystem's - "title" property. Reading other properties is similar. Consider the API - documentation of org.apache.poi.hpsf.SummaryInformation.

    - - -

    The standard properties this section focusses on can be - found in a document called \005SummaryInformation in the root of - the POI filesystem. The notation \005 in the document's name - means the character with the decimal value of 5. In order to read the - title, an application has to perform the following steps:

    - - -
      - -
    1. - -

      Open the document \005SummaryInformation located in the root - of the POI filesystem.

      - -
      2. - -
    2. - -

      Create an instance of the class - SummaryInformation from that - document.

      - -
      3. - -
    3. - -

      Call the SummaryInformation instance's - getTitle() method.

      - -
      4. - -
    - - -

    Sounds easy, doesn't it? Here are the steps in detail.

    - - - -
    - - - - - - - -
    Open the document \005SummaryInformation in the root of the POI filesystem
    -
    - - -

    An application that wants to open a document in a POI filesystem - (POIFS) proceeds as shown by the following code fragment. (The full - source code of the sample application is available in the - examples section of the POI source tree as - ReadTitle.java.)

    - - -
    - - - - -
    -
    -import java.io.*;
-import org.apache.poi.hpsf.*;
-import org.apache.poi.poifs.eventfilesystem.*;
-
-// ...
-
-public static void main(String[] args)
-    throws IOException
-{
-    final String filename = args[0];
-    POIFSReader r = new POIFSReader();
-    r.registerListener(new MyPOIFSReaderListener(),
-                       "\005SummaryInformation");
-    r.read(new FileInputStream(filename));
-}
    -
    -
    - - -

    The first interesting statement is

    - - -
    - - - - -
    -
    POIFSReader r = new POIFSReader();
    -
    -
    - - -

    It creates a - org.apache.poi.poifs.eventfilesystem.POIFSReader instance - which we shall need to read the POI filesystem. Before the application - actually opens the POI filesystem we have to tell the - POIFSReader which documents we are interested in. In this - case the application should do something with the document - \005SummaryInformation.

    - - -
    - - - - -
    -
    -r.registerListener(new MyPOIFSReaderListener(),
-                   "\005SummaryInformation");
    -
    -
    - - -

    This method call registers a - org.apache.poi.poifs.eventfilesystem.POIFSReaderListener - with the POIFSReader. The POIFSReaderListener - interface specifies the method processPOIFSReaderEvent - which processes a document. The class - MyPOIFSReaderListener implements the - POIFSReaderListener and thus the - processPOIFSReaderEvent method. The eventing POI filesystem - calls this method when it finds the \005SummaryInformation - document. In the sample application MyPOIFSReaderListener is - a static class in the ReadTitle.java source file.)

    - - -

    Now everything is prepared and reading the POI filesystem can - start:

    - - -
    - - - - -
    -
    r.read(new FileInputStream(filename));
    -
    -
    - - -

    The following source code fragment shows the - MyPOIFSReaderListener class and how it retrieves the - title.

    - - -
    - - - - -
    -
    -static class MyPOIFSReaderListener implements POIFSReaderListener
-{
-    public void processPOIFSReaderEvent(POIFSReaderEvent e)
-    {
-        SummaryInformation si = null;
-        try
-        {
-            si = (SummaryInformation)
-                 PropertySetFactory.create(e.getStream());
-        }
-        catch (Exception ex)
-        {
-            throw new RuntimeException
-                ("Property set stream \"" +
-                 event.getPath() + event.getName() + "\": " + ex);
-        }
-        final String title = si.getTitle();
-        if (title != null)
-            System.out.println("Title: \"" + title + "\"");
-        else
-            System.out.println("Document has no title.");
-    }
-}
-
    -
    -
    - - -

    The line

    - - -
    - - - - -
    -
    SummaryInformation si = null;
    -
    -
    - - -

    declares a SummaryInformation variable and initializes it - with null. We need an instance of this class to access the - title. The instance is created in a try block:

    - - -
    - - - - -
    -
    si = (SummaryInformation)
-                 PropertySetFactory.create(e.getStream());
    -
    -
    - - -

    The expression e.getStream() returns the input stream - containing the bytes of the property set stream named - \005SummaryInformation. This stream is passed into the - create method of the factory class - org.apache.poi.hpsf.PropertySetFactory which returns - a org.apache.poi.hpsf.PropertySet instance. It is more or - less safe to cast this result to SummaryInformation, a - convenience class with methods like getTitle(), - getAuthor() etc.

    - - -

    The PropertySetFactory.create method may throw all sorts - of exceptions. We'll deal with them in the next sections. For now we just - catch all exceptions and throw a RuntimeException - containing the message text of the origin exception.

    - - -

    If all goes well, the sample application retrieves the title and prints - it to the standard output. As you can see you must be prepared for the - case that the POI filesystem does not have a title.

    - - -
    - - - - -
    -
    final String title = si.getTitle();
-    if (title != null)
-        System.out.println("Title: \"" + title + "\"");
-    else
-        System.out.println("Document has no title.");
    -
    -
    - - -

    Please note that a Microsoft Office document does not necessarily - contain the \005SummaryInformation stream. The documents created - by the Microsoft Office suite have one, as far as I know. However, an - Excel spreadsheet exported from StarOffice 5.2 won't have a - \005SummaryInformation stream. In this case the applications - won't throw an exception but simply does not call the - processPOIFSReaderEvent method. You have been warned!

    - -
    -
    -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    Additional Standard Properties, Exceptions And Embedded Objects
    -
    - - -This section focusses on reading additional standard properties. It - also talks about exceptions that may be thrown when dealing with HPSF and - shows how you can read properties of embedded objects. - - -

    A couple of additional standard properties are not - contained in the \005SummaryInformation stream explained above, - for example a document's category or the number of multimedia clips in a - PowerPoint presentation. Microsoft has invented an additional stream named - \005DocumentSummaryInformation to hold these properties. With two - minor exceptions you can proceed exactly as described above to read the - properties stored in \005DocumentSummaryInformation:

    - - -
      - -
    • -

      Instead of \005SummaryInformation use - \005DocumentSummaryInformation as the stream's name.

      -
      • - -
    • -

      Replace all occurrences of the class - SummaryInformation by - DocumentSummaryInformation.

      -
      • - -
    - - -

    And of course you cannot call getTitle() because - DocumentSummaryInformation has different query methods. See - the API documentation for the details!

    - - -

    In the previous section the application simply caught all - exceptions and was in no way interested in any - details. However, a real application will likely want to know what went - wrong and act appropriately. Besides any IO exceptions there are three - HPSF resp. POI specific exceptions you should know about:

    - - -
    - -
    -NoPropertySetStreamException:
    - -
    -

    This exception is thrown if the application tries to create a - PropertySet or one of its subclasses - SummaryInformation and - DocumentSummaryInformation from a stream that is not a - property set stream. A faulty property set stream counts as not being a - property set stream at all. An application should be prepared to deal - with this case even if opens streams named - \005SummaryInformation or - \005DocumentSummaryInformation only. These are just names. A - stream's name by itself does not ensure that the stream contains the - expected contents and that this contents is correct.

    -
    - - -
    -UnexpectedPropertySetTypeException -
    - -
    -

    This exception is thrown if a certain type of property set is - expected somewhere (e.g. a SummaryInformation or - DocumentSummaryInformation) but the provided property - set is not of that type.

    -
    - - -
    -MarkUnsupportedException -
    - -
    -

    This exception is thrown if an input stream that is to be parsed - into a property set does not support the - InputStream.mark(int) operation. The POI filesystem uses - the DocumentInputStream class which does support this - operation, so you are safe here. However, if you read a property set - stream from another kind of input stream things may be - different.

    -
    - -
    - - -

    Many Microsoft Office documents contain embedded - objects, for example an Excel sheet on a page in a Word - document. Embedded objects may have property sets of their own. An - application can open these property set streams as described above. The - only difference is that they are not located in the POI filesystem's root - but in a nested directory instead. Just register a - POIFSReaderListener for the property set streams you are - interested in. For example, the POIBrowser application in the - contrib section tries to open each and every document in a POI filesystem - as a property set stream. If this operation was successful it displays the - properties.

    - -
    -
    -
    - - - - -
    - - - - - - - -
    Reading Non-Standard Properties
    -
    - - -This section tells how to read - non-standard properties. Non-standard properties are application-specific - name/value/type triples. - - -
    - - - - -
    Write this section!
    -
    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hpsf/images/built-with-cocoon.gif b/build/jakarta-poi/docs/hpsf/images/built-with-cocoon.gif deleted file mode 100644 index 0b38f7857b..0000000000 Binary files a/build/jakarta-poi/docs/hpsf/images/built-with-cocoon.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hpsf/images/cocoon2-small.jpg b/build/jakarta-poi/docs/hpsf/images/cocoon2-small.jpg deleted file mode 100644 index e8f6dd8c8c..0000000000 Binary files a/build/jakarta-poi/docs/hpsf/images/cocoon2-small.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/hpsf/images/header.gif b/build/jakarta-poi/docs/hpsf/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/hpsf/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hpsf/images/jakarta-logo.gif b/build/jakarta-poi/docs/hpsf/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/hpsf/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hpsf/images/krysalis-compatible.jpg b/build/jakarta-poi/docs/hpsf/images/krysalis-compatible.jpg deleted file mode 100644 index 077f8a1179..0000000000 Binary files a/build/jakarta-poi/docs/hpsf/images/krysalis-compatible.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/hpsf/index.html b/build/jakarta-poi/docs/hpsf/index.html deleted file mode 100644 index 4360f8f3b2..0000000000 --- a/build/jakarta-poi/docs/hpsf/index.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - -HPSF (Horrible Property Set Format) - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HPSF -
    -Overview -
    -How To -
    -Internals -
    -To Do -
    -    		 -
    -    		 -HPSF (Horrible Property Set Format) - - - - - - -
    - - - - - - -
    - - - - - - -
    HPSF (Horrible Property Set Format)
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Overview
    -
    - -

    Microsoft applications like "Word" or "Excel" let the user describe his - document by properties like "title", "category" and so on. The application - itself adds further information: last author, creation date etc. These - properties are stored in so-called property set streams. A - property set stream is a separate document within a POI filesystem. HPSF is POI's pure-Java - implementation to read (and in future to write) property set streams.

    - - -

    The HPSF HOWTO describes what a Java - application should do to read a property set using HPSF and to retrieve the - information it needs.

    - - -

    HPSF supports OLE2 property set streams in general, not only the special - case of document properties mentioned above. The HPSF description describes the internal - structure of property set streams.

    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hpsf/internals.html b/build/jakarta-poi/docs/hpsf/internals.html deleted file mode 100644 index d30d9e3177..0000000000 --- a/build/jakarta-poi/docs/hpsf/internals.html +++ /dev/null @@ -1,2578 +0,0 @@ - - - - -HPSF Internals: The Horrible Property Set Format - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HPSF -
    -Overview -
    -How To -
    -Internals -
    -To Do -
    -    		 -
    -    		 -HPSF Internals: The Horrible Property Set Format - - - - - - -
    - - - - - - -
    - - - - - - -
    HPSF Internals: The Horrible Property Set Format
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    HPSF Internals
    -
    - - -
    - - - - - - - -
    Introduction
    -
    - - -

    A Microsoft Office document is internally organized like a filesystem - with directory and files. Microsoft calls these files - streams. A document can have properties attached to it, - like author, title, number of words etc. These metadata are not stored in - the main stream of, say, a Word document, but instead in a dedicated - stream with a special format. Usually this stream's name is - \005SummaryInformation, where \005 represents - the character with a decimal value of 5.

    - - -

    A single piece of information in the stream is called a - property, for example the document title. Each property - has an integral ID (e.g. 2 for title), a - type (telling that the title is a string of bytes) and a - value (what this is should be obvious). A stream - containing properties is called a - property set stream.

    - - -

    This document describes the internal structure of a property set stream, - i.e. the Horrible Property Set Format (HDF). It does not - describe how a Microsoft Office document is organized internally and how - to retrieve a stream from it. See the POIFS documentation for that kind of - stuff.

    - - -

    The Horrible Property Set Format is not only used in the Summary - Information stream in the top-level document of a Microsoft Office - document. Often there is also a property set stream named - \005DocumentSummaryInformation with additional properties. - Embedded documents may have their own property set streams. You cannot - tell by a stream's name whether it is a property set stream or not. - Instead you have to open the stream and look at its bytes.

    - -
    -
    -
    - - - - -
    - - - - - - - -
    Data Types
    -
    - - -

    Before delving into the details of the property set stream format we - have to have a short look at data types. Integral values are stored in the - so-called little endian format. In this format the bytes - that make out an integral value are stored in the "wrong" order. For - example, the decimal value 4660 is 0x1234 in the hexadecimal notation. If - you think this should be represented by a byte 0x12 followed by another - byte 0x34, you are right. This is called the big endian - format. In the little endian format, however, this order is reversed and - the low-value byte comes first: 0x3412. -

    - - -

    The following table gives an overview about some important data - types:

    - - - - - - - -

    Name

    - - - - - -

    Length

    - - - - - -

    Example (Little Endian)

    - - - - - -

    Example (Big Endian)

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    -Bytes -

    -    		 - -

    1 byte

    - -    		 -

    -0x12 -

    -    		 -

    -0x12 -

    -
    -

    -Word -

    -    		 - -

    2 bytes

    - -    		 -

    -0x1234 -

    -    		 -

    -0x3412 -

    -
    -

    -DWord -

    -    		 - -

    4 bytes

    - -    		 -

    -0x12345678 -

    -    		 -

    -0x78563412 -

    -
    - -

    -ClassID -

    - -

    A sequence of one DWord, two Words and eight Bytes

    - -    		 - -

    16 bytes

    - -    		 - -

    -0xE0859FF2F94F6810AB9108002B27B3D9 resp. - E0859FF2-F94F-6810-AB-91-08-00-2B-27-B3-D9 -

    - -    		 - -

    -0xF29F85E04FF91068AB9108002B27B3D9 resp. - F29F85E0-4FF9-1068-AB-91-08-00-2B-27-B3-D9 -

    - -
    - -

    The ClassID examples are given here in two different notations. The - second notation without the "0x" at the beginning and with dashes - inside shows the internal grouping into one DWord, two Words and eight - Bytes.

    - -    		 - -

    -Watch out: Microsoft documentation and tools show class IDs - a little bit differently like - F29F85E0-4FF9-1068-AB91-08002B27B3D9. - However, that representation is (intentionally?) misleading with - respect to endianess.

    - -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    HPSF Overview
    -
    - - -

    A property set stream consists of three main parts:

    - - -
      - -
    1. - -

      The header and

      - -
      2. - -
    2. - -

      the section(s) containing the properties.

      - -
      3. - -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    The Header
    -
    - - -

    The first bytes in a property set stream is the header. - It has a fixed length and looks like this:

    - - - - - - - -

    Offset

    - - - - - -

    Type

    - - - - - -

    Contents

    - - - - - -

    Remarks

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - -

    0

    - -    		 - -

    Word

    - -    		 -

    -0xFFFE -

    -    		 - -

    If the first four bytes of a stream do not contain these values, the - stream is not a property set stream.

    - -
    - -

    2

    - -    		 - -

    Word

    - -    		 -

    -0x0000 -

    -
    - -

    4

    - -    		 - -

    DWord

    - -    		 - -

    Denotes the operating system and the OS version under which this - stream was created. The operating system ID is in the DWord's higher - word (after little endian decoding): 0x0000 for Win16, - 0x0001 for Macintosh and 0x0002 for Win32 - that's - all. The reader is most likely aware of the fact that there are some - more operating systems. However, Microsoft does not seem to know.

    - -
    - -

    8

    - -    		 - -

    ClassID

    - -    		 -

    -0x00000000000000000000000000000000 -

    -    		 - -

    Most property set streams have this value but this is not - required.

    - -
    - -

    24

    - -    		 - -

    DWord

    - -    		 - -

    -0x01000000 or greater

    - -    		 - -

    Section count. This field's value should be equal to 1 or greater. - Microsoft claims that this is a "reserved" field, but it seems to tell - how many sections (see below) are following in the stream. This would - really make sense because otherwise you could not know where and how - far you should read section data.

    - -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    Section List
    -
    - - -

    Following the header is the section list. This is an array of pairs each - consisting of a section format ID and an offset. This array has as many - pairs of ClassID and and DWord fields as the section count field in the - header says. The Summary Information stream contains a single section, the - Document Summary Information stream contains two.

    - - - - - - - -

    Type

    - - - - - -

    Contents

    - - - - - -

    Remarks

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - -

    ClassID

    - -    		 - -

    Section format ID

    - -    		 - -

    -0xF29F85E04FF91068AB9108002B27B3D9 for the single section - in the Summary Information stream.

    - - -

    -0xD5CDD5022E9C101B939708002B2CF9AE for the first - section in the Document Summary Information stream.

    - -
    - -

    DWord

    - -    		 - -

    Offset

    - -    		 - -

    The number of bytes between the beginning of the stream and the - beginning of the section within the stream.

    - -
    - -

    ClassID

    - -    		 - -

    Section format ID

    - -    		 - -

    ...

    - -
    - -

    DWord

    - -    		 - -

    Offset

    - -    		 - -

    ...

    - -
    - -

    ...

    - -    		 - -

    ...

    - -    		 - -

    ...

    - -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    Section
    -
    - - -

    A section is divided into three parts: the section header (with the - section length and the number of properties in the section), the - properties list (with type and offset of each property), and the - properties themselves. Here are the details:

    - - - - - - - -

     

    - - - - - -

    Type

    - - - - - -

    Contents

    - - - - - -

    Remarks

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - -

    Section header

    - -    		 - -

    DWord

    - -    		 - -

    Length

    - -    		 - -

    The length of the section in bytes.

    - -
    - -

    DWord

    - -    		 - -

    Property count

    - -    		 - -

    The number of properties in the section.

    - -
    - -

    Properties list

    - -    		 - -

    DWord

    - -    		 - -

    Property ID

    - -    		 - -

    The property ID tells what the property means. For example, an ID of - 0x0002 in the Summary Information stands for the document's - title. See the Property IDs - chapter below for more details.

    - -
    - -

    DWord

    - -    		 - -

    Offset

    - -    		 - -

    The number of bytes between the beginning of the section and the - property.

    - -
    - -

    ...

    - -    		 - -

    ...

    - -    		 - -

    ...

    - -
    - -

    Properties

    - -    		 - -

    DWord

    - -    		 - -

    Property type ("variant")

    - -    		 - -

    This is the property's data type, e.g. an integer value, a byte - string or a Unicode string. See the - Property Types chapter for - details!

    - -
    -

    -Field length depends on the property type - ("variant") -

    -    		 - -

    Property value

    - -    		 - -

    This field's length depends on the property's type. These are the - bytes that make out the DWord, the byte string or some other data of - fixed or variable length.

    - - -

    The property value's length is always stored in an area which is a - multiple of 4 in length. If the property is shorter, e.g. a byte - string of 13 bytes, the remaining bytes are padded with 0x00 - bytes.

    - -
    - -

    ...

    - -    		 - -

    ...

    - -    		 - -

    ...

    - -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    Property IDs
    -
    - - - - -

    As seen above, a section holds a property list: an array with property - IDs and offsets. The property ID gives each property a meaning. For - example, in the Summary Information stream the property ID 2 says that - this property is the document's title.

    - - -

    If you want to know a property ID's meaning, it is not sufficient to - know the ID itself. You must also know the - section format ID. For example, in the Document Summary - Information stream the property ID 2 means not the document's title but - its category. Due to Microsoft's infinite wisdom the section format ID is - not part of the section. Thus if you have only a section without the - stream it is in, you cannot make any sense of the properties because you - do not know what they mean.

    - - -

    So each section format ID has its own name space of property IDs. - Microsoft defined some "well-known" property IDs for the Summary - Information and the Document Summary Information streams. You can extend - them by your own additional IDs. This will be described below.

    - - -
    - - - - - - - -
    Property IDs in The Summary Information Stream
    -
    - - -

    The Summary Information stream has a single section with a section - format ID of 0xF29F85E04FF91068AB9108002B27B3D9. The following - table defines the meaning of its property IDs. Each row associates a - property ID with a name and an ID string. (The property - type is just for informational purposes given here. As we have - seen above, the type is always given along with the value.)

    - - -

    The property name is a readable string which could be - displayed to the user. However, this string is useful only for users who - understand English. The property name does not help with other - languages.

    - - -

    The property ID string is about the same but looks more - technically and is nothing a user should bother with. You could the ID - string and map it to an appropriate display string in a particular - language. Of course you could do that with the property ID as well and - with less overhead, but people (including software developers) tend to be - better in remembering symbolic constants than remembering numbers.

    - - - - - - -

    Property ID

    - - - -

    Property Name

    - - - -

    Property ID String

    - - - -

    Property Type

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    2

    -    		 -

    Title

    -    		 -

    PID_TITLE

    -    		 -

    VT_LPSTR

    -
    -

    3

    -    		 -

    Subject

    -    		 -

    PID_SUBJECT

    -    		 -

    VT_LPSTR

    -
    -

    4

    -    		 -

    Author

    -    		 -

    PID_AUTHOR

    -    		 -

    VT_LPSTR

    -
    -

    5

    -    		 -

    Keywords

    -    		 -

    PID_KEYWORDS

    -    		 -

    VT_LPSTR

    -
    -

    6

    -    		 -

    Comments

    -    		 -

    PID_COMMENTS

    -    		 -

    VT_LPSTR

    -
    -

    7

    -    		 -

    Template

    -    		 -

    PID_TEMPLATE

    -    		 -

    VT_LPSTR

    -
    -

    8

    -    		 -

    Last Saved By

    -    		 -

    PID_LASTAUTHOR

    -    		 -

    VT_LPSTR

    -
    -

    9

    -    		 -

    Revision Number

    -    		 -

    PID_REVNUMBER

    -    		 -

    VT_LPSTR

    -
    -

    10

    -    		 -

    Total Editing Time

    -    		 -

    PID_EDITTIME

    -    		 -

    VT_FILETIME

    -
    -

    11

    -    		 -

    Last Printed

    -    		 -

    PID_LASTPRINTED

    -    		 -

    VT_FILETIME

    -
    -

    12

    -    		 -

    Create Time/Date

    -    		 -

    PID_CREATE_DTM

    -    		 -

    VT_FILETIME

    -
    -

    13

    -    		 -

    Last Saved Time/Date

    -    		 -

    PID_LASTSAVE_DTM

    -    		 -

    VT_FILETIME

    -
    -

    14

    -    		 -

    Number of Pages

    -    		 -

    PID_PAGECOUNT

    -    		 -

    VT_I4

    -
    -

    15

    -    		 -

    Number of Words

    -    		 -

    PID_WORDCOUNT

    -    		 -

    VT_I4

    -
    -

    16

    -    		 -

    Number of Characters

    -    		 -

    PID_CHARCOUNT

    -    		 -

    VT_I4

    -
    -

    17

    -    		 -

    Thumbnail

    -    		 -

    PID_THUMBNAIL

    -    		 -

    VT_CF

    -
    -

    18

    -    		 -

    Name of Creating Application

    -    		 -

    PID_APPNAME

    -    		 -

    VT_LPSTR

    -
    -

    19

    -    		 -

    Security

    -    		 -

    PID_SECURITY

    -    		 -

    VT_I4

    -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    Property IDs in The Document Summary Information Stream
    -
    - - -

    The Document Summary Information stream has two sections with a section - format ID of 0xD5CDD5022E9C101B939708002B2CF9AE for the first - one. The following table defines the meaning of the property IDs in the - first section. See the preceeding section for interpreting the table.

    - - - - - - -

    Property ID

    - - - -

    Property name

    - - - -

    Property ID string

    - - - -

    VT type

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    2

    -    		 -

    Category

    -    		 -

    PID_CATEGORY

    -    		 -

    VT_LPSTR

    -
    -

    3

    -    		 -

    PresentationTarget

    -    		 -

    PID_PRESFORMAT

    -    		 -

    VT_LPSTR

    -
    -

    4

    -    		 -

    Bytes

    -    		 -

    PID_BYTECOUNT

    -    		 -

    VT_I4

    -
    -

    5

    -    		 -

    Lines

    -    		 -

    PID_LINECOUNT

    -    		 -

    VT_I4

    -
    -

    6

    -    		 -

    Paragraphs

    -    		 -

    PID_PARCOUNT

    -    		 -

    VT_I4

    -
    -

    7

    -    		 -

    Slides

    -    		 -

    PID_SLIDECOUNT

    -    		 -

    VT_I4

    -
    -

    8

    -    		 -

    Notes

    -    		 -

    PID_NOTECOUNT

    -    		 -

    VT_I4

    -
    -

    9

    -    		 -

    HiddenSlides

    -    		 -

    PID_HIDDENCOUNT

    -    		 -

    VT_I4

    -
    -

    10

    -    		 -

    MMClips

    -    		 -

    PID_MMCLIPCOUNT

    -    		 -

    VT_I4

    -
    -

    11

    -    		 -

    ScaleCrop

    -    		 -

    PID_SCALE

    -    		 -

    VT_BOOL

    -
    -

    12

    -    		 -

    HeadingPairs

    -    		 -

    PID_HEADINGPAIR

    -    		 -

    VT_VARIANT | VT_VECTOR

    -
    -

    13

    -    		 -

    TitlesofParts

    -    		 -

    PID_DOCPARTS

    -    		 -

    VT_LPSTR | VT_VECTOR

    -
    -

    14

    -    		 -

    Manager

    -    		 -

    PID_MANAGER

    -    		 -

    VT_LPSTR

    -
    -

    15

    -    		 -

    Company

    -    		 -

    PID_COMPANY

    -    		 -

    VT_LPSTR

    -
    -

    16

    -    		 -

    LinksUpTo Date

    -    		 -

    PID_LINKSDIRTY

    -    		 -

    VT_BOOL

    -
    - -
    -
    -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    Property Types
    -
    - - - - -

    A property consists of a DWord type field followed by the - property value. The property type is an integer value and tells how the - data byte following it are to be interpreted. In the Microsoft world it is - also known as the variant.

    - - -

    The Usage column says where a variant type may occur. Not all - of them are allowed in a property set but just those marked with a [P]. - [V] - may appear in a VARIANT, [T] - may - appear in a TYPEDESC, [P] - may appear in an OLE property - set, [S] - may appear in a Safe Array.

    - - - - - - -

    Variant ID

    - - - -

    Variant Type

    - - - -

    Usage

    - - - -

    Description

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    0

    -    		 -

    VT_EMPTY

    -    		 -

    [V] [P]

    -    		 -

    nothing

    -
    -

    1

    -    		 -

    VT_NULL

    -    		 -

    [V] [P]

    -    		 -

    SQL style Null

    -
    -

    2

    -    		 -

    VT_I2

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    2 byte signed int

    -
    -

    3

    -    		 -

    VT_I4

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    4 byte signed int

    -
    -

    4

    -    		 -

    VT_R4

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    4 byte real

    -
    -

    5

    -    		 -

    VT_R8

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    8 byte real

    -
    -

    6

    -    		 -

    VT_CY

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    currency

    -
    -

    7

    -    		 -

    VT_DATE

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    date

    -
    -

    8

    -    		 -

    VT_BSTR

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    OLE Automation string

    -
    -

    9

    -    		 -

    VT_DISPATCH

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    IDispatch *

    -
    -

    10

    -    		 -

    VT_ERROR

    -    		 -

    [V] [T] [S]

    -    		 -

    SCODE

    -
    -

    11

    -    		 -

    VT_BOOL

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    True=-1, False=0

    -
    -

    12

    -    		 -

    VT_VARIANT

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    VARIANT *

    -
    -

    13

    -    		 -

    VT_UNKNOWN

    -    		 -

    [V] [T] [S]

    -    		 -

    IUnknown *

    -
    -

    14

    -    		 -

    VT_DECIMAL

    -    		 -

    [V] [T] [S]

    -    		 -

    16 byte fixed point

    -
    -

    16

    -    		 -

    VT_I1

    -    		 -

    [T]

    -    		 -

    signed char

    -
    -

    17

    -    		 -

    VT_UI1

    -    		 -

    [V] [T] [P] [S]

    -    		 -

    unsigned char

    -
    -

    18

    -    		 -

    VT_UI2

    -    		 -

    [T] [P]

    -    		 -

    unsigned short

    -
    -

    19

    -    		 -

    VT_UI4

    -    		 -

    [T] [P]

    -    		 -

    unsigned short

    -
    -

    20

    -    		 -

    VT_I8

    -    		 -

    [T] [P]

    -    		 -

    signed 64-bit int

    -
    -

    21

    -    		 -

    VT_UI8

    -    		 -

    [T] [P]

    -    		 -

    unsigned 64-bit int

    -
    -

    22

    -    		 -

    VT_INT

    -    		 -

    [T]

    -    		 -

    signed machine int

    -
    -

    23

    -    		 -

    VT_UINT

    -    		 -

    [T]

    -    		 -

    unsigned machine int

    -
    -

    24

    -    		 -

    VT_VOID

    -    		 -

    [T]

    -    		 -

    C style void

    -
    -

    25

    -    		 -

    VT_HRESULT

    -    		 -

    [T]

    -    		 -

    Standard return type

    -
    -

    26

    -    		 -

    VT_PTR

    -    		 -

    [T]

    -    		 -

    pointer type

    -
    -

    27

    -    		 -

    VT_SAFEARRAY

    -    		 -

    [T]

    -    		 -

    (use VT_ARRAY in VARIANT)

    -
    -

    28

    -    		 -

    VT_CARRAY

    -    		 -

    [T]

    -    		 -

    C style array

    -
    -

    29

    -    		 -

    VT_USERDEFINED

    -    		 -

    [T]

    -    		 -

    user defined type

    -
    -

    30

    -    		 -

    VT_LPSTR

    -    		 -

    [T] [P]

    -    		 -

    null terminated string

    -
    -

    31

    -    		 -

    VT_LPWSTR

    -    		 -

    [T] [P]

    -    		 -

    wide null terminated string

    -
    -

    64

    -    		 -

    VT_FILETIME

    -    		 -

    [P]

    -    		 -

    FILETIME

    -
    -

    65

    -    		 -

    VT_BLOB

    -    		 -

    [P]

    -    		 -

    Length prefixed bytes

    -
    -

    66

    -    		 -

    VT_STREAM

    -    		 -

    [P]

    -    		 -

    Name of the stream follows

    -
    -

    67

    -    		 -

    VT_STORAGE

    -    		 -

    [P]

    -    		 -

    Name of the storage follows

    -
    -

    68

    -    		 -

    VT_STREAMED_OBJECT

    -    		 -

    [P]

    -    		 -

    Stream contains an object

    -
    -

    69

    -    		 -

    VT_STORED_OBJECT

    -    		 -

    [P]

    -    		 -

    Storage contains an object

    -
    -

    70

    -    		 -

    VT_BLOB_OBJECT

    -    		 -

    [P]

    -    		 -

    Blob contains an object

    -
    -

    71

    -    		 -

    VT_CF

    -    		 -

    [P]

    -    		 -

    Clipboard format

    -
    -

    72

    -    		 -

    VT_CLSID

    -    		 -

    [P]

    -    		 -

    A Class ID

    -
    -

    0x1000

    -    		 -

    VT_VECTOR

    -    		 -

    [P]

    -    		 -

    simple counted array

    -
    -

    0x2000

    -    		 -

    VT_ARRAY

    -    		 -

    [V]

    -    		 -

    SAFEARRAY*

    -
    -

    0x4000

    -    		 -

    VT_BYREF

    -    		 -

    [V]

    -    		 -

    void* for local use

    -
    -

    0x8000

    -    		 -

    VT_RESERVED

    -    		 -

    -

    -

    -    		 -

    -

    -

    -
    -

    0xFFFF

    -    		 -

    VT_ILLEGAL

    -    		 -

    -

    -

    -    		 -

    -

    -

    -
    -

    0xFFF

    -    		 -

    VT_ILLEGALMASKED

    -    		 -

    -

    -

    -    		 -

    -

    -

    -
    -

    0xFFF

    -    		 -

    VT_TYPEMASK

    -    		 -

    -

    -

    -    		 -

    -

    -

    -
    - -
    -
    -
    - - - - -
    - - - - - - - -
    References
    -
    - - -

    In order to assemble the HPSF description I used information publically - available on the Internet only. The references given below have been very - helpful. If you have any amendments or corrections, please let us know! - Thank you!

    - - -
      - - -
    1. - -

      In - Understanding OLE - documents, Ken Kyler gives an introduction to OLE2 - documents - and especially to property sets. He names the property names, types, and - IDs of the Summary Information and Document Summary Information - stream.

      - -
      2. - - -
    2. - -

      The - ActiveX Programmer's - Reference at - http://www.dwam.net/docs/oleref/ - seems a little outdated, but that's what I have found.

      - -
      3. - - -
    3. - -

      An overview of the VT_ types is in - Variant - Type Definitions.

      - -
      4. - - -
    4. - -

      What is a FILETIME? The answer can be found for example under - http://www.vbapi.com/ref/f/filetime.html - or - http://www.cs.rpi.edu/courses/fall01/os/FILETIME.html. In - short: - The FILETIME structure holds a date and time associated with a file. - The structure identifies a 64-bit integer specifying the number of - 100-nanosecond intervals which have passed since January 1, 1601. This - 64-bit value is split into the two dwords stored in the - structure. -

      - -
      5. - - -
    5. - -

      This documentation origins from the HPSF description available at http://www.rainer-klute.de/~klute/Software/poibrowser/doc/HPSF-Description.html.

      - -
      6. - -
    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hpsf/todo.html b/build/jakarta-poi/docs/hpsf/todo.html deleted file mode 100644 index 6641d7388d..0000000000 --- a/build/jakarta-poi/docs/hpsf/todo.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - -To Do - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HPSF -
    -Overview -
    -How To -
    -Internals -
    -To Do -
    -    		 -
    -    		 -To Do - - - - - - -
    - - - - - - -
    - - - - - - -
    To Do
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    To Do
    -
    - - -

    The following functionalities should be added to HPFS:

    - - -
      - -
    1. - -

      Complete writing the HPSF documentation.

      - -
      2. - -
    2. - -

      Add writing capability for property sets.

      - -
      3. - -
    3. - -

      Add codepage support.

      - -
      4. - -
    4. - -

      Add Unicode support.

      - -
      5. - -
    5. - -

      Add resource bundles to - org.apache.poi.hpsf.wellknown to ease - localizations.

      - -
      6. - -
    6. - -

      Implement reading functionality for those property types that are not - yet supported (other than byte arrays).

      - -
      7. - -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hssf/alternatives.html b/build/jakarta-poi/docs/hssf/alternatives.html deleted file mode 100644 index 98fbb79007..0000000000 --- a/build/jakarta-poi/docs/hssf/alternatives.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - - - - - - -
    -www.apache.org >  - jakarta.apache.org >  - -
    - - - - -
    - -
    - - - - - - - -
    How do I...?
    -
    Learn more about this project?
    -
    Print this page...
    -
    Troubleshoot...
    -
    -
    -    		 -
    - - - - -
    -
    -   -   -   - web site mail lists -
    -
    -
    -

    HSSF

    -Alternatives to HSSF -
    - -

    - -

    -     - -
    - - - - - - - -
    Alternatives
    -
    - -

    - Maybe it's unwise to advertise your competitors but we believe - competition is good and we have the best support reading and - write Excel workbooks currently available. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ProductURLDescription
    Formula One - www.tidestone.com - An alternative to this project is to - buy the $10,000 Formula 1 library - and accept its crude api and limitations.
    Visual Basic - www.microsoft.com - Give up XML and write Visual Basic code on a Microsoft Windows based - Environment or output in Microsoft's beta and primarily undocumented - XML for office format.
    JExcelhttp://stareyes.homeip.net:8888Frequently unavailable. Little currently known about it's capabilities.
    JWorkbookhttp://www.object-refinery.com/jworkbook/index.htmlThis effort supports Gnumeric and Excel, however the Excel part is done using POI anyway.
    xlReaderhttp://www.sourceforge.net/projects/xlrdProvides decent support for reading Excel.
    Excel ODBC Driverhttp://www.nwlink.com/~leewal/content/exceljavasample.htmODBC offers a somewhat wierd method for using Excel.
    ExtenXLShttp://www.extentech.com/products/ExtenXLS/docs/intro3.jspCommercial library for reading, modifying and writing Excel spreadsheets. Not cheap but - certainly a lot more affordable than Formula 1. No idea as to it's quality.
    J-Integra Java-Excel Bridgehttp://www.intrinsyc.com/products/bridging/jintegra.aspUses DCOM to an Excel instance on a windows machine.
    Perl & C-There are a number of perl and C libraries, however none of them are consistent.
    - -
    -
    -
    - -
    - - - diff --git a/build/jakarta-poi/docs/hssf/diagram1.html b/build/jakarta-poi/docs/hssf/diagram1.html deleted file mode 100644 index 1e342014d7..0000000000 --- a/build/jakarta-poi/docs/hssf/diagram1.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - -HSSF - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HSSF -
    -Quick Guide -
    -HOWTO -
    -Use Case -
    -Pictorial Docs -
    -Alternatives -
    -
    -Contributer's Guide -
    -Record Generator -
    -    		 -
    -    		 -HSSF - - - - - - -
    - - - - - - -
    - - - - - - -
    HSSF
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Usermodel Class Diagram by Matthew Young
    -
    - - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hssf/diagrams.html b/build/jakarta-poi/docs/hssf/diagrams.html deleted file mode 100644 index a4fe26df27..0000000000 --- a/build/jakarta-poi/docs/hssf/diagrams.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - -HSSF - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HSSF -
    -Quick Guide -
    -HOWTO -
    -Use Case -
    -Pictorial Docs -
    -Alternatives -
    -
    -Contributer's Guide -
    -Record Generator -
    -    		 -
    -    		 -HSSF - - - - - - -
    - - - - - - -
    - - - - - - -
    HSSF
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Overview
    -
    - -

    - This section is intended for diagrams (UML/etc) that help - explain HSSF. -

    - - - -

    - Have more? Add a new "bug" to the bug database with [DOCUMENTATION] - prefacing the description and a link to the file on an http server - somewhere. If you don't have your own webserver, then you can email it - to (acoliver at apache dot org) provided its < 5MB. Diagrams should be - in some format that can be read at least on Linux and Windows. Diagrams - that can be edited are preferrable, but lets face it, there aren't too - many good affordable UML tools yet! And no they don't HAVE to be UML... - just useful. -

    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hssf/how-to.html b/build/jakarta-poi/docs/hssf/how-to.html deleted file mode 100644 index 37ffa9f763..0000000000 --- a/build/jakarta-poi/docs/hssf/how-to.html +++ /dev/null @@ -1,870 +0,0 @@ - - - - -The New Halloween Document - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HSSF -
    -Quick Guide -
    -HOWTO -
    -Use Case -
    -Pictorial Docs -
    -Alternatives -
    -
    -Contributer's Guide -
    -Record Generator -
    -    		 -
    -    		 -The New Halloween Document - - - - - - -
    - - - - - - -
    - - - - - - -
    The New Halloween Document
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    How to use the HSSF prototype API
    -
    - - -
    - - - - - - - -
    Capabilities
    -
    - -

    This release of the how-to outlines functionality for 1.5. - Those looking for information on the release edition should - look in the poi-src for the release or at a - previous edition in CVS tagged for that release.

    - -

    - This release allows numeric and string cell values to be written to - or read from an XLS file as well as reading and writing dates. Also - in this release is row and column sizing, cell styling (bold, - italics, borders,etc), and support for built-in data formats. New - to this release is an event-based API for reading XLS files. - It differs greatly from the read/write API - and is intended for intermediate developers who need a smaller - memory footprint. It will also serve as the basis for the HSSF - Generator.

    - -
    -
    -
    - -
    - - - - - - - -
    Target Audience
    -
    - -

    This release is intended for developers, java-fanatics and the -just generally all around impatient. HSSF has not yet been -extensively tested in a high load multi-threaded situation. This -release is not considered to be "golden" as it has new -features that have not been extensively tested, and is an early 2.0 -build that could be restructured significantly in the future (not -that there are necessarily plans to do so, just that you're better -off basing your code on 1.0 and sticking with it if you don't need -2.0 stuff bad enough to deal with us pulling the rug out from under -you regularly).

    - -
    -
    -
    - -
    - - - - - - - -
    General Use
    -
    - -
    - - - - - - - -
    User API
    -
    - -
    - - - - - - - -
    Writing a new one
    -
    - - -

    The high level API (package: org.apache.poi.hssf.usermodel) -is what most people should use. Usage is very simple. -

    - -

    Workbooks are created by creating an instance of -org.apache.poi.hssf.usermodel.HSSFWorkbook. -

    - -

    Sheets are created by calling createSheet() from an existing -instance of HSSFWorkbook, the created sheet is automatically added in -sequence to the workbook. Sheets do not in themselves have a sheet -name (the tab at the bottom); you set -the name associated with a sheet by calling -HSSFWorkbook.setSheetName(sheetindex,"SheetName").

    - -

    Rows are created by calling createRow(rowNumber) from an existing -instance of HSSFSheet. Only rows that have cell values should be -added to the sheet. To set the row's height, you just call -setRowHeight(height) on the row object. The height must be given in -twips, or 1/20th of a point. If you prefer, there is also a -setRowHeightInPoints method. -

    - -

    Cells are created by calling createCell(column, type) from an -existing HSSFRow. Only cells that have values should be added to the -row. Cells should have their cell type set to either -HSSFCell.CELL_TYPE_NUMERIC or HSSFCell.CELL_TYPE_STRING depending on -whether they contain a numeric or textual value. Cells must also have -a value set. Set the value by calling setCellValue with either a -String or double as a parameter. Individual cells do not have a -width; you must call setColumnWidth(colindex, width) (use units of -1/256th of a character) on the HSSFSheet object. (You can't do it on -an individual basis in the GUI either).

    - -

    Cells are styled with HSSFCellStyle objects which in turn contain -a reference to an HSSFFont object. These are created via the -HSSFWorkbook object by calling createCellStyle() and createFont(). -Once you create the object you must set its parameters (colors, -borders, etc). To set a font for an HSSFCellStyle call -setFont(fontobj). -

    - -

    Once you have generated your workbook, you can write it out by -calling write(outputStream) from your instance of Workbook, passing -it an OutputStream (for instance, a FileOutputStream or -ServletOutputStream). You must close the OutputStream yourself. HSSF -does not close it for you. -

    - -

    Here is some example code (excerpted and adapted from -org.apache.poi.hssf.dev.HSSF test class):

    - -
    - - - - -
    -
            short rownum;
-
-        // create a new file
-        FileOutputStream out = new FileOutputStream("workbook.xls");
-        // create a new workbook
-        HSSFWorkbook wb = new HSSFWorkbook();
-        // create a new sheet
-        HSSFSheet s = wb.createSheet();
-        // declare a row object reference
-        HSSFRow r = null;
-        // declare a cell object reference
-        HSSFCell c = null;
-        // create 3 cell styles
-        HSSFCellStyle cs = wb.createCellStyle();
-        HSSFCellStyle cs2 = wb.createCellStyle();
-        HSSFCellStyle cs3 = wb.createCellStyle();
-        // create 2 fonts objects
-        HSSFFont f = wb.createFont();
-        HSSFFont f2 = wb.createFont();
-
-        //set font 1 to 12 point type
-        f.setFontHeightInPoints((short) 12);
-        //make it red
-        f.setColor((short) HSSFCellStyle.RED);
-        // make it bold
-        //arial is the default font
-        f.setBoldweight(f.BOLDWEIGHT_BOLD);
-
-        //set font 2 to 10 point type
-        f2.setFontHeightInPoints((short) 10);
-        //make it the color at palette index 0xf (white)
-        f2.setColor((short) HSSFCellStyle.WHITE);
-        //make it bold
-        f2.setBoldweight(f2.BOLDWEIGHT_BOLD);
-
-        //set cell stlye
-        cs.setFont(f);
-        //set the cell format see HSSFDataFromat for a full list
-        cs.setDataFormat(HSSFDataFormat.getFormat("($#,##0_);[Red]($#,##0)"));
-
-        //set a thin border
-        cs2.setBorderBottom(cs2.BORDER_THIN);
-        //fill w fg fill color
-        cs2.setFillPattern((short) HSSFCellStyle.SOLID_FOREGROUND);
-        // set foreground fill to red
-        cs2.setFillForegroundColor((short) HSSFCellStyle.RED);
-
-        // set the font
-        cs2.setFont(f2);
-
-        // set the sheet name to HSSF Test
-        wb.setSheetName(0, "HSSF Test");
-        // create a sheet with 300 rows (0-299)
-        for (rownum = (short) 0; rownum < 300; rownum++)
-        {
-            // create a row
-            r = s.createRow(rownum);
-            // on every other row
-            if ((rownum % 2) == 0)
-            {
-                // make the row height bigger  (in twips - 1/20 of a point)
-                r.setHeight((short) 0x249);
-            }
-
-            //r.setRowNum(( short ) rownum);
-            // create 50 cells (0-49) (the += 2 becomes apparent later
-            for (short cellnum = (short) 0; cellnum < 50; cellnum += 2)
-            {
-                // create a numeric cell
-                c = r.createCell(cellnum);
-                // do some goofy math to demonstrate decimals
-                c.setCellValue(rownum * 10000 + cellnum
-                        + (((double) rownum / 1000)
-                        + ((double) cellnum / 10000)));
-
-                // on every other row
-                if ((rownum % 2) == 0)
-                {
-                    // set this cell to the first cell style we defined
-                    c.setCellStyle(cs);
-                }
-
-                // create a string cell (see why += 2 in the
-                c = r.createCell((short) (cellnum + 1));
-
-                // set the cell's string value to "TEST"
-                c.setCellValue("TEST");
-                // make this column a bit wider
-                s.setColumnWidth((short) (cellnum + 1), (short) ((50 * 8) / ((double) 1 / 20)));
-
-                // on every other row
-                if ((rownum % 2) == 0)
-                {
-                    // set this to the white on red cell style
-                    // we defined above
-                    c.setCellStyle(cs2);
-                }
-
-            }
-        }
-
-        //draw a thick black border on the row at the bottom using BLANKS
-        // advance 2 rows
-        rownum++;
-        rownum++;
-
-        r = s.createRow(rownum);
-
-        // define the third style to be the default
-        // except with a thick black border at the bottom
-        cs3.setBorderBottom(cs3.BORDER_THICK);
-
-        //create 50 cells
-        for (short cellnum = (short) 0; cellnum < 50; cellnum++)
-        {
-            //create a blank type cell (no value)
-            c = r.createCell(cellnum);
-            // set it to the thick black border style
-            c.setCellStyle(cs3);
-        }
-
-        //end draw thick black border
-
-
-        // demonstrate adding/naming and deleting a sheet
-        // create a sheet, set its title then delete it
-        s = wb.createSheet();
-        wb.setSheetName(1, "DeletedSheet");
-        wb.removeSheetAt(1);
-        //end deleted sheet
-
-        // write the workbook to the output stream
-        // close our file (don't blow out our file handles
-        wb.write(out);
-        out.close();
-
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    Reading or modifying an existing file
    -
    - - -

    Reading in a file is equally simple. To read in a file, create a -new instance of org.apache.poi.poifs.Filesystem, passing in an open InputStream, such as a FileInputStream -for your XLS, to the constructor. Construct a new instance of -org.apache.poi.hssf.usermodel.HSSFWorkbook passing the -Filesystem instance to the constructor. From there you have access to -all of the high level model objects through their assessor methods -(workbook.getSheet(sheetNum), sheet.getRow(rownum), etc). -

    - -

    Modifying the file you have read in is simple. You retrieve the -object via an assessor method, remove it via a parent object's remove -method (sheet.removeRow(hssfrow)) and create objects just as you -would if creating a new xls. When you are done modifying cells just -call workbook.write(outputstream) just as you did above.

    - -

    An example of this can be seen in -org.apache.poi.hssf.dev.HSSF.

    - -
    -
    -
    -
    -
    -
    - -
    - - - - - - - -
    Event API
    -
    - - -

    The event API is brand new. It is intended for intermediate -developers who are willing to learn a little bit of the low level API -structures. Its relatively simple to use, but requires a basic -understanding of the parts of an Excel file (or willingness to -learn). The advantage provided is that you can read an XLS with a -relatively small memory footprint. -

    - -

    To use this API you construct an instance of -org.apache.poi.hssf.eventmodel.HSSFRequest. Register a class you -create that supports the -org.apache.poi.hssf.eventmodel.HSSFListener interface using the -HSSFRequest.addListener(yourlistener, recordsid). The recordsid -should be a static reference number (such as BOFRecord.sid) contained -in the classes in org.apache.poi.hssf.record. The trick is you -have to know what these records are. Alternatively you can call -HSSFRequest.addListenerForAllRecords(mylistener). In order to learn -about these records you can either read all of the javadoc in the -org.apache.poi.hssf.record package or you can just hack up a -copy of org.apache.poi.hssf.dev.EFHSSF and adapt it to your -needs. TODO: better documentation on records.

    - -

    Once you've registered your listeners in the HSSFRequest object -you can construct an instance of -org.apache.poi.poifs.filesystem.FileSystem (see POIFS howto) and -pass it your XLS file inputstream. You can either pass this, along -with the request you constructed, to an instance of HSSFEventFactory -via the HSSFEventFactory.processWorkbookEvents(request, Filesystem) -method, or you can get an instance of DocumentInputStream from -Filesystem.createDocumentInputStream("Workbook") and pass -it to HSSFEventFactory.processEvents(request, inputStream). Once you -make this call, the listeners that you constructed receive calls to -their processRecord(Record) methods with each Record they are -registered to listen for until the file has been completely read. -

    - -

    A code excerpt from org.apache.poi.hssf.dev.EFHSSF (which is -in CVS or the source distribution) is reprinted below with excessive -comments:

    - -
    - - - - -
    -
    -/**
- * This example shows how to use the event API for reading a file.
- */
-public class EventExample
-        implements HSSFListener
-{
-    private SSTRecord sstrec;
-
-    /**
-     * This method listens for incoming records and handles them as required.
-     * @param record    The record that was found while reading.
-     */
-    public void processRecord(Record record)
-    {
-        switch (record.getSid())
-        {
-            // the BOFRecord can represent either the beginning of a sheet or the workbook
-            case BOFRecord.sid:
-                BOFRecord bof = (BOFRecord) record;
-                if (bof.getType() == bof.TYPE_WORKBOOK)
-                {
-                    System.out.println("Encountered workbook");
-                    // assigned to the class level member
-                } else if (bof.getType() == bof.TYPE_WORKSHEET)
-                {
-                    System.out.println("Encountered sheet reference");
-                }
-                break;
-            case BoundSheetRecord.sid:
-                BoundSheetRecord bsr = (BoundSheetRecord) record;
-                System.out.println("New sheet named: " + bsr.getSheetname());
-                break;
-            case RowRecord.sid:
-                RowRecord rowrec = (RowRecord) record;
-                System.out.println("Row found, first column at "
-                        + rowrec.getFirstCol() + " last column at " + rowrec.getLastCol());
-                break;
-            case NumberRecord.sid:
-                NumberRecord numrec = (NumberRecord) record;
-                System.out.println("Cell found with value " + numrec.getValue()
-                        + " at row " + numrec.getRow() + " and column " + numrec.getColumn());
-                break;
-                // SSTRecords store a array of unique strings used in Excel.
-            case SSTRecord.sid:
-                sstrec = (SSTRecord) record;
-                for (int k = 0; k < sstrec.getNumUniqueStrings(); k++)
-                {
-                    System.out.println("String table value " + k + " = " + sstrec.getString(k));
-                }
-                break;
-            case LabelSSTRecord.sid:
-                LabelSSTRecord lrec = (LabelSSTRecord) record;
-                System.out.println("String cell found with value "
-                        + sstrec.getString(lrec.getSSTIndex()));
-                break;
-        }
-    }
-
-    /**
-     * Read an excel file and spit out what we find.
-     *
-     * @param args      Expect one argument that is the file to read.
-     * @throws IOException  When there is an error processing the file.
-     */
-    public static void main(String[] args) throws IOException
-    {
-        // create a new file input stream with the input file specified
-        // at the command line
-        FileInputStream fin = new FileInputStream(args[0]);
-        // create a new org.apache.poi.poifs.filesystem.Filesystem
-        POIFSFileSystem poifs = new POIFSFileSystem(fin);
-        // get the Workbook (excel part) stream in a InputStream
-        InputStream din = poifs.createDocumentInputStream("Workbook");
-        // construct out HSSFRequest object
-        HSSFRequest req = new HSSFRequest();
-        // lazy listen for ALL records with the listener shown above
-        req.addListenerForAllRecords(new EventExample());
-        // create our event factory
-        HSSFEventFactory factory = new HSSFEventFactory();
-        // process our events based on the document input stream
-        factory.processEvents(req, din);
-        // once all the events are processed close our file input stream
-        fin.close();
-        // and our document input stream (don't want to leak these!)
-        din.close();
-        System.out.println("done.");
-    }
-}
-
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    Low Level APIs
    -
    - - -

    The low level API is not much to look at. It consists of lots of -"Records" in the org.apache.poi.hssf.record.* package, -and set of helper classes in org.apache.poi.hssf.model.*. The -record classes are consistent with the low level binary structures -inside a BIFF8 file (which is embedded in a POIFS file system). You -probably need the book: "Microsoft Excel 97 Developer's Kit" -from Microsoft Press in order to understand how these fit together -(out of print but easily obtainable from Amazon's used books). In -order to gain a good understanding of how to use the low level APIs -should view the source in org.apache.poi.hssf.usermodel.* and -the classes in org.apache.poi.hssf.model.*. You should read the -documentation for the POIFS libraries as well.

    - -
    -
    -
    - -
    - - - - - - - -
    HSSF Class/Test Application
    -
    - - -

    The HSSF application is nothing more than a test for the high -level API (and indirectly the low level support). The main body of -its code is repeated above. To run it: -

    - -
      - -
    • download the poi-alpha build and untar it (tar xvzf - tarball.tar.gz) -
      • - -
    • set up your classpath as follows: - export HSSFDIR={wherever you put HSSF's jar files} -export LOG4JDIR={wherever you put LOG4J's jar files} -export CLASSPATH=$CLASSPATH:$HSSFDIR/hssf.jar:$HSSFDIR/poi-poifs.jar:$HSSFDIR/poi-util.jar:$LOG4JDIR/jog4j.jar - -
      • -
    • type: - java org.apache.poi.hssf.dev.HSSF ~/myxls.xls write -
      • - -
    - -

    - -

    This should generate a test sheet in your home directory called "myxls.xls".

    - -
      - -
    • Type: - java org.apache.poi.hssf.dev.HSSF ~/input.xls output.xls - -

      -This is the read/write/modify test. It reads in the spreadsheet, modifies a cell, and writes it back out. -Failing this test is not necessarily a bad thing. If HSSF tries to modify a non-existant sheet then this will -most likely fail. No big deal.

      -
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    HSSF Logging facility
    -
    - -

    HSSF now has a logging facility (using - commons logging) -that will record massive amounts of debugging information. Its mostly -useful to us hssf-developing geeks, but might be useful in tracking -down problems. -

    - -

    So Why use commons logging rather than log4j? Well the following discussion from -the jakarta-general mailing list sums it up pretty well. (Thanks Morgan) -

    - -

    -Here's the problem, as I see it. - -

    - -

    -Suppose Commons component A decides to adopt Log4J, Commons component B -decides to adopt LogKit, and Commons component C adopts JDK1.4 logging. -They will all minimally function with the right jars in the classpath. -However you (the end-user) are left with maintaining configuration for 3 -different logging APIs, which is tedious at best. When you take into -account cool features like variable log levels, Log4J appenders and the -like, you're pretty much guaranteed to swallow up useful configuration -options because sophisticated configurations are too difficult to maintain -over mutiple logging implementations. - -

    - -

    - -Contrarily, if all three Commons components use a logging facade, you can -focus all your configuration efforts on one logging implementation. Sure, -there is a trade-off; you don't have access to all the features, and the -interface between the facade and the implementation must be maintained. But -the benefits are not just political; they potentially make the end-users -configuration much easier. - -

    - -

    -Even if all Commons components used the same logging implementation (Log4J -for example), other projects in Jakarta-land may choose otherwise. If you -add enough Jakarta projects to your environment, you eventually end up with -the scenario described above. It's a worthwhile effort to attempt a logging -solution that plays well with the Jakarta community at large. I think in -many cases the Commons Logging component can fill that role. - -

    - -

    -Refer to the commons logging package level javadoc for more information concerning how to -configure commons logging. - -

    - -
    -
    -
    - -
    - - - - - - - -
    HSSF Developer's tools
    -
    - - -

    HSSF has a number of tools useful for developers to debug/develop -stuff using HSSF (and more generally XLS files). We've already -discussed the app for testing HSSF read/write/modify capabilities; -now we'll talk a bit about BiffViewer. Early on in the development of -HSSF, it was decided that knowing what was in a record, what was -wrong with it, etc. was virtually impossible with the available -tools. So we developed BiffViewer. You can find it at -org.apache.poi.hssf.dev.BiffViewer. It performs two basic -functions and a derivative. -

    - -

    The first is "biffview". To do this you run it (assumes -you have everything setup in your classpath and that you know what -you're doing enough to be thinking about this) with an xls file as a -parameter. It will give you a listing of all understood records with -their data and a list of not-yet-understood records with no data -(because it doesn't know how to interpret them). This listing is -useful for several things. First, you can look at the values and SEE -what is wrong in quasi-English. Second, you can send the output to a -file and compare it. -

    - -

    The second function is "big freakin dump", just pass a -file and a second argument matching "bfd" exactly. This -will just make a big hexdump of the file. -

    - -

    Lastly, there is "mixed" mode which does the same as -regular biffview, only it includes hex dumps of certain records -intertwined. To use that just pass a file with a second argument -matching "on" exactly.

    - -

    In the next release cycle we'll also have something called a -FormulaViewer. The class is already there, but its not very useful -yet. When it does something, we'll document it.

    - - -
    -
    -
    - -
    - - - - - - - -
    What's Next?
    -
    - - -

    This release contains code that supports "internationalization" -or more accurately non-US/UK languages; however, it has not been -tested with the new API changes (please help us with this). We've -shifted focus a bit for this release in recognition of the -international support we've gotten. We're going to focus on western -European languages for our first beta. We're more than happy to -accept help in supporting non-Western European languages if someone -who knows what they're doing in this area is willing to pitch in! -(There is next to no documentation on what is necessary to support -such a move and its really hard to support a language when you don't even -know the alphabet).

    - -

    This release of HSSF does not yet support Formulas. I've been -focusing on the requests I've gotten in. That being said, if we get -more user feedback on what is most useful first we'll aim for that. -As a general principal, HSSF's goal is to support HSSF-Serializer -(meaning an emphasis on write). We would like to hear from you! How -are you using HSSF/POIFS? How would you like to use it? What features -are most important first? -

    - -
    -
    -
    - - -
    -
    -
    - - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hssf/images/cocoon2-small.jpg b/build/jakarta-poi/docs/hssf/images/cocoon2-small.jpg deleted file mode 100644 index e8f6dd8c8c..0000000000 Binary files a/build/jakarta-poi/docs/hssf/images/cocoon2-small.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/hssf/images/header.gif b/build/jakarta-poi/docs/hssf/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/hssf/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hssf/images/jakarta-logo.gif b/build/jakarta-poi/docs/hssf/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/hssf/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hssf/images/usermodel.gif b/build/jakarta-poi/docs/hssf/images/usermodel.gif deleted file mode 100644 index 4f4c3606c3..0000000000 Binary files a/build/jakarta-poi/docs/hssf/images/usermodel.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/hssf/index.html b/build/jakarta-poi/docs/hssf/index.html deleted file mode 100644 index ea4d075381..0000000000 --- a/build/jakarta-poi/docs/hssf/index.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - -HSSF - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HSSF -
    -Quick Guide -
    -HOWTO -
    -Use Case -
    -Pictorial Docs -
    -Alternatives -
    -
    -Contributer's Guide -
    -Record Generator -
    -    		 -
    -    		 -HSSF - - - - - - -
    - - - - - - -
    - - - - - - -
    HSSF
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Overview
    -
    - - -

    HSSF is the POI Project's pure Java implementation of the Excel '97(-2002) file format.

    - -

    HSSF provides a way to read spreadsheets create, modify, read and write XLS spreadsheets - It provides: -

    - -
      - -
    • low level structures for those with special needs
      • - -
    • an eventmodel api for efficient read-only access
      • - -
    • a full usermodel api for creating, reading and modifying XLS files
      • - -
    - -

    - Truth be told there is probably a better way to generate your spreadsheet - generation (yet you'll still be using HSSF indirectly). At the time of - this writing we're in the process of moving the HSSF Serializer over to - the Apache Cocoon - Project. With Cocoon you can serialize any XML datasource (of - which might be a ESQL page outputting in SQL for instance) by simply - applying the stylesheet and designating the serializer. -

    - -

    - If you're merely reading spreadsheet data, then use the eventmodel api - in the org.apache.poi.hssf.eventmodel package. -

    - -

    - If you're modifying spreadsheet data then use the usermodel api. You - can also generate spreadsheets this way, but using Cocoon (which will do - it this way indirectly) is the best way...we promise. -

    - - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hssf/quick-guide.html b/build/jakarta-poi/docs/hssf/quick-guide.html deleted file mode 100644 index f053d86d29..0000000000 --- a/build/jakarta-poi/docs/hssf/quick-guide.html +++ /dev/null @@ -1,597 +0,0 @@ - - - - - - - - - - - -
    -www.apache.org >  - jakarta.apache.org >  - -
    - - - - -
    - -
    - - - - - - - -
    How do I...?
    -
    Learn more about this project?
    -
    Print this page...
    -
    Troubleshoot...
    -
    -
    -    		 -
    - - - - -
    -
    -   -   -   - web site mail lists -
    -
    -
    -

    Quick Guide to HSSF Features

    - -

    - -

    -     - -
    - - - - - - - -
    Quick Guide to Features
    -
    - -

    - Want to use HSSF read and write spreadsheets in a hurry? This guide is for you. If you're after - more in-depth coverage of the HSSF user-API please consult the HOWTO - guide as it contains actual descriptions of how to use this stuff. -

    - - -
    - -
    - - - - - - - -
    Features
    -
    - - - -

    New Workbook

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    New Sheet

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    HSSFSheet sheet1 = wb.createSheet("new sheet");
-    HSSFSheet sheet2 = wb.createSheet("second sheet");
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    Creating Cells

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    HSSFSheet sheet = wb.createSheet("new sheet");
-
-    // Create a row and put some cells in it. Rows are 0 based.
-    HSSFRow row = sheet.createRow((short)0);
-    // Create a cell and put a value in it.
-    HSSFCell cell = row.createCell((short)0);
-    cell.setCellValue(1);
-
-    // Or do it on one line.
-    row.createCell((short)1).setCellValue(1.2);
-    row.createCell((short)2).setCellValue("This is a string");
-    row.createCell((short)3).setCellValue(true);
-
-    // Write the output to a file
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    Creating Date Cells

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    HSSFSheet sheet = wb.createSheet("new sheet");
-
-    // Create a row and put some cells in it. Rows are 0 based.
-    HSSFRow row = sheet.createRow((short)0);
-
-    // Create a cell and put a date value in it.  The first cell is not styled
-    // as a date.
-    HSSFCell cell = row.createCell((short)0);
-    cell.setCellValue(new Date());
-
-    // we style the second cell as a date (and time).  It is important to
-    // create a new cell style from the workbook otherwise you can end up
-    // modifying the built in style and effecting not only this cell but other cells.
-    HSSFCellStyle cellStyle = wb.createCellStyle();
-    cellStyle.setDataFormat(HSSFDataFormat.getFormat("m/d/yy h:mm"));
-    cell = row.createCell((short)1);
-    cell.setCellValue(new Date());
-    cell.setCellStyle(cellStyle);
-
-    // Write the output to a file
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    Working with different types of cells

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    HSSFSheet sheet = wb.createSheet("new sheet");
-    HSSFRow row = sheet.createRow((short)2);
-    row.createCell((short) 0).setCellValue(1.1);
-    row.createCell((short) 1).setCellValue(new Date());
-    row.createCell((short) 2).setCellValue("a string");
-    row.createCell((short) 3).setCellValue(true);
-    row.createCell((short) 4).setCellType(HSSFCell.CELL_TYPE_ERROR);
-
-    // Write the output to a file
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    Demonstrates various alignment options

    - -
    - - - - -
    -
    -    public static void main(String[] args)
-            throws IOException
-    {
-        HSSFWorkbook wb = new HSSFWorkbook();
-        HSSFSheet sheet = wb.createSheet("new sheet");
-        HSSFRow row = sheet.createRow((short) 2);
-        createCell(wb, row, (short) 0, HSSFCellStyle.ALIGN_CENTER);
-        createCell(wb, row, (short) 1, HSSFCellStyle.ALIGN_CENTER_SELECTION);
-        createCell(wb, row, (short) 2, HSSFCellStyle.ALIGN_FILL);
-        createCell(wb, row, (short) 3, HSSFCellStyle.ALIGN_GENERAL);
-        createCell(wb, row, (short) 4, HSSFCellStyle.ALIGN_JUSTIFY);
-        createCell(wb, row, (short) 5, HSSFCellStyle.ALIGN_LEFT);
-        createCell(wb, row, (short) 6, HSSFCellStyle.ALIGN_RIGHT);
-
-        // Write the output to a file
-        FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-        wb.write(fileOut);
-        fileOut.close();
-
-    }
-
-    /**
-     * Creates a cell and aligns it a certain way.
-     *
-     * @param wb        the workbook
-     * @param row       the row to create the cell in
-     * @param column    the column number to create the cell in
-     * @param align     the alignment for the cell.
-     */
-    private static void createCell(HSSFWorkbook wb, HSSFRow row, short column, short align)
-    {
-        HSSFCell cell = row.createCell(column);
-        cell.setCellValue("Align It");
-        HSSFCellStyle cellStyle = wb.createCellStyle();
-        cellStyle.setAlignment(align);
-        cell.setCellStyle(cellStyle);
-    }
-
    -
    -
    - - - - -

    Working with borders

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    HSSFSheet sheet = wb.createSheet("new sheet");
-
-    // Create a row and put some cells in it. Rows are 0 based.
-    HSSFRow row = sheet.createRow((short) 1);
-
-    // Create a cell and put a value in it.
-    HSSFCell cell = row.createCell((short) 1);
-    cell.setCellValue(4);
-
-    // Style the cell with borders all around.
-    HSSFCellStyle style = wb.createCellStyle();
-    style.setBorderBottom(HSSFCellStyle.BORDER_THIN);
-    style.setBottomBorderColor(HSSFCellStyle.BLACK);
-    style.setBorderLeft(HSSFCellStyle.BORDER_THIN);
-    style.setLeftBorderColor(HSSFCellStyle.GREEN);
-    style.setBorderRight(HSSFCellStyle.BORDER_THIN);
-    style.setRightBorderColor(HSSFCellStyle.BLUE);
-    style.setBorderTop(HSSFCellStyle.BORDER_MEDIUM_DASHED);
-    style.setTopBorderColor(HSSFCellStyle.AUTOMATIC);
-    cell.setCellStyle(style);
-
-    // Write the output to a file
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    Fills and colors

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    HSSFSheet sheet = wb.createSheet("new sheet");
-
-    // Create a row and put some cells in it. Rows are 0 based.
-    HSSFRow row = sheet.createRow((short) 1);
-
-    // Aqua background
-    HSSFCellStyle style = wb.createCellStyle();
-    style.setFillBackgroundColor(HSSFCellStyle.AQUA);
-    style.setFillPattern(HSSFCellStyle.BIG_SPOTS);
-    HSSFCell cell = row.createCell((short) 1);
-    cell.setCellValue("X");
-    cell.setCellStyle(style);
-
-    // Orange "foreground", foreground being the fill foreground not the font color.
-    style = wb.createCellStyle();
-    style.setFillForegroundColor(HSSFCellStyle.ORANGE);
-    style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
-    cell = row.createCell((short) 2);
-    cell.setCellValue("X");
-    cell.setCellStyle(style);
-
-    // Write the output to a file
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    Merging cells

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    HSSFSheet sheet = wb.createSheet("new sheet");
-
-    HSSFRow row = sheet.createRow((short) 1);
-    HSSFCell cell = row.createCell((short) 1);
-    cell.setCellValue("This is a test of merging");
-
-    sheet.addMergedRegion(new Region(1,(short)1,1,(short)2));
-
-    // Write the output to a file
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    Working with fonts

    - -
    - - - - -
    -
    -    HSSFWorkbook wb = new HSSFWorkbook();
-    HSSFSheet sheet = wb.createSheet("new sheet");
-
-    // Create a row and put some cells in it. Rows are 0 based.
-    HSSFRow row = sheet.createRow((short) 1);
-
-    // Create a new font and alter it.
-    HSSFFont font = wb.createFont();
-    font.setFontHeightInPoints((short)24);
-    font.setFontName("Courier New");
-    font.setItalic(true);
-    font.setStrikeout(true);
-
-    // Fonts are set into a style so create a new one to use.
-    HSSFCellStyle style = wb.createCellStyle();
-    style.setFont(font);
-
-    // Create a cell and put a value in it.
-    HSSFCell cell = row.createCell((short) 1);
-    cell.setCellValue("This is a test of fonts");
-    cell.setCellStyle(style);
-
-    // Write the output to a file
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - - - -

    Reading and Rewriting Workbooks

    - -
    - - - - -
    -
    -    POIFSFileSystem fs      =
-            new POIFSFileSystem(new FileInputStream("workbook.xls"));
-    HSSFWorkbook wb = new HSSFWorkbook(fs);
-    HSSFSheet sheet = wb.getSheetAt(0);
-    HSSFRow row = sheet.getRow(2);
-    HSSFCell cell = row.getCell((short)3);
-    if (cell == null)
-        cell = row.createCell((short)3);
-    cell.setCellType(HSSFCell.CELL_TYPE_STRING);
-    cell.setCellValue("a test");
-
-    // Write the output to a file
-    FileOutputStream fileOut = new FileOutputStream("workbook.xls");
-    wb.write(fileOut);
-    fileOut.close();
-
    -
    -
    - - -
    -
    -
    - -
    -
    -
    - -
    - - - diff --git a/build/jakarta-poi/docs/hssf/record-generator.html b/build/jakarta-poi/docs/hssf/record-generator.html deleted file mode 100644 index e691284e0c..0000000000 --- a/build/jakarta-poi/docs/hssf/record-generator.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - -Record Generator HOWTO - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HSSF -
    -Quick Guide -
    -HOWTO -
    -Use Case -
    -Pictorial Docs -
    -Alternatives -
    -
    -Contributer's Guide -
    -Record Generator -
    -    		 -
    -    		 -Record Generator HOWTO - - - - - - -
    - - - - - - -
    - - - - - - -
    Record Generator HOWTO
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    How to Use the Record Generator
    -
    - - -
    - - - - - - - -
    History
    -
    - -

    - The record generator was born from frustration with translating - the Excel records to Java classes. Doing this manually is a time - consuming process. It's also very easy to make mistakes. -

    - -

    - A utility was needed to take the defintition of what a - record looked like and do all the boring stuff. Thus the - record generator was born. -

    - -
    -
    -
    - - -
    - - - - - - - -
    Capabilities
    -
    - -

    - The record generator takes XML as input and produced the following - output: -

      - -
    • A Java file capabile of decoding and encoding the record.
      • - -
    • A test class with provides a fill-in-the-blanks implementation of a test case - for ensuring the record operates as designed.
      • - -
    - -

    - -
    -
    -
    - -
    - - - - - - - -
    Usage
    -
    - -

    - The record generator is invoked as an Ant target (generate-records). It goes - through looking for all files in src/records/defintitions ending with _record.xml. - It then creates two files; the Java record definition and the Java test case template. -

    - -

    - The records themselves have the following general layout: -

    - -
    - - - - -
    -
    -<record id="0x1032" name="Frame" package="org.apache.poi.hssf.record">
-    <description>The frame record indicates whether there is a border 
-                 around the displayed text of a chart.</description>
-    <author>Glen Stampoultzis (glens at apache.org)</author>
-    <fields>
-        <field type="int" size="2" name="border type">
-            <const name="regular" value="0" description="regular rectangle or no border"/>
-            <const name="shadow" value="1" description="rectangle with shadow"/>
-        </field>
-        <field type="int" size="2" name="options">
-            <bit number="0" name="auto size" 
-               description="excel calculates the size automatically if true"/>
-            <bit number="1" name="auto position" 
-               description="excel calculates the position automatically"/>
-        </field>
-    </fields>
-</record>
-
    -
    -
    - -

    - Currently the type can be of type int, float or string. The 'int' - type covers bytes, shorts and integers which is selected using a - size of 1, 2 or 4. An additional type called varword is used to - represent a array of word values where the first short is the length - of the array. The string type generation is only partially - implemented. If choosing string you must select a size of 'var'. -

    - -

    - The Java records are regenerated each time the record generator is - run, however the test stubs are only created if the test stub does - not already exist. What this means is that you may change test - stubs but not the generated records. -

    - -
    -
    -
    - -
    - - - - - - - -
    How it Works
    -
    - -

    - The record generation works by taking an XML file and styling it - using XLST. Given that XSLT is a little limited in some ways it was - necessary to add a little Java code to the mix. -

    - -

    - See record.xsl, record_test.xsl, FieldIterator.java, - RecordUtil.java, RecordGenerator.java -

    - -
    -
    -
    - -
    - - - - - - - -
    Limitations
    -
    - -

    - The record generator does not handle all possible record types and - is not ment to. Sometimes it's going to make more sense to generate - the records manually. The main point of this thing is to make the - easy stuff simple. -

    - -

    - Currently the record generator is optimized to create Excel records. - It could be adapted to create Word records with a little poking - around. -

    - -

    - Currently the the XSL file that generates the record calls out to - Java objects. This would have been better done as Javascript inside - the XSL file itself. The Java code for the record generation is - currently quite messy with minimal comments. -

    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/hssf/use-case.html b/build/jakarta-poi/docs/hssf/use-case.html deleted file mode 100644 index a8548ee287..0000000000 --- a/build/jakarta-poi/docs/hssf/use-case.html +++ /dev/null @@ -1,520 +0,0 @@ - - - - -HSSF Use Cases - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -HSSF -
    -Quick Guide -
    -HOWTO -
    -Use Case -
    -Pictorial Docs -
    -Alternatives -
    -
    -Contributer's Guide -
    -Record Generator -
    -    		 -
    -    		 -HSSF Use Cases - - - - - - -
    - - - - - - -
    - - - - - - -
    HSSF Use Cases
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    HSSF Use Cases
    -
    - -
    - - - - - - - -
    Use Case 1: Read existing HSSF
    -
    - - -

    -Primary Actor: HSSF client

    - -

    -Scope: HSSF

    - -

    -Level: Summary

    - -

    -Stakeholders and Interests: -

    - -
      - -
    • HSSF client- wants to read content - of HSSF file
      • - -
    • HSSF - understands HSSF file
      • - -
    • POIFS - understands underlying POI - file system
      • - -
    - -

    -Precondition: None

    - -

    -Minimal Guarantee: None

    - -

    -Main Success Guarantee: -

    - -
      - -
    1. HSSF client requests HSSF to read - a HSSF file, providing an InputStream - containing HSSF file in question.
      2. - -
    2. HSSF requests POIFS to read the HSSF - file, passing the InputStream - object to POIFS (POIFS use case 1, read existing file system)
      3. - -
    3. HSSF reads the "Workbook" - file (use case 4, read workbook entry)
      4. - -
    - -

    -Extensions: -

    - -

    2a. Exceptions -thrown by POIFS will be passed on to the HSSF client.

    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 2: Write HSSF file
    -
    - - -

    -Primary Actor: HSSF client

    - -

    -Scope: HSSF

    - -

    -Level: Summary

    - -

    -Stakeholders and Interests: -

    - -
      - -
    • HSSF client- wants to write file - out.
      • - -
    • HSSF - knows how to write file - out.
      • - -
    • POIFS - knows how to write file - system out.
      • - -
    - -

    -Precondition: -

    - -
      - -
    • File has been - read (use case 1, read existing HSSF file) and subsequently modified - or file has been created (use case 3, create HSSF file)
      • - -
    - -

    -Minimal Guarantee: None

    - -

    -Main Success Guarantee: -

    - -
      - -
    1. HSSF client - provides an OutputStream to - write the file to.
      2. - -
    2. HSSF writes - the "Workbook" to its associated POIFS file system (use case - 5, write workbook entry)
      3. - -
    3. HSSF - requests POIFS to write its file system out, using the OutputStream - obtained from the HSSF client (POIFS use case 2, write file system).
      4. - -
    - -

    -Extensions: -

    - -

    3a. Exceptions -from POIFS are passed to the HSSF client.

    - - -
    -
    -
    - -
    - - - - - - - -
    Use Case 3:Create HSSF file
    -
    - - -

    -Primary Actor: HSSF client

    - -

    -Scope: HSSF

    - -

    - -Level: Summary

    - -

    -Stakeholders and Interests: -

    - -
      - -
    • HSSF client- wants to create a new - file.
      • - -
    • HSSF - knows how to create a new - file.
      • - -
    • POIFS - knows how to creat a new - file system.
      • - -
    - -

    -Precondition: -

    - -

    -Minimal Guarantee: None

    - -

    -Main Success Guarantee: -

    - -
      - -
    1. HSSF requests - POIFS to create a new file system (POIFS use case 3, create new file - system)
      2. - -
    - -

    -Extensions: -None

    - - -
    -
    -
    - -
    - - - - - - - -
    Use Case 4: Read workbook entry
    -
    - -

    -Primary Actor: HSSF

    - -

    -Scope: HSSF

    - -

    - -Level: Summary

    - -

    -Stakeholders and Interests: -

    - -
      - -
    • HSSF - knows how to read the - workbook entry
      • - -
    • POIFS - knows how to manage the file - system.
      • - -
    - -

    -Precondition: -

    - -
      - -
    • The file - system has been read (use case 1, read existing HSSF file) or has - been created and written to (use case 3, create HSSF file system; - use case 5, write workbook entry).
      • - -
    - -

    -Minimal -Guarantee: None

    - -

    -Main Success Guarantee: -

    - -
      - -
    1. - HSSF requests POIFS for the "Workbook" file
      2. - -
    2. POIFS returns - an InputStream for the file.
      3. - -
    3. HSSF reads - from the InputStream provided by POIFS
      4. - -
    4. HSSF closes - the InputStream provided by POIFS
      5. - -
    - -

    -Extensions: -

    - -

    3a. Exceptions -thrown by POIFS will be passed on

    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 5: Write workbook entry
    -
    - - - -

    -Primary Actor: HSSF

    - -

    -Scope: HSSF

    - -

    - -Level: Summary

    - -

    -Stakeholders and Interests: -

    - -
      - -
    • HSSF - knows how to manage the - write the workbook entry.
      • - -
    • POIFS - knows how to manage the file - system.
      • - -
    - -

    -Precondition: - -

    - -
      - -
    • Either an existing HSSF file has - been read (use case 1, read existing HSSF file) or an HSSF file has - been created (use case 3, create HSSF file).
      • - -
    - -

    -Minimal Guarantee: None

    - -

    -Main Success Guarantee: -

    - -
      - -
    1. HSSF - checks the POIFS file system directory for the "Workbook" - file (POIFS use case 8, read file system directory)
      2. - -
    2. If "Workbook" is in the directory, HSSF requests POIFS to - replace it with the new workbook entry (POIFS use case 4, replace file - in file system). Otherwise, HSSF requests POIFS to write the new - workbook file, with the name "Workbook" (POIFS use case 6, - write new file to file system)
      3. - -
    - -

    -Extensions:None

    - -
    -
    -
    - - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/images/built-with-cocoon.gif b/build/jakarta-poi/docs/images/built-with-cocoon.gif deleted file mode 100644 index 0b38f7857b..0000000000 Binary files a/build/jakarta-poi/docs/images/built-with-cocoon.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/images/cocoon2-small.jpg b/build/jakarta-poi/docs/images/cocoon2-small.jpg deleted file mode 100644 index e8f6dd8c8c..0000000000 Binary files a/build/jakarta-poi/docs/images/cocoon2-small.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/images/header.gif b/build/jakarta-poi/docs/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/images/jakarta-logo.gif b/build/jakarta-poi/docs/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/images/krysalis-compatible.jpg b/build/jakarta-poi/docs/images/krysalis-compatible.jpg deleted file mode 100644 index 077f8a1179..0000000000 Binary files a/build/jakarta-poi/docs/images/krysalis-compatible.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/images/update.jpg b/build/jakarta-poi/docs/images/update.jpg deleted file mode 100644 index 586a4527e3..0000000000 Binary files a/build/jakarta-poi/docs/images/update.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/index.html b/build/jakarta-poi/docs/index.html deleted file mode 100644 index 73cc87acb3..0000000000 --- a/build/jakarta-poi/docs/index.html +++ /dev/null @@ -1,471 +0,0 @@ - - - - - - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -

    - -

    -     -
    - - - - - - - -
    Logo Contest
    -
    - -

    - The POI committers have voted to - "innovate" and hold a - logo contest. The big P at the top of the page is just a placeholder. - So the rules are pretty much this: -

    - -
      - -
    • - -Only PNG submissions - be accepted (we can convert them as needed). -
      • - -
    • - Submissions must be sent to the POI - User's mailing list via an http link. If you do not - have an available webserver contact Andy (acoliver at apache dot - org) and ask him to post it for you (and he will if it doesn't - suck royally). Large binary attachments annoyingly posted to - the list will be rebuked. :-) -
      • - -
    • - Image authors must be willing to work with us on any font and - sizing issues, etc. -
      • - -
    • - All submissions become property of the Apache Software - Foundation to do whatever it wants with them (thanks!). -
      • - -
    • - A non-binding poll will be taken and everyone can vote. -
      • - -
    • - Based on the poll results and the fact that Andy won't vote for - anything that isn't some kind of tiki god or hawaiian theme - (maybe a poi pounder would be acceptable), the committers will - vote on the new POI logo. -
      • - -
    • - Logos should be submitted in two flavors: one for the top of the - page and another for posting on other sites that note projects - that use POI technology. -
      • - -
    • - The winner will get credit posted somewhere on the POI site and - have their logo used wherever POI is proudly served. -
      • - -
    - -

    - You can see the current submissions here. - -

    - -
    -
    -
    -
    - - - - - - - -
    Purpose
    -
    - -

    - The POI project consists of APIs for manipulating various file formats - based upon Microsoft's OLE 2 Compound Document format using pure Java. -

    - -

    - OLE 2 Compound Document Format based files include most Microsoft Office - files such as XLS and DOC. -

    - -

    - As a general policy we try to collaborate as much as possible with other projects to - provide this functionality. Examples include: Cocoon for - which you'll soon find generators and serializers for our projects; - Open Office.org with whom we collaborate in documenting the - XLS format; and Lucene for which we'll soon have file - format interpretors. When practical, we donate components directly to those projects for POI-enabling them. -

    - -
    - - - - - - - -
    Why/when would I use POI?
    -
    - -

    - We'll tackle this on a component level. POI refers to the whole project. -

    - -

    - So why should you use POIFS or HSSF? -

    - -

    - You'd use POIFS if you had a document written in OLE 2 Compound Document Format, probably written using - MFC, that you needed to read in Java. Alternatively, you'd use POI to write OLE 2 Compound Document Format - if you needed to inter-operate with software running on the Windows platform. We are not just bragging when - we say that POIFS is the most complete and correct port of this file format to date! -

    - -

    - You'd use HSSF if you needed to read or write an XLS (Excel) file using Java. You can also read and modify - spreadsheets using this API, although right now writing is more mature. -

    - -
    -
    -
    - - -
    - - - - - - - -
    What does POI stand for?
    -
    - -

    - POI stands for Poor Obfuscation Implementation. Why would we name our project such a derogatory name? Well, - Microsoft's OLE 2 Compound Document Format is a poorly conceived thing. It is essentially an archive structured - much like the old DOS FAT filesystem. Redmond chose, instead of using tar, gzip, zip or arc, to invent their own - archive format that does not provide any standard encryption or compression, is not very appendable and is prone - to fragmentation. -

    - -

    - Poi is also a Hawaiian delicacy that Merriam Webster's dictionary defines as: - "A Hawaiian food of taro root cooked, pounded, and kneaded to a paste and often allowed to ferment." This seemed - strangely descriptive of the file format. -

    - -

    - So if you like acronyms, then POI is an acronym. If you hate them, then we just used the name of the food for our - project. If you wish to signify your love or hate for acronyms, use POI or Poi to refer to the project respectively. -

    - -
    -
    -
    - - -
    -
    -
    -
    - - - - - - - -
    Components To Date
    -
    - -
    - - - - - - - -
    Overview
    -
    - -

    A common misconception is that POI writes Excel files. POI is the name of the project. POI contains several - components, one of which, HSSF, writes Excel files. The following are components of the entire POI project - and a brief summary of their purpose.

    - -
    -
    -
    - -
    - - - - - - - -
    POIFS (POI Filesystem)
    -
    - -

    POIFS is the oldest and most stable part of the project. It is our port of the OLE 2 Compound Document Format to - pure Java. It supports both read and write functionality. All of our components ultimately rely on it by - definition. Please see the POIFS project page for more information.

    - -
    -
    -
    - -
    - - - - - - - -
    HSSF (Horrible Spreadsheet Format)
    -
    - -

    HSSF is our port of the Microsoft Excel 97(-2002) file format (BIFF8) to pure Java. It supports read and write - capability. Please see the HSSF project page for more information.

    - -
    -
    -
    - -
    - - - - - - - -
    HDF (Horrible Document Format)
    -
    - -

    HDF is our port of the Microsoft Word 97 file format to pure Java. It supports read and write capability. - Please see the HDF project page for more information. This component is - in the early stages of design. Jump in!

    - -
    -
    -
    - -
    - - - - - - - -
    HPSF (Horrible Property Set Format)
    -
    - -

    HPSF is our port of the OLE 2 property set format to pure - Java. Property sets are mostly use to store a document's properties - (title, author, date of last modification etc.), but they can be used - for application-specific purposes as well. Currently HPSF supports - read functionality only. Please see the HPSF project page for more - information.

    - -
    -
    -
    - - -
    -
    -
    -
    - - - - - - - -
    What happened to the HSSF Serializer?
    -
    - -

    The HSSF Serializer, which was part of our 1.0 release and last builds on - Sourceforge, has been donated to the Cocoon project. We're - currently in the process of porting it over.

    - -
    -
    -
    -
    - - - - - - - -
    Contributing
    -
    - -

    - So you'd like to contribute to the project? Great! We need enthusiastic, hard-working, talented folks to help - us on the project in several areas. The first is bug reports and feature requests! The second is documentation - - we'll be at your every beck and call if you've got a critique or you'd like to contribute or otherwise improve - the documentation. We could especially use some help documenting the HSSF file format! Last, but not least, we - could use some binary crunching Java coders to chew through the convolution that characterizes Microsoft's file - formats and help us port new ones to a superior Java platform! -

    - -

    So if you're motivated, ready, and have the time, join the mail lists and we'll be happy to help you get started on the - project! -

    - - - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/inthenews.html b/build/jakarta-poi/docs/inthenews.html deleted file mode 100644 index 6b859afe4c..0000000000 --- a/build/jakarta-poi/docs/inthenews.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -

    - -

    -     -
    - - - - - - - -
    POI in the news
    -
    - -

    - These are articles/etc. posted about POI around the web. If you - see POI in the news or mentioned at least somewhat prominently - on a site (not your homepage that you put the work POI on in - order to get us to link you and by the why here is a picture of - your wife in kids) then send a patch to the list. In general - equal time will be given so please feel free to send inflamatory - defamation as well as favorable, technical and factual. Really - stupid things won't be mentioned (sorry). -

    - -
    -
    -
    -
    - - - - - - - -
    English
    -
    - - - -
    -
    -
    -
    - - - - - - - -
    Deutsch (German)
    -
    - - - -
    -
    -
    -
    - - - - - - - -
    Español (Spanish)
    -
    - - - -
    -
    -
    -
    - - - - - - - -
    Francais (French)
    -
    - - - -
    -
    -
    -
    - - - - - - - -
    Nihongo (Japanese)
    -
    - - - - -
    -
    -
    -
    - - - - - - - -
    No freaking idea
    -
    - -

    - If you can read one of these languages, send mail to the list - telling us what language it is and we'll categorize it! -

    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/livesites.html b/build/jakarta-poi/docs/livesites.html deleted file mode 100644 index f6e4b8684b..0000000000 --- a/build/jakarta-poi/docs/livesites.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - -Live Sites using Poi - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -Live Sites using Poi - - - - - - -
    - - - - - - -
    - - - - - - -
    Live Sites using Poi
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Live Sites using Poi
    -
    - -

    Currently we don't have any sites listed that use Poi, but we're sure they're out there. - Help us change this. If you've - written a site that utilises Poi let us know. -

    - - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/mail-archives.html b/build/jakarta-poi/docs/mail-archives.html deleted file mode 100644 index 8e1916bca4..0000000000 --- a/build/jakarta-poi/docs/mail-archives.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - -Mail Archives - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -Mail Archives - - - - - - -
    - - - - - - -
    - - - - - - -
    Mail Archives
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Mailing List Archives
    -
    - -

    - There are a number of mailing list archives available. -

    - - - - - - - - - - - - - - - - - - - - - - - -
    poi-userpoi-devRegularly updated?Searchable?SpeedOther features?
    - Apache - ApacheYes???
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/mail-lists.html b/build/jakarta-poi/docs/mail-lists.html deleted file mode 100644 index 0407222193..0000000000 --- a/build/jakarta-poi/docs/mail-lists.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - -Mailing Lists - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -Mailing Lists - - - - - - -
    - - - - - - -
    - - - - - - -
    Mailing Lists
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Important Notice
    -
    - -

    -IMPORTANT: Before posting a question or problem to any mailing list, - please first look at the following resources in this order:

    - -
      - -
    1. -FAQs -
      2. - -
    2. -ODP XML links - - a wealth of general XML information.
      3. - -
    3. -Mailing list archives - - a veritable goldmine of Poi-specific information - if you know where to look!
      4. - -
    - - -

    -IMPORTANT: Careful postings please. - These are high-volume lists, so we all needs ways to help us all - work smarter. - See tips for Contributing - -

    - -
    -
    -
    -
    - - - - - - - -
    Poi Users
    -
    - -

    -Subscribe - Unsubscribe - -

    - - -

    The general list, for problems, bug reports, asking for advice on how - best to implement a site, comparisons with other frameworks, etc. - But don't forget to look in the FAQ first, please!

    - - -

    -This is also not an appropriate list for general Java questions. - Instead try news:comp.lang.java.help - or http://hotdispatch.com/, for - example.

    - - -

    -This is not an appropriate list for general XML questions. - Instead - look at the ODP for - XML/XSL links - (such as the excellent - XSL tutorial at Zvon.org) or try the - Mulberrytech XSL list.

    - - -

    -IMPORTANT: If you are posting about a problem - you are having (as most people do), it will aid in finding a - speedy resolution if you provide full configuration details - (especially the version number, but also your - operating system, JDK version, etc.), and full details of any - errors encountered (including full error messages and stack - traces).

    - - -

    Please also have some consideration for the other users on the list - this is a - busy list and we do not appreciate getting the exact same message posted impatiently - several times a day/week! Doing so is only likely to make your question answered more - slowly, or not at all, not faster.

    - -
    -
    -
    -
    - - - - - - - -
    Poi Dev
    -
    - -

    -Subscribe - Unsubscribe - -

    - - -

    This list is for developers working on or wanting to work on - Poi itself (not developers merely working with Poi), - for code patches to Poi to be posted (please use diff -u format), - and for general Poi questions.

    - - -

    Note this is NOT for general Poi questions like "Why - isn't Poi working on my machine?" - - please ask those sorts of questions on users list (after reading the - FAQ first, of course).

    - -
    -
    -
    -
    - - - - - - - -
    Related Mailing Lists
    -
    - - -

    (See also - ODP XML links for related websites.)

    - -
      - -
    • -XML Apache Projects - - list of mailing lists for all the projects on xml.apache.org.
      • - -
    • Some servlet engines have their own mailing lists for servlet-engine - configuration questions, such as - tomcat-user (note it is "user" - and not "users").
      • - -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/news/images/built-with-cocoon.gif b/build/jakarta-poi/docs/news/images/built-with-cocoon.gif deleted file mode 100644 index 0b38f7857b..0000000000 Binary files a/build/jakarta-poi/docs/news/images/built-with-cocoon.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/built-with-cocoon.png b/build/jakarta-poi/docs/news/images/built-with-cocoon.png deleted file mode 100644 index 64e25d3bbf..0000000000 Binary files a/build/jakarta-poi/docs/news/images/built-with-cocoon.png and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/header.gif b/build/jakarta-poi/docs/news/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/news/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/jakarta-logo.gif b/build/jakarta-poi/docs/news/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/news/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/krysalis-compatible.jpg b/build/jakarta-poi/docs/news/images/krysalis-compatible.jpg deleted file mode 100644 index 077f8a1179..0000000000 Binary files a/build/jakarta-poi/docs/news/images/krysalis-compatible.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/krysalis-compatible.png b/build/jakarta-poi/docs/news/images/krysalis-compatible.png deleted file mode 100644 index 589305e604..0000000000 Binary files a/build/jakarta-poi/docs/news/images/krysalis-compatible.png and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/logoGlenStampoutlzis.png b/build/jakarta-poi/docs/news/images/logoGlenStampoutlzis.png deleted file mode 100644 index f7707c7f27..0000000000 Binary files a/build/jakarta-poi/docs/news/images/logoGlenStampoutlzis.png and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/logoGustafsson1.png b/build/jakarta-poi/docs/news/images/logoGustafsson1.png deleted file mode 100644 index ff13834ff5..0000000000 Binary files a/build/jakarta-poi/docs/news/images/logoGustafsson1.png and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/logoGustafsson2.png b/build/jakarta-poi/docs/news/images/logoGustafsson2.png deleted file mode 100644 index a3f5c86d24..0000000000 Binary files a/build/jakarta-poi/docs/news/images/logoGustafsson2.png and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/logoLoicLefevre.png b/build/jakarta-poi/docs/news/images/logoLoicLefevre.png deleted file mode 100644 index 520840dff7..0000000000 Binary files a/build/jakarta-poi/docs/news/images/logoLoicLefevre.png and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/logoLoicLefevre2.png b/build/jakarta-poi/docs/news/images/logoLoicLefevre2.png deleted file mode 100644 index ce8efa3113..0000000000 Binary files a/build/jakarta-poi/docs/news/images/logoLoicLefevre2.png and /dev/null differ diff --git a/build/jakarta-poi/docs/news/images/logoMichaelMosmann.png b/build/jakarta-poi/docs/news/images/logoMichaelMosmann.png deleted file mode 100644 index 08424c7bf8..0000000000 Binary files a/build/jakarta-poi/docs/news/images/logoMichaelMosmann.png and /dev/null differ diff --git a/build/jakarta-poi/docs/news/logocontest.html b/build/jakarta-poi/docs/news/logocontest.html deleted file mode 100644 index 90d55ad755..0000000000 --- a/build/jakarta-poi/docs/news/logocontest.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -News -
    -Logo Submissions -
    -    		 -
    -    		 -

    - -

    -     -
    - - - - - - - -
    POI logos
    -
    - -

    - Here are the current logo submissions. Thanks to the artists! -

    - -
    - - - - - - - -
    Michael Mosmann
    -
    - -

    - - -

    - -
    -
    -
    - -
    - - - - - - - -
    Loïc Lefèvre
    -
    - -

    - -    - -

    - -
    -
    -
    - -
    - - - - - - - -
    Glen Stampoultzis
    -
    - -

    - - -

    - -
    -
    -
    - -
    - - - - - - - -
    Marcus Gustafsson
    -
    - -

    - -    - -

    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/overview.html b/build/jakarta-poi/docs/overview.html deleted file mode 100644 index 9af14a038b..0000000000 --- a/build/jakarta-poi/docs/overview.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - -Overview - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -Overview - - - - - - -
    - - - - - - -
    - - - - - - -
    Overview
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    What is it?
    -
    - -

    The POI project is the master project for developing pure - Java ports of file formats based on Microsoft's OLE 2 Compound - Document Format. OLE 2 Compound Document Format is used by - Microsoft Office Documents, as well as by programs using MFC - property sets to serialize their document objects. -

    - -
    -
    -
    -
    - - - - - - - -
    Sub-Projects
    -
    - -

    - There following are ports, packages or components contained in the POI project. -

    - -
    - - - - - - - -
    POIFS
    -
    - -

    - -POIFS is the set of APIs - for reading and writing OLE 2 Compound Document Formats using (only) Java. -

    - -
    -
    -
    - - -
    - - - - - - - -
    HSSF
    -
    - -

    - -HSSF is the set of APIs - for reading and writing Microsoft Excel 97(-XP) spreadsheet using (only) Java. -

    - -
    -
    -
    - - -
    - - - - - - - -
    HDF
    -
    - -

    - -HDF is the set of APIs - for reading and writing Microsoft Word 97(-XP) spreadsheet using (only) Java. -

    - -
    -
    -
    - - -
    - - - - - - - -
    HPSF
    -
    - -

    - -HPSF is the set of APIs - for reading property sets using (only) Java. -

    - -
    -
    -
    - - -
    - - - - - - - -
    POI-Utils
    -
    - -

    - -POI-Utils are general purpose artifacts - from POI development that have not yet been implemented elsewhere. We're - always looking to donate these and maintain them as part of a general library - used in another project. These are things we need to complete our mission but - are generally outside of it. -

    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/plan/POI10Vision.html b/build/jakarta-poi/docs/plan/POI10Vision.html deleted file mode 100644 index 40f7547167..0000000000 --- a/build/jakarta-poi/docs/plan/POI10Vision.html +++ /dev/null @@ -1,1142 +0,0 @@ - - - - -POI 1.0 Vision Document - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -Planning Documents -
    -1.0 Vision -
    -2.0 Vision -
    -    		 -
    -    		 -POI 1.0 Vision Document - - - - - - -
    - - - - - - -
    - - - - - - -
    POI 1.0 Vision Document
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Preface
    -
    - -

    - (21-Jan-02) While this document is just full of useful project - introductory information and I do suggest those interested in getting - involved in the project read it, it is woefully out of date. -

    - -

    - We deliberately allowed this document to run out of date because it - is a good reflection of what the original vision was for POI 1.0. - You'll note that some of the terminology is not used in quite the same - way any longer. I've made some minor corrections where reading this - confused me. An example: in some places this document may refer to - POI API instead of POIFS API. When this vision was written we had - an incomplete understanding of the project. -

    - -

    - Lastly, the scope of the project expanded dramatically near the end - of the 1.0 cycle. Our vision at the time was to focus merely on the - Excel port (having no idea how the project would grow or be received) - and provide the OLE 2 Compound Document port for others to port later - formats. We now plan to spearhead these ports under the umbrella of - the POI project. So, you've been warned. Read on, but just realize - that we had a fuzzy view of things to come, and hindsight is 20-20. -

    - -

    - If I recall major holes were: a complete understanding of the format - of OLE 2 Compound Document format, Excel file format, and exactly how - Cocoon 2 Serializers worked. (that just about covers the whole range - huh?) -

    - -
    -
    -
    -
    - - - - - - - -
    1. Introduction
    -
    - -
    - - - - - - - -
    1.1 Purpose of this document
    -
    - -

    - The purpose of this document is to - collect, analyze and define high-level requirements, user needs and - features of the HSSF Serializer for Cocoon 2 and related libraries. - The HSSF Serializer is a java class supporting the Serializer - interface from the Cocoon 2 project and outputting in a compatible - format of that used by the spreadsheet program Microsoft Excel '97. - The HSSF Serializer will be responsible for converting XML - spreadsheet-like documents into Excel-compatible XLS spreadsheets. -

    - -
    -
    -
    - - - -
    - - - - - - - -
    1.2 Project Overview
    -
    - -

    - Many web apps today hit a brick wall - when it comes to the user request that they be able to easily - manipulate their reports and data extracts in the popular Microsoft - Excel spreadsheet format. This often causes inferior technologies to be - chosen for the project simply because they easily support this - format. This project seeks to extend existing XML, Java and Apache - Cocoon 2 project technologies by: -

    - - -
      - -
    • - providing an extensible library - (POIFS) which reads/writes in a compatable format to OLE 2 Compound - Document Format (aka Structured Storage Format) for easy - implementation of other document types; -
      • - -
    • - providing a library (HSSF) for - manipulating spreadsheet data and outputting it in a compatible - format to Microsoft Excel XLS format; -
      • - -
    • - and providing a Cocoon 2 - Serializer (HSSFSerializer) for serializing XML documents as - Excel-compatible spreadsheets. -
      • - -
    - - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    2. User Description
    -
    - -
    - - - - - - - -
    2.1 User/Market Demographics
    -
    - -

    - There are a number of enthusiastic - users of XML, UNIX and Java technology. Secondly, the Microsoft - solution for outputting Office Document formats often involves - actually manipulating the software as an OLE Server. This method - provides extremely low performance, extremely high overhead and is - only capable of handling one document at a time. -

    - -
      - -
    1. - Our intended audience for the HSSF - Serializer portion of this project are developers writing reports or - data extracts in XML format. -
      2. - -
    2. - Our intended audience for the HSSF - library portion of this project is ourselves as we are developing - the Serializer and anyone who needs to write to Excel spreadsheets - in a non-XML Java environment or who has specific needs not - addressed by the Serializer. -
      3. - -
    3. - Our intended audience for the - "POIFS" OLE 2 Compound Document format reader/writer is - ourselves as we are writing the HSSF library and secondly, anyone - wishing to provide other libraries for reading/writing OLE 2 - Compound Document Format in Java. -
      4. - -
    - -
    -
    -
    - -
    - - - - - - - -
    2.2. User environment
    -
    - -

    - The users of this software shall be - developers in a Java environment on any Operating System or power - users who are capable of XML document generation/deployment. -

    - -
    -
    -
    - -
    - - - - - - - -
    2.3. Key User Needs
    -
    - -

    - The OLE 2 Compound Document format is - undocumented for all practical purposes and cryptic for all - impractical purposes. Developer needs in this area include - documentation and an easy to use library for reading and writing in - this format without requiring the developer to have intimate - knowledge of the format. -

    - -

    - There is currently no good way to write - to Microsoft Excel documents from Java or from a non-Microsoft - Windows based platform for that matter. Developers need an easy to - use library that supports a reasonable feature set and allows - seperation of data from formatting/stylistic concerns. -

    - -

    - There is currently no good way to - transform XML data to Microsoft Excel. Apache's Cocoon 2 project - supplies a complete framework for XML, but nothing for outputting in - Excel's XLS format. Developers and power users alike need a simple - method to output XML documents to Excel through server-side - processing. -

    - - - -
    -
    -
    - -
    - - - - - - - -
    2.4. Alternatives and Competition
    -
    - -

    - Originally there weren't any decent alternatives for reading or writing - to Excel. This has changed somewhat. -

    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    3. Project Overview
    -
    - -
    - - - - - - - -
    3.1. Project Perspective
    -
    - -

    - The produced code shall be licensed by - the Apache License as used by the Cocoon 2 project and maintained on - a project page until such time as the Cocoon 2 developers accept it - as a donation (at which time the copyright will be turned over to - them). -

    - -
    -
    -
    - -
    - - - - - - - -
    3.2. Project Position Statement
    -
    - -

    - For developers on a Java and/or XML - environment this project will provide all the tools necessary for - outputting XML data in the Microsoft Excel format. This project seeks - to make the use of Microsoft Windows based servers unnecessary for - file format considerations and to fully document the OLE 2 Compound - Document format. The project aims not only to provide the tools for - serializing XML to Excel's file format and the tools for writing to - that file format from Java, but also to provide the tools for later - projects to convert other OLE 2 Compound Document formats to pure - Java APIs. -

    - -
    -
    -
    - -
    - - - - - - - -
    3.3. Summary of Capabilities
    -
    - -

    - HSSF Serializer for Apache Cocoon 2 -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - Benefit - - Supporting Features -
    - Standard XML tag language for sheet data - - Serializer will transform documents utilizing a defined tag - language -
    - Utilize XML to output in Excel - - Serializer will output in Excel -
    - Java API to output in Excel on any platform - - The project will develop an API that outputs in Excel using - pure Java. -
    - Make it easy for developers to port other OLE 2 Compound - Document-based formats to Java. - - The POIFS library will contain both a high-level abstraction - along with low-level constructs. The project will fully document - the OLE 2 Compound Document Format. -
    - -
    -
    -
    - -
    - - - - - - - -
    3.4. Assumptions and Dependencies
    -
    - -
      - -
    • - The HSSF Serializer will run on - any Java 2 supporting platform with Apache Cocoon 2 installed along - with the HSSF and POIFS APIs. -
      • - -
    • - The HSSF API requires a Java 2 - implementation and the POI API. -
      • - -
    • - The POIFS API requires a Java 2 - implementation. -
      • - -
    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    4. Project Features
    -
    - -

    - The POIFS API will include: -

    - -
      - -
    • - Low level structures representing - the structures in a POI filesystems. -
      • - -
    • - A low-level API for - creating/manipulating POI filesystems. -
      • - -
    • - A set of high level interfaces - abstracting the user from the POI filesystem constructs and - representing it as a standard filesystem (Files, directories, etc) -
      • - -
    - -

    - The HSSF API will include: -

    - -
      - -
    • - Low level structures representing - the structures in an Excel file. -
      • - -
    • - A low-level API for creating and - manipulating Excel files and writing them into POI filesystems. -
      • - -
    • - A high level model and style - interface for manipulating spreadsheet data without knowing anything - about the Excel format itself. -
      • - -
    - -
    - - - - - - - -
    4.1 POI Filesystem API
    -
    - -

    - The POI Filesystem API includes: -

    - -
      - -
    • An implementation of Big Blocks
      • - -
    • An implementation of Small Blocks
      • - -
    • An implementation of Header Blocks
      • - -
    • An implementation of Block Allocation Tables
      • - -
    • An implementation of Property Sets
      • - -
    • An implementation of the POI - filesystem including functions to get and set the above constructs; - compound functions for reading/writing files/directories. -
      • - -
    • An abstraction of the POI - filesystem providing interfaces representing Files, Directories, - FileSystems in normal terminology and encapulating the above - constructs. -
      • - -
    • Full documentation of the POI file - format. -
      • - -
    • Full documentation of the APIs and - interfaces provided through Javadoc, user documentation (aimed at - developers using the APIs) -
      • - -
    • Examples aimed at teaching the - user to write code using POI. (titled: recipes for POI) -
      • - -
    • Performance specifications. - (Example POI filesystems rated by some measure of complexity along - with system specifications and execution times for given operations) -
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    4.2 HSSF API
    -
    - -

    - The HSSF API includes: -

    - -
      - -
    • An implementation of Record - (binary 2 byte type followed by 2 byte size (n) followed by n bytes)
      • - -
    • Implementations of many standard - record types mapping the data bytes to fields along with methods to - reserialize those fields
      • - -
    • An implementation of the HSSF File - including functions to get/set the above constructs, create a blank - file with the minimum required record types and mappings between - getting/setting data and style in a workbook to the creation of - record types, and read HSSF files.
      • - -
    • An abstraction of the HSSF file - format providing interfaces representing the HSSF File, HSSF - Workbook, HSSF Sheet, HSSF Column, HSSF Formulas in a manner - seperating the data from the styling and encapsulating the above - constructs.
      • - -
    • Full documentation of the HSSF - file format (which will be a subset of the Excel '97 File format). - This must be done with care for legal reasons.
      • - -
    • Full documentation of the APIs and - interfaces provided through Javadoc, user documentation (aimed at - developers using the apis).
      • - -
    • Examples aimed at teaching - developers to use the APIs. -
      • - -
    • Performance specifications. - (Example files rated by some measure of complexity along with system - specifications and execution times for given operations - possibly - the same files used for POI's tests)
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    4.3 HSSF Serializer
    -
    - -

    - The HSSF Serializer subproject: -

    - -
      - -
    • A class supporting the Cocoon 2 - Serializer Interface.
      • - -
    • An interface between the SAX - events and the HSSF APIs.
      • - -
    • A specified tag language for using - with the Serializer.
      • - -
    • Documentation on the tag language - for the HSSF Serializer
      • - -
    • Normal javadocs.
      • - -
    • Example XML files
      • - -
    • Performance specifications. - (Example XML docs and stylesheets rated by some measure of - complexity along with system specifications and execution times)
      • - -
    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    5. Other Product Requirements
    -
    - -
    - - - - - - - -
    5.1. Applicable Standards
    -
    - -

    - All Java code will be 100% pure Java. -

    - -
    -
    -
    - -
    - - - - - - - -
    5.2. System Requirements
    -
    - -

    - The minimum system requirements for POIFS are: -

    - -
      - -
    • 64 Mbytes memory
      • - -
    • Java 2 environment
      • - -
    • Pentium or better processor (or equivalent on other platforms)
      • - -
    - -

    - The minimum system requirements for HSSF are: -

    - -
      - -
    • 64 Mbytes memory
      • - -
    • Java 2 environment
      • - -
    • Pentium or better processor (or equivalent on other platforms)
      • - -
    • POIFS API
      • - -
    - -

    - The minimum system requirements for the HSSF Serializer are: -

    - -
      - -
    • 64 Mbytes memory
      • - -
    • Java 2 environment
      • - -
    • Pentium or better processor (or equivalent on other platforms)
      • - -
    • Cocoon 2
      • - -
    • HSSF API
      • - -
    • POI API
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    5.3. Performance Requirements
    -
    - -

    - All components must perform well enough - to be practical for use in a webserver environment (especially - Cocoon2/Tomcat/Apache combo) -

    - -
    -
    -
    - -
    - - - - - - - -
    5.4. Environmental Requirements
    -
    - -

    - The software will run primarily in - developer environments. We should make some allowances for - not-highly-technical users to write XML documents for the HSSF - Serializer. All other components will assume intermediate Java 2 - knowledge. No XML knowledge will be required except for using the - HSSF Serializer. As much documentation as is practical shall be - required for all components as XML is relatively new, and the - concepts introduced for writing spreadsheets and to POI filesystems - will be brand new to Java and many Java developers. -

    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    6. Documentation Requirements
    -
    - -
    - - - - - - - -
    6.1 POI Filesystem
    -
    - -

    - The filesystem as read and written by - POI shall be fully documented and explained so that the average Java - developer can understand it. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.2. POI API
    -
    - -

    - The POI API will be fully documented - through Javadoc. A walkthrough of using the high level POI API shall - be provided. No documentation outside of the Javadoc shall be - provided for the low-level POI APIs. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.3. HSSF File Format
    -
    - -

    - The HSSF File Format as implemented by - the HSSF API will be fully documented. No documentation will be - provided for features that are not supported by HSSF API that are - supported by the Excel 97 File Format. Care will be taken not to - infringe on any "legal stuff". -

    - -
    -
    -
    - -
    - - - - - - - -
    6.4. HSSF API
    -
    - -

    - The HSSF API will be documented by - javadoc. A walkthrough of using the high level HSSF API shall be - provided. No documentation outside of the Javadoc shall be provided - for the low level HSSF APIs. -

    - -
    -
    -
    - - -
    - - - - - - - -
    6.5. HSSF Serializer
    -
    - -

    - The HSSF Serializer will be documented - by javadoc. -

    - -
    -
    -
    - - -
    - - - - - - - -
    6.6 HSSF Serializer Tag language
    -
    - -

    - The XML tag language along with - function and usage shall be fully documented. Examples will be - provided as well. -

    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    7. Terminology
    -
    - -
    - - - - - - - -
    7.1 Filesystem
    -
    - -

    - filesystem shall refer only to the POI formatted archive. -

    - -
    -
    -
    - -
    - - - - - - - -
    7.2 File
    -
    - -

    - file shall refer to the embedded data stream within a - POI filesystem. This will be the actual embedded document. -

    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/plan/POI20Vision.html b/build/jakarta-poi/docs/plan/POI20Vision.html deleted file mode 100644 index aa0e1f7010..0000000000 --- a/build/jakarta-poi/docs/plan/POI20Vision.html +++ /dev/null @@ -1,1214 +0,0 @@ - - - - -POI 2.0 Vision Document - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -Planning Documents -
    -1.0 Vision -
    -2.0 Vision -
    -    		 -
    -    		 -POI 2.0 Vision Document - - - - - - -
    - - - - - - -
    - - - - - - -
    POI 2.0 Vision Document
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Preface
    -
    - -

    - This is the POI 2.0 cycle vision document. Although the vision - has not changed and this document is certainly not out of date and - the vision has not changed, the structure of the project has - changed a bit. We're not going to change the vision document to - reflect this (however proper that may be) because it would only - involve deletion. There is no purpose in providing less - information provided we give clarification. -

    - -

    - This document was created before the POI components for - Apache Cocoon - were accepted into the Cocoon project itself. It was also - written before POI was accepted into Jakarta. So while the - vision hasn't changed some of the components are actually now - part of other projects. We'll still be working on them on the - same timeline roughly (minus the overhead of coordination with - other groups), but they are no longer technically part of the - POI project itself. -

    - -
    -
    -
    -
    - - - - - - - -
    1. Introduction
    -
    - -
    - - - - - - - -
    1.1 Purpose of this document
    -
    - -

    - The purpose of this document is to - collect, analyze and define high-level requirements, user needs, - and features of the second release of the POI project software. - The POI project currently consists of the following components: - the HSSF Serializer, the HSSF library and the POIFS library. -

    - -
      - -
    • - The HSSF Serializer is a set of Java classes whose main - class supports the Serializer interface from the Cocoon - 2 project and outputs the serialized data in a format - compatible with the spreadsheet program Microsoft Excel - '97. -
      • - -
    • - The HSSF library is a set of classes for reading and - writing Microsoft Excel 97 file format using pure Java. -
      • - -
    • - The POIFS library is a set of classes for reading and - writing Microsoft's OLE 2 Compound Document format using - pure Java. -
      • - -
    - -

    By the completion of this release cycle the POI project will also - include the HSSF Generator and the HDF library. -

    - -
      - -
    • The HSSF Generator will be responsible for using HSSF to read - in the XLS (Excel 97) file format and create SAX events. The HSSF - Generator will support the applicable interfaces specified by the - Apache Cocoon 2 project. -
      • - -
    • The HDF library will provide a set of high level interfaces - for reading and writing Microsoft Word 97 file format using pure - Java.
      • - -
    - - -
    -
    -
    - - - -
    - - - - - - - -
    1.2 Project Overview
    -
    - -

    - The first release of the POI project - was an astounding success. This release seeks to build on that - success by: -

    - -
      - -
    • - Refactoring POIFS into imput and - output classes as well as an event-driven API for reading. -
      • - -
    • - Refactor HSSF for greater - performance as well as an event-driven API for reading -
      • - -
    • - Extend HSSF by adding the ability to read and write formulas. -
      • - -
    • - Extend HSSF by adding the ability to read and write - user-defined styles. -
      • - -
    • - Create a Cocoon 2 Generator for HSSF using the same tags - as the HSSF Serializer. -
      • - -
    • - Create a new library (HDF) for reading and writing - Microsoft Word DOC format. -
      • - -
    • - Refactor the HSSFSerializer into a separate extensible - POIFSSerializer and HSSFSerializer -
      • - -
    • - Providing the create excel charts. (write only) -
      • - -
    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    2. User Description
    -
    - -
    - - - - - - - -
    2.1 User/Market Demographics
    -
    - -

    - There are a number of enthusiastic - users of XML, UNIX and Java technology. Furthermore, the Microsoft - solution for outputting Office Document formats often involves - actually manipulating the software as an OLE Server. This method - provides extremely low performance, extremely high overhead and is - only capable of handing one document at a time. -

    - -
      - -
    1. - Our intended audience for the HSSF - Serializer portion of this project are developers writing reports or - data extracts in XML format. -
      2. - -
    2. - Our intended audience for the HSSF - library portion of this project is ourselves as we are developing - the HSSF serializer and anyone who needs to read and write Excel - spreadsheets in a non-XML Java environment, or who has specific - needs not addressed by the Serializer -
      3. - -
    3. - Our intended audience for the - POIFS library is ourselves as we are developing the HSSF and HDF - libraries and anyone wishing to provide other libraries for - reading/writing other file formats utilizing the OLE 2 Compound - Document Format in Java. -
      4. - -
    4. - Our intended audience for the HSSF - generator are developers who need to export Excel spreadsheets to - XML in a non-proprietary environment. -
      5. - -
    5. - Our intended audience for the HDF - library is ourselves, as we will be developing a HDF Serializer in a - later release, and anyone wishing to add .DOC file processing and - creation to their projects. -
      6. - -
    - -
    -
    -
    - -
    - - - - - - - -
    2.2. User environment
    -
    - -

    - The users of this software shall be - developers in a Java environment on any operating system, or power - users who are capable of XML document generation/deployment. -

    - -
    -
    -
    - -
    - - - - - - - -
    2.3. Key User Needs
    -
    - -

    - The HSSF library currently requires a - full object representation to be created before reading values. This - results in very high memory utilization. We need to reduce this - substantially for reading. It would be preferable to do this for - writing, but it may not be possible due to the constraints imposed by - the file format itself. Memory utilization during read is our top - user complaint. -

    - -

    - The POIFS library currently requires a - full object representation to be created before reading values. This - results in very high memory utilization. We need to reduce this - substantially for reading. -

    - -

    - The HSSF library currently ignores - formula cells and identifies them as "UnknownRecord" at the - lower level of the API. We must provide a way to read and write - formulas. This is now the top requested feature. -

    - -

    - The HSSF library currently does not support - charts. This is a key requirement of some users who wish to use HSSF - in a reporting engine. -

    - -

    - The HSSF Serializer currently does not - provide serialization for cell styling. User's will want stylish - spreadsheets to result from their XML. -

    - -

    - There is currently no way to generate - the XML from an XLS that is consistent with the format used by the - HSSF Serializer. -

    - -

    - There should be a way to read and write - the DOC file format using pure Java. -

    - - -
    -
    -
    - -
    - - - - - - - -
    2.4. Alternatives and Competition
    -
    - -

    - Originally there weren't any decent alternatives for reading or writing - to Excel. This has changed somewhat. -

    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    3. Project Overview
    -
    - -
    - - - - - - - -
    3.1. Project Perspective
    -
    - -

    - The produced code shall be licensed by - the Apache License as used by the Cocoon 2 project (APL 1.1) and - maintained on at http://poi.sourceforge.net - and http://sourcefoge.net/projects/poi. - It is our hope to at some point integrate with the various Apache - projects (xml.apache.org and jakarta.apache.org), at which point we'd - turn the copyright over to them. -

    - -
    -
    -
    - -
    - - - - - - - -
    3.2. Project Position Statement
    -
    - -

    - For developers on a Java and/or XML - environment this project will provide all the tools necessary for - outputting XML data in the Microsoft Excel format. This project seeks - to make the use of Microsoft Windows based servers unnecessary for - file format considerations and to fully document the OLE 2 Compound - Document format. The project aims not only to provide the tools for - serializing XML to Excel and Word file formats and the tools for - writing to those file formats from Java, but also to provide the - tools for later projects to convert other OLE 2 Compound Document - formats to pure Java APIs. -

    - -
    -
    -
    - -
    - - - - - - - -
    3.3. Summary of Capabilities
    -
    - -

    - HSSF Serializer for Apache Cocoon 2 -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - Benefit - - Supporting Features -
    - Ability to serialize styles from XML spreadsheets. - - HSSFSerialzier will support styles. -
    - Ability to read and write formulas in XLS files. - - HSSF will support reading/writing formulas. -
    - Ability to output in MS Word on any platform using Java. - - The project will develop an API that outputs in Word format - using pure Java. -
    - Enhance performance for reading and writing XLS files. - - HSSF will undergo a number of performance enhancements. HSSF - will include a new event-based API for reading XLS files. POIFS - will support a new event-based API for reading OLE2 CDF files. -
    - Ability to generate XML from XLS files - - The project will develop an HSSF Generator. -
    - The ability to generate charts - - HSSF will provide low level support for chart records as well - as high level API support for generating charts. The ability - to read chart information will not initially be provided. -
    - -
    -
    -
    - -
    - - - - - - - -
    3.4. Assumptions and Dependencies
    -
    - -
      - -
    • - The HSSF Serializer and Generator - will support the Gnumeric 1.0 XML tag language. -
      • - -
    • - The HSSF Generator and HSSF - Serializer will be mutually validating. It should be possible to - have an XLS file created by the Serializer run through the Generator - and the output back through the Serializer (via the Cocoon pipeline) - and get the same file or a reasonable facimille (no one cares if it - differs by the order of the binary records in some minor but - non-visually recognizable manner). -
      • - -
    • - The HSSF Generator will run on any - Java 2 supporting platform with Apache Cocoon 2 installed along with - the HSSF and POIFS APIs. -
      • - -
    • - The HSSF Serializer will run on - any Java 2 supporting platform with Apache Cocoon 2 installed along - with the HSSF and POIFS APIs. -
      • - -
    • - The HDF API requires a Java 2 - implementation and the POIFS API. -
      • - -
    • - The HSSF API requires a Java 2 - implementation and the POIFS API. -
      • - -
    • - The POIFS API requires a Java 2 - implementation. -
      • - - -
    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    4. Project Features
    -
    - -

    - Enhancements to the POIFS API will - include: -

    - -
      - -
    • - An event driven API for reading - POIFS Filesystems. -
      • - -
    • - A low-level API for - creating/manipulating POI filesystems. -
      • - -
    • - Code improvements supporting - greater separation between read and write structures. -
      • - -
    - -

    - Enhancements to the HSSF API will - include: -

    - -
      - -
    • - An event driven API for reading - XLS files. -
      • - -
    • - Performance improvements. -
      • - -
    • - Formula support (read/write) -
      • - -
    • - Support for user-defined data - formats -
      • - -
    • - Better documentation of the file - format and structure. -
      • - -
    • - An API for creation of charts. -
      • - -
    - -

    - The HSSF Generator will include: -

    - -
      - -
    • - A set of classes supporting the - Cocoon 2 Generator interfaces providing a method for reading XLS - files and outputting SAX events. -
      • - -
    • - The same tag format used by the - HSSFSerializer in any given release. -
      • - -
    - -

    - The HDF API will include: -

    - -
      - -
    • - An event driven API for reading - DOC files. -
      • - -
    • - A set of high and low level APIs - for reading and writing DOC files. -
      • - -
    • - Documentation of the DOC file - format or enhancements to existing documentation. -
      • - -
    - -
    -
    -
    -
    - - - - - - - -
    5. Other Product Requirements
    -
    - -
    - - - - - - - -
    5.1. Applicable Standards
    -
    - -

    - All Java code will be 100% pure Java. -

    - -
    -
    -
    - -
    - - - - - - - -
    5.2. System Requirements
    -
    - -

    - The minimum system requirements for the POIFS API are: -

    - -
      - -
    • 64 Mbytes memory
      • - -
    • Java 2 environment
      • - -
    • Pentium or better processor (or equivalent on other platforms)
      • - -
    - -

    - The minimum system requirements for the the HSSF API are: -

    - -
      - -
    • 64 Mbytes memory
      • - -
    • Java 2 environment
      • - -
    • Pentium or better processor (or equivalent on other platforms)
      • - -
    • POIFS API
      • - -
    - -

    - The minimum system requirements for the the HDF API are: -

    - -
      - -
    • 64 Mbytes memory
      • - -
    • Java 2 environment
      • - -
    • Pentium or better processor (or equivalent on other platforms)
      • - -
    • POIFS API
      • - -
    - - -

    - The minimum system requirements for the HSSF Serializer are: -

    - -
      - -
    • 64 Mbytes memory
      • - -
    • Java 2 environment
      • - -
    • Pentium or better processor (or equivalent on other platforms)
      • - -
    • Cocoon 2
      • - -
    • HSSF API
      • - -
    • POI API
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    5.3. Performance Requirements
    -
    - -

    - All components must perform well enough - to be practical for use in a webserver environment (especially - the "killer trio": Cocoon2/Tomcat/Apache combo) -

    - -
    -
    -
    - -
    - - - - - - - -
    5.4. Environmental Requirements
    -
    - -

    - The software will run primarily in - developer environments. We should make some allowances for - not-highly-technical users to write XML documents for the HSSF - Serializer. All other components will assume intermediate Java 2 - knowledge. No XML knowledge will be required except for using the - HSSF Serializer. As much documentation as is practical shall be - required for all components as XML is relatively new, and the - concepts introduced for writing spreadsheets and to POI filesystems - will be brand new to Java and many Java developers. -

    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    6. Documentation Requirements
    -
    - -
    - - - - - - - -
    6.1 POI Filesystem
    -
    - -

    - The filesystem as read and written by - POI shall be fully documented and explained so that the average Java - developer can understand it. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.2. POI API
    -
    - -

    - The POI API will be fully documented - through Javadoc. A walkthrough of using the high level POI API shall - be provided. No documentation outside of the Javadoc shall be - provided for the low-level POI APIs. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.3. HSSF File Format
    -
    - -

    - The HSSF File Format as implemented by - the HSSF API will be fully documented. No documentation will be - provided for features that are not supported by HSSF API that are - supported by the Excel 97 File Format. Care will be taken not to - infringe on any "legal stuff". Additionally, we are - collaborating with the fine folks at OpenOffice.org on - *free* documentation of the format. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.4. HSSF API
    -
    - -

    - The HSSF API will be documented by - javadoc. A walkthrough of using the high level HSSF API shall be - provided. No documentation outside of the Javadoc shall be provided - for the low level HSSF APIs. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.5 HDF API
    -
    - -

    - The HDF API will be documented by - javadoc. A walkthrough of using the high level HDF API shall be - provided. No documentation outside of the Javadoc shall be provided - for the low level HDF APIs. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.6 HSSF Serializer
    -
    - -

    - The HSSF Serializer will be documented - by javadoc. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.7 HSSF Generator
    -
    - -

    - The HSSF Generator will be documented - by javadoc. -

    - -
    -
    -
    - -
    - - - - - - - -
    6.8 HSSF Serializer Tag language
    -
    - -

    - The XML tag language along with - function and usage shall be fully documented. Examples will be - provided as well. -

    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    7. Terminology
    -
    - -
    - - - - - - - -
    7.1 Filesystem
    -
    - -

    - filesystem shall refer only to the POI formatted archive. -

    - -
    -
    -
    - -
    - - - - - - - -
    7.2 File
    -
    - -

    - file shall refer to the embedded data stream within a - POI filesystem. This will be the actual embedded document. -

    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/plan/images/built-with-cocoon.gif b/build/jakarta-poi/docs/plan/images/built-with-cocoon.gif deleted file mode 100644 index 0b38f7857b..0000000000 Binary files a/build/jakarta-poi/docs/plan/images/built-with-cocoon.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/plan/images/cocoon2-small.jpg b/build/jakarta-poi/docs/plan/images/cocoon2-small.jpg deleted file mode 100644 index e8f6dd8c8c..0000000000 Binary files a/build/jakarta-poi/docs/plan/images/cocoon2-small.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/plan/images/header.gif b/build/jakarta-poi/docs/plan/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/plan/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/plan/images/jakarta-logo.gif b/build/jakarta-poi/docs/plan/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/plan/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/plan/images/krysalis-compatible.jpg b/build/jakarta-poi/docs/plan/images/krysalis-compatible.jpg deleted file mode 100644 index 077f8a1179..0000000000 Binary files a/build/jakarta-poi/docs/plan/images/krysalis-compatible.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/poifs/fileformat.html b/build/jakarta-poi/docs/poifs/fileformat.html deleted file mode 100644 index ad380633f4..0000000000 --- a/build/jakarta-poi/docs/poifs/fileformat.html +++ /dev/null @@ -1,1155 +0,0 @@ - - - - - - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -How To -
    -File System Documentation -
    -Use Cases -
    -    		 -
    -    		 -

    - -

    -     -
    - - - - - - - -
    POIFS File System Internals
    -
    - -
    - - - - - - - -
    Introduction
    -
    - -

    POIFS file systems are essentially normal files stored on a - Java-compatible platform's native file system. They are - typically identified by names ending in a four character - extension noting what type of data they contain. For - example, a file ending in ".xls" would likely - contain spreadsheet data, and a file ending in - ".doc" would probably contain a word processing - document. POIFS file systems are called "file - system", because they contain multiple embedded files - in a manner similar to traditional file systems. Along - functional lines, it would be more accurate to call these - POIFS archives. For the remainder of this document it is - referred to as a file system in order to avoid confusion - with the "files" it contains.

    - -

    POIFS file systems are compatible with those document - formats used by a well-known software company's popular - office productivity suite and programs outputting - compatible data. Because the POIFS file system does not - provide compression, encryption or any other worthwhile - feature, its not a good choice unless you require - interoperability with these programs.

    - -

    The POIFS file system does not encode the documents - themselves. For example, if you had a word processor file - with the extension ".doc", you would actually - have a POIFS file system with a document file archived - inside of that file system.

    - -
    -
    -
    - -
    - - - - - - - -
    Document Conventions
    -
    - -

    This document utilizes the numeric types as described by - the Java Language Specification, which can be found at - http://java.sun.com. In - short:

    - -
      - -
    • A byte is an 8 bit signed integer ranging from - -128 to 127.
      • - -
    • A short is a 16 bit signed integer ranging from - -32768 to 32767
      • - -
    • An int is a 32 bit signed integer ranging from - -2147483648 to 2147483647
      • - -
    • A long is a 64 bit signed integer ranging from - -9.22E18 to 9.22E18.
      • - -
    - -

    The Java Language Specification spells out a number of - other types that are not referred to by this document.

    - -

    Where this document makes references to "endian - conversion" it is referring to the byte order of - stored numbers. Numbers in "little-endian order" - are stored with the least significant byte first. In - order to properly read a short, for example, you'd read two - bytes and then shift the second byte 8 bits to the left - before performing an or operation to it - against the first byte. The following code illustrates this - method:

    - -
    - - - - -
    -
    -public int getShort (byte[] rec)
-{
-    return ((rec[1] << 8) | (rec[0] & 0x00ff));
-}
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    File System Walkthrough
    -
    - -

    This is a walkthrough of a POIFS file system and how it is - put together. It is not intended to give a concise - description but to give a "big picture" of the - general structure and how it's interpreted.

    - -

    A POIFS file system begins with a header. This header - identifies locations in the file by function and provides a - sanity check identifying a file as a POIFS file system.

    - -

    The first 64 bits of the header compose a magic number - identifier. This identifier tells the client software - that this is indeed a POIFS file system and that it should - be treated as such. This is a "sanity check" to - make sure this is a POIFS file system and not some other - format. The header also contains an array of block - numbers. These block numbers refer to blocks in the - file. When these blocks are read together they form the - Block Allocation Table. The header also contains a - pointer to the first element in the property table, - also known as the root element, and a pointer to the - small Block Allocation Table (SBAT).

    - -

    The block allocation table or BAT, along with - the property table, specify which blocks in the file - system belong to which files. After the header block, the - file system is divided into identically sized blocks of - data, numbered from 0 to however many blocks there are in - the file system. For each file in the file system, its - entry in the property table includes the index of the first - block in the array of blocks. Each block's index into the - array of blocks is also its index into the BAT, and the - integer value stored at that index in the BAT gives the - index of the next block in the array (and thus the index of - the next BAT value). A special value is stored in the BAT - to indicate "end of file".

    - -

    The property table is essentially the directory - storage for the file system. It consists of the name of the - file or directory, its start block in both the file - system and BAT, and its actual size. The first - property in the property table is the root - element. It has two purposes: to be a directory entry - (the root of the directory tree, to be specific), and to - hold the start block for the small block data.

    - -

    Small block data is a special file that contains the data - for small files (less than 4K bytes). It subdivides its - blocks into smaller blocks and there is a special small - block allocation table that, like the main BAT for larger - files, is used to map a small file to its small blocks.

    - -
    -
    -
    - -
    - - - - - - - -
    Header Block
    -
    - -

    The POIFS file system begins with a header - block. The first 64 bits of the header form a long - file type id or magic number identifier of - 0xE11AB1A1E011CFD0L. This is basically a - sanity check. If this isn't the first thing in the header - (and consequently the file system) then this is not a - POIFS file system and should be read with some other - library.

    - -

    It's important to know the most important parts of the - header. These are discussed in the rest of this - section.

    - -
    - - - - - - - -
    BATs
    -
    - -

    At offset 0x2C is an int specifying the number - of elements in the BAT array. The array at - 0x4C an array of ints. This array contains the - indices of every block in the Block Allocation - Table.

    - -
    -
    -
    - -
    - - - - - - - -
    XBATs
    -
    - -

    Very large POIFS archives may have more blocks than can - be addressed by the BAT blocks enumerated in the header - block. How large? Well, the BAT array in the header can - contain up to 109 BAT block indices; each BAT block - references up to 128 blocks, and each block is 512 - bytes, so we're talking about 109 * 128 * 512 = - 6.8MB. That's a pretty respectable document! But, you - could have much more data than that, and in today's - world of cheap gigabyte drives, why not? So, the BAT - may be extended in that event. The integer value at - offset 0x44 of the header is the index of the - first extended BAT (XBAT) block. At offset - 0x48 of the header, there is an int value that - specifies how many XBAT blocks there are. The XBAT - blocks begin at the specified index into the array of - blocks making up the POIFS file system, and continue in - sequence for the specified count of XBAT blocks.

    - -

    Each XBAT block contains the indices of up to 128 BAT - blocks, so the document size can be expanded by another - 8MB for each XBAT block. The BAT blocks indexed by an - XBAT block are appended to the end of the list of BAT - blocks enumerated in the header block. Thus the BAT - blocks enumerated in the header block are BAT blocks 0 - through 108, the BAT blocks enumerated in the first - XBAT block are BAT blocks 109 through 236, the BAT - blocks enumerated in the second XBAT block are BAT - blocks 237 through 364, and so on.

    - -

    Through the use of XBAT blocks, the limit on the - overall document size is that imposed by the 4-byte - block indices; if the indices are unsigned ints, the - maximum file size is 2 terabytes, 1 terabyte if the - indices are treated as signed ints. Either way, I have - yet to see a disk drive large enough to accommodate - such a file on the shelves at the local office supply - stores.

    - -
    -
    -
    - -
    - - - - - - - -
    SBATs
    -
    - -

    If a file contained in a POIFS archive is smaller than - 4096 bytes, it is stored in small blocks. Small blocks - are 64 bytes in length and are contained within big - blocks, up to 8 to a big block. As the main BAT is used - to navigate the array of big blocks, so the small - block allocation table is used to navigate the - array of small blocks. The SBAT's start block index is - found at offset 0x3C of the header block, and - remaining blocks constituting the SBAT are found by - walking the main BAT as if it were an ordinary file in - the POIFS file system (this process is described - below).

    - -
    -
    -
    - -
    - - - - - - - -
    Property Table Start Index
    -
    - -

    An integer at address 0x30 specifies the start - index of the property table. This integer is specified - as a "block index". The Property Table - is stored, as is almost everything in a POIFS file - system, in big blocks and walked via the BAT. The - Property Table is described below.

    - -
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    Property Table
    -
    - -

    The property table is essentially nothing more than the - directory system. Properties are 128 byte records - contained within the 512 byte blocks. The first property - is always the Root Entry. The following applies to - individual properties within a property table:

    - -
      - -
    • At offset 0x00 in the property is the - "name". This is stored as an - uncompressed 16 bit unicode string. In short every - other byte corresponds to an "ASCII" - character. The size of this string is stored at offset - 0x40 (string size) as a short.
      • - -
    • At offset 0x42 is the property type - (byte). The type is 1 for directory, 2 for file or 5 - for the Root Entry.
      • - -
    • At offset 0x43 is the node color - (byte). The color is either 1, (black), or 0, - (red). Properties are apparently meant to be arranged - in a red-black binary tree, subject to the following - rules: -
        - -
      1. The root of the tree is always black
        2. - -
      2. Two consecutive nodes cannot both be red
        3. - -
      3. A property is less than another property if its - name length is less than the other property's name - length
        4. - -
      4. If two properties have the same name length, the - sort order is determined by the sort order of the - properties' names.
        5. - -
      -
      • - -
    • At offset 0x44 is the index (int) of the - previous property.
      • - -
    • At offset 0x48 is the index (int) of the - next property.
      • - -
    • At offset 0x4C is the index (int) of the - first directory entry. This is used by - directory entries.
      • - -
    • At offset 0x74 is an integer giving the - start block for the file described by this - property. This index corresponds to an index in the - array of indices that is the Block Allocation Table - (or the Small Block Allocation Table) as well as the - index of the first block in the file. This is used by - files and the root entry.
      • - -
    • At offset 0x78 is an integer giving the total - actual size of the file pointed at by this - property. If the file size is less than 4096, the file - is stored in small blocks and the SBAT is used to walk - the small blocks making up the file. If the file size - is 4096 or larger, the file is stored in big blocks - and the main BAT is used to walk the big blocks making - up the file. The exception to this rule is the Root - Entry, which, regardless of its size, is - always stored in big blocks and the main BAT is - used to walk the big blocks making up this special - file.
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    Root Entry
    -
    - -

    The Root Entry in the Property Table - contains the information necessary to read and write - small files, which are files less than 4096 bytes - long. The start block field of the Root Entry is the - start index of the Small Block Array, which is - read like any other file in the POIFS file system. Since - the SBAT cannot be used without the Small Block Array, - the Root Entry MUST be read or written using the Block - Allocation Table. The blocks making up the Small - Block Array are divided into 64-byte small blocks, up to - the size indicated in the Root Entry (which should always - be a multiple of 64).

    - -
    -
    -
    - -
    - - - - - - - -
    Walking the Nodes of the Property Table
    -
    - -

    The individual properties form a directory tree, with the - Root Entry as the directory tree's root, as shown - in the accompanying drawing. Note the numbers in - parentheses in each node; they represent the node's index - in the array of properties. The NEXT_PROP, - PREVIOUS_PROP, and CHILD_PROP fields hold - these indices, and are used to navigate the tree.

    - - -

    Each directory entry (i.e., a property whose type is - directory or root entry) uses its - CHILD_PROP field to point to one of its - subordinate (child) properties. It doesn't seem to matter - which of its children it points to. Thus in the previous - drawing, the Root Entry's CHILD_PROP field may contain 1, - 4, or the index of one of its other children. Similarly, - the directory node (index 1) may have, in its CHILD_PROP - field, 2, 3, or the index of one of its other - children.

    - -

    The children of a given directory property point to each - other in a similar fashion by using their - NEXT_PROP and PREVIOUS_PROP fields.

    - -

    Unused NEXT_PROP, PREVIOUS_PROP, and - CHILD_PROP fields contain the marker value of - -1. All file properties have a value of -1 for their - CHILD_PROP fields for example.

    - -
    -
    -
    - -
    - - - - - - - -
    Block Allocation Table
    -
    - -

    The BAT blocks are pointed at by the bat array - contained in the header and supplemented, if necessary, - by the XBAT blocks. These blocks form a large - table of integers. These integers are block numbers. The - Block Allocation Table holds chains of integers. - These chains are terminated with -2. The elements in - these chains refer to blocks in the files. The starting - block of a file is NOT specified in the BAT. It is - specified by the property for a given file. The - elements in this BAT are both the block number (within - the file minus the header) and the number of the - next BAT element in the chain. This can be thought of as - a linked list of blocks. The BAT array contains the links - from one block to the next, including the end of chain - marker.

    - -

    Here's an example: Let's assume that the BAT begins as - follows:

    - -

    -BAT[ 0 ] = 2 -

    - -

    -BAT[ 1 ] = 5 -

    - -

    -BAT[ 2 ] = 3 -

    - -

    -BAT[ 3 ] = 4 -

    - -

    -BAT[ 4 ] = 6 -

    - -

    -BAT[ 5 ] = -2 -

    - -

    -BAT[ 6 ] = 7 -

    - -

    -BAT[ 7 ] = -2 -

    - -

    -... -

    - -

    Now, if we have a file whose Property Table entry says it - begins with index 0, we walk the BAT array and see that - the file consists of blocks 0 (because the start block is - 0), 2 (because BAT[ 0 ] is 2), 3 (BAT[ 2 ] is 3), 4 (BAT[ - 3 ] is 4), 6 (BAT[ 4 ] is 6), and 7 (BAT[ 6 ] is 7). It - ends at block 7 because BAT[ 7 ] is -2, which is the end - of chain marker.

    - -

    Similarly, a file beginning at index 1 consists of - blocks 1 and 5.

    - -

    Other special numbers in a BAT array are:

    - -
      - -
    • -1, which indicates an unused block
      • - -
    • -3, which indicates a "special" block, such - as a block used to make up the Small Block Array, the - Property Table, the main BAT, or the SBAT
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    File System Structures
    -
    - -

    The following outlines the basic file system structures.

    - -
    - - - - - - - -
    Header (block 1) -- 512 (0x200) bytes
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionOffsetLengthDefault value or const
    FILETYPEMagic number identifying this as a POIFS file - system.0x0000Long0xE11AB1A1E011CFD0
    UK1Unknown constant0x0008Integer0
    UK2Unknown Constant0x000CInteger0
    UK3Unknown Constant0x0014Integer0
    UK4Unknown Constant (revision?)0x0018Short0x003B
    UK5Unknown Constant (version?)0x001AShort0x0003
    UK6Unknown Constant0x001CShort-2
    LOG_2_BIG_BLOCK_SIZELog, base 2, of the big block size0x001EShort9 (2 ^ 9 = 512 bytes)
    LOG_2_SMALL_BLOCK_SIZELog, base 2, of the small block size0x0020Integer6 (2 ^ 6 = 64 bytes)
    UK7Unknown Constant0x0024Integer0
    UK8Unknown Constant0x0028Integer0
    BAT_COUNTNumber of elements in the BAT array0x002CIntegerrequired
    PROPERTIES_STARTBlock index of the first block of the property - table0x0030Integerrequired
    UK9Unknown Constant0x0034Integer0
    UK10Unknown Constant0x0038Integer0x00001000
    SBAT_STARTBlock index of first big block containing the small - block allocation table (SBAT)0x003CInteger-2
    UK11Unknown Constant0x0040Integer1
    XBAT_STARTBlock index of the first block in the Extended Block - Allocation Table (XBAT)0x0044Integer-2
    XBAT_COUNTNumber of elements in the Extended Block Allocation - Table (to be added to the BAT)0x0048Integer0
    BAT_ARRAYArray of block indices constituting the Block - Allocation Table (BAT)0x004C, 0x0050, 0x0054 ... 0x01FCInteger[]-1 for unused elements, at least first element must - be filled.
    N/AHeader block data not otherwise described in this - tableN/AN/A-1
    - -
    -
    -
    - -
    - - - - - - - -
    Block Allocation Table Block -- 512 (0x200) bytes
    -
    - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionOffsetLengthDefault value or const
    BAT_ELEMENTAny given element in the BAT block0x0000, 0x0004, 0x0008, ... 0x01FCInteger - -
      - -
    • -1 = unused
      • - -
    • -2 = end of chain
      • - -
    • -3 = special (e.g., BAT block)
      • - -
    - -

    All other values point to the next element in the - chain and the next index of a block composing the - file.

    - -
    - -
    -
    -
    - -
    - - - - - - - -
    Property Block -- 512 (0x200) byte block
    -
    - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionOffsetLengthDefault value or const
    Properties[]This block contains the properties.0x0000, 0x0080, 0x0100, 0x0180128 bytesAll unused space is set to -1.
    - -
    -
    -
    - -
    - - - - - - - -
    Property -- 128 (0x80) byte block
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescriptionOffsetLengthDefault value or const
    NAMEA unicode null-terminated uncompressed 16bit string - (lose the high bytes) containing the name of the - property.0x00, 0x02, 0x04, ... 0x3EShort[]0x0000 for unused elements, field required, 32 - (0x40) element max
    NAME_SIZENumber of characters in the NAME field0x40ShortRequired
    PROPERTY_TYPEProperty type (directory, file, or root)0x42Byte1 (directory), 2 (file), or 5 (root entry)
    NODE_COLORNode color0x43Byte0 (red) or 1 (black)
    PREVIOUS_PROPPrevious property index0x44Integer-1
    NEXT_PROPNext property index0x48Integer-1
    CHILD_PROPFirst child property index0x4cInteger-1
    SECONDS_1Seconds component of the created timestamp?0x64Integer0
    DAYS_1Days component of the created timestamp?0x68Integer0
    SECONDS_2Seconds component of the modified timestamp?0x6CInteger0
    DAYS_2Days component of the modified timestamp?0x70Integer0
    START_BLOCKStarting block of the file, used as the first block - in the file and the pointer to the next block from - the BAT0x74IntegerRequired
    SIZEActual size of the file this property points - to. (used to truncate the blocks to the real - size).0x78Integer0
    - -
    -
    -
    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/poifs/how-to.html b/build/jakarta-poi/docs/poifs/how-to.html deleted file mode 100644 index 3db863416f..0000000000 --- a/build/jakarta-poi/docs/poifs/how-to.html +++ /dev/null @@ -1,1018 +0,0 @@ - - - - - - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -How To -
    -File System Documentation -
    -Use Cases -
    -    		 -
    -    		 -

    - -

    -     -
    - - - - - - - -
    How To Use the POIFS APIs
    -
    - -

    This document describes how to use the POIFS APIs to read, write, and modify files that employ a POIFS-compatible data structure to organize their content.

    - -
    - - - - - - - -
    Revision History
    -
    - -
      - -
    • 02.10.2002 - completely rewritten from original documents on sourceforge -
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    Target Audience
    -
    - -

    This document is intended for Java developers who need to use the POIFS APIs to read, write, or modify files that employ a POIFS-compatible data structure to organize their content. It is not necessary for developers to understand the POIFS data structures, and an explanation of those data structures is beyond the scope of this document. It is expected that the members of the target audience will understand the rudiments of a hierarchical file system, and familiarity with the event pattern employed by Java APIs such as AWT would be helpful.

    - -
    -
    -
    - -
    - - - - - - - -
    Glossary
    -
    - -

    This document attempts to be consistent in its terminology, which is defined here:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TermDefinition
    DirectoryA special file that may contain other directories and documents.
    DirectoryEntryRepresentation of a directory within another directory.
    DocumentA file containing data, such as word processing data or a spreadsheet workbook.
    DocumentEntryRepresentation of a document within a directory.
    EntryRepresentation of a file in a directory.
    FileA named entity, managed and contained by the file system.
    File SystemThe POIFS data structures, plus the contained directories and documents, which are maintained in a hierarchical directory structure.
    Root DirectoryThe directory at the base of a file system. All file systems have a root directory. The POIFS APIs will not allow the root directory to be removed or renamed, but it can be accessed for the purpose of reading its contents or adding files (directories and documents) to it.
    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    Reading a File System
    -
    - -

    This section covers reading a file system. There are two ways to read a file system; these techniques are sketched out in the following table, and then explained in greater depth in the sections following the table.

    - - - - - - - - - - - - - - - - - - - - - - - -
    TechniqueAdvantagesDisadvantages
    Conventional Reading - -
      - -
    • Simpler API similar to reading a conventional file system.
      • - -
    • Can read documents in any order.
      • - -
    - -    		 - -
      - -
    • All files are resident in memory, whether your application needs them or not.
      • - -
    - -
    Event-Driven Reading - -
      - -
    • Reduced footprint -- only the documents you care about are processed.
      • - -
    • Improved performance -- no time is wasted reading the documents you're not interested in.
      • - -
    - -    		 - -
      - -
    • More complicated API.
      • - -
    • Need to know in advance which documents you want to read.
      • - -
    • No control over the order in which the documents are read.
      • - -
    • No way to go back and get additional documents except to re-read the file system, which may not be possible, e.g., if the file system is being read from an input stream that lacks random access support.
      • - -
    - -
    - -
    - - - - - - - -
    Conventional Reading
    -
    - -

    In this technique for reading, the entire file system is loaded into memory, and the entire directory tree can be walked by an application, reading specific documents at the application's leisure.

    - -
    - - - - - - - -
    Preparation
    -
    - -

    Before an application can read a file from the file system, the file system needs to be loaded into memory. This is done by using the org.apache.poi.poifs.filesystem.POIFSFileSystem class. Once the file system has been loaded into memory, the application may need the root directory. The following code fragment will accomplish this preparation stage:

    - -
    - - - - -
    -
    -// need an open InputStream; for a file-based system, this would be appropriate:
-// InputStream stream = new FileInputStream(fileName);
-POIFSFileSystem fs;
-try
-{
-    fs = new POIFSFileSystem(inputStream);
-}
-catch (IOException e)
-{
-    // an I/O error occurred, or the InputStream did not provide a compatible
-    // POIFS data structure
-}
-DirectoryEntry root = fs.getRoot();
    -
    -
    - -

    Assuming no exception was thrown, the file system can then be read.

    - -

    Note: loading the file system can take noticeable time, particularly for large file systems.

    - -
    -
    -
    - -
    - - - - - - - -
    Reading the Directory Tree
    -
    - -

    Once the file system has been loaded into memory and the root directory has been obtained, the root directory can be read. The following code fragment shows how to read the entries in an org.apache.poi.poifs.filesystem.DirectoryEntry instance:

    - -
    - - - - -
    -
    -// dir is an instance of DirectoryEntry ...
-for (Iterator iter = dir.getEntries(); iter.hasNext(); )
-{
-    Entry entry = (Entry)iter.next();
-    System.out.println("found entry: " + entry.getName());
-    if (entry instanceof DirectoryEntry)
-    {
-        // .. recurse into this directory
-    }
-    else if (entry instanceof DocumentEntry)
-    {
-        // entry is a document, which you can read
-    }
-    else
-    {
-        // currently, either an Entry is a DirectoryEntry or a DocumentEntry,
-	// but in the future, there may be other entry subinterfaces. The
-	// internal data structure certainly allows for a lot more entry types.
-    }
-}
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    Reading a Specific Document
    -
    - -

    There are a couple of ways to read a document, depending on whether the document resides in the root directory or in another directory. Either way, you will obtain an org.apache.poi.poifs.filesystem.DocumentInputStream instance.

    - -
    - - - - - - - -
    DocumentInputStream
    -
    - -

    The DocumentInputStream class is a simple implementation of InputStream that makes a few guarantees worth noting:

    - -
      - -
    • -available() always returns the number of bytes in the document from your current position in the document.
      • - -
    • -markSupported() returns true.
      • - -
    • -mark(int limit) ignores the limit parameter; basically the method marks the current position in the document.
      • - -
    • -reset() takes you back to the position when mark() was last called, or to the beginning of the document if mark() has not been called.
      • - -
    • -skip(long n) will take you to your current position + n (but not past the end of the document).
      • - -
    - -

    The behavior of available means you can read in a document in a single read call like this:

    - -
    - - - - -
    -
    -byte[] content = new byte[ stream.available() ];
-stream.read(content);
-stream.close();
    -
    -
    - -

    The combination of mark, reset, and skip provide the basic mechanisms needed for random access of the document contents.

    - -
    -
    -
    - -
    - - - - - - - -
    Reading a Document From the Root Directory
    -
    - -

    If the document resides in the root directory, you can obtain a DocumentInputStream like this:

    - -
    - - - - -
    -
    -// load file system
-try
-{
-    DocumentInputStream stream = filesystem.createDocumentInputStream(documentName);
-    // process data from stream
-}
-catch (IOException e)
-{
-    // no such document, or the Entry represented by documentName is not a
-    // DocumentEntry
-}
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    Reading a Document From an Arbitrary Directory
    -
    - -

    A more generic technique for reading a document is to obtain an org.apache.poi.poifs.filesystem.DirectoryEntry instance for the directory containing the desired document (recall that you can use getRoot() to obtain the root directory from its file system). From that DirectoryEntry, you can then obtain a DocumentInputStream like this:

    - -
    - - - - -
    -
    -DocumentEntry document = (DocumentEntry)directory.getEntry(documentName);
-DocumentInputStream stream = new DocumentInputStream(document);
-
    -
    -
    - -
    -
    -
    - -
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    Event-Driven Reading
    -
    - -

    The event-driven API for reading documents is a little more complicated and requires that your application know, in advance, which files it wants to read. The benefit of using this API is that each document is in memory just long enough for your application to read it, and documents that you never read at all are not in memory at all. When you're finished reading the documents you wanted, the file system has no data structures associated with it at all and can be discarded.

    - -
    - - - - - - - -
    Preparation
    -
    - -

    The preparation phase involves creating an instance of org.apache.poi.poifs.eventfilesystem.POIFSReader and to then register one or more org.apache.poi.poifs.eventfilesystem.POIFSReaderListener instances with the POIFSReader.

    - -
    - - - - -
    -
    -POIFSReader reader = new POIFSReader();
-// register for everything
-reader.registerListener(myOmnivorousListener);
-// register for selective files
-reader.registerListener(myPickyListener, "foo");
-reader.registerListener(myPickyListener, "bar");
-// register for selective files
-reader.registerListener(myOtherPickyListener, new POIFSDocumentPath(),
-     "fubar");
-reader.registerListener(myOtherPickyListener, new POIFSDocumentPath(
-    new String[] { "usr", "bin" ), "fubar");
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    POIFSReaderListener
    -
    - -

    -org.apache.poi.poifs.eventfilesystem.POIFSReaderListener is an interface used to register for documents. When a matching document is read by the org.apache.poi.poifs.eventfilesystem.POIFSReader, the POIFSReaderListener instance receives an org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent instance, which contains an open DocumentInputStream and information about the document.

    - -

    A POIFSReaderListener instance can register for individual documents, or it can register for all documents; once it has registered for all documents, subsequent (and previous!) registration requests for individual documents are ignored. There is no way to unregister a POIFSReaderListener.

    - -

    Thus, it is possible to register a single POIFSReaderListener for multiple documents - one, some, or all documents. It is guaranteed that a single POIFSReaderListener will receive exactly one notification per registered document. There is no guarantee as to the order in which it will receive notification of its documents, as future implementations of POIFSReader are free to change the algorithm for walking the file system's directory structure.

    - -

    It is also permitted to register more than one POIFSReaderListener for the same document. There is no guarantee of ordering for notification of POIFSReaderListener instances that have registered for the same document when POIFSReader processes that document.

    - -

    It is guaranteed that all notifications occur in the same thread. A future enhancement may be made to provide multi-threaded notifications, but such an enhancement would very probably be made in a new reader class, a ThreadedPOIFSReader perhaps.

    - -

    The following table describes the three ways to register a POIFSReaderListener for a document or set of documents:

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Method SignatureWhat it does
    registerListener(POIFSReaderListener listener)registers listener for all documents.
    registerListener(POIFSReaderListener listener, String name)registers listener for a document with the specified name in the root directory.
    registerListener(POIFSReaderListener listener, POIFSDocumentPath path, String name)registers listener for a document with the specified name in the directory described by path
    - -
    -
    -
    - -
    - - - - - - - -
    POIFSDocumentPath
    -
    - -

    The org.apache.poi.poifs.filesystem.POIFSDocumentPath class is used to describe a directory in a POIFS file system. Since there are no reserved characters in the name of a file in a POIFS file system, a more traditional string-based solution for describing a directory, with special characters delimiting the components of the directory name, is not feasible. The constructors for the class are used as follows:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Constructor exampleDirectory described
    new POIFSDocumentPath()The root directory.
    new POIFSDocumentPath(null)The root directory.
    new POIFSDocumentPath(new String[ 0 ])The root directory.
    new POIFSDocumentPath(new String[ ] { "foo", "bar"} )in Unix terminology, "/foo/bar".
    new POIFSDocumentPath(new POIFSDocumentPath(new String[] { "foo" }), new String[ ] { "fu", "bar"} )in Unix terminology, "/foo/fu/bar".
    - -
    -
    -
    - -
    - - - - - - - -
    Processing POIFSReaderEvent Events
    -
    - -

    Processing org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent events is relatively easy. After all of the POIFSReaderListener instances have been registered with POIFSReader, the POIFSReader.read(InputStream stream) method is called.

    - -

    Assuming that there are no problems with the data, as the POIFSReader processes the documents in the specified InputStream's data, it calls registered POIFSReaderListener instances' processPOIFSReaderEvent method with a POIFSReaderEvent instance.

    - -

    The POIFSReaderEvent instance contains information to identify the document (a POIFSDocumentPath object to identify the directory that the document is in, and the document name), and an open DocumentInputStream instance from which to read the document.

    - -
    -
    -
    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    Writing a File System
    -
    - -

    Writing a file system is very much like reading a file system in that there are multiple ways to do so. You can load an existing file system into memory and modify it (removing files, renaming files) and/or add new files to it, and write it, or you can start with a new, empty file system:

    - -
    - - - - -
    -
    -POIFSFileSystem fs = new POIFSFileSystem();
    -
    -
    - -
    - - - - - - - -
    The Naming of Names
    -
    - -

    There are two restrictions on the names of files in a file system that must be considered when creating files:

    - -
      - -
    1. The name of the file must not exceed 31 characters. If it does, the POIFS API will silently truncate the name to fit.
      2. - -
    2. The name of the file must be unique within its containing directory. This seems pretty obvious, but if it isn't spelled out, there'll be hell to pay, to be sure. Uniqueness, of course, is determined after the name has been truncated, if the original name was too long to begin with.
      3. - -
    - -
    -
    -
    - -
    - - - - - - - -
    Creating a Document
    -
    - -

    A document can be created by acquiring a DirectoryEntry and calling one of the two createDocument methods:

    - - - - - - - - - - - - - - - - - - - - - - - -
    Method SignatureAdvantagesDisadvantages
    CreateDocument(String name, InputStream stream) - -
      - -
    • Simple API.
      • - -
    - -    		 - -
      - -
    • Increased memory footprint (document is in memory until file system is written).
      • - -
    - -
    CreateDocument(String name, int size, POIFSWriterListener writer) - -
      - -
    • Decreased memory footprint (only very small documents are held in memory, and then only for a short time).
      • - -
    - -    		 - -
      - -
    • More complex API.
      • - -
    • Determining document size in advance may be difficult.
      • - -
    • Lose control over when document is to be written.
      • - -
    - -
    - -

    Unlike reading, you don't have to choose between the in-memory and event-driven writing models; both can co-exist in the same file system.

    - -

    Writing is initiated when the POIFSFileSystem instance's writeFilesystem() method is called with an OutputStream to write to.

    - -

    The event-driven model is quite similar to the event-driven model for reading, in that the file system calls your org.apache.poi.poifs.filesystem.POIFSWriterListener when it's time to write your document, just as the POIFSReader calls your POIFSReaderListener when it's time to read your document. Internally, when writeFilesystem() is called, the final POIFS data structures are created and are written to the specified OutputStream. When the file system needs to write a document out that was created with the event-driven model, it calls the POIFSWriterListener back, calling its processPOIFSWriterEvent() method, passing an org.apache.poi.poifs.filesystem.POIFSWriterEvent instance. This object contains the POIFSDocumentPath and name of the document, its size, and an open org.apache.poi.poifs.filesystem.DocumentOutputStream to which to write. A DocumentOutputStream is a wrapper over the OutputStream that was provided to the POIFSFileSystem to write to, and has the responsibility of making sure that the document your application writes fits within the size you specified for it.

    - -
    -
    -
    - -
    - - - - - - - -
    Creating a Directory
    -
    - -

    Creating a directory is similar to creating a document, except that there's only one way to do so:

    - -
    - - - - -
    -
    -DirectoryEntry createdDir = existingDir.createDirectory(name);
    -
    -
    - -
    -
    -
    - -
    - - - - - - - -
    Using POIFSFileSystem Directly To Create a Document Or Directory
    -
    - -

    As with reading documents, it is possible to create a new document or directory in the root directory by using convenience methods of POIFSFileSystem.

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    DirectoryEntry Method SignaturePOIFSFileSystem Method Signature
    createDocument(String name, InputStream stream)createDocument(InputStream stream, String name)
    createDocument(String name, int size, POIFSWriterListener writer)createDocument(String name, int size, POIFSWriterListener writer)
    createDirectory(String name)createDirectory(String name)
    - -
    -
    -
    - -
    -
    -
    -
    - - - - - - - -
    Modifying a File System
    -
    - -

    It is possible to modify an existing POIFS file system, whether it's one your application has loaded into memory, or one which you are creating on the fly.

    - -
    - - - - - - - -
    Removing a Document
    -
    - -

    Removing a document is simple: you get the Entry corresponding to the document and call its delete() method. This is a boolean method, but should always return true, indicating that the operation succeeded.

    - -
    -
    -
    - -
    - - - - - - - -
    Removing a Directory
    -
    - -

    Removing a directory is also simple: you get the Entry corresponding to the directory and call its delete() method. This is a boolean method, but, unlike deleting a document, may not always return true, indicating that the operation succeeded. Here are the reasons why the operation may fail:

    - -
      - -
    • The directory still has files in it (to check, call isEmpty() on its DirectoryEntry; is the return value false?)
      • - -
    • The directory is the root directory. You cannot remove the root directory.
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    Renaming a File
    -
    - -

    Regardless of whether the file is a directory or a document, it can be renamed, with one exception - the root directory has a special name that is expected by the components of a major software vendor's office suite, and the POIFS API will not let that name be changed. Renaming is done by acquiring the file's corresponding Entry instance and calling its renameTo method, passing in the new name.

    - -

    Like delete, renameTo returns true if the operation succeeded, otherwise false. Reasons for failure include these:

    - -
      - -
    • The new name is the same as another file in the same directory. And don't forget - if the new name is longer than 31 characters, it will be silently truncated. In its original length, the new name may have been unique, but truncated to 31 characters, it may not be unique any longer.
      • - -
    • You tried to rename the root directory.
      • - -
    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/poifs/images/PropertySet.jpg b/build/jakarta-poi/docs/poifs/images/PropertySet.jpg deleted file mode 100644 index c0d1461020..0000000000 Binary files a/build/jakarta-poi/docs/poifs/images/PropertySet.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/poifs/images/built-with-cocoon.gif b/build/jakarta-poi/docs/poifs/images/built-with-cocoon.gif deleted file mode 100644 index 0b38f7857b..0000000000 Binary files a/build/jakarta-poi/docs/poifs/images/built-with-cocoon.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/poifs/images/cocoon2-small.jpg b/build/jakarta-poi/docs/poifs/images/cocoon2-small.jpg deleted file mode 100644 index e8f6dd8c8c..0000000000 Binary files a/build/jakarta-poi/docs/poifs/images/cocoon2-small.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/poifs/images/header.gif b/build/jakarta-poi/docs/poifs/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/poifs/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/poifs/images/jakarta-logo.gif b/build/jakarta-poi/docs/poifs/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/poifs/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/poifs/images/krysalis-compatible.jpg b/build/jakarta-poi/docs/poifs/images/krysalis-compatible.jpg deleted file mode 100644 index 077f8a1179..0000000000 Binary files a/build/jakarta-poi/docs/poifs/images/krysalis-compatible.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/poifs/index.html b/build/jakarta-poi/docs/poifs/index.html deleted file mode 100644 index 9abadb0748..0000000000 --- a/build/jakarta-poi/docs/poifs/index.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - -PoiFS - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -How To -
    -File System Documentation -
    -Use Cases -
    -    		 -
    -    		 -PoiFS - - - - - - -
    - - - - - - -
    - - - - - - -
    PoiFS
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Overview
    -
    - -

    POIFS is a pure Java implementation of the OLE 2 Compound - Document format.

    - -

    By definition, all APIs developed by the POI project are - based somehow on the POIFS API.

    - -

    A common confusion is on just what POIFS buys you or what OLE - 2 Compound Document format is exactly. POIFS does not buy you - DOC, or XLS, but is necessary to generate or read DOC or XLS - files. You see, all file formats based on the OLE 2 Compound - Document Format have a common structure. The OLE 2 Compound - Document Format is essentially a convoluted archive - format. Think of POIFS as a "zip" library. Once you can get - the data in a zip file you still need to interpret the - data. As a general rule, while all of our formats use - POIFS, most of them attempt to abstract you from it. There - are some circumstances where this is not possible, but as a - general rule this is true.

    - -

    If you're an end user type just looking to generate XLS - files, then you'd be looking for HSSF not POIFS; however, if - you have legacy code that uses MFC property sets, POIFS is - for you! Regardless, you may or may not need to know how to - use POIFS but ultimately if you use technologies that come - from the POI project, you're using POIFS underneith. Perhaps - we should have a branding campaign "POIFS Inside!". ;-)

    - -

    TODO: copy POIFS docs and port to XML (in progress). For now - please reference old - site.

    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/poifs/usecases.html b/build/jakarta-poi/docs/poifs/usecases.html deleted file mode 100644 index 942914ec66..0000000000 --- a/build/jakarta-poi/docs/poifs/usecases.html +++ /dev/null @@ -1,1266 +0,0 @@ - - - - - - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -How To -
    -File System Documentation -
    -Use Cases -
    -    		 -
    -    		 -

    - -

    -     -
    - - - - - - - -
    POIFS Use Cases
    -
    - -
    - - - - - - - -
    Use Case 1: Read existing file system
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to read content of file - system
      • - -
    • POIFS - understands POIFS file system
      • - -
    - -
    Precondition:None
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. POIFS client requests POIFS to read a POIFS file - system, providing an InputStream - containing POIFS file system in question.
      2. - -
    2. POIFS reads from the InputStream in - 512 byte blocks
      3. - -
    3. POIFS verifies that the first block begins with - the well known signature - (0xE11AB1A1E011CFD0)
      4. - -
    4. POIFS reads the Block Allocation Table from the - first block and, if necessary, from the XBAT - blocks.
      5. - -
    5. POIFS obtains the start block of the Property - Table and reads the Property Table (use case 9, - read file)
      6. - -
    6. POIFS reads the individual entries in the Property - Table
      7. - -
    7. POIFS obtains the start block of the Small Block - Allocation Table and reads the Small Block - Allocation Table (use case 9, read file)
      8. - -
    8. POIFS obtains the start block of the Small Block - store from the first entry in the Property Table - and reads the Small Block Array (use case 9, read - file)
      9. - -
    - -
    Extensions: - -
      - -
    • 2a. If the last block read is not a 512 byte - block, the InputStream is not that of - a POIFS file system, and POIFS throws an - appropriate exception.
      • - -
    • 3a. If the signature is incorrect, the - InputStream is not that of a POIFS - file system, and POIFS throws an appropriate - exception.
      • - -
    - -
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 2: Write file system
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to write file system out.
      • - -
    • POIFS - knows how to write file system out.
      • - -
    - -
    Precondition: - -
      - -
    • File system has been read (use case 1, read - existing file system) and subsequently modified - (use case 4, replace file in file system; use case - 5, delete file from file system; or use case 6, - write new file to file system; in any - combination)
      • - -
    - -

    or

    - -
      - -
    • File system has been created (use case 3, create - new file system)
      • - -
    - -
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. POIFS client provides an OutputStream - to write the file system to.
      2. - -
    2. POIFS gets the sizes of the Property Table and - each file in the file system.
      3. - -
    3. If any files in the file system requires storage - in a Small Block Array, POIFS creates a Small - Block Array of sufficient size to hold all of the - small files.
      4. - -
    4. POIFS calculates the number of big blocks needed - to hold all of the large files, the Property - Table, and, if necessary, the Small Block Array - and the Small Block Allocation Table.
      5. - -
    5. POIFS creates a set of big blocks sufficient to - store the Block Allocation Table
      6. - -
    6. POIFS creates and writes the header block
      7. - -
    7. POIFS writes out the XBAT blocks, if needed.
      8. - -
    8. POIFS writes out the Small Block Array, if - needed
      9. - -
    9. POIFS writes out the Small Block Allocation Table, - if needed
      10. - -
    10. POIFS writes out the Property Table
      11. - -
    11. POIFS writes out the large files, if needed
      12. - -
    12. POIFS closes the OutputStream.
      13. - -
    - -
    Extensions: - -
      - -
    • 6a. Exceptions writing to the - OutputStream will be propagated back - to the POIFS client.
      • - -
    • 7a. Exceptions writing to the - OutputStream will be propagated back - to the POIFS client.
      • - -
    • 8a. Exceptions writing to the - OutputStream will be propagated back - to the POIFS client.
      • - -
    • 9a. Exceptions writing to the - OutputStream will be propagated back - to the POIFS client.
      • - -
    • 10a. Exceptions writing to the - OutputStream will be propagated back - to the POIFS client.
      • - -
    • 11a. Exceptions writing to the - OutputStream will be propagated back - to the POIFS client.
      • - -
    • 12a. Exceptions closing the - OutputStream will be propagated back - to the POIFS client.
      • - -
    - -
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 3: Create new file system
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to create a new file - system
      • - -
    • POIFS - knows how to create a new file system
      • - -
    - -
    Precondition:None
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. POIFS creates an empty Property Table.
      2. - -
    - -
    Extensions:None
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 4: Replace file in file system
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to replace an existing file in - the file system
      • - -
    • POIFS - knows how to manage the file system
      • - -
    - -
    Precondition: - -

    Either

    - -
      - -
    • The file system has been read (use case 1, read - existing file system) and a file has been - extracted from the file system (use case 7, read - existing file from file system)
      • - -
    - -

    or

    - -
      - -
    • The file system has been created (use case 3, - create new file system) and a file has been - written to the file system (use case 6, write new - file to file system)
      • - -
    - -
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. POIFS discards storage of the existing file.
      2. - -
    2. POIFS updates the existing file's entry in the - Property Table
      3. - -
    3. POIFS stores the new file's data
      4. - -
    - -
    Extensions: - -
      - -
    • 1a. POIFS throws an exception if the file does not - exist.
      • - -
    - -
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 5: Delete file from file system
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to remove a file from a file - system
      • - -
    • POIFS - knows how to manage the file system
      • - -
    - -
    Precondition: - -

    Either

    - -
      - -
    • The file system has been read (use case 1, read - existing file system) and a file has been - extracted from the file system (use case 7, read - existing file from file system)
      • - -
    - -

    or

    - -
      - -
    • The file system has been created (use case 3, - create new file system) and a file has been - written to the file system (use case 6, write new - file to file system)
      • - -
    - -
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. POIFS discards the specified file's storage.
      2. - -
    2. POIFS discards the file's Property Table - entry.
      3. - -
    - -
    Extensions: - -
      - -
    • 1a. POIFS throws an exception if the file does not - exist.
      • - -
    - -
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 6: Write new file to file system
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to add a new file to the file - system
      • - -
    • POIFS - knows how to manage the file system
      • - -
    - -
    Precondition:The specified file does not yet exist in the file - system
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. The POIFS client provides a file name
      2. - -
    2. POIFS creates a new Property Table entry for the - new file
      3. - -
    3. POIFS provides the POIFS client with an - OutputStream to write to.
      4. - -
    4. The POIFS client writes data to the provided - OutputStream.
      5. - -
    5. The POIFS client closes the provided - OutputStream -
      6. - -
    6. POIFS updates the Property Table entry with the - new file's size
      7. - -
    - -
    Extensions: - -
      - -
    • 1a. POIFS throws an exception if a file with the - specified name already exists in the file - system.
      • - -
    • 1b. POIFS throws an exception if the file name is - too long. The limit on file name length is 31 - characters.
      • - -
    - -
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 7: Read existing file from file system
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to read a file from the file - system
      • - -
    • POIFS - knows how to manage the file system
      • - -
    - -
    Precondition: - -
      - -
    • The file system has been read (use case 1, read - existing file system) or has been created and - written to (use case 3, create new file system; - use case 6, write new file to file system).
      • - -
    • The specified file exists in the file system.
      • - -
    - -
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. The POIFS client provides the name of a file to be - read
      2. - -
    2. POIFS provides an InputStream to read - from.
      3. - -
    3. The POIFS client reads from the - InputStream.
      4. - -
    4. The POIFS client closes the - InputStream.
      5. - -
    - -
    Extensions:1a. POIFS throws an exception if no file with the - specified name exists.
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 8: Read file system directory
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to know what files exist in - the file system
      • - -
    • POIFS - knows how to manage the file system
      • - -
    - -
    Precondition:The file system has been read (use case 1, read - existing file system) or created (use case 3, create - new file system)
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. The POIFS client requests the file system - directory.
      2. - -
    2. POIFS returns an Iterator. The - Iterator will not include the root - entry in the Property Table, and may be an - Iterator over an empty - Collection.
      3. - -
    - -
    Extensions:None
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 9: Read file
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS - POIFS needs to read a file, or something - resembling a file (i.e., the Property Table, the - Small Block Array, or the Small Block Allocation - Table)
      • - -
    - -
    Precondition:None
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. POIFS begins with a start block, a file size, and - a flag indicating whether to use the Big Block - Allocation Table or the Small Block Allocation - Table
      2. - -
    2. POIFS returns an InputStream.
      3. - -
    3. Reads from the InputStream are - performed by walking the specified Block - Allocation Table and reading the blocks - indicated.
      4. - -
    4. POIFS closes the InputStream when - finished reading the file, or its client wants to - close the InputStream.
      5. - -
    - -
    Extensions:3a. An exception will be thrown if the specified Block - Allocation Table is corrupt, as evidenced by an index - pointing to a non-existent block, or by a chain - extending past the known size of the file.
    - -
    -
    -
    - -
    - - - - - - - -
    Use Case 10: Rename existing file in the file system
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Primary Actor:POIFS client
    Scope:POIFS
    Level:Summary
    Stakeholders and Interests: - -
      - -
    • POIFS client- wants to rename an existing file in - the file system.
      • - -
    • POIFS - knows how to manage the file system.
      • - -
    - -
    Precondition: - -
      - -
    • The file system is has been read (use case 1, read - existing file system) or has been created and - written to (use case 3, create new file system; - use case 6, write new file to file system.
      • - -
    • The specified file exists in the file system.
      • - -
    • The new name for the file does not duplicate - another file in the file system.
      • - -
    - -
    Minimal Guarantee:None
    Main Success Guarantee: - -
      - -
    1. POIFS updates the Property Table entry for the - specified file with its new name.
      2. - -
    - -
    Extensions: - -
      - -
    • 1a. If the old file name is not in the file - system, POIFS throws an exception.
      • - -
    • 1b. If the new file name already exists in the - file system, POIFS throws an exception.
      • - -
    • 1c. If the new file name is too long (the limit is - 31 characters), POIFS throws an exception.
      • - -
    - -
    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/resolutions/images/built-with-cocoon.gif b/build/jakarta-poi/docs/resolutions/images/built-with-cocoon.gif deleted file mode 100644 index 0b38f7857b..0000000000 Binary files a/build/jakarta-poi/docs/resolutions/images/built-with-cocoon.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/resolutions/images/cocoon2-small.jpg b/build/jakarta-poi/docs/resolutions/images/cocoon2-small.jpg deleted file mode 100644 index e8f6dd8c8c..0000000000 Binary files a/build/jakarta-poi/docs/resolutions/images/cocoon2-small.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/resolutions/images/header.gif b/build/jakarta-poi/docs/resolutions/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/resolutions/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/resolutions/images/jakarta-logo.gif b/build/jakarta-poi/docs/resolutions/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/resolutions/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/resolutions/images/krysalis-compatible.jpg b/build/jakarta-poi/docs/resolutions/images/krysalis-compatible.jpg deleted file mode 100644 index 077f8a1179..0000000000 Binary files a/build/jakarta-poi/docs/resolutions/images/krysalis-compatible.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/resolutions/index.html b/build/jakarta-poi/docs/resolutions/index.html deleted file mode 100644 index 30fc185523..0000000000 --- a/build/jakarta-poi/docs/resolutions/index.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - -Resolutons - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -About -
    -About -
    -
    -Resolutions -
    -Coding Standards -
    -    		 -
    -    		 -Resolutons - - - - - - -
    - - - - - - -
    - - - - - - -
    Resolutons
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    About Resolutions
    -
    - -

    - Every project on Jakarta has resolutions that they vote on. - Decisions are made, etc. But what happens once those decisions - are made? They are archived in the mail list archive never to - be read again (once its not in the top 10 or so posts). So they - get discussed again and again. -

    - -

    - Rather than have that big waste of time, we have this section to - record important POI decisions. Once a decision is passed it - need only be linked to this page (either by creating a page for - it or by simply linking it to the archive messages). Wherever - possible a brief about how many votes for and against an maybe - some background should be posted. -

    - -

    - This section is intended mainly to reduce big waste of time - discussions from taking away from whats important...developing - POI! :-D -

    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/resolutions/res001.html b/build/jakarta-poi/docs/resolutions/res001.html deleted file mode 100644 index 9e0c8260bf..0000000000 --- a/build/jakarta-poi/docs/resolutions/res001.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - -POI Resoluton - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -
    -About -
    -About -
    -
    -Resolutions -
    -Coding Standards -
    -    		 -
    -    		 -POI Resoluton - - - - - - -
    - - - - - - -
    - - - - - - -
    POI Resoluton
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Resolution 001 - Minimal Coding Standards
    -
    - -
    - - - - - - - -
    Majority Position
    -
    - -

    - As the POI project has grown the "styles" used have become more - varied, some see this as a bad thing, but in reality it - can be a good thing. Each can learn from the different - styles by working with different code. That being said - there are some universal "good quality" guidelines that - must be adopted on a project of any proportions. -

    - -

    - Marc Johnson Authored the following resolution: -

    - -

    - On Tue, 2002-01-08 at 22:23, Marc Johnson wrote: - Standards are wonderful; everyone should have a set. - Here's what I propose for coding standards for POI WRT comments (should I - feel the need, I'll post more of these little gems): -

    - -
      - -
    1. - All classes and interfaces MUST have, right at the beginning, the POI - License (see poi/doc/LICENSE). -
      2. - -
    2. - All classes and interfaces MUST include class javadoc. Conventionally, - this goes after the package and imports, and before the start of the class - or interface. The class javadoc MUST have at least one @author tag -
      3. - -
    3. - All methods that are accessible outside the class MUST have javadoc - comments. In other words, if it isn't private, it MUST have javadoc - comments. Simple getters can consist of a simple @return tag; simple setters - can consist of a simple @param tag. Anything else requires some verbiage - plus all the standard javadoc tags as appropriate. You MUST include @throws - or @exception for any non-runtime exceptions, and you SHOULD document any - runtime exceptions you expect to throw. @throws/@exception tags SHOULD - include an explanation of why that exception would be thrown. If your method - might return null, you MUST say so. An accompanying explanation of the - circumstances for doing so would be nice. -
      4. - -
    - -
    -
    -
    - -
    - - - - - - - -
    Amendments (informal by extension and not by vote)
    -
    - -

    - As opposed to the formerly used POI License which was - based on the Apache Public License, now that POI is part of - Jakarta, use the APL 1.1 for the header. Currently, the - Apache Software Foundation requires us to use the full - long version. -

    - -
    -
    -
    - -
    - - - - - - - -
    Dissent
    -
    - -

    - The motion was passed unanimously with no negative or - positive votes. -

    - -
    -
    -
    - -
    - - - - - - - -
    Comments
    -
    - -

    - Andy didn't feel like going through his mail and sucking - out the comments.. If there is anything you feel should - be added here do it yourself ;-). -

    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/todo.html b/build/jakarta-poi/docs/todo.html deleted file mode 100644 index 97fd01ee4e..0000000000 --- a/build/jakarta-poi/docs/todo.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - -Things To Do for Poi - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -Things To Do for Poi - - - - - - -
    - - - - - - -
    - - - - - - -
    Things To Do for Poi
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    high
    -
    - -
  • -[code] - Finish HDF -
    • -
  • -[code] - Finish Charts -
    • -
  • -[code] - Add Formulas. -
    • -     -
    -
    -
    -
    - - - - - - - -
    medium
    -
    - -
  • -[code] - Expose functionality in low level records in higher level API -
    • -
  • -[code] - Implement more record types (for other things ... not sure - what this will mean yet). -
    • -
  • -[code] - Implement more record types (for other things ... not sure - what this will mean yet). -
    • -
  • -[code] - Add more dummy checks (for when API user's do things they - "can't" do) -
    • -
  • -[code] - Add support for embedded graphics and stuff like that. -
    • -
  • -[code] - Create new adapter object for handling MulBlank, MulRk, Rk - records. -
    • -     -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/utils/images/built-with-cocoon.gif b/build/jakarta-poi/docs/utils/images/built-with-cocoon.gif deleted file mode 100644 index 0b38f7857b..0000000000 Binary files a/build/jakarta-poi/docs/utils/images/built-with-cocoon.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/utils/images/cocoon2-small.jpg b/build/jakarta-poi/docs/utils/images/cocoon2-small.jpg deleted file mode 100644 index e8f6dd8c8c..0000000000 Binary files a/build/jakarta-poi/docs/utils/images/cocoon2-small.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/utils/images/header.gif b/build/jakarta-poi/docs/utils/images/header.gif deleted file mode 100644 index b9c2ee1391..0000000000 Binary files a/build/jakarta-poi/docs/utils/images/header.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/utils/images/jakarta-logo.gif b/build/jakarta-poi/docs/utils/images/jakarta-logo.gif deleted file mode 100644 index 82baef3abe..0000000000 Binary files a/build/jakarta-poi/docs/utils/images/jakarta-logo.gif and /dev/null differ diff --git a/build/jakarta-poi/docs/utils/images/krysalis-compatible.jpg b/build/jakarta-poi/docs/utils/images/krysalis-compatible.jpg deleted file mode 100644 index 077f8a1179..0000000000 Binary files a/build/jakarta-poi/docs/utils/images/krysalis-compatible.jpg and /dev/null differ diff --git a/build/jakarta-poi/docs/utils/index.html b/build/jakarta-poi/docs/utils/index.html deleted file mode 100644 index d3c3aea563..0000000000 --- a/build/jakarta-poi/docs/utils/index.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - -Poi Utils - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -Navigation -
    -Main -
    -    		 -
    -    		 -Poi Utils - - - - - - -
    - - - - - - -
    - - - - - - -
    Poi Utils
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Overview
    -
    - - -

    The POI Utils are classes we're looking to donate elsewhere and include. - These are usually classes that while are required for our mission, - are somehow outside of it. General utilities that could be used in - any project are what we would normally put here. If you see one, and you - think "gee that would be great as part of X project" then let us know. - While we wish to put these in their rightful place, we also don't want to - include a 40mb jar file just to process text strings, so that will - be a consideraton. -

    - -

    - Currently, we're looking into which subprojects in the Jakarta Commons project - to donate these too. The "Poi Utils" package won't go away, as there may - be later classes. The idea is that "go ahead and add it, we'll merge it or - find an alternative later, just keep pounding out that poi!" -

    - - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - - diff --git a/build/jakarta-poi/docs/who.html b/build/jakarta-poi/docs/who.html deleted file mode 100644 index 44885e2c87..0000000000 --- a/build/jakarta-poi/docs/who.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - -Who we are - - - - - - - - - - - - - -
    www.apache.org >jakarta.apache.org >jakarta.apache.org/poi
    - - - - -
    -
    -    		 -
    -About -
    -Index -
    -History -
    -Future -
    -Download -
    -1.0 Vision -
    -2.0 Vision -
    -Who we are -
    -Changes -
    -FAQ -
    -
    -Sub-Projects -
    -Overview -
    -POIFS -
    -HSSF -
    -HDF -
    -HPSF -
    -POI-Utils -
    -
    -References -
    -In The News -
    -Live Sites -
    -XLS spec [PDF] -
    -Apache Cocoon -
    -Resolutions -
    -
    -Get Involved -
    -Contributing -
    -Bug Database -
    -CVS -
    -Mail Lists -
    -    		 -
    -    		 -Who we are - - - - - - -
    - - - - - - -
    - - - - - - -
    Who we are
    -
    -
    - -

    - -

    -     -
    - - - - - - - -
    Who we are
    -
    - -

    - The Poi Project operates on a meritocracy: the more you do, the more - responsibility you will obtain. This page lists all of the people who have - gone the extra mile and are Committers. If you would like to get involved, - the first step is to join the mailing lists. -

    - - -

    - We ask that you please do not send us emails privately asking for support. - We are non-paid volunteers who help out with the project and we do not - necessarily have the time or energy to help people on an individual basis. - Instead, we have set up mailing lists which often contain hundreds of - individuals who will help answer detailed requests for help. The benefit of - using mailing lists over private communication is that it is a shared - resource where others can also learn from common mistakes and as a - community we all grow together. -

    - - -
    - - - - - - - -
    Advisors
    -
    - - - -
    -
    -
    - - -
    - - - - - - - -
    Committers
    -
    - -
      - -
    • -Andrew C. Oliver (acoliver at apache dot org)
      • - -
    • -Marc Johnson (mjohnson at apache dot org)
      • - -
    • Glen Stampoultzis (glens at apache.org)
      • - -
    • -Rainer Klute (klute at apache dot org)
      • - -
    • Nicola Ken Barozzi (barozzi at nicolaken dot com)
      • - -
    - -
    -
    -
    - -
    - - - - - - - -
    Developers
    -
    - -
      - -
    • Ryan Ackley (sackley at cfl dot rr dot com)
      • - -
    - -
    -
    -
    - -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    Copyright © 2002 Apache Software Foundation
    -
    -
    Krysalis LogoCocoon Logo
    - -