]> source.dussan.org Git - poi.git/commitdiff
PR:
authorAndrew C. Oliver <acoliver@apache.org>
Fri, 22 Feb 2002 04:28:55 +0000 (04:28 +0000)
committerAndrew C. Oliver <acoliver@apache.org>
Fri, 22 Feb 2002 04:28:55 +0000 (04:28 +0000)
Obtained from:
Submitted by:
Reviewed by:
added stuff from the klute-meister

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352112 13f79535-47bb-0310-9956-ffa450edef68

src/contrib/src/org/apache/poi/contrib/poibrowser/POIBrowser.java
src/contrib/src/org/apache/poi/contrib/poibrowser/TreeReaderListener.java
src/documentation/xdocs/book.xml
src/documentation/xdocs/hpsf/book.xml [new file with mode: 0644]
src/documentation/xdocs/hpsf/how-to.xml [new file with mode: 0644]
src/documentation/xdocs/hpsf/index.xml [new file with mode: 0644]
src/documentation/xdocs/hpsf/internals.xml [new file with mode: 0644]
src/documentation/xdocs/index.xml
src/documentation/xdocs/overview.xml
src/documentation/xdocs/who.xml

index 1eb18783ccc73c46bc0a613f8b674f2a6381f2c7..90ccf3c6941a52ffdaf8d637585a73ebc1a319e8 100644 (file)
@@ -110,7 +110,7 @@ public class POIBrowser extends JFrame
         /* Create the tree model with a root node. The latter is
          * invisible but it must be present because a tree model
          * always needs a root. */
-        rootNode = new DefaultMutableTreeNode("POIFS");
+        rootNode = new DefaultMutableTreeNode("POI Filesystems");
         DefaultTreeModel treeModel = new DefaultTreeModel(rootNode);
 
         /* Create the tree UI element. */
@@ -118,6 +118,7 @@ public class POIBrowser extends JFrame
         getContentPane().add(new JScrollPane(treeUI));
 
         /* Add the POI filesystems to the tree. */
+        int displayedFiles = 0;
         for (int i = 0; i < args.length; i++)
         {
             final String filename = args[i];
@@ -126,6 +127,7 @@ public class POIBrowser extends JFrame
                 POIFSReader r = new POIFSReader();
                 r.registerListener(new TreeReaderListener(filename, rootNode));
                 r.read(new FileInputStream(filename));
+                displayedFiles++;
             }
             catch (IOException ex)
             {
@@ -139,6 +141,14 @@ public class POIBrowser extends JFrame
             }
         }
 
+        /* Exit if there is no file to display (none specified or only
+         * files with problems). */
+        if (displayedFiles == 0)
+        {
+            System.out.println("No POI filesystem(s) to display.");
+            System.exit(0);
+        }
+
         /* Make the tree UI element visible. */
         treeUI.setRootVisible(true);
         treeUI.setShowsRootHandles(true);
@@ -149,7 +159,7 @@ public class POIBrowser extends JFrame
                       new PropertySetDescriptorRenderer());
         treeUI.setCellRenderer(etcr);
         setSize(600, 450);
-       setTitle("POI Browser 0.10");
+        setTitle("POI Browser 0.06");
         setVisible(true);
     }
 
index 124c595b6005533de04df61eb0289956bc0446c9..bcb237ea9be7ae5e5d231e8636d4f8408e1c6958 100644 (file)
@@ -134,7 +134,7 @@ public class TreeReaderListener implements POIFSReaderListener
     {
         this.filename = filename;
         this.rootNode = rootNode;
-        pathToNode = new HashMap(15);
+        pathToNode = new HashMap(15); // Should be a reasonable guess.
     }
 
 
index 02756a5527c80a5a0d37a3bc3a2e8a9dea249fa1..cff2077fcc15acb7190eb2ec19aae1e0e678875d 100644 (file)
@@ -27,6 +27,7 @@
     <menu-item label="POIFS" href="poifs/index.html"/>
     <menu-item label="HSSF" href="hssf/index.html"/>
     <menu-item label="HDF" href="hdf/index.html"/>
+    <menu-item label="HPSF" href="hpsf/index.html"/>
     <menu-item label="POI-Utils" href="utils/index.html"/>
   </menu>
 
diff --git a/src/documentation/xdocs/hpsf/book.xml b/src/documentation/xdocs/hpsf/book.xml
new file mode 100644 (file)
index 0000000..2af0755
--- /dev/null
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "../dtd/book-cocoon-v10.dtd">
+
+<book software="POI Project" 
+      title="HPSF" 
+      copyright="@year@ POI Project">
+
+  <menu label="Navigation">
+    <menu-item label="Main" href="../index.html"/>
+    <menu-item label="How To" href="how-to.html"/>
+    <menu-item label="Internals" href="internals.html"/>
+  </menu>
+
+</book>
+
+
diff --git a/src/documentation/xdocs/hpsf/how-to.xml b/src/documentation/xdocs/hpsf/how-to.xml
new file mode 100644 (file)
index 0000000..4436b14
--- /dev/null
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../dtd/document-v10.dtd"> 
+<document>
+  <header>
+    <title>HPSF HOW-TO</title>
+    <authors>
+      <person name="Rainer Klute" email="klute@rainer-klute.de"/>
+    </authors>
+  </header>
+  <body>
+    <s1 title="How To Use the HPSF APIs">
+      <p class="todo">TODO: This documentation is still to be written. For the
+       time being, please see the API documentation (javadocs) of the
+       <code>org.apache.poi.hpsf</code> package.</p>
+    </s1>
+  </body>
+</document>
diff --git a/src/documentation/xdocs/hpsf/index.xml b/src/documentation/xdocs/hpsf/index.xml
new file mode 100644 (file)
index 0000000..91d6166
--- /dev/null
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../dtd/document-v10.dtd">
+<document>
+  <header>
+    <title>HPSF (Horrible Property Set Format)</title>
+    <subtitle>Overview</subtitle>
+    <authors>     
+      <person name="Rainer Klute" email="klute@rainer-klute.de"/>
+    </authors>
+  </header>
+  <body>
+    <s1 title="Overview">
+      <p class="todo">TODO: This documentation is still to be written.</p>
+    </s1>
+  </body>
+</document>
diff --git a/src/documentation/xdocs/hpsf/internals.xml b/src/documentation/xdocs/hpsf/internals.xml
new file mode 100644 (file)
index 0000000..37602d0
--- /dev/null
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../dtd/document-v10.dtd"> 
+<document>
+  <header>
+    <title>HPSF Internals</title>
+    <authors>
+      <person name="Rainer Klute" email="klute@rainer-klute.de"/>
+    </authors>
+  </header>
+  <body>
+    <s1 title="HPSF Internals">
+      <p class="todo">TODO: This documentation is still to be written. For the
+       time being, please see <link
+         href="http://www.rainer-klute.de/~klute/Software/poibrowser/doc/HPSF-Description.html">http://www.rainer-klute.de/~klute/Software/poibrowser/doc/HPSF-Description.html</link>.</p>
+    </s1>
+  </body>
+</document>
index e7430573d063978de57dbad8408df4ec47855041..0f0f68553388d8cf4b43204259d6b79974932198 100644 (file)
@@ -27,7 +27,7 @@
          XLS format; and <link href="http://jakarta.apache.org/lucene">Lucene</link> for which we'll soon have file 
          format interpretors.  When practical, we donate components directly to those projects for POI-enabling them.
       </p>
-      <s2 title="Why/when would I use POI">
+      <s2 title="Why/when would I use POI?">
         <p>
                We'll tackle this on a component level. POI refers to the whole project.
         </p> 
 
     <s1 title="Components To Date">
         <s2 title="Overview">
-             A common misconception is that POI writes Excel files.  POI is the name of the project.  POI contains several
+            <p>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.
+             and a brief summary of their purpose.</p>
         </s2>
-        <s2 title="POIFS">
-             POIFS is the oldest and most stable part of the project.  It is our port of the OLE 2 Compound Document Format to
+        <s2 title="POIFS (POI Filesystem)">
+             <p>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 <link href="./poifs/index.html">the POIFS project page</link> for more information.
+             definition.  Please see <link href="./poifs/index.html">the POIFS project page</link> for more information.</p>
         </s2>
-        <s2 title="HSSF">
-             HSSF is our port of the Microsoft Excel 97(-2002) file format (BIFF8) to pure Java.  It supports read and write 
-             capability.  Please see <link href="./hssf/index.html">the HSSF project page</link> for more information.
+        <s2 title="HSSF (Horrible Spreadsheet Format)">
+             <p>HSSF is our port of the Microsoft Excel 97(-2002) file format (BIFF8) to pure Java.  It supports read and write 
+             capability.  Please see <link href="./hssf/index.html">the HSSF project page</link> for more information.</p>
         </s2>
-        <s2 title="HDF">
-             HDF is our port of the Microsoft Word 97 file format to pure Java.  It supports read and write capability.
+        <s2 title="HDF (Horrible Document Format)">
+             <p>HDF is our port of the Microsoft Word 97 file format to pure Java.  It supports read and write capability.
              Please see <link href="./hdf/index.html">the HDF project page for more information</link>.  This component is 
-             in the early stages of design.  Jump in!
+             in the early stages of design.  Jump in!</p>
+        </s2>
+        <s2 title="HPSF (Horrible Property Set Format)">
+       <p>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 <link
+           href="./hpsf/index.html">the HPSF project page</link> for more
+         information.</p>
         </s2>
 
      </s1>
 
     <s1 title="What happened to the HSSF Serializer?">
-       The HSSF Serializer, which was part of our 1.0 release and last builds on 
+       <p>The HSSF Serializer, which was part of our 1.0 release and last builds on 
         <link href="http://www.sourceforge.net/projects/poi">Sourceforge</link>, has been donated to the Cocoon project.  We're
-        currently in the process of porting it over.
-    </s1> 
+        currently in the process of porting it over.</p>
+    </s1>
 
     <s1 title="Contributing ">
         <p>
index 42ec4aedba01bd84951e4ca389a4a8d19b39e5c2..951985e6e46178b51833e5cf518d6f641e3a6139 100644 (file)
         </p>
       </s2>
 
+      <s2 title="HPSF">
+        <p>
+          <link href="hpsf/index.html">HPSF</link> is the set of APIs 
+          for reading property sets using (only) Java.
+        </p> 
+      </s2>
+
       <s2 title="POI-Utils">
         <p>
           <link href="utils/index.html">POI-Utils</link> are general purpose artifacts
index 250bbb77b420ce8edbe63c819c6072fc60602ac6..8b4b87c176d8a5c06c03b7f947accd27473e533e 100644 (file)
@@ -48,6 +48,7 @@
     <ul>
       <li>Glen Stampoultzis (glens at apache.org)</li>
       <li>Nicola Ken Barozzi (barozzi at nicolaken dot com)</li>
+      <li>Rainer Klute (klute at rainer-klute dot de)</li>
     </ul>
   </s2>
  </s1>