svn commit: r615683 - /lenya/trunk/src/modules/resource/java/src/org/apache/lenya/modules/resource/PdfToTextGenerator.java

Author: andreas
Date: Sun Jan 27 16:09:37 2008
New Revision: 615683

URL: http://svn.apache.org/viewvc?rev=615683&view=rev
Log:
Added javadocs for PdfToTextGenerator

Modified:
    lenya/trunk/src/modules/resource/java/src/org/apache/lenya/modules/resource/PdfToTextGenerator.java

Modified: lenya/trunk/src/modules/resource/java/src/org/apache/lenya/modules/resource/PdfToTextGenerator.java
URL: http://svn.apache.org/viewvc/lenya/trunk/src/modules/resource/java/src/org/apache/lenya/modules/resource/PdfToTextGenerator.java?rev=615683&r1=615682&r2=615683&view=diff
==============================================================================
--- lenya/trunk/src/modules/resource/java/src/org/apache/lenya/modules/resource/PdfToTextGenerator.java (original)
+++ lenya/trunk/src/modules/resource/java/src/org/apache/lenya/modules/resource/PdfToTextGenerator.java Sun Jan 27 16:09:37 2008
@@ -31,10 +31,25 @@
 import org.xml.sax.SAXException;
 import org.xml.sax.helpers.AttributesImpl;
 
+/**
+ * <p>
+ * Generate an XML document from a PDF document. The XMl document is of the form
+ * </p>
+ * <pre>
+ *   &lt;pdf:document xmlns:pdf="http://apache.org/lenya/pdf/1.0"&gt;
+ *     (text of the PDF document)
+ *   &lt;/pdf:document&gt;
+ * </pre>
+ * <p>Parameters:</p>
+ * <ul>
+ * <li><em>src</em>: The URI to read the PDF document from.</li>
+ * </ul>
+ */
 public class PdfToTextGenerator extends AbstractGenerator {
 
-    private static final String PREFIX = "pdf";
-    private static final String NAMESPACE = "http://apache.org/lenya/pdf/1.0";
+    protected static final String PREFIX = "pdf";
+    protected static final String NAMESPACE = "http://apache.org/lenya/pdf/1.0";
+    
     private ContentHolder content;
 
     public void setup(SourceResolver resolver, Map objectModel, String src, Parameters par)