You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by sp...@apache.org on 2010/07/21 09:08:43 UTC

svn commit: r966110 [12/29] - in /xmlgraphics/site/deploy/fop: 0.95/ 1.0/ 1.0/images/

Added: xmlgraphics/site/deploy/fop/1.0/embedding.xml
URL: http://svn.apache.org/viewvc/xmlgraphics/site/deploy/fop/1.0/embedding.xml?rev=966110&view=auto
==============================================================================
--- xmlgraphics/site/deploy/fop/1.0/embedding.xml (added)
+++ xmlgraphics/site/deploy/fop/1.0/embedding.xml Wed Jul 21 07:08:39 2010
@@ -0,0 +1,697 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+--><!-- $Id$ --><!-- Embedding FOP --><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "document-v13.dtd">
+<document>
+  <header>
+    <title>Apache FOP: Embedding</title>
+    <subtitle>How to Embed FOP in a Java application</subtitle>
+    <version>$Revision: 964711 $</version>
+  </header>
+
+  <body>
+  <section id="overview">
+    <title>Overview</title>
+    <p>
+      Review <link href="running.html">Running FOP</link> for important information that applies
+      to embedded applications as well as command-line use, such as options and performance.
+    </p>
+    <p>
+      To embed Apache FOP in your application, first create a new
+      org.apache.fop.apps.FopFactory instance. This object can be used to launch multiple
+      rendering runs. For each run, create a new org.apache.fop.apps.Fop instance through
+      one of the factory methods of FopFactory. In the method call you specify which output
+      format (i.e. Renderer) to use and, if the selected renderer requires an OutputStream,
+      which OutputStream to use for the results of the rendering. You can customize FOP's
+      behaviour in a rendering run by supplying your own FOUserAgent instance. The
+      FOUserAgent can, for example, be used to set your own Renderer instance (details
+      below). Finally, you retrieve a SAX DefaultHandler instance from the Fop object and
+      use that as the SAXResult of your transformation.
+    </p>
+    <note>
+      We recently changed FOP's outer API to what we consider the final API. This might require
+      some changes in your application. The main reasons for these changes were performance
+      improvements due to better reuse of reusable objects and reduced use of static variables
+      for added flexibility in complex environments.
+    </note>
+  </section>
+  <section id="basics">
+    <title>Basic Usage Pattern</title>
+    <p>
+      Apache FOP relies heavily on JAXP. It uses SAX events exclusively to receive the XSL-FO
+      input document. It is therefore a good idea that you know a few things about JAXP (which
+      is a good skill anyway). Let's look at the basic usage pattern for FOP...
+    </p>
+    <p>Here is the basic pattern to render an XSL-FO file to PDF:
+    </p>
+    <source xml:space="preserve"><![CDATA[
+import org.apache.fop.apps.FopFactory;
+import org.apache.fop.apps.Fop;
+import org.apache.fop.apps.MimeConstants;
+
+/*..*/
+
+// Step 1: Construct a FopFactory
+// (reuse if you plan to render multiple documents!)
+FopFactory fopFactory = FopFactory.newInstance();
+
+// Step 2: Set up output stream.
+// Note: Using BufferedOutputStream for performance reasons (helpful with FileOutputStreams).
+OutputStream out = new BufferedOutputStream(new FileOutputStream(new File("C:/Temp/myfile.pdf")));
+
+try {
+  // Step 3: Construct fop with desired output format
+  Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, out);
+
+  // Step 4: Setup JAXP using identity transformer
+  TransformerFactory factory = TransformerFactory.newInstance();
+  Transformer transformer = factory.newTransformer(); // identity transformer
+
+  // Step 5: Setup input and output for XSLT transformation
+  // Setup input stream
+  Source src = new StreamSource(new File("C:/Temp/myfile.fo"));
+
+  // Resulting SAX events (the generated FO) must be piped through to FOP
+  Result res = new SAXResult(fop.getDefaultHandler());
+
+  // Step 6: Start XSLT transformation and FOP processing
+  transformer.transform(src, res);
+
+} finally {
+  //Clean-up
+  out.close();
+}]]></source>
+    <p>
+      Let's discuss these 5 steps in detail:
+    </p>
+    <ul>
+      <li>
+        <strong>Step 1:</strong> You create a new FopFactory instance. The FopFactory instance holds
+        references to configuration information and cached data. It's important to reuse this
+        instance if you plan to render multiple documents during a JVM's lifetime.
+      </li>
+      <li>
+        <strong>Step 2:</strong> You set up an OutputStream that the generated document
+        will be written to. It's a good idea to buffer the OutputStream as demonstrated
+        to improve performance.
+      </li>
+      <li>
+        <strong>Step 3:</strong> You create a new Fop instance through one of the factory
+        methods on the FopFactory. You tell the FopFactory what your desired output format
+        is. This is done by using the MIME type of the desired output format (ex. "application/pdf").
+        You can use one of the MimeConstants.* constants. The second parameter is the
+        OutputStream you've setup up in step 2.
+      </li>
+      <li>
+        <strong>Step 4</strong> We recommend that you use JAXP Transformers even
+        if you don't do XSLT transformations to generate the XSL-FO file. This way
+        you can always use the same basic pattern. The example here sets up an
+        "identity transformer" which just passes the input (Source) unchanged to the
+        output (Result). You don't have to work with a SAXParser if you don't do any
+        XSLT transformations.
+      </li>
+      <li>
+        <strong>Step 5:</strong> Here you set up the input and output for the XSLT
+        transformation. The Source object is set up to load the "myfile.fo" file.
+        The Result is set up so the output of the XSLT transformation is sent to FOP.
+        The FO file is sent to FOP in the form of SAX events which is the most efficient
+        way. Please always avoid saving intermediate results to a file or a memory buffer
+        because that affects performance negatively.
+      </li>
+      <li>
+        <strong>Step 6:</strong> Finally, we start the XSLT transformation by starting
+        the JAXP Transformer. As soon as the JAXP Transformer starts to send its output
+        to FOP, FOP itself starts its processing in the background. When the
+        <code>transform()</code> method returns FOP will also have finished converting
+        the FO file to a PDF file and you can close the OutputStream.
+        <note label="Tip!">
+          It's a good idea to enclose the whole conversion in a try..finally statement. If
+          you close the OutputStream in the finally section, this will make sure that the
+          OutputStream is properly closed even if an exception occurs during the conversion.
+        </note>
+      </li>
+    </ul>
+    <p>
+      If you're not totally familiar with JAXP Transformers, please have a look at the
+      <link href="#examples">Embedding examples</link> below. The section contains examples
+      for all sorts of use cases. If you look at all of them in turn you should be able
+      to see the patterns in use and the flexibility this approach offers without adding
+      too much complexity.
+    </p>
+    <p>
+      This may look complicated at first, but it's really just the combination of an
+      XSL transformation and a FOP run. It's also easy to comment out the FOP part
+      for debugging purposes, for example when you're tracking down a bug in your
+      stylesheet. You can easily write the XSL-FO output from the XSL transformation
+      to a file to check if that part generates the expected output. An example for that
+      can be found in the <link href="#examples">Embedding examples</link> (See "ExampleXML2FO").
+    </p>
+    <section id="basic-logging">
+      <title>Logging</title>
+      <p>
+        Logging is now a little different than it was in FOP 0.20.5. We've switched from
+        Avalon Logging to <link href="ext:commons-logging">Jakarta Commons Logging</link>.
+        While with Avalon Logging the loggers were directly given to FOP, FOP now retrieves
+        its logger(s) through a statically available LogFactory. This is similar to the
+        general pattern that you use when you work with Apache Log4J directly, for example.
+        We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging"
+        (Avalon Logging). This has a consequence: You can't give FOP a logger for each
+        processing run anymore. The log output of multiple, simultaneously running FOP instances
+        is sent to the same logger.
+      </p>
+      <p>
+        By default, <link href="ext:commons-logging">Jakarta Commons Logging</link> uses
+        JDK logging (available in JDKs 1.4 or higher) as its backend. You can configure Commons
+        Logging to use an alternative backend, for example Log4J. Please consult the
+        <link href="ext:commons-logging">documentation for Jakarta Commons Logging</link> on
+        how to configure alternative backends.
+      </p>
+      <p>
+        As a result of the above we differentiate between two kinds of "logging":
+      </p>
+      <ul>
+        <li>(FOP-)Developer-oriented logging</li>
+        <li><link href="events.html">User/Integrator-oriented feedback</link> (NEW!)</li>
+      </ul>
+      <p>
+        The use of "feedback" instead of "logging" is intentional. Most people were using
+        log output as a means to get feedback from events within FOP. Therefore, FOP now
+        includes an <code>event</code> package which can be used to receive feedback from
+        the layout engine and other components within FOP <strong>per rendering run</strong>.
+        This feedback is not just some
+        text but event objects with parameters so these events can be interpreted by code.
+        Of course, there is a facility to turn these events into normal human-readable
+        messages. For details, please read on on the <link href="events.html">Events page</link>.
+        This leaves normal logging to be mostly a thing used by the FOP developers
+        although anyone can surely activate certain logging categories but the feedback
+        from the loggers won't be separated by processing runs. If this is required,
+        the <link href="events.html">Events subsystem</link> is the right approach.
+      </p>
+    </section>
+
+    <section id="render">
+      <title>Processing XSL-FO</title>
+      <p>
+        Once the Fop instance is set up, call <code>getDefaultHandler()</code> to obtain a SAX
+        DefaultHandler instance to which you can send the SAX events making up the XSL-FO
+        document you'd like to render. FOP processing starts as soon as the DefaultHandler's
+        <code>startDocument()</code> method is called. Processing stops again when the
+        DefaultHandler's <code>endDocument()</code> method is called. Please refer to the basic
+        usage pattern shown above to render a simple XSL-FO document.
+      </p>
+    </section>
+
+    <section id="render-with-xslt">
+      <title>Processing XSL-FO generated from XML+XSLT</title>
+      <p>
+        If you want to process XSL-FO generated from XML using XSLT we recommend
+        again using standard JAXP to do the XSLT part and piping the generated SAX
+        events directly through to FOP. The only thing you'd change to do that
+        on the basic usage pattern above is to set up the Transformer differently:
+      </p>
+      <source xml:space="preserve"><![CDATA[
+  //without XSLT:
+  //Transformer transformer = factory.newTransformer(); // identity transformer
+
+  //with XSLT:
+  Source xslt = new StreamSource(new File("mystylesheet.xsl"));
+  Transformer transformer = factory.newTransformer(xslt);]]></source>
+    </section>
+  </section>
+  <section id="input">
+    <title>Input Sources</title>
+    <p>
+      The input XSL-FO document is always received by FOP as a SAX stream (see the
+      <link href="../dev/design/parsing.html">Parsing Design Document</link> for the rationale).
+    </p>
+    <p>
+      However, you may not always have your input document available as a SAX stream.
+      But with JAXP it's easy to convert different input sources to a SAX stream so you
+      can pipe it into FOP. That sounds more difficult than it is. You simply have
+      to set up the right Source instance as input for the JAXP transformation.
+      A few examples:
+    </p>
+    <ul>
+      <li>
+        <strong>URL:</strong> <code>Source src = new StreamSource("http://localhost:8080/testfile.xml");</code>
+      </li>
+      <li>
+        <strong>File:</strong> <code>Source src = new StreamSource(new File("C:/Temp/myinputfile.xml"));</code>
+      </li>
+      <li>
+        <strong>String:</strong> <code>Source src = new StreamSource(new StringReader(myString)); // myString is a String</code>
+      </li>
+      <li>
+        <strong>InputStream:</strong> <code>Source src = new StreamSource(new MyInputStream(something));</code>
+      </li>
+      <li>
+        <strong>Byte Array:</strong> <code>Source src = new StreamSource(new ByteArrayInputStream(myBuffer)); // myBuffer is a byte[] here</code>
+      </li>
+      <li>
+        <strong>DOM:</strong> <code>Source src = new DOMSource(myDocument); // myDocument is a Document or a Node</code>
+      </li>
+      <li>
+        <strong>Java Objects:</strong> Please have a look at the <link href="#examples">Embedding examples</link> which contain an example for this.
+      </li>
+    </ul>
+    <p>
+      There are a variety of upstream data manipulations possible.
+      For example, you may have a DOM and an XSL stylesheet; or you may want to
+      set variables in the stylesheet. Interface documentation and some cookbook
+      solutions to these situations are provided in
+      <link href="http://xml.apache.org/xalan-j/usagepatterns.html">Xalan Basic Usage Patterns</link>.
+    </p>
+  </section>
+  <section id="config-internal">
+    <title>Configuring Apache FOP Programmatically</title>
+    <p>
+      Apache FOP provides two levels on which you can customize FOP's
+      behaviour: the FopFactory and the user agent.
+    </p>
+    <section id="fop-factory">
+      <title>Customizing the FopFactory</title>
+      <p>
+        The FopFactory holds configuration data and references to objects which are reusable over
+        multiple rendering runs. It's important to instantiate it only once (except in special
+        environments) and reuse it every time to create new FOUserAgent and Fop instances.
+      </p>
+      <p>
+        You can set all sorts of things on the FopFactory:
+      </p>
+      <ul>
+        <li>
+          <p>
+            The <strong>font base URL</strong> to use when resolving relative URLs for fonts. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[fopFactory.getFontManager().setFontBaseURL("file:///C:/Temp/fonts");]]></source>
+        </li>
+        <li>
+          <p>
+            The <strong>hyphenation base URL</strong> to use when resolving relative URLs for
+            hyphenation patterns. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[fopFactory.setHyphenBaseURL("file:///C:/Temp/hyph");]]></source>
+        </li>
+        <li>
+          <p>
+            Disable <strong>strict validation</strong>. When disabled FOP is less strict about the rules
+            established by the XSL-FO specification. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[fopFactory.setStrictValidation(false);]]></source>
+        </li>
+        <li>
+          <p>
+            Enable an <strong>alternative set of rules for text indents</strong> that tries to mimic the behaviour of many commercial
+            FO implementations, that chose to break the specification in this respect. The default of this option is
+            'false', which causes Apache FOP to behave exactly as described in the specification. To enable the
+            alternative behaviour, call:
+          </p>
+          <source xml:space="preserve"><![CDATA[fopFactory.setBreakIndentInheritanceOnReferenceAreaBoundary(true);]]></source>
+        </li>
+        <li>
+          <p>
+            Set the <strong>source resolution</strong> for the document. This is used internally to determine the pixel
+            size for SVG images and bitmap images without resolution information. Default: 72 dpi. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[fopFactory.setSourceResolution(96); // =96dpi (dots/pixels per Inch)]]></source>
+        </li>
+        <li>
+          <p>
+            Manually add an <strong>ElementMapping instance</strong>. If you want to supply a special FOP extension
+            you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected
+            (see the documentation on extension for more info). Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[fopFactory.addElementMapping(myElementMapping); // myElementMapping is a org.apache.fop.fo.ElementMapping]]></source>
+        </li>
+        <li>
+          <p>
+            Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
+            custom URI resolution functionality to FOP. For example, you can use
+            <link href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</link> to make use of XCatalogs. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[fopFactory.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver]]></source>
+          <note>
+            Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FopFactory
+            is primarily used to resolve URIs on factory-level (hyphenation patterns, for example) and it is always used
+            if no other URIResolver (for example on the FOUserAgent) resolved the URI first.
+          </note>
+        </li>
+      </ul>
+    </section>
+    <section id="user-agent">
+      <title>Customizing the User Agent</title>
+      <p>
+        The user agent is the entity that allows you to interact with a single rendering run, i.e. the processing of a single
+        document. If you wish to customize the user agent's behaviour, the first step is to create your own instance
+        of FOUserAgent using the appropriate factory method on FopFactory and pass that
+        to the factory method that will create a new Fop instance:
+      </p>
+      <source xml:space="preserve"><![CDATA[
+  FopFactory fopFactory = FopFactory.newInstance(); // Reuse the FopFactory if possible!
+  // do the following for each new rendering run
+  FOUserAgent userAgent = fopFactory.newFOUserAgent();
+  // customize userAgent
+  Fop fop = fopFactory.newFop(MimeConstants.MIME_POSTSCRIPT, userAgent, out);]]></source>
+      <p>
+        You can do all sorts of things on the user agent:
+      </p>
+      <ul>
+        <li>
+          <p>
+            The <strong>base URL</strong> to use when resolving relative URLs. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setBaseURL("file:///C:/Temp/");]]></source>
+        </li>
+        <li>
+          <p>
+            Set the <strong>producer</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. The default producer is "Apache FOP". Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setProducer("MyKillerApplication");]]></source>
+        </li>
+        <li>
+          <p>
+            Set the <strong>creating user</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setCreator("John Doe");]]></source>
+        </li>
+        <li>
+          <p>
+            Set the <strong>author</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setAuthor("John Doe");]]></source>
+        </li>
+        <li>
+          <p>
+            Override the <strong>creation date and time</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setCreationDate(new Date());]]></source>
+        </li>
+        <li>
+          <p>
+            Set the <strong>title</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setTitle("Invoice No 138716847");]]></source>
+        </li>
+        <li>
+          <p>
+            Set the <strong>keywords</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setKeywords("XML XSL-FO");]]></source>
+        </li>
+        <li>
+          <p>
+            Set the <strong>target resolution</strong> for the document. This is used to
+            specify the output resolution for bitmap images generated by bitmap renderers
+            (such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter
+            effects and such. Default: 72 dpi. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setTargetResolution(300); // =300dpi (dots/pixels per Inch)]]></source>
+        </li>
+        <li>
+          <p>
+            Set <strong>your own Renderer instance</strong>. If you want to supply your own renderer or
+            configure a Renderer in a special way you can give the instance to the FOUserAgent. Normally,
+            the Renderer instance is created by FOP. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setRendererOverride(myRenderer); // myRenderer is an org.apache.fop.render.Renderer]]></source>
+        </li>
+        <li>
+          <p>
+            Set <strong>your own FOEventHandler instance</strong>. If you want to supply your own FOEventHandler or
+            configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally,
+            the FOEventHandler instance is created by FOP. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setFOEventHandlerOverride(myFOEventHandler); // myFOEventHandler is an org.apache.fop.fo.FOEventHandler]]></source>
+        </li>
+        <li>
+          <p>
+            Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
+            custom URI resolution functionality to FOP. For example, you can use
+            <link href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</link> to make use of XCatalogs. Example:
+          </p>
+          <source xml:space="preserve"><![CDATA[userAgent.setURIResolver(myResolver); // myResolver is a javax.xml.transform.URIResolver]]></source>
+          <note>
+            Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FOUserAgent is
+            used for resolving URIs which are document-related. If it's not set or cannot resolve a URI, the URIResolver
+            from the FopFactory is used.
+          </note>
+        </li>
+      </ul>
+      <note>
+        You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially
+        in multi-threaded environment, this is a bad idea.
+      </note>
+    </section>
+  </section>
+  <section id="config-external">
+    <title>Using a Configuration File</title>
+    <p>
+      Instead of setting the parameters manually in code as shown above you can also set
+      many values from an XML configuration file:
+    </p>
+    <source xml:space="preserve"><![CDATA[
+import org.apache.avalon.framework.configuration.Configuration;
+import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
+
+/*..*/
+
+DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder();
+Configuration cfg = cfgBuilder.buildFromFile(new File("C:/Temp/mycfg.xml"));
+fopFactory.setUserConfig(cfg);
+
+/* ..or.. */
+
+fopFactory.setUserConfig(new File("C:/Temp/mycfg.xml"));]]></source>
+    <p>
+      The layout of the configuration file is described on the <link href="configuration.html">Configuration page</link>.
+    </p>
+  </section>
+  <section id="hints">
+    <title>Hints</title>
+    <section id="object-reuse">
+      <title>Object reuse</title>
+      <p>
+        Fop instances shouldn't (and can't) be reused. Please recreate
+        Fop and FOUserAgent instances for each rendering run using the FopFactory.
+        This is a cheap operation as all reusable information is held in the
+        FopFactory. That's why it's so important to reuse the FopFactory instance.
+     </p>
+    </section>
+    <section id="awt">
+      <title>AWT issues</title>
+      <p>
+        If your XSL-FO files contain SVG then Apache Batik will be used. When Batik is
+        initialised it uses certain classes in <code>java.awt</code> that
+        intialise the Java AWT classes. This means that a daemon thread
+        is created by the JVM and on Unix it will need to connect to a
+        DISPLAY.
+      </p>
+      <p>
+        The thread means that the Java application may not automatically quit
+        when finished, you will need to call <code>System.exit()</code>. These
+        issues should be fixed in the JDK 1.4.
+      </p>
+      <p>
+        If you run into trouble running FOP on a head-less server, please see the
+        <link href="graphics.html#batik">notes on Batik</link>.
+      </p>
+    </section>
+    <section id="render-info">
+      <title>Getting information on the rendering process</title>
+      <p>
+        To get the number of pages that were rendered by FOP you can call
+        <code>Fop.getResults()</code>. This returns a <code>FormattingResults</code> object
+        where you can look up the number of pages produced. It also gives you the
+        page-sequences that were produced along with their id attribute and their
+        numbers of pages. This is particularly useful if you render multiple
+        documents (each enclosed by a page-sequence) and have to know the number of
+        pages of each document.
+      </p>
+    </section>
+  </section>
+  <section id="performance">
+    <title>Improving performance</title>
+    <p>
+      There are several options to consider:
+    </p>
+    <ul>
+      <li>
+        Whenever possible, try to use SAX to couple the individual components involved
+        (parser, XSL transformer, SQL datasource etc.).
+      </li>
+      <li>
+        Depending on the target OutputStream (in case of a FileOutputStream, but not
+        for a ByteArrayOutputStream, for example) it may improve performance considerably
+        if you buffer the OutputStream using a BufferedOutputStream:
+        <code>out = new java.io.BufferedOutputStream(out);</code>
+        <br/>
+        Make sure you properly close the OutputStream when FOP is finished.
+      </li>
+      <li>
+        Cache the stylesheet. If you use the same stylesheet multiple times
+        you can set up a JAXP <code>Templates</code> object and reuse it each time you do
+        the XSL transformation.  (More information can be found
+        <link class="fork" href="http://www.javaworld.com/javaworld/jw-05-2003/jw-0502-xsl.html">here</link>.)
+      </li>
+      <li>
+        Use an XSLT compiler like <link class="fork" href="http://xml.apache.org/xalan-j/xsltc_usage.html">XSLTC</link>
+        that comes with Xalan-J.
+      </li>
+      <li>
+        Fine-tune your stylesheet to make the XSLT process more efficient and to create XSL-FO that can
+        be processed by FOP more efficiently. Less is more: Try to make use of property inheritance where possible.
+      </li>
+      <li>
+        You may also wish to consider trying to reduce <link href="http://xmlgraphics.apache.org/fop/trunk/running.html#memory">memory usage</link>.
+      </li>
+    </ul>
+  </section>
+  <section id="multithreading">
+    <title>Multithreading FOP</title>
+    <p>
+      Apache FOP may currently not be completely thread safe.
+      The code has not been fully tested for multi-threading issues, yet.
+      If you encounter any suspicious behaviour, please notify us.
+    </p>
+    <p>
+      There is also a known issue with fonts being jumbled between threads when using
+      the Java2D/AWT renderer (which is used by the -awt and -print output options).
+      In general, you cannot safely run multiple threads through the AWT renderer.
+    </p>
+  </section>
+<section id="examples">
+  <title>Examples</title>
+  <p>
+   The directory "{fop-dir}/examples/embedding" contains several working examples.
+  </p>
+  <section id="ExampleFO2PDF">
+    <title>ExampleFO2PDF.java</title>
+    <p>This
+        <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">
+            example</link>
+demonstrates the basic usage pattern to transform an XSL-FO
+file to PDF using FOP.
+    </p>
+    <figure src="images/EmbeddingExampleFO2PDF.png" alt="Example XSL-FO to PDF"/>
+  </section>
+  <section id="ExampleXML2FO">
+    <title>ExampleXML2FO.java</title>
+    <p>This
+        <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">
+            example</link>
+has nothing to do with FOP. It is there to show you how an XML
+file can be converted to XSL-FO using XSLT. The JAXP API is used to do the
+transformation. Make sure you've got a JAXP-compliant XSLT processor in your
+classpath (ex. <link href="http://xml.apache.org/xalan-j">Xalan</link>).
+    </p>
+    <figure src="images/EmbeddingExampleXML2FO.png" alt="Example XML to XSL-FO"/>
+  </section>
+  <section id="ExampleXML2PDF">
+    <title>ExampleXML2PDF.java</title>
+    <p>This
+        <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">
+        example</link>
+demonstrates how you can convert an arbitrary XML file to PDF
+using XSLT and XSL-FO/FOP. It is a combination of the first two examples
+above. The example uses JAXP to transform the XML file to XSL-FO and FOP to
+transform the XSL-FO to PDF.
+    </p>
+    <figure src="images/EmbeddingExampleXML2PDF.png" alt="Example XML to PDF (via XSL-FO)"/>
+    <p>
+The output (XSL-FO) from the XSL transformation is piped through to FOP using
+SAX events. This is the most efficient way to do this because the
+intermediate result doesn't have to be saved somewhere. Often, novice users
+save the intermediate result in a file, a byte array or a DOM tree. We
+strongly discourage you to do this if it isn't absolutely necessary. The
+performance is significantly higher with SAX.
+    </p>
+  </section>
+  <section id="ExampleObj2XML">
+    <title>ExampleObj2XML.java</title>
+    <p>This
+    <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">
+        example</link>
+is a preparatory example for the next one. It's an example that
+shows how an arbitrary Java object can be converted to XML. It's an often
+needed task to do this. Often people create a DOM tree from a Java object and
+use that. This is pretty straightforward. The example here, however, shows how
+to do this using SAX, which will probably be faster and not even more
+complicated once you know how this works.
+    </p>
+    <figure src="images/EmbeddingExampleObj2XML.png" alt="Example Java object to XML"/>
+    <p>
+For this example we've created two classes: ProjectTeam and ProjectMember
+(found in xml-fop/examples/embedding/java/embedding/model). They represent
+the same data structure found in
+xml-fop/examples/embedding/xml/xml/projectteam.xml. We want to serialize to XML a
+project team with several members which exist as Java objects.
+Therefore we created the two classes: ProjectTeamInputSource and
+ProjectTeamXMLReader (in the same place as ProjectTeam above).
+    </p>
+    <p>
+The XMLReader implementation (regard it as a special kind of XML parser) is
+responsible for creating SAX events from the Java object. The InputSource
+class is only used to hold the ProjectTeam object to be used.
+    </p>
+    <p>
+Have a look at the source of ExampleObj2XML.java to find out how this is
+used. For more detailed information see other resources on JAXP (ex.
+<link class="fork" href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</link>).
+    </p>
+  </section>
+  <section id="ExampleObj2PDF">
+    <title>ExampleObj2PDF.java</title>
+    <p>This
+        <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">
+            example</link>
+combines the previous and the third to demonstrate
+how you can transform a Java object to a PDF directly in one smooth run
+by generating SAX events from the Java object that get fed to an XSL
+transformation. The result of the transformation is then converted to PDF
+using FOP as before.
+    </p>
+    <figure src="images/EmbeddingExampleObj2PDF.png" alt="Example Java object to PDF (via XML and XSL-FO)"/>
+  </section>
+  <section id="ExampleDOM2PDF">
+    <title>ExampleDOM2PDF.java</title>
+    <p>This
+        <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">
+            example</link>
+has FOP use a DOMSource instead of a StreamSource in order to
+use a DOM tree as input for an XSL transformation.
+    </p>
+  </section>
+  <section id="ExampleSVG2PDF">
+    <title>ExampleSVG2PDF.java (PDF Transcoder example)</title>
+    <p>This
+        <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">
+            example</link>
+shows the usage of the PDF Transcoder, a sub-application within FOP.
+It is used to generate a PDF document from an SVG file.
+    </p>
+  </section>
+  <section id="example-notes">
+    <title>Final notes</title>
+    <p>
+These examples should give you an idea of what's possible. It should be easy
+to adjust these examples to your needs. Also, if you have other examples that you
+think should be added here, please let us know via either the fop-users or fop-dev
+mailing lists.  Finally, for more help please send your questions to the fop-users
+mailing list.
+    </p>
+  </section>
+</section>
+  </body>
+</document>

Propchange: xmlgraphics/site/deploy/fop/1.0/embedding.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xmlgraphics/site/deploy/fop/1.0/embedding.xml
------------------------------------------------------------------------------
    svn:keywords = Id

Added: xmlgraphics/site/deploy/fop/1.0/events.html
URL: http://svn.apache.org/viewvc/xmlgraphics/site/deploy/fop/1.0/events.html?rev=966110&view=auto
==============================================================================
--- xmlgraphics/site/deploy/fop/1.0/events.html (added)
+++ xmlgraphics/site/deploy/fop/1.0/events.html Wed Jul 21 07:08:39 2010
@@ -0,0 +1,719 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Events/Processing Feedback</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+    |header
+    +-->
+<div class="header">
+<!--+
+    |start group logo
+    +-->
+<div class="grouplogo">
+<a href="http://xmlgraphics.apache.org/"><img class="logoImage" alt="Apache XML Graphics" src="../images/group-logo.gif" title="Apache XML Graphics is responsible for the creation and maintenance of software for managing the conversion of XML formats to graphical output, and the creation and maintenance of related software components, based on software licensed to the Foundation"></a>
+</div>
+<!--+
+    |end group logo
+    +-->
+<!--+
+    |start Project Logo
+    +-->
+<div class="projectlogo">
+<a href="http://xmlgraphics.apache.org/fop/"><img class="logoImage" alt="Apache FOP" src="../images/logo.jpg" title="Apache FOP (Formatting Objects Processor) is the world's first output independent formatter. Output formats currently supported include PDF, PCL, PS, SVG, XML (area tree representation), Print, AWT, MIF and TXT. The primary output target is PDF."></a>
+</div>
+<!--+
+    |end Project Logo
+    +-->
+<!--+
+    |start Search
+    +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp; 
+                    <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+    |end search
+    +-->
+<!--+
+    |start Tabs
+    +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../0.95/index.html">Version 0.95</a>
+</li>
+<li class="current">
+<a class="selected" href="../1.0/index.html">Version 1.0</a>
+</li>
+<li>
+<a class="unselected" href="../trunk/index.html">FOP Trunk</a>
+</li>
+<li>
+<a class="unselected" href="../dev/index.html">Development</a>
+</li>
+</ul>
+<!--+
+    |end Tabs
+    +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+    |start Subtabs
+    +-->
+<div id="level2tabs"></div>
+<!--+
+    |end Endtabs
+    +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache.org</a> &gt; <a href="http://xml.apache.org/">XML Federation</a> &gt; <a href="http://xmlgraphics.apache.org/">xmlgraphics.apache.org</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+    |start Menu, mainarea
+    +-->
+<!--+
+    |start Menu
+    +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">FOP 1.0</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../1.0/index.html">About</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/releaseNotes_1.0.html">Release Notes</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/changes_1.0.html">Changes (1.0)</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/knownissues_overview.html">Known Issues</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/upgrading.html">Upgrading</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.6', '../skin/')" id="menu_1.1.6Title" class="menutitle">Using FOP</div>
+<div id="menu_1.1.6" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.0/compiling.html">Build</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/configuration.html">Configure</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/running.html">Run</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/embedding.html">Embed</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/servlets.html">Servlets</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/anttask.html">Ant Task</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.7', '../skin/')" id="menu_selected_1.1.7Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Features</div>
+<div id="menu_selected_1.1.7" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../1.0/output.html">Output Targets</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/intermediate.html">Intermediate Format</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/pdfencryption.html">PDF Encryption</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/pdfa.html">PDF/A</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/pdfx.html">PDF/X</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/graphics.html">Graphics</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/fonts.html">Fonts</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/hyphenation.html">Hyphenation</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/extensions.html">Extensions</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Events</div>
+</div>
+<div class="menuitem">
+<a href="../1.0/metadata.html">Metadata</a>
+</div>
+<div class="menuitem">
+<a href="../1.0/accessibility.html">Accessibility</a>
+</div>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+  |alternative credits
+  +-->
+<div id="credit2"></div>
+</div>
+<!--+
+    |end Menu
+    +-->
+<!--+
+    |start content
+    +-->
+<div id="content">
+<div title="raw XML" class="xmllink">
+<a class="dida" href="events.xml"><img alt="XML - icon" src="../skin/images/xmldoc.gif" class="skin"><br>
+        XML</a>
+</div>
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="events.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+        PDF</a>
+</div>
+<div class="trail">Font size: 
+	          &nbsp;<input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">      
+	          &nbsp;<input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Events/Processing Feedback</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#introduction">Introduction</a>
+</li>
+<li>
+<a href="#consumer">The consumer side</a>
+<ul class="minitoc">
+<li>
+<a href="#write-listener">Writing an EventListener</a>
+</li>
+<li>
+<a href="#add-listener">Adding an EventListener</a>
+</li>
+<li>
+<a href="#listener-example1">An additional listener example</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#producer">The producer side (for FOP developers)</a>
+<ul class="minitoc">
+<li>
+<a href="#basic-event-production">Producing and sending an event</a>
+</li>
+<li>
+<a href="#event-producer">The EventProducer interface</a>
+</li>
+<li>
+<a href="#event-model">The event model</a>
+</li>
+<li>
+<a href="#event-severity">Event severity</a>
+</li>
+<li>
+<a href="#plug-ins">Plug-ins to the event subsystem</a>
+</li>
+<li>
+<a href="#l10n">Localization (L10n)</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+    
+<a name="N10011"></a><a name="introduction"></a>
+<h2 class="underlined_10">Introduction</h2>
+<div class="section">
+<p>
+        In versions until 0.20.5, FOP used
+        <a class="external" href="http://excalibur.apache.org/framework/index.html">Avalon-style Logging</a> where
+        it was possible to supply a logger per processing run. During the redesign
+        the logging infrastructure was switched over to
+        <a class="external" href="http://commons.apache.org/logging/">Commons Logging</a> which is (like Log4J or
+        java.util.logging) a "static" logging framework (the logger is accessed through static
+        variables). This made it very difficult in a multi-threaded system to retrieve information
+        for a single processing run.
+      </p>
+<p>
+        With FOP's event subsystem, we'd like to close this gap again and even go further. The
+        first point is to realize that we have two kinds of "logging". Firstly, we have the logging
+        infrastructure for the (FOP) developer who needs to be able to enable finer log messages
+        for certain parts of FOP to track down a certain problem. Secondly, we have the user who
+        would like to be informed about missing images, overflowing lines or substituted fonts.
+        These messages (or events) are targeted at less technical people and may ideally be
+        localized (translated). Furthermore, tool and solution builders would like to integrate
+        FOP into their own solutions. For example, an FO editor should be able to point the user
+        to the right place where a particular problem occurred while developing a document template.
+        Finally, some integrators would like to abort processing if a resource (an image or a font)
+        has not been found, while others would simply continue. The event system allows to
+        react on these events.
+      </p>
+<p>
+        On this page, we won't discuss logging as such. We will show how the event subsystem can
+        be used for various tasks. We'll first look at the event subsystem from the consumer side.
+        Finally, the production of events inside FOP will be discussed (this is mostly interesting
+        for FOP developers only).
+      </p>
+</div>
+    
+<a name="N10029"></a><a name="consumer"></a>
+<h2 class="underlined_10">The consumer side</h2>
+<div class="section">
+<p>
+        The event subsystem is located in the <span class="codefrag">org.apache.fop.events</span> package and its
+        base is the <span class="codefrag">Event</span> class. An instance is created for each event and is sent
+        to a set of <span class="codefrag">EventListener</span> instances by the <span class="codefrag">EventBroadcaster</span>.
+        An <span class="codefrag">Event</span> contains:
+      </p>
+<ul>
+        
+<li>an event ID,</li>
+        
+<li>a source object (which generated the event),</li>
+        
+<li>a severity level (Info, Warning, Error and Fatal Error) and</li>
+        
+<li>a map of named parameters.</li>
+      
+</ul>
+<p>
+        The <span class="codefrag">EventFormatter</span> class can be used to translate the events into
+        human-readable, localized messages.
+      </p>
+<p>
+        A full example of what is shown here can be found in the
+        <span class="codefrag">examples/embedding/java/embedding/events</span> directory in the FOP distribution.
+        The example can also be accessed
+        <a class="external" href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/examples/embedding/java/embedding/events/">via the web</a>.
+      </p>
+<a name="N10060"></a><a name="write-listener"></a>
+<h3 class="underlined_5">Writing an EventListener</h3>
+<p>
+          The following code sample shows a very simple EventListener. It basically just sends
+          all events to System.out (stdout) or System.err (stderr) depending on the event severity.
+        </p>
+<pre class="code">import org.apache.fop.events.Event;
+import org.apache.fop.events.EventFormatter;
+import org.apache.fop.events.EventListener;
+import org.apache.fop.events.model.EventSeverity;
+
+/** A simple event listener that writes the events to stdout and stderr. */
+public class SysOutEventListener implements EventListener {
+
+    /** {@inheritDoc} */
+    public void processEvent(Event event) {
+        String msg = EventFormatter.format(event);
+        EventSeverity severity = event.getSeverity();
+        if (severity == EventSeverity.INFO) {
+            System.out.println("[INFO ] " + msg);
+        } else if (severity == EventSeverity.WARN) {
+            System.out.println("[WARN ] " + msg);
+        } else if (severity == EventSeverity.ERROR) {
+            System.err.println("[ERROR] " + msg);
+        } else if (severity == EventSeverity.FATAL) {
+            System.err.println("[FATAL] " + msg);
+        } else {
+            assert false;
+        }
+    }
+}</pre>
+<p>
+          You can see that for every event the method <span class="codefrag">processEvent</span> of the
+          <span class="codefrag">EventListener</span> will be called. Inside this method you can do whatever
+          processing you would like including throwing a <span class="codefrag">RuntimeException</span>, if you want
+          to abort the current processing run.
+        </p>
+<p>
+          The code above also shows how you can turn an event into a human-readable, localized
+          message that can be presented to a user. The <span class="codefrag">EventFormatter</span> class does
+          this for you. It provides additional methods if you'd like to explicitly specify
+          the locale.
+        </p>
+<p>
+          It is possible to gather all events for a whole processing run so they can be
+          evaluated afterwards. However, care should be taken about memory consumption since
+          the events provide references to objects inside FOP which may themselves have
+          references to other objects. So holding on to these objects may mean that whole
+          object trees cannot be released!
+        </p>
+<a name="N10083"></a><a name="add-listener"></a>
+<h3 class="underlined_5">Adding an EventListener</h3>
+<p>
+          To register the event listener with FOP, get the <span class="codefrag">EventBroadcaster</span> which
+          is associated with the user agent (<span class="codefrag">FOUserAgent</span>) and add it there:
+        </p>
+<pre class="code">FOUserAgent foUserAgent = fopFactory.newFOUserAgent();
+foUserAgent.getEventBroadcaster().addEventListener(new SysOutEventListener());</pre>
+<p>
+          Please note that this is done separately for each processing run, i.e. for each
+          new user agent.
+        </p>
+<a name="N1009A"></a><a name="listener-example1"></a>
+<h3 class="underlined_5">An additional listener example</h3>
+<p>
+          Here's an additional example of an event listener:
+        </p>
+<p>
+          By default, FOP continues processing even if an image wasn't found. If you have
+          more strict requirements and want FOP to stop if an image is not available, you can
+          do something like the following in the simplest case:
+        </p>
+<pre class="code">public class MyEventListener implements EventListener {
+
+    public void processEvent(Event event) {
+        if ("org.apache.fop.ResourceEventProducer".equals(
+                event.getEventGroupID())) {
+            event.setSeverity(EventSeverity.FATAL);
+        } else {
+            //ignore all other events (or do something of your choice)
+        }
+    }
+    
+}</pre>
+<p>
+          Increasing the event severity to FATAL will signal the event broadcaster to throw
+          an exception and stop further processing. In the above case, all resource-related
+          events will cause FOP to stop processing.
+        </p>
+<p>
+          You can also customize the exception to throw (you can may throw a RuntimeException
+          or subclass yourself) and/or which event to respond to:
+        </p>
+<pre class="code">public class MyEventListener implements EventListener {
+
+    public void processEvent(Event event) {
+        if ("org.apache.fop.ResourceEventProducer.imageNotFound"
+                .equals(event.getEventID())) {
+            
+            //Get the FileNotFoundException that's part of the event's parameters
+            FileNotFoundException fnfe = (FileNotFoundException)event.getParam("fnfe");
+
+            throw new RuntimeException(EventFormatter.format(event), fnfe);
+        } else {
+            //ignore all other events (or do something of your choice)
+        }
+    }
+    
+}</pre>
+<p>
+          This throws a <span class="codefrag">RuntimeException</span> with the <span class="codefrag">FileNotFoundException</span>
+          as the cause. Further processing effectively stops in FOP. You can catch the exception
+          in your code and react as you see necessary.
+        </p>
+</div>
+    
+<a name="N100BF"></a><a name="producer"></a>
+<h2 class="underlined_10">The producer side (for FOP developers)</h2>
+<div class="section">
+<p>
+        This section is primarily for FOP and FOP plug-in developers. It describes how to use
+        the event subsystem for producing events.
+      </p>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+        The event package has been designed in order to be theoretically useful for use cases
+        outside FOP. If you think this is interesting independently from FOP, please talk to
+        <a href="mailto:fop-dev.at.xmlgraphics.apache.org">us</a>.
+      </div>
+</div>
+<a name="N100CF"></a><a name="basic-event-production"></a>
+<h3 class="underlined_5">Producing and sending an event</h3>
+<p>
+          The basics are very simple. Just instantiate an <span class="codefrag">Event</span> object and fill
+          it with the necessary parameters. Then pass it to the <span class="codefrag">EventBroadcaster</span>
+          which distributes the events to the interested listeneners. Here's a code example:
+        </p>
+<pre class="code">Event ev = new Event(this, "complain", EventSeverity.WARN,
+        Event.paramsBuilder()
+            .param("reason", "I'm tired")
+            .param("blah", new Integer(23))
+            .build());
+EventBroadcaster broadcaster = [get it from somewhere];
+broadcaster.broadcastEvent(ev);
+</pre>
+<p>
+          The <span class="codefrag">Event.paramsBuilder()</span> is a
+          <a class="external" href="http://en.wikipedia.org/wiki/Fluent_interface">fluent interface</a>
+          to help with the build-up of the parameters. You could just as well instantiate a
+          <span class="codefrag">Map</span> (<span class="codefrag">Map&lt;String, Object&gt;</span>) and fill it with values.
+        </p>
+<a name="N100F3"></a><a name="event-producer"></a>
+<h3 class="underlined_5">The EventProducer interface</h3>
+<p>
+          To simplify event production, the event subsystem provides the <span class="codefrag">EventProducer</span>
+          interface. You can create interfaces which extend <span class="codefrag">EventProducer</span>. These
+          interfaces will contain one method per event to be generated. By contract, each event
+          method must have as its first parameter a parameter named "source" (Type Object) which
+          indicates the object that generated the event. After that come an arbitrary number of
+          parameters of any type as needed by the event.
+        </p>
+<p>
+          The event producer interface does not need to have any implementation. The implementation
+          is produced at runtime by a dynamic proxy created by <span class="codefrag">DefaultEventBroadcaster</span>.
+          The dynamic proxy creates <span class="codefrag">Event</span> instances for each method call against
+          the event producer interface. Each parameter (except "source") is added to the event's
+          parameter map.
+        </p>
+<p>
+          To simplify the code needed to get an instance of the event producer interface it is
+          suggested to create a public inner provider class inside the interface.
+        </p>
+<p>
+          Here's an example of such an event producer interface:
+        </p>
+<pre class="code">public interface MyEventProducer extends EventProducer {
+
+    public class Provider {
+        
+        public static MyEventProducer get(EventBroadcaster broadcaster) {
+            return (MyEventProducer)broadcaster.getEventProducerFor(MyEventProducer.class);
+        }
+    }
+
+    /**
+     * Complain about something.
+     * @param source the event source
+     * @param reason the reason for the complaint
+     * @param blah the complaint
+     * @event.severity WARN
+     */
+    void complain(Object source, String reason, int blah);
+    
+}</pre>
+<p>
+          To produce the same event as in the first example above, you'd use the following code:
+        </p>
+<pre class="code">EventBroadcaster broadcaster = [get it from somewhere];
+TestEventProducer producer = TestEventProducer.Provider.get(broadcaster);
+producer.complain(this, "I'm tired", 23);</pre>
+<a name="N1011D"></a><a name="event-model"></a>
+<h3 class="underlined_5">The event model</h3>
+<p>
+          Inside an invocation handler for a dynamic proxy, there's no information about
+          the names of each parameter. The JVM doesn't provide it. The only thing you know is
+          the interface and method name. In order to properly fill the <span class="codefrag">Event</span>'s
+          parameter map we need to know the parameter names. These are retrieved from an
+          event object model. This is found in the <span class="codefrag">org.apache.fop.events.model</span>
+          package. The data for the object model is retrieved from an XML representation of the
+          event model that is loaded as a resource. The XML representation is generated using an
+          Ant task at build time (<span class="codefrag">ant resourcegen</span>). The Ant task (found in
+          <span class="codefrag">src/codegen/java/org/apache/fop/tools/EventProducerCollectorTask.java</span>)
+          scans FOP's sources for descendants of the <span class="codefrag">EventProducer</span> interface and
+          uses <a class="external" href="http://qdox.codehaus.org/">QDox</a> to parse these interfaces.
+        </p>
+<p>
+          The event model XML files are generated during build by the Ant task mentioned above when
+          running the "resourcegen" task. So just run <span class="codefrag">"ant resourcegen"</span> if you receive
+          a <span class="codefrag">MissingResourceException</span> at runtime indicating that
+          <span class="codefrag">"event-model.xml"</span> is missing.
+        </p>
+<p>
+          Primarily, the QDox-based collector task records the parameters' names and types.
+          Furthermore, it extracts additional attributes embedded as Javadoc comments from
+          the methods. At the moment, the only such attribute is "@event.severity" which indicates
+          the default event severity (which can be changed by event listeners). The example event
+          producer above shows the Javadocs for an event method.
+        </p>
+<p>
+          There's one more information that is extracted from the event producer information for
+          the event model: an optional primary exception. The first exception in the "throws"
+          declaration of an event method is noted. It is used to throw an exception from
+          the invocation handler if the event has an event severity of "FATAL" when all
+          listeners have been called (listeners can update the event severity). Please note
+          that an implementation of
+          <span class="codefrag">org.apache.fop.events.EventExceptionManager$ExceptionFactory</span> has to be
+          registered for the <span class="codefrag">EventExceptionManager</span> to be able to construct the
+          exception from an event.
+        </p>
+<p>
+          For a given application, there can be multiple event models active at the same time.
+          In FOP, each renderer is considered to be a plug-in and provides its own specific
+          event model. The individual event models are provided through an
+          <span class="codefrag">EventModelFactory</span>. This interface is implemented for each event model
+          and registered through the service provider mechanism
+          (see the <a href="#plug-ins">plug-ins section</a> for details).
+        </p>
+<a name="N1015C"></a><a name="event-severity"></a>
+<h3 class="underlined_5">Event severity</h3>
+<p>
+          Four different levels of severity for events has been defined:
+        </p>
+<ol>
+          
+<li>INFO: informational only</li>
+          
+<li>WARN: a Warning</li>
+          
+<li>ERROR: an error condition from which FOP can recover. FOP will continue processing.</li>
+          
+<li>FATAL: a fatal error which causes an exception in the end and FOP will stop processing.</li>
+        
+</ol>
+<p>
+          Event listeners can choose to ignore certain events based on their event severity.
+          Please note that you may recieve an event "twice" in a specific case: if there is
+          a fatal error an event is generated and sent to the listeners. After that an exception
+          is thrown with the same information and processing stops. If the fatal event is
+          shown to the user and the following exception is equally presented to the user it
+          may appear that the event is duplicated. Of course, the same information is just
+          published through two different channels.
+        </p>
+<a name="N10178"></a><a name="plug-ins"></a>
+<h3 class="underlined_5">Plug-ins to the event subsystem</h3>
+<p>
+          The event subsystem is extensible. There are a number of extension points:
+        </p>
+<ul>
+          
+<li>
+            
+<strong><span class="codefrag">org.apache.fop.events.model.EventModelFactory</span>:</strong> Provides
+            an event model to the event subsystem.
+          </li>
+          
+<li>
+            
+<strong><span class="codefrag">org.apache.fop.events.EventExceptionManager$ExceptionFactory</span>:</strong>
+            Creates exceptions for events, i.e. turns an event into a specific exception.
+          </li>
+        
+</ul>
+<p>
+          The names in bold above are used as filenames for the service provider files that
+          are placed in the <span class="codefrag">META-INF/services</span> directory. That way, they are
+          automatically detected. This is a mechanism defined by the
+          <a class="external" href="http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html#Service%20Provider">JAR file specification</a>.
+        </p>
+<a name="N1019F"></a><a name="l10n"></a>
+<h3 class="underlined_5">Localization (L10n)</h3>
+<p>
+          One goal of the event subsystem was to have localized (translated) event messages.
+          The <span class="codefrag">EventFormatter</span> class can be used to convert an event to a
+          human-readable message. Each <span class="codefrag">EventProducer</span> can provide its own XML-based
+          translation file. If there is none, a central translation file is used, called
+          "EventFormatter.xml" (found in the same directory as the <span class="codefrag">EventFormatter</span>
+          class).
+        </p>
+<p>
+          The XML format used by the <span class="codefrag">EventFormatter</span> is the same as
+          <a class="external" href="http://cocoon.apache.org/">Apache Cocoon's</a> catalog format. Here's an example:
+        </p>
+<pre class="code">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;catalogue xml:lang="en"&gt;
+  &lt;message key="locator"&gt;
+    [ (See position {loc})| (See {#gatherContextInfo})| (No context info available)]
+  &lt;/message&gt;
+  &lt;message key="org.apache.fop.render.rtf.RTFEventProducer.explicitTableColumnsRequired"&gt;
+    RTF output requires that all table-columns for a table are defined. Output will be incorrect.{{locator}}
+  &lt;/message&gt;
+  &lt;message key="org.apache.fop.render.rtf.RTFEventProducer.ignoredDeferredEvent"&gt;
+    Ignored deferred event for {node} ({start,if,start,end}).{{locator}}
+  &lt;/message&gt;
+&lt;/catalogue&gt;
+</pre>
+<p>
+          The example (extracted from the RTF handler's event producer) has message templates for
+          two event methods. The class used to do variable replacement in the templates is
+          <span class="codefrag">org.apache.fop.util.text.AdvancedMessageFormat</span> which is more powerful
+          than the <span class="codefrag">MessageFormat</span> classes provided by the Java class library
+          (<span class="codefrag">java.util.text</span> package).
+        </p>
+<p>
+          "locator" is a template that is reused by the other message templates
+          by referencing it through "{{locator}}". This is some kind of include command.
+        </p>
+<p>
+          Normal event parameters are accessed by name inside single curly braces, for example:
+          "{node}". For objects, this format just uses the <span class="codefrag">toString()</span> method to turn
+          the object into a string, unless there is an <span class="codefrag">ObjectFormatter</span> registered
+          for that type (there's an example for <span class="codefrag">org.xml.sax.Locator</span>).
+        </p>
+<p>
+          The single curly braces pattern supports additional features. For example, it is possible
+          to do this: "{start,if,start,end}". "if" here is a special field modifier that evaluates
+          "start" as a boolean and if that is true returns the text right after the second comma
+          ("start"). Otherwise it returns the text after the third comma ("end"). The "equals"
+          modifier is similar to "if" but it takes as an additional (comma-separated) parameter
+          right after the "equals" modifier, a string that is compared to the value of the variable.
+          An example: {severity,equals,EventSeverity:FATAL,,some text} (this adds "some text" if
+          the severity is not FATAL).
+        </p>
+<p>
+          Additional such modifiers can be added by implementing the
+          <span class="codefrag">AdvancedMessageFormat$Part</span> and <span class="codefrag">AdvancedMessageFormat$PartFactory</span>
+          interfaces.
+        </p>
+<p>
+          Square braces can be used to specify optional template sections. The whole section will
+          be omitted if any of the variables used within are unavailable. Pipe (|) characters can
+          be used to specify alternative sub-templates (see "locator" above for an example).
+        </p>
+<p>
+          Developers can also register a function (in the above example:
+          <span class="codefrag">{#gatherContextInfo})</span>
+          to do more complex information rendering. These functions are implementations of the
+          <span class="codefrag">AdvancedMessageFormat$Function</span> interface. Please take care that this is
+          done in a locale-independent way as there is no locale information available, yet.
+        </p>
+</div>
+  
+<span class="version">
+          version 964711</span>
+</div>
+<!--+
+    |end content
+    +-->
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<!--+
+    |start bottomstrip
+    +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         1999-2009 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
+</div>
+<!--+
+    |end bottomstrip
+    +-->
+</div>
+</body>
+</html>

Propchange: xmlgraphics/site/deploy/fop/1.0/events.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xmlgraphics/site/deploy/fop/1.0/events.html
------------------------------------------------------------------------------
    svn:keywords = Id



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org