You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

embedding.xml 32KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680
  1. <?xml version="1.0" standalone="no"?>
  2. <!--
  3. Copyright 1999-2006 The Apache Software Foundation
  4. Licensed under the Apache License, Version 2.0 (the "License");
  5. you may not use this file except in compliance with the License.
  6. You may obtain a copy of the License at
  7. http://www.apache.org/licenses/LICENSE-2.0
  8. Unless required by applicable law or agreed to in writing, software
  9. distributed under the License is distributed on an "AS IS" BASIS,
  10. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. See the License for the specific language governing permissions and
  12. limitations under the License.
  13. -->
  14. <!-- $Id$ -->
  15. <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
  16. <!-- Embedding FOP -->
  17. <document>
  18. <header>
  19. <title>Apache FOP: Embedding</title>
  20. <subtitle>How to Embed FOP in a Java application</subtitle>
  21. <version>$Revision$</version>
  22. </header>
  23. <body>
  24. <section id="overview">
  25. <title>Overview</title>
  26. <p>
  27. Review <a href="running.html">Running FOP</a> for important information that applies
  28. to embedded applications as well as command-line use, such as options and performance.
  29. </p>
  30. <p>
  31. To embed Apache FOP in your application, instantiate a new org.apache.fop.apps.FopFactory
  32. instance and create a new org.apache.fop.apps.Fop instance through one of the factory
  33. methods of FopFactory. There, you can specify which output format (i.e. Renderer) to use
  34. and you can optionally set the OutputStream to use to output the results of the
  35. rendering. You can customize FOP's behaviour by supplying
  36. your own FOUserAgent instance. The FOUserAgent can, for example, be used to
  37. set your own Renderer instance (details below). Finally, you retrieve a SAX
  38. DefaultHandler instance from the Fop instance to which you can send your
  39. FO file.
  40. </p>
  41. <note>
  42. We recently changed FOP's outer API to what we consider the final API. This might require
  43. some changes in your application. The main reasons for these changes were performance
  44. improvements due to better reuse of reusable objects and reduced use of static variables
  45. for added flexibility in complex environments.
  46. </note>
  47. </section>
  48. <section id="basics">
  49. <title>Basic Usage Pattern</title>
  50. <p>
  51. Apache FOP relies heavily on JAXP. It uses SAX events exclusively to receive the XSL-FO
  52. input document. It is therefore a good idea that you know a few things about JAXP (which
  53. is a good skill anyway). Let's look at the basic usage pattern for FOP...
  54. </p>
  55. <p>Here is the basic pattern to render an XSL-FO file to PDF:
  56. </p>
  57. <source><![CDATA[
  58. import org.apache.fop.apps.FopFactory;
  59. import org.apache.fop.apps.Fop;
  60. import org.apache.fop.apps.MimeConstants;
  61. /*..*/
  62. // Step 1: Construct a FopFactory
  63. // (reuse if you plan to render multiple documents!)
  64. FopFactory fopFactory = FopFactory.newInstance();
  65. // Step 2: Setup output stream.
  66. // Note: Using BufferedOutputStream for performance reasons (helpful with FileOutputStreams).
  67. OutputStream out = new BufferedOutputStream(new FileOutputStream(new File("C:/Temp/myfile.pdf")));
  68. try {
  69. // Step 3: Construct fop with desired output format
  70. Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, out);
  71. // Step 4: Setup JAXP using identity transformer
  72. TransformerFactory factory = TransformerFactory.newInstance();
  73. Transformer transformer = factory.newTransformer(); // identity transformer
  74. // Step 5: Setup input and output for XSLT transformation
  75. // Setup input stream
  76. Source src = new StreamSource(new File("C:/Temp/myfile.fo"));
  77. // Resulting SAX events (the generated FO) must be piped through to FOP
  78. Result res = new SAXResult(fop.getDefaultHandler());
  79. // Step 6: Start XSLT transformation and FOP processing
  80. transformer.transform(src, res);
  81. } finally {
  82. //Clean-up
  83. out.close();
  84. }]]></source>
  85. <p>
  86. Let's discuss these 5 steps in detail:
  87. </p>
  88. <ul>
  89. <li>
  90. <strong>Step 1:</strong> You create a new FopFactory instance. The FopFactory holds
  91. references to configuration information and cached data. It's important to reuse this
  92. instance if you plan to render multiple documents during a JVM's lifetime.
  93. </li>
  94. <li>
  95. <strong>Step 2:</strong> You set up an OutputStream that the generated document
  96. will be written to. It's a good idea to buffer the OutputStream as demonstrated
  97. to improve performance.
  98. </li>
  99. <li>
  100. <strong>Step 3:</strong> You create a new Fop instance through one of the factory
  101. methods on the FopFactory. You tell the FopFactory what your desired output format
  102. is. This is done by using the MIME type of the desired output format (ex. "application/pdf").
  103. You can use one of the MimeConstants.* constants. The second parameter is the
  104. OutputStream you've setup up in step 2.
  105. </li>
  106. <li>
  107. <strong>Step 4</strong> We recommend that you use JAXP Transformers even
  108. if you don't do XSLT transformations to generate the XSL-FO file. This way
  109. you can always use the same basic pattern. The example here sets up an
  110. "identity transformer" which just passes the input (Source) unchanged to the
  111. output (Result). You don't have to work with a SAXParser if you don't do any
  112. XSLT transformations.
  113. </li>
  114. <li>
  115. <strong>Step 5:</strong> Here you set up the input and output for the XSLT
  116. transformation. The Source object is set up to load the "myfile.fo" file.
  117. The Result is set up so the output of the XSLT transformation is sent to FOP.
  118. The FO file is sent to FOP in the form of SAX events which is the most efficient
  119. way. Please always avoid saving intermediate results to a file or a memory buffer
  120. because that affects performance negatively.
  121. </li>
  122. <li>
  123. <strong>Step 6:</strong> Finally, we start the XSLT transformation by starting
  124. the JAXP Transformer. As soon as the JAXP Transformer starts to send its output
  125. to FOP, FOP itself starts its processing in the background. When the
  126. <code>transform()</code> method returns FOP will also have finished converting
  127. the FO file to a PDF file and you can close the OutputStream.
  128. <note label="Tip!">
  129. It's a good idea to enclose the whole conversion in a try..finally statement. If
  130. you close the OutputStream in the finally section, this will make sure that the
  131. OutputStream is properly closed even if an exception occurs during the conversion.
  132. </note>
  133. </li>
  134. </ul>
  135. <p>
  136. If you're not totally familiar with JAXP Transformers, please have a look at the
  137. <a href="#examples">Embedding examples</a> below. The section contains examples
  138. for all sorts of use cases. If you look at all of them in turn you should be able
  139. to see the patterns in use and the flexibility this approach offers without adding
  140. too much complexity.
  141. </p>
  142. <p>
  143. This may look complicated at first, but it's really just the combination of an
  144. XSL transformation and a FOP run. It's also easy to comment out the FOP part
  145. for debugging purposes, for example when you're tracking down a bug in your
  146. stylesheet. You can easily write the XSL-FO output from the XSL transformation
  147. to a file to check if that part generates the expected output. An example for that
  148. can be found in the <a href="#examples">Embedding examples</a> (See "ExampleXML2FO").
  149. </p>
  150. <section id="basic-logging">
  151. <title>Logging</title>
  152. <p>
  153. Logging is now a little different than it was in FOP 0.20.5. We've switched from
  154. Avalon Logging to <a href="ext:jakarta/commons/logging">Jakarta Commons Logging</a>.
  155. While with Avalon Logging the loggers were directly given to FOP, FOP now retrieves
  156. its logger(s) through a statically available LogFactory. This is similar to the
  157. general pattern that you use when you work with Apache Log4J directly, for example.
  158. We call this "static logging" (Commons Logging, Log4J) as opposed to "instance logging"
  159. (Avalon Logging). This has a consequence: You can't give FOP a logger for each
  160. processing run anymore. The log output of multiple, simultaneously running FOP instances
  161. is sent to the same logger.
  162. </p>
  163. <note>
  164. We know this may be an issue in multi-threaded server environments if you'd like to
  165. know what's going on in every single FOP processing run. We're planning to add an
  166. additional feedback facility to FOP which can be used to obtain all sorts of specific
  167. feedback (validation messages, layout problems etc.). "Static logging" is mainly
  168. interesting for a developer working on FOP and for advanced users who are debugging
  169. FOP. We don't consider the logging output to be useful to normal FOP users. Please
  170. have some patience until we can add this feature or jump in and help us build it. We've
  171. set up a <a href="http://wiki.apache.org/xmlgraphics-fop/ProcessingFeedback">Wiki page</a>
  172. which documents what we're going to build.
  173. </note>
  174. <p>
  175. By default, <a href="ext:jakarta/commons/logging">Jakarta Commons Logging</a> uses
  176. JDK logging (available in JDKs 1.4 or higher) as its backend. You can configure Commons
  177. Logging to use an alternative backend, for example Log4J. Please consult the
  178. <a href="ext:jakarta/commons/logging">documentation for Jakarta Commons Logging</a> on
  179. how to configure alternative backends.
  180. </p>
  181. </section>
  182. <section id="render">
  183. <title>Processing XSL-FO</title>
  184. <p>
  185. Once the Fop instance is set up, call <code>getDefaultHandler()</code> to obtain a SAX
  186. DefaultHandler instance to which you can send the SAX events making up the XSL-FO
  187. document you'd like to render. FOP processing starts as soon as the DefaultHandler's
  188. <code>startDocument()</code> methods is called. Processing stops again when the
  189. DefaultHandler's <code>endDocument()</code> method is called. Please refer to the basic
  190. usage pattern shown above to render a simple XSL-FO document.
  191. </p>
  192. </section>
  193. <section id="render-with-xslt">
  194. <title>Processing XSL-FO generated from XML+XSLT</title>
  195. <p>
  196. If you want to process XSL-FO generated from XML using XSLT we recommend
  197. again using standard JAXP to do the XSLT part and piping the generated SAX
  198. events directly through to FOP. The only thing you'd change to do that
  199. on the basic usage pattern above is to set up the Transformer differently:
  200. </p>
  201. <source><![CDATA[
  202. //before (without XSLT):
  203. //Transformer transformer = factory.newTransformer(); // identity transformer
  204. //after (with XSLT):
  205. Source xslt = new StreamSource(new File("mystylesheet.xsl"));
  206. Transformer transformer = factory.newTransformer(xslt);]]></source>
  207. </section>
  208. </section>
  209. <section id="input">
  210. <title>Input Sources</title>
  211. <p>
  212. The input XSL-FO document is always handled internally as SAX (see the
  213. <a href="../dev/design/parsing.html">Parsing Design Document</a> for the rationale).
  214. </p>
  215. <p>
  216. However, you may not always have your input document available as a SAX stream.
  217. But with JAXP it's easy to convert different input sources to a SAX stream so you
  218. can pipe it into FOP. That sounds more difficult than it is. You simply have
  219. to set up the right Source instance as input for the JAXP transformation.
  220. A few examples:
  221. </p>
  222. <ul>
  223. <li>
  224. <strong>URL:</strong> <code>Source src = new StreamSource("http://localhost:8080/testfile.xml");</code>
  225. </li>
  226. <li>
  227. <strong>File:</strong> <code>Source src = new StreamSource(new File("C:/Temp/myinputfile.xml"));</code>
  228. </li>
  229. <li>
  230. <strong>String:</strong> <code>Source src = new StreamSource(new StringReader(myString)); //myString is a String</code>
  231. </li>
  232. <li>
  233. <strong>InputStream:</strong> <code>Source src = new StreamSource(new MyInputStream(something));</code>
  234. </li>
  235. <li>
  236. <strong>Byte Array:</strong> <code>Source src = new StreamSource(new ByteArrayInputStream(myBuffer)); //myBuffer is a byte[] here</code>
  237. </li>
  238. <li>
  239. <strong>DOM:</strong> <code>Source src = new DOMSource(myDocument); //myDocument is a Document or a Node</code>
  240. </li>
  241. <li>
  242. <strong>Java Objects:</strong> Please have a look at the <a href="#examples">Embedding examples</a> which contains an example for this.
  243. </li>
  244. </ul>
  245. <p>
  246. There are a variety of upstream data manipulations possible.
  247. For example, you may have a DOM and an XSL stylesheet; or you may want to
  248. set variables in the stylesheet. Interface documentation and some cookbook
  249. solutions to these situations are provided in
  250. <a href="http://xml.apache.org/xalan-j/usagepatterns.html">Xalan Basic Usage Patterns</a>.
  251. </p>
  252. </section>
  253. <section id="config-internal">
  254. <title>Configuring Apache FOP Programmatically</title>
  255. <p>
  256. Apache FOP provides two levels on which you can customize FOP's
  257. behaviour: the FopFactory and the user agent.
  258. </p>
  259. <section id="fop-factory">
  260. <title>Customizing the FopFactory</title>
  261. <p>
  262. The FopFactory holds configuration data and references to objects which are reusable over
  263. multiple rendering runs. It's important to instantiate it only once (except in special
  264. environments) and reuse it every time to create new FOUserAgent and Fop instances.
  265. </p>
  266. <p>
  267. You can set all sorts of things on the FopFactory:
  268. </p>
  269. <ul>
  270. <li>
  271. <p>
  272. The <strong>font base URL</strong> to use when resolving relative URLs for fonts. Example:
  273. </p>
  274. <source>fopFactory.setFontBaseURL("file:///C:/Temp/fonts");</source>
  275. </li>
  276. <li>
  277. <p>
  278. Disable <strong>strict validation</strong>. When disabled FOP is less strict about the rules
  279. established by the XSL-FO specification. Example:
  280. </p>
  281. <source>fopFactory.setStrictValidation(false);</source>
  282. </li>
  283. <li>
  284. <p>
  285. Enable an <strong>alternative set of rules for text indents</strong> that tries to mimic the behaviour of many commercial
  286. FO implementations that chose to break the specification in this aspect. The default of this option is
  287. 'false' which causes Apache FOP to behave exactly as describes in the specification. To enable the
  288. alternative behaviour, call:
  289. </p>
  290. <source>fopFactory.setBreakIndentInheritanceOnReferenceAreaBoundary(true);</source>
  291. </li>
  292. <li>
  293. <p>
  294. Set the <strong>source resolution</strong> for the document. This is used internally to determine the pixel
  295. size for SVG images and bitmap images without resolution information. Default: 72 dpi. Example:
  296. </p>
  297. <source>fopFactory.setSourceResolution(96); //=96dpi (dots/pixels per Inch)</source>
  298. </li>
  299. <li>
  300. <p>
  301. Manually add a <strong>ElementMapping instance</strong>. If you want to supply a special FOP extension
  302. you can give the instance to the FOUserAgent. Normally, the FOP extensions can be automatically detected
  303. (see the documentation on extension for more info).
  304. </p>
  305. <source>fopFactory.addElementMapping(myElementMapping); //myElementMapping is a org.apache.fop.fo.ElementMapping</source>
  306. </li>
  307. <li>
  308. <p>
  309. Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
  310. custom URI resolution functionality to FOP. For example, you can use
  311. <a href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</a> to make use of XCatalogs.
  312. </p>
  313. <source>fopFactory.setURIResolver(myResolver); //myResolver is a javax.xml.transform.URIResolver</source>
  314. <note>
  315. Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FopFactory
  316. is primarily used to resolve URIs on factory-level (hyphenation patterns, for example) and it is always used
  317. if no other URIResolver (for example on the FOUserAgent) resolved the URI first.
  318. </note>
  319. </li>
  320. </ul>
  321. </section>
  322. <section id="user-agent">
  323. <title>Customizing the User Agent</title>
  324. <p>
  325. The user agent is the entity that allows you to interact with a single rendering run, i.e. the processing of a single
  326. document. If you wish to customize the user agent's behaviour, the first step is to create your own instance
  327. of FOUserAgent using the respective factory method on FopFactory and pass that
  328. to the factory method that will create a new Fop instance:
  329. </p>
  330. <source><![CDATA[
  331. FopFactory fopFactory = FopFactory.newInstance(); //Reuse the FopFactory if possible!
  332. FOUserAgent userAgent = fopFactory.newFOUserAgent();
  333. Fop fop = fopFactory.newFop(MimeConstants.MIME_POSTSCRIPT, userAgent);]]></source>
  334. <p>
  335. You can do all sorts of things on the user agent:
  336. </p>
  337. <ul>
  338. <li>
  339. <p>
  340. The <strong>base URL</strong> to use when resolving relative URLs. Example:
  341. </p>
  342. <source>userAgent.setBaseURL("file:///C:/Temp/");</source>
  343. </li>
  344. <li>
  345. <p>
  346. 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:
  347. </p>
  348. <source>userAgent.setProducer("MyKillerApplication");</source>
  349. </li>
  350. <li>
  351. <p>
  352. 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:
  353. </p>
  354. <source>userAgent.setCreator("John Doe");</source>
  355. </li>
  356. <li>
  357. <p>
  358. Set the <strong>author</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
  359. </p>
  360. <source>userAgent.setAuthor("John Doe");</source>
  361. </li>
  362. <li>
  363. <p>
  364. 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:
  365. </p>
  366. <source>userAgent.setCreationDate(new Date());</source>
  367. </li>
  368. <li>
  369. <p>
  370. Set the <strong>title</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
  371. </p>
  372. <source>userAgent.setTitle("Invoice No 138716847");</source>
  373. </li>
  374. <li>
  375. <p>
  376. Set the <strong>keywords</strong> of the document. This is metadata information that can be used for certain output formats such as PDF. Example:
  377. </p>
  378. <source>userAgent.setKeywords("XML XSL-FO");</source>
  379. </li>
  380. <li>
  381. <p>
  382. Set the <strong>target resolution</strong> for the document. This is used to
  383. specify the output resolution for bitmap images generated by bitmap renderers
  384. (such as the TIFF renderer) and by bitmaps generated by Apache Batik for filter
  385. effects and such. Default: 72 dpi. Example:
  386. </p>
  387. <source>userAgent.setTargetResolution(300); //=300dpi (dots/pixels per Inch)</source>
  388. </li>
  389. <li>
  390. <p>
  391. Set <strong>your own Renderer instance</strong>. If you want to supply your own renderer or
  392. configure a Renderer in a special way you can give the instance to the FOUserAgent. Normally,
  393. the Renderer instance is created by FOP. Example:
  394. </p>
  395. <source>userAgent.setRendererOverride(myRenderer); //myRenderer is an org.apache.fop.render.Renderer</source>
  396. </li>
  397. <li>
  398. <p>
  399. Set <strong>your own FOEventHandler instance</strong>. If you want to supply your own FOEventHandler or
  400. configure an FOEventHandler subclass in a special way you can give the instance to the FOUserAgent. Normally,
  401. the FOEventHandler instance is created by FOP. Example:
  402. </p>
  403. <source>userAgent.setFOEventHandlerOverride(myFOEventHandler); //myFOEventHandler is an org.apache.fop.fo.FOEventHandler</source>
  404. </li>
  405. <li>
  406. <p>
  407. Set a <strong>URIResolver</strong> for custom URI resolution. By supplying a JAXP URIResolver you can add
  408. custom URI resolution functionality to FOP. For example, you can use
  409. <a href="ext:xml.apache.org/commons/resolver">Apache XML Commons Resolver</a> to make use of XCatalogs.
  410. </p>
  411. <source>userAgent.setURIResolver(myResolver); //myResolver is a javax.xml.transform.URIResolver</source>
  412. <note>
  413. Both the FopFactory and the FOUserAgent have a method to set a URIResolver. The URIResolver on the FOUserAgent is
  414. used for resolving URIs which are document-related. If it's not set or cannot resolve a URI, the URIResolver
  415. from the FopFactory is used.
  416. </note>
  417. </li>
  418. </ul>
  419. <note>
  420. You should not reuse an FOUserAgent instance between FOP rendering runs although you can. Especially
  421. in multi-threaded environment, this is a bad idea.
  422. </note>
  423. </section>
  424. </section>
  425. <section id="config-external">
  426. <title>Using a Configuration File</title>
  427. <p>
  428. Instead of setting the parameters manually in code as shown above you can also set
  429. many values from an XML configuration file:
  430. </p>
  431. <source><![CDATA[
  432. import org.apache.avalon.framework.configuration.Configuration;
  433. import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
  434. /*..*/
  435. DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder();
  436. Configuration cfg = cfgBuilder.buildFromFile(new File("C:/Temp/mycfg.xml"));
  437. fopFactory.setUserConfig(cfg);
  438. /* ..or.. */
  439. fopFactory.setUserConfig(new File("C:/Temp/mycfg.xml"));]]></source>
  440. <p>
  441. The layout of the configuration file is described on the <a href="configuration.html">Configuration page</a>.
  442. </p>
  443. </section>
  444. <section id="hints">
  445. <title>Hints</title>
  446. <section id="object-reuse">
  447. <title>Object reuse</title>
  448. <p>
  449. Fop instances shouldn't (and can't) be reused. Please recreate
  450. Fop and FOUserAgent instances for each rendering run using the FopFactory.
  451. This is a cheap operation as all reusable information is held in the
  452. FopFactory. That's why it's so important to reuse the FopFactory instance.
  453. </p>
  454. </section>
  455. <section id="awt">
  456. <title>AWT issues</title>
  457. <p>
  458. If your XSL-FO files contain SVG then Apache Batik will be used. When Batik is
  459. initialised it uses certain classes in <code>java.awt</code> that
  460. intialise the Java AWT classes. This means that a daemon thread
  461. is created by the JVM and on Unix it will need to connect to a
  462. DISPLAY.
  463. </p>
  464. <p>
  465. The thread means that the Java application may not automatically quit
  466. when finished, you will need to call <code>System.exit()</code>. These
  467. issues should be fixed in the JDK 1.4.
  468. </p>
  469. <p>
  470. If you run into trouble running FOP on a head-less server, please see the
  471. <a href="graphics.html#batik">notes on Batik</a>.
  472. </p>
  473. </section>
  474. <section id="render-info">
  475. <title>Getting information on the rendering process</title>
  476. <p>
  477. To get the number of pages that were rendered by FOP you can call
  478. <code>Fop.getResults()</code>. This returns a <code>FormattingResults</code> object
  479. where you can lookup the number of pages produced. It also gives you the
  480. page-sequences that were produced along with their id attribute and their
  481. number of pages. This is particularly useful if you render multiple
  482. documents (each enclosed by a page-sequence) and have to know the number of
  483. pages of each document.
  484. </p>
  485. </section>
  486. </section>
  487. <section id="performance">
  488. <title>Improving performance</title>
  489. <p>
  490. There are several options to consider:
  491. </p>
  492. <ul>
  493. <li>
  494. Whenever possible, try to use SAX to couple the individual components involved
  495. (parser, XSL transformer, SQL datasource etc.).
  496. </li>
  497. <li>
  498. Depending on the target OutputStream (in case of an FileOutputStream, but not
  499. for a ByteArrayOutputStream, for example) it may improve performance considerably
  500. if you buffer the OutputStream using a BufferedOutputStream:
  501. <code>fop.setOutputStream(new java.io.BufferedOutputStream(out));</code>
  502. <br/>
  503. Make sure you properly close the OutputStream when FOP is finished.
  504. </li>
  505. <li>
  506. Cache the stylesheet. If you use the same stylesheet multiple times
  507. you can setup a JAXP <code>Templates</code> object and reuse it each time you do
  508. the XSL transformation. (More information can be found
  509. <a class="fork" href="http://www.javaworld.com/javaworld/jw-05-2003/jw-0502-xsl.html">here</a>.)
  510. </li>
  511. <li>
  512. Use an XSLT compiler like <a class="fork" href="http://xml.apache.org/xalan-j/xsltc_usage.html">XSLTC</a>
  513. that comes with Xalan-J.
  514. </li>
  515. <li>
  516. Fine-tune your stylesheet to make the XSLT process more efficient and to create XSL-FO that can
  517. be processed by FOP more efficiently. Less is more: Try to make use of property inheritance where possible.
  518. </li>
  519. </ul>
  520. </section>
  521. <section id="multithreading">
  522. <title>Multithreading FOP</title>
  523. <p>
  524. Apache FOP may currently not be completely thread safe.
  525. The code has not been fully tested for multi-threading issues, yet.
  526. If you encounter any suspicious behaviour, please notify us.
  527. </p>
  528. <p>
  529. There is also a known issue with fonts being jumbled between threads when using
  530. the Java2D/AWT renderer (which is used by the -awt and -print output options).
  531. In general, you cannot safely run multiple threads through the AWT renderer.
  532. </p>
  533. </section>
  534. <section id="examples">
  535. <title>Examples</title>
  536. <p>
  537. The directory "{fop-dir}/examples/embedding" contains several working examples.
  538. In contrast to the examples above the examples here primarily use JAXP for
  539. XML access. This may be easier to understand for people familiar with JAXP.
  540. </p>
  541. <section id="ExampleFO2PDF">
  542. <title>ExampleFO2PDF.java</title>
  543. <p>This
  544. <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleFO2PDF.java?view=markup">
  545. example</a>
  546. demonstrates the basic usage pattern to transform an XSL-FO
  547. file to PDF using FOP.
  548. </p>
  549. <figure src="images/EmbeddingExampleFO2PDF.png" alt="Example XSL-FO to PDF"/>
  550. </section>
  551. <section id="ExampleXML2FO">
  552. <title>ExampleXML2FO.java</title>
  553. <p>This
  554. <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2FO.java?view=markup">
  555. example</a>
  556. has nothing to do with FOP. It is there to show you how an XML
  557. file can be converted to XSL-FO using XSLT. The JAXP API is used to do the
  558. transformation. Make sure you've got a JAXP-compliant XSLT processor in your
  559. classpath (ex. <a href="http://xml.apache.org/xalan-j">Xalan</a>).
  560. </p>
  561. <figure src="images/EmbeddingExampleXML2FO.png" alt="Example XML to XSL-FO"/>
  562. </section>
  563. <section id="ExampleXML2PDF">
  564. <title>ExampleXML2PDF.java</title>
  565. <p>This
  566. <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleXML2PDF.java?view=markup">
  567. example</a>
  568. demonstrates how you can convert an arbitrary XML file to PDF
  569. using XSLT and XSL-FO/FOP. It is a combination of the first two examples
  570. above. The example uses JAXP to transform the XML file to XSL-FO and FOP to
  571. transform the XSL-FO to PDF.
  572. </p>
  573. <figure src="images/EmbeddingExampleXML2PDF.png" alt="Example XML to PDF (via XSL-FO)"/>
  574. <p>
  575. The output (XSL-FO) from the XSL transformation is piped through to FOP using
  576. SAX events. This is the most efficient way to do this because the
  577. intermediate result doesn't have to be saved somewhere. Often, novice users
  578. save the intermediate result in a file, a byte array or a DOM tree. We
  579. strongly discourage you to do this if it isn't absolutely necessary. The
  580. performance is significantly higher with SAX.
  581. </p>
  582. </section>
  583. <section id="ExampleObj2XML">
  584. <title>ExampleObj2XML.java</title>
  585. <p>This
  586. <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2XML.java?view=markup">
  587. example</a>
  588. is a preparatory example for the next one. It's an example that
  589. shows how an arbitrary Java object can be converted to XML. It's an often
  590. needed task to do this. Often people create a DOM tree from a Java object and
  591. use that. This is pretty straightforward. The example here however shows how
  592. to do this using SAX which will probably be faster and not even more
  593. complicated once you know how this works.
  594. </p>
  595. <figure src="images/EmbeddingExampleObj2XML.png" alt="Example Java object to XML"/>
  596. <p>
  597. For this example we've created two classes: ProjectTeam and ProjectMember
  598. (found in xml-fop/examples/embedding/java/embedding/model). They represent
  599. the same data structure found in
  600. xml-fop/examples/embedding/xml/xml/projectteam.xml. We want to serialize a
  601. project team with several members which exist as Java objects to XML.
  602. Therefore we created the two classes: ProjectTeamInputSource and
  603. ProjectTeamXMLReader (in the same place as ProjectTeam above).
  604. </p>
  605. <p>
  606. The XMLReader implementation (regard it as a special kind of XML parser)is
  607. responsible for creating SAX events from the Java object. The InputSource
  608. class is only used to hold the ProjectTeam object to be used.
  609. </p>
  610. <p>
  611. Have a look at the source of ExampleObj2XML.java to find out how this is
  612. used. For more detailed information see other resources on JAXP (ex.
  613. <a class="fork" href="http://java.sun.com/xml/jaxp/dist/1.1/docs/tutorial/xslt/3_generate.html">An older JAXP tutorial</a>).
  614. </p>
  615. </section>
  616. <section id="ExampleObj2PDF">
  617. <title>ExampleObj2PDF.java</title>
  618. <p>This
  619. <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleObj2PDF.java?view=markup">
  620. example</a>
  621. combines the previous and the third to demonstrate
  622. how you can transform a Java object to a PDF directly in one smooth run
  623. by generating SAX events from the Java object that get fed to an XSL
  624. transformation. The result of the transformation is then converted to PDF
  625. using FOP as before.
  626. </p>
  627. <figure src="images/EmbeddingExampleObj2PDF.png" alt="Example Java object to PDF (via XML and XSL-FO)"/>
  628. </section>
  629. <section id="ExampleDOM2PDF">
  630. <title>ExampleDOM2PDF.java</title>
  631. <p>This
  632. <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleDOM2PDF.java?view=markup">
  633. example</a>
  634. has FOP use a DOMSource instead of a StreamSource in order to
  635. use a DOM tree as input for an XSL transformation.
  636. </p>
  637. </section>
  638. <section id="ExampleSVG2PDF">
  639. <title>ExampleSVG2PDF.java (PDF Transcoder example)</title>
  640. <p>This
  641. <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/examples/embedding/java/embedding/ExampleSVG2PDF.java?view=markup">
  642. example</a>
  643. shows use of the PDF Transcoder, a sub-application within FOP.
  644. It is used to generate a PDF document from an SVG file.
  645. </p>
  646. </section>
  647. <section id="example-notes">
  648. <title>Final notes</title>
  649. <p>
  650. These examples should give you an idea of what's possible. It should be easy
  651. to adjust these examples to your needs. Also, if you have other examples that you
  652. think should be added here, please let us know via either the fop-users or fop-dev
  653. mailing lists. Finally, for more help please send your questions to the fop-users
  654. mailing list.
  655. </p>
  656. </section>
  657. </section>
  658. </body>
  659. </document>