You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by gm...@apache.org on 2004/06/20 14:35:17 UTC
cvs commit: xml-fop/src/java/org/apache/fop/tools/anttasks Fop.java
gmazza 2004/06/20 05:35:17
Modified: examples/embedding/java/embedding ExampleDOM2PDF.java
ExampleFO2PDF.java ExampleObj2PDF.java
ExampleXML2PDF.java
src/documentation/content/xdocs embedding.xml
src/java/org/apache/fop/apps CommandLineOptions.java
Driver.java Fop.java
src/java/org/apache/fop/render AbstractRenderer.java
src/java/org/apache/fop/servlet FopPrintServlet.java
FopServlet.java
src/java/org/apache/fop/tools/anttasks Fop.java
Log:
1.) Removed the get/setLogger methods from Driver, obsolete with Commons-Logging.
2.) Updated examples and documentation.
3.) Added a -v option to show version of FOP being used.
Revision Changes Path
1.7 +4 -12 xml-fop/examples/embedding/java/embedding/ExampleDOM2PDF.java
Index: ExampleDOM2PDF.java
===================================================================
RCS file: /home/cvs/xml-fop/examples/embedding/java/embedding/ExampleDOM2PDF.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ExampleDOM2PDF.java 14 Apr 2004 22:57:10 -0000 1.6
+++ ExampleDOM2PDF.java 20 Jun 2004 12:35:17 -0000 1.7
@@ -18,12 +18,10 @@
package embedding;
-//Java
+// Java
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
-
-//JAXP
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.DocumentBuilder;
@@ -33,10 +31,7 @@
import org.w3c.dom.Node;
import org.w3c.dom.Text;
-// Commons-Logging
-import org.apache.commons.logging.impl.SimpleLog;
-
-//FOP
+// FOP
import org.apache.fop.apps.Driver;
import org.apache.fop.apps.FOPException;
@@ -61,10 +56,7 @@
// Construct driver
Driver driver = new Driver();
- // Setup logger
- SimpleLog logger = new SimpleLog("log");
- logger.setLevel(SimpleLog.LOG_LEVEL_INFO);
- driver.setLogger(logger);
+ // Setup driver
driver.initialize();
// Setup Renderer (output format)
1.7 +4 -10 xml-fop/examples/embedding/java/embedding/ExampleFO2PDF.java
Index: ExampleFO2PDF.java
===================================================================
RCS file: /home/cvs/xml-fop/examples/embedding/java/embedding/ExampleFO2PDF.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ExampleFO2PDF.java 14 Apr 2004 22:57:10 -0000 1.6
+++ ExampleFO2PDF.java 20 Jun 2004 12:35:17 -0000 1.7
@@ -18,19 +18,16 @@
package embedding;
-//Java
+// Java
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
-//SAX
+// SAX
import org.xml.sax.InputSource;
-// Commons-Logging
-import org.apache.commons.logging.impl.SimpleLog;
-
-//FOP
+// FOP
import org.apache.fop.apps.Driver;
import org.apache.fop.apps.FOPException;
@@ -51,10 +48,7 @@
// Construct driver
Driver driver = new Driver();
- // Setup logger
- SimpleLog logger = new SimpleLog("log");
- logger.setLevel(SimpleLog.LOG_LEVEL_INFO);
- driver.setLogger(logger);
+ // Setup driver
driver.initialize();
// Setup Renderer (output format)
1.7 +4 -11 xml-fop/examples/embedding/java/embedding/ExampleObj2PDF.java
Index: ExampleObj2PDF.java
===================================================================
RCS file: /home/cvs/xml-fop/examples/embedding/java/embedding/ExampleObj2PDF.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ExampleObj2PDF.java 14 Apr 2004 22:57:10 -0000 1.6
+++ ExampleObj2PDF.java 20 Jun 2004 12:35:17 -0000 1.7
@@ -18,12 +18,12 @@
package embedding;
-//Java
+// Java
import java.io.File;
import java.io.OutputStream;
import java.io.IOException;
-//JAXP
+// JAXP
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.TransformerException;
@@ -32,13 +32,9 @@
import javax.xml.transform.stream.StreamSource;
import javax.xml.transform.sax.SAXResult;
-// Commons-Logging
-import org.apache.commons.logging.impl.SimpleLog;
-
-//FOP
+// FOP
import org.apache.fop.apps.Driver;
import org.apache.fop.apps.FOPException;
-
import embedding.model.ProjectTeam;
/**
@@ -62,10 +58,7 @@
// Construct driver
Driver driver = new Driver();
- // Setup logger
- SimpleLog logger = new SimpleLog("log");
- logger.setLevel(SimpleLog.LOG_LEVEL_INFO);
- driver.setLogger(logger);
+ // Setup driver
driver.initialize();
// Setup Renderer (output format)
1.8 +0 -6 xml-fop/examples/embedding/java/embedding/ExampleXML2PDF.java
Index: ExampleXML2PDF.java
===================================================================
RCS file: /home/cvs/xml-fop/examples/embedding/java/embedding/ExampleXML2PDF.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ExampleXML2PDF.java 14 Apr 2004 22:57:10 -0000 1.7
+++ ExampleXML2PDF.java 20 Jun 2004 12:35:17 -0000 1.8
@@ -32,9 +32,6 @@
import javax.xml.transform.stream.StreamSource;
import javax.xml.transform.sax.SAXResult;
-// Commons-Logging
-import org.apache.commons.logging.impl.SimpleLog;
-
//FOP
import org.apache.fop.apps.Driver;
import org.apache.fop.apps.FOPException;
@@ -74,9 +71,6 @@
Driver driver = new Driver();
// Setup logger
- SimpleLog logger = new SimpleLog("log");
- logger.setLevel(SimpleLog.LOG_LEVEL_INFO);
- driver.setLogger(logger);
driver.initialize();
// Setup Renderer (output format)
1.22 +8 -21 xml-fop/src/documentation/content/xdocs/embedding.xml
Index: embedding.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/embedding.xml,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- embedding.xml 11 Apr 2004 21:53:41 -0000 1.21
+++ embedding.xml 20 Jun 2004 12:35:17 -0000 1.22
@@ -93,26 +93,13 @@
<section id="basic-logging-new-version">
<title>Logging (Upcoming FOP 1.0 Version only)</title>
<p>
- You also need to set up logging. Global logging for all FOP
- processes is managed by MessageHandler. Per-instance logging
- is handled by Driver. You want to set both using an implementation
- of org.apache.commons.logging.Log. See
- <jump href="#logging">below</jump> for more information.
+ Logging is handled automatically via Jakarta Commons-Logging, which uses
+ JDK logging by default. No special driver configuration is needed.
+ For specialized configuration of Commons-Logging (e.g. to use a
+ different logger or to change logging levels), please see the
+ <fork href="http://jakarta.apache.org/commons/logging/">Jakarta Commons-Logging</fork>
+ site.
</p>
- <p>
- Call <code>setLogger(Logger)</code> always immediately after
- instantiating the Driver object. See here:
- </p>
- <source><![CDATA[
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.impl.SimpleLog;
-
-/*..*/
-
-Driver driver = new Driver();
-Log logger = new SimpleLog(SimpleLog.LOG_LEVEL_INFO);
-MessageHandler.setScreenLogger(logger);
-driver.setLogger(logger);]]></source>
</section>
<section id="render">
1.19 +5 -3 xml-fop/src/java/org/apache/fop/apps/CommandLineOptions.java
Index: CommandLineOptions.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/apps/CommandLineOptions.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- CommandLineOptions.java 18 Apr 2004 22:39:02 -0000 1.18
+++ CommandLineOptions.java 20 Jun 2004 12:35:17 -0000 1.19
@@ -174,6 +174,8 @@
i = i + parseUnknownOption(args, i);
} else if (args[i].equals("-at")) {
i = i + parseAreaTreeOption(args, i);
+ } else if (args[i].equals("-v")) {
+ System.out.println("FOP Version " + Version.getVersion());
} else if (args[i].equals("-param")) {
if (i + 2 < args.length) {
if (xsltParams == null) {
@@ -575,7 +577,8 @@
+ " -x dump configuration settings \n"
+ " -c cfg.xml use additional configuration file cfg.xml\n"
+ " -l lang the language to use for user information \n"
- + " -s for area tree XML, down to block areas only\n\n"
+ + " -s for area tree XML, down to block areas only\n"
+ + " -v to show FOP version being used\n\n"
+ " [INPUT] \n"
+ " infile xsl:fo input file (the same as the next) \n"
+ " -fo infile xsl:fo input file \n"
@@ -608,13 +611,12 @@
/**
* shows the options for print output
*/
- public void printUsagePrintOutput() {
+ private void printUsagePrintOutput() {
System.err.println("USAGE: -print [-Dstart=i] [-Dend=i] [-Dcopies=i] [-Deven=true|false] "
+ " org.apache.fop.apps.Fop (..) -print \n"
+ "Example:\n"
+ "java -Dstart=1 -Dend=2 org.apache.Fop.apps.Fop infile.fo -print ");
}
-
/**
* Outputs all commandline settings
1.73 +14 -49 xml-fop/src/java/org/apache/fop/apps/Driver.java
Index: Driver.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/apps/Driver.java,v
retrieving revision 1.72
retrieving revision 1.73
diff -u -r1.72 -r1.73
--- Driver.java 20 Jun 2004 07:46:13 -0000 1.72
+++ Driver.java 20 Jun 2004 12:35:17 -0000 1.73
@@ -18,10 +18,20 @@
package org.apache.fop.apps;
+// Java
+import java.io.IOException;
+import java.io.OutputStream;
+
+// XML
+import org.xml.sax.ContentHandler;
+import org.xml.sax.InputSource;
+import org.xml.sax.SAXException;
+import org.xml.sax.XMLReader;
+import org.w3c.dom.Document;
+
// FOP
import org.apache.fop.fo.ElementMapping;
import org.apache.fop.fo.FOTreeBuilder;
-
import org.apache.fop.fo.FOInputHandler;
import org.apache.fop.fo.FOTreeHandler;
import org.apache.fop.render.Renderer;
@@ -31,20 +41,6 @@
import org.apache.fop.tools.DocumentInputSource;
import org.apache.fop.tools.DocumentReader;
-import org.apache.commons.logging.impl.SimpleLog;
-import org.apache.commons.logging.Log;
-
-// XML
-import org.xml.sax.ContentHandler;
-import org.xml.sax.InputSource;
-import org.xml.sax.SAXException;
-import org.xml.sax.XMLReader;
-import org.w3c.dom.Document;
-
-// Java
-import java.io.IOException;
-import java.io.OutputStream;
-
/**
* Primary class that drives overall FOP process.
* <P>
@@ -57,7 +53,6 @@
* <PRE>
* Driver driver = new Driver(new InputSource (args[0]),
* new FileOutputStream(args[1]));
- * driver.setLogger(myLogger); //optional
* driver.setRenderer(RENDER_PDF);
* driver.run();
* </PRE>
@@ -87,7 +82,6 @@
*
* <PRE>
* Driver driver = new Driver();
- * driver.setLogger(myLogger); //optional
* driver.setRenderer(new org.apache.fop.render.awt.AWTRenderer(translator));
* driver.render(parser, fileInputSource(args[0]));
* </PRE>
@@ -185,9 +179,8 @@
private XMLReader reader;
/**
- * the system resources that FOP will use
+ * The system resources that FOP will use
*/
- private Log log = null;
private FOUserAgent userAgent = null;
/**
@@ -239,33 +232,6 @@
}
/**
- * Provide the Driver instance with a logger.
- * @param log the logger. Must not be <code>null</code>.
- */
- public void setLogger(Log log) {
- if (this.log == null) {
- this.log = log;
- } else {
- getLogger().warn("Logger is already set! Won't use the new logger.");
- }
- }
-
-
- /**
- * Returns the logger for use by FOP.
- * @return the logger
- */
- public Log getLogger() {
- if (this.log == null) {
- // use SimpleLog as default when logger not explicitly set
- log = new SimpleLog("FOP");
- ((SimpleLog) log).setLevel(SimpleLog.LOG_LEVEL_INFO);
- }
-
- return this.log;
- }
-
- /**
* Resets the Driver so it can be reused. Property and element
* mappings are reset to defaults.
* The output stream is cleared. The renderer is cleared.
@@ -377,7 +343,7 @@
/**
* Set the Renderer to use.
- * @param renderer the renderer instance to use (Note: Logger must be set at this point)
+ * @param renderer the renderer instance to use
*/
public void setRenderer(Renderer renderer) {
// AWTStarter calls this function directly
@@ -584,5 +550,4 @@
render(reader, source);
}
}
-
}
1.11 +1 -6 xml-fop/src/java/org/apache/fop/apps/Fop.java
Index: Fop.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/apps/Fop.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Fop.java 9 Apr 2004 03:05:40 -0000 1.10
+++ Fop.java 20 Jun 2004 12:35:17 -0000 1.11
@@ -22,8 +22,6 @@
import java.io.BufferedOutputStream;
import java.io.FileOutputStream;
-import org.apache.commons.logging.impl.SimpleLog;
-
// FOP
import org.apache.fop.render.awt.AWTRenderer;
@@ -46,9 +44,6 @@
try {
Driver driver = new Driver();
options = new CommandLineOptions(args);
-
- driver.setLogger(options.getLogger());
- driver.getLogger().info(version);
inputHandler = options.getInputHandler();
1.28 +1 -1 xml-fop/src/java/org/apache/fop/render/AbstractRenderer.java
Index: AbstractRenderer.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/render/AbstractRenderer.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- AbstractRenderer.java 20 Jun 2004 07:46:13 -0000 1.27
+++ AbstractRenderer.java 20 Jun 2004 12:35:17 -0000 1.28
@@ -87,7 +87,7 @@
/**
* logging instance
*/
- protected static Log logger = LogFactory.getLog("Renderer");
+ protected static Log logger = LogFactory.getLog("FOP");
/**
* producer (usually "FOP")
1.12 +0 -2 xml-fop/src/java/org/apache/fop/servlet/FopPrintServlet.java
Index: FopPrintServlet.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/servlet/FopPrintServlet.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- FopPrintServlet.java 31 Mar 2004 10:55:07 -0000 1.11
+++ FopPrintServlet.java 20 Jun 2004 12:35:17 -0000 1.12
@@ -134,7 +134,6 @@
Driver driver = new Driver(foFile, null);
AWTPrintRenderer renderer = new AWTPrintRenderer();
- driver.setLogger(log);
driver.setRenderer(renderer);
driver.run();
@@ -156,7 +155,6 @@
Driver driver = new Driver();
AWTPrintRenderer renderer = new AWTPrintRenderer();
- driver.setLogger(log);
driver.setRenderer(renderer);
driver.render(input.getParser(), input.getInputSource());
1.7 +0 -1 xml-fop/src/java/org/apache/fop/servlet/FopServlet.java
Index: FopServlet.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/servlet/FopServlet.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- FopServlet.java 31 Mar 2004 10:55:07 -0000 1.6
+++ FopServlet.java 20 Jun 2004 12:35:17 -0000 1.7
@@ -202,7 +202,6 @@
//Setup FOP
Driver driver = new Driver();
- driver.setLogger(this.log);
driver.setRenderer(Driver.RENDER_PDF);
driver.initialize();
1.15 +0 -1 xml-fop/src/java/org/apache/fop/tools/anttasks/Fop.java
Index: Fop.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/tools/anttasks/Fop.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Fop.java 12 May 2004 23:19:53 -0000 1.14
+++ Fop.java 20 Jun 2004 12:35:17 -0000 1.15
@@ -532,7 +532,6 @@
try {
Driver driver = new Driver();
- driver.setLogger(getLogger());
FOUserAgent userAgent = new FOUserAgent();
userAgent.setBaseURL(this.baseURL);
driver.setUserAgent(userAgent);
---------------------------------------------------------------------
To unsubscribe, e-mail: fop-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: fop-cvs-help@xml.apache.org
Re: cvs commit: xml-fop/src/java/org/apache/fop/tools/anttasks Fop.java
Posted by Glen Mazza <gr...@yahoo.com>.
Simon Pepping schrieb:
>Glen,
>
>On Sun, Jun 20, 2004 at 12:35:17PM -0000, gmazza@apache.org wrote:
>
>
>>gmazza 2004/06/20 05:35:17
>>
>> src/java/org/apache/fop/render AbstractRenderer.java
>>
>> Index: AbstractRenderer.java
>> ===================================================================
>> RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/render/AbstractRenderer.java,v
>> retrieving revision 1.27
>> retrieving revision 1.28
>> diff -u -r1.27 -r1.28
>> --- AbstractRenderer.java 20 Jun 2004 07:46:13 -0000 1.27
>> +++ AbstractRenderer.java 20 Jun 2004 12:35:17 -0000 1.28
>> @@ -87,7 +87,7 @@
>> /**
>> * logging instance
>> */
>> - protected static Log logger = LogFactory.getLog("Renderer");
>> + protected static Log logger = LogFactory.getLog("FOP");
>>
>> /**
>> * producer (usually "FOP")
>>
>>
>
>I am not happy with this change. Especially debug and trace logging
>may produce large amounts of output. Then it is an advantage if one
>can select for which classes or packages one wants to see the
>logging. That is possible if we use a separate logger per package, and
>for classes that may produce a lot of log output, even a separate
>logger per class. You can see my logging strategy in my recent patch.
>
>In that patch I have also started to use the trace level for very
>detailed logging.
>
>Let us discuss a common logging strategy.
>
>Regards, Simon
>
>
>
Simon,
OK. I was taking a user-centric approach to naming (where they don't
know much about FOP's internal objects, and *they* wish to have
everything named "FOP" to separate it from other parts of their
application.) However, a developer-centric naming approach is also fine
for me, especially while we do heavy debugging. If you wish, feel free
to switch it back.
Glen
Re: cvs commit: xml-fop/src/java/org/apache/fop/tools/anttasks Fop.java
Posted by Simon Pepping <sp...@leverkruid.nl>.
Glen,
On Sun, Jun 20, 2004 at 12:35:17PM -0000, gmazza@apache.org wrote:
> gmazza 2004/06/20 05:35:17
>
> src/java/org/apache/fop/render AbstractRenderer.java
>
> Index: AbstractRenderer.java
> ===================================================================
> RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/render/AbstractRenderer.java,v
> retrieving revision 1.27
> retrieving revision 1.28
> diff -u -r1.27 -r1.28
> --- AbstractRenderer.java 20 Jun 2004 07:46:13 -0000 1.27
> +++ AbstractRenderer.java 20 Jun 2004 12:35:17 -0000 1.28
> @@ -87,7 +87,7 @@
> /**
> * logging instance
> */
> - protected static Log logger = LogFactory.getLog("Renderer");
> + protected static Log logger = LogFactory.getLog("FOP");
>
> /**
> * producer (usually "FOP")
I am not happy with this change. Especially debug and trace logging
may produce large amounts of output. Then it is an advantage if one
can select for which classes or packages one wants to see the
logging. That is possible if we use a separate logger per package, and
for classes that may produce a lot of log output, even a separate
logger per class. You can see my logging strategy in my recent patch.
In that patch I have also started to use the trace level for very
detailed logging.
Let us discuss a common logging strategy.
Regards, Simon
--
Simon Pepping
home page: http://www.leverkruid.nl