XF Rendering Server 2007 Java Tutorial and QuickStarts Copyright ECRION Software. All Rights Reserved.

Size: px

Start display at page:

Kelly Campbell
6 years ago
Views:

1 XF Rendering Server 2007 Java Tutorial and QuickStarts Copyright ECRION Software. All Rights Reserved. This document is designed to quickly acquaint Java programmers with the programming model of XF Rendering Server 2007 Java SDK (Software Development Kit). Please contact Technical Support at if you need additional information about this product, or visit our Web Site at Table of Contents About XF Rendering Server Product Features... 2 Before You Get Started Platform Requirements... 2 Feedback and Support... 2 XF Rendering Server 2007 Java Tutorial... 3 Hello World!... 4 XSL Transformations... 5 In Memory Operations... 6 Selective Rendering and Thumbnails... 7 Using XF Merge Contexts... 8 Print... 9 Last updated: August 2006 Important Notice: This document and the information within is furnished as is and is subject to change without notice. In no event shall the author be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the use of or inability to use this product, even if the author has been advised of the possibility of such damages. This document was generated using XF Rendering Server For the latest version, visit Technical Resources section on our web site.

2 Chapter 1: About XF Rendering Server 2007 About XF Rendering Server 2007 XF Rendering Server 2007 is a highly scalable, enterprise class rendering product. It can be used to automate the creation of electronic documents like technical manuals, brochures, proposals, business reports containing charts and graphs, by dynamically generating them from XML. XF Rendering Server 2007 supports two major industry standards: XSL-FO (Extensible Style Language Formatting Objects) describing how an XML document should be formatted for a variety of media as well as SVG (Scalable Vector Graphics) used to describe twodimensional vector and mixed vector/raster graphics in XML. In addition, high quality, all-purpose charts can be generated directly from XML using xchart XML language. More information can be found in xchart 1.0 Language Reference. Product Features Supports XSL-FO, SVG, WordML, xchart as input. Produces PDF, Postscript, HTML, GIF, JPEG, PNG, BMP, TIFF, AFP and other formats. Supports TrueType and Postscript Type 1 font embedding. Scalable server architecture that can run across multiple CPUs, meeting the highperformance needs of your applications. Available in 32 bit and 64 bit editions. Is accessible from a multitude of development environments: C++, VB, ASP, Java, Java. Includes XF Designer 2004 XSL-FO authoring tool. Before You Get Started... In order to compile the samples you must have JDK Java compiler instaled. Platform Requirements XF Rendering Server 2007 can be used in the Microsoft Windows 2000 Professional and Server, Windows XP (32 and 64 bit) and Windows Server 2003 (32 and 64 bit) environments. Minimum Intel Pentium III, AMD Athlon 500 MHz or better. Intel Pentium IV 2.4 GHz recommended for development computers, dual XEON 3.0 GHz for production servers. Minimum 128 Mb RAM, 512 Mb recommended for development computers, 1Gb for productions servers. Feedback and Support Send error reports, feature requests, and comments about the SDK documentation or samples directly to the Technical Support team. Further information about support options can be found on the Web site. Copyright ECRION Software. All Rights Reserved. Page 2 of 10

3 XF Rendering Server 2007 Java Tutorial The tutorial provides a step-by-step introduction to fundamental areas of programming using the XF Rendering Server Java samples are included when you install the product. The location of the samples has a path similar to the following. Here, it is assumed that C: is the XF Rendering Server 2007 installation drive: C:\Program Files\ Software\XF Rendering Server 2007\Code Samples\ The tutorial includes the following sections: Hello World! XSL Transformations In Memory Operations Selective Rendering and Thumbnails Using Merge Contexts Print Demonstrates the basic code needed to create a console application using the Java Environment and generate a PDF document. Demonstrates how to transform XML using a stylesheet and then feed this input into the rendering engine. Demonstrates how to receive rendering output in a memory stream. Demonstrates how to generate thumnails and render pages selectively. Describes how to render multiple input documents into one output. Describes how to print documents. Copyright ECRION Software. All Rights Reserved. Page 3 of 10

4 Hello World! The following console program is the PDF version of the traditional "Hello World!" program, which displays the string Hello World!. import com.ecrion.xf.*; public class HelloWorld public static void main(string args[]) try XFEngine engine = new XFEngine(); engine.render( "<fo:root xmlns:fo=' + "<fo:layout-master-set>" + "<fo:simple-page-master master-name='all-pages'>" + "<fo:region-body region-name='xsl-region-body' margin='0.7in'/>" + "</fo:simple-page-master>" + "</fo:layout-master-set>" + "<fo:page-sequence master-reference='all-pages'>" + "<fo:flow flow-name='xsl-region-body'>" + "<fo:block>hello World!</fo:block>" + "</fo:flow>" + "</fo:page-sequence>" + "</fo:root>", "C:\\HelloWorld.pdf"); System.out.println("Document rendered successfully!\n"); catch (Exception e) // Report any errors that may occur System.out.println(e); The complete source code for this example is located in the installation folder, under Code Samples/Java/HelloWorld. To use the XFEngine class which is the engine for rendering documents you must import com.ecrion.xf package. To be able to do this you must add to the CLASSPATH environment variable the path to this package witch is by default located in the Software/XF Rendering Server 2007/Java folder. You have also in the Code Samples/Java folder a HelloWorld.bat that does this for you. Also HelloWorld.bat will execute the above example. This instructions stands for all code samples and also for all other programs that may use the ecrion.com.xf package. The path to this package could be added only once to the CLASSPATH variable. A XFEngine object is created. We call render, supplying an XSL-FO text and an output file name. Remarks When rendering in a file, the output format can be derived from the file's extension (in this case is PDF) if is not specified explicitly using setoutputformat/getoutputformat accesors. The method render accepts a string or InputStream derivative object as input. For output, use a string (denoting a file name), OutputStream derivative object. There is also another method called renderurl if the document you want converted to PDF resides in a file. Copyright ECRION Software. All Rights Reserved. Page 4 of 10

5 XSL Transformations One typical usage scenario is when you have a stylesheet (XSL) file, and you want to use-it to transform input XML into XSL-FO or XCHART and then generate PDF documents or JPG images. In this example you must add as parameters the input xml and xsl file. The result will be the Result.fo file located on the C: drive. XF Designer 2004 can be used to test transformation results and preview the generated PDFs (just open the XML, and hit F5). import javax.xml.transform.source; import javax.xml.transform.transformer; import javax.xml.transform.transformerfactory; import javax.xml.transform.stream.streamsource; import javax.xml.transform.stream.streamresult; import java.io.*; //This example ilustrates how to create a XSLFO file from an XML and a style sheet XSL //The result will be an.fo etension file public class XSLTransformations public static void main(string[] args) throws Exception if (args.length!= 2) System.err.println( "Usage: java XSLTransformations [xmlfile] [xsltfile]"); return; File xmlfile = new File(args[0]); File xsltfile = new File(args[1]); // JAXP reads data using the Source interface Source xmlsource = new StreamSource(xmlFile); Source xsltsource = new StreamSource(xsltFile); // the factory pattern supports different XSLT processors TransformerFactory transfact = TransformerFactory.newInstance(); Transformer trans = transfact.newtransformer(xsltsource); //transform the.fo result into a memory stream ByteArrayOutputStream memorystream = new ByteArrayOutputStream(); trans.transform(xmlsource, new StreamResult(memoryStream)); byte [] documentbytes = memorystream.tobytearray(); //transfer the.fo result into a disk file FileOutputStream fos = new FileOutputStream("C:\\Result.fo"); fos.write(documentbytes); The complete source code for this example is located in the installation folder, under Code Samples/Java/XSLTransformations. First, we create and load two documents: the input XML and the stylesheet. Transform the xml and xsl files into a stream sources. With TransformerFactory we transform the xsl and xml into an XSL-FO document. Copyright ECRION Software. All Rights Reserved. Page 5 of 10

6 In Memory Operations In memory only operations are useful in certain special situations like storing the generated PDFs in a database BLOB, performing additional post-processing, etc. The example below shows one way to create an in memory stream and then use it as output destination for the rendering process. import com.ecrion.xf.*; import java.io.*; public class InMemoryRendering public static void main(string args[]) try XFEngine engine = new XFEngine(); //Renders the result into a stream in memory ByteArrayOutputStream memorystream = new ByteArrayOutputStream(); // The output format must be specified when rendering into a Stream. engine.setoutputformat(xfengine.xof_pdf); // Render some XSL-FO text and place the output into our stream engine.render( "<fo:root xmlns:fo=' + "<fo:layout-master-set>" + "<fo:simple-page-master master-name='all-pages'>" + "<fo:region-body region-name='xsl-region-body' margin='0.7in'/>" + "</fo:simple-page-master>" + "</fo:layout-master-set>" + "<fo:page-sequence master-reference='all-pages'>" + "<fo:flow flow-name='xsl-region-body'>" + "<fo:block>hello World!</fo:block>" + "</fo:flow>" + "</fo:page-sequence>" + "</fo:root>", memorystream); //Do something useful with the stream //The bytes stored in memory byte [] documentbytes = memorystream.tobytearray(); //Write the bytes into a file FileOutputStream fos = new FileOutputStream("c:\\InMemoryRendering.pdf"); fos.write(documentbytes); fos.close(); memorystream.close(); System.out.println("Document rendered successfully!\n"); catch (Exception e) // Report any errors that may occur System.out.println(e); The complete source code for this example is located in the installation folder, under Code Samples/Java/InMemoryRendering. We create a memory stream (ByteArrayOutputStream) for storing the document. Output format must be set before calling render. Copyright ECRION Software. All Rights Reserved. Page 6 of 10

7 Call render passing the stream as the second parameter. Remarks Be aware that using this feature for large documents (>1MB) can result in poor performance if the sever doesn't have enough memory - the operating system will swap memory pages to disk in order to accommodate your memory requests. Selective Rendering and Thumbnails XF Rendering Server 2007 also offers support for selective rendering of document's pages, as well as resizing the output. You can use theese features to generate thumbnails, as shown below: import com.ecrion.xf.*; public class Thumbnail public static void main(string args[]) XFDocument doc = new XFDocument(); try doc.loadurl(" if (doc.getpagecount() > 0) double width = doc.getpagewidth(0); double height = doc.getpageheight(0); double zoom; double thumbsize = 256; if (thumbsize/width < thumbsize/height) zoom = thumbsize/width*100.0; else zoom = thumbsize/height*100.0; doc.setoutputformat(xfdocument.xof_bitmap); doc.setproperty("compression", 100); doc.setproperty("zoom", zoom); doc.setproperty("pages", "0"); doc.exportto("c:\\testpage0.bmp"); doc.setproperty("pages", "1"); doc.exportto("c:\\testpage1.bmp"); catch(exception e) // Report any errors that may occur System.out.println(e); finally doc.dispose(); // XFDocuments must aways be disposed properly! The complete source code for this example is located in the installation folder, under Code Samples/Java/Thumbnail. Document is loaded with loadurl (or load). The url in the code exists but can be any url. Once the document is loaded, you can find the number of pages, as well as the dimensions of each individual page. Use exportto to generate the output. You can call this method multiple times, for example to generate a thumbnail for each page, or to generate the document and a thumbnail of the first page, etc. Copyright ECRION Software. All Rights Reserved. Page 7 of 10

8 Using XF Merge Contexts XF can render multiple input documents into one output file or stream. This feature can very useful for printing jobs which require all inputs to be sent to a printer into one large file Postscript file. It can also be used for archiving purposes. The following code fragment exemplifies this feature: import com.ecrion.xf.*; public class MergeOfMultipleFoDocuments public static void main(string args[]) if (args.length<2) System.out.println(args.length); System.out.println("The first arguments represent the paths to the files that will be merged"); System.out.println("The last argument represents the result file"); return; XFMergeContext ctx = new XFMergeContext(); XFDocument doc=new XFDocument(); try //Setting the Merge Context //For merging putposes the output must be PDF or POSTSCRIPT only ctx.setoutputformat(xfmergecontext.xof_pdf); ctx.setoutput(args[args.length-1]); for (int i=0; i<args.length-1; i++) //merging the files System.out.println("Merging "+args[i]+"..."); doc.loadurl(args[i]); doc.exportto(ctx); System.out.println("Document rendered succesfuly..."); catch (Exception e) System.out.println("Exception occured: "+ e); finally doc.dispose();//the document must be disposed properly ctx.dispose();//the context must be disposed properly A merge context object is created. The output destination, as well as the output format are set. Please note that only PDF and POSTSCRIPT are valid output formats. More output formats may be added in the future. Each input is loaded into new instances of XFDocument, and then "exported" into the merge context. When the merge context is disposed, the renderer will perform closing tasks on the output. For PDF output this is equivalent with writing the trailer. Copyright ECRION Software. All Rights Reserved. Page 8 of 10

9 Remarks The example above describes a generic way to merge multiple inputs into one output. You can also use a OutputStream derivative object as parameter to SetOutput method. Please note that the merge context must be closed gracefully in order to obtain a valid output file. Print XF can print documents previously loaded with load or loadurl method. The following code fragment exemplifies this feature: import com.ecrion.xf.*; public class Print static boolean validatecommandline(string[] args) if (args.length!= 4 && args.length!= 5) return false; if ((!args[0].equals("-fo")) (!args[2].equals("-device"))) return false; if (args.length == 5 && (!args[4].equals("-gdi")) && (!args[4].equals("-ps")) && (!args[4].equals("-pcl"))) return false; return true; public static void main(string[] args) if (!validatecommandline(args)) System.out.println("Prints a XSL-FO file to a printer.\n"); System.out.println("java -cp [set classpath] print -fo fofile -device printer [-gdi -ps]\n"); System.out.println(" -fo\t\tthe XSL-FO file to be printed."); System.out.println(" -device\tthe printer name."); System.out.println(" -gdi\t\tprint using Widows GDI (default)."); System.out.println(" -ps\t\tprint as POSTSCRIPT directly to the device.\n"); System.out.println("Examples:"); System.out.println(" For a local printer:java -cp [set classpath] \t print -fo \"C:\\Test Print\\Test.fo\" -device HP4650"); System.out.println(" For a network printer:java -cp[set classpath] \t print -fo \"C:\\Test Print\\Test.fo\" -device \\\\PRINTSRV\\HP4650"); System.out.println(); return; String String String filename = args[1];//the full path to the file printername = args[3]; mode = args.length == 5? args[4]: "-gdi"; XFDocument doc = new XFDocument(); try doc.loadurl(filename); int pagecount = doc.getpagecount(); System.out.println("Printing "+filename+" to "+printername+" using " +mode+" mode..."); if (mode == "-gdi") doc.printto(printername, XFDocument.XPF_GDI); else if (mode == "-ps") doc.printto(printername, XFDocument.XPF_PCL); Copyright ECRION Software. All Rights Reserved. Page 9 of 10

10 else if (mode == "-pcl") doc.printto(printername, XFDocument.XPF_POSTSCRIPT); else throw new Exception("Unrecognized option: "+mode); doc.dispose(); catch (Exception e) System.out.println("Exception occured: "+ e); finally doc.dispose();// XFDocuments must aways be disposed properly! You must pass the command line arguments as the program explains. An instance of XFDocument is created and the document loads the input file given as parameter. The printto method is called and does the job for you. You must give the printer name and the print mode. You can get the printer from Control Panel/Printers and Faxes select a printer and right click properties. Copyright ECRION Software. All Rights Reserved. Page 10 of 10

XF RENDERING SERVER 2009 ARCHITECTS OVERVIEW

XF RENDERING SERVER 2009 ARCHITECTS OVERVIEW XF RENDERING SERVER 2009 XF Rendering Server 2009 is a high-volume, high-speed solution for generating a wide range of communication materials from XML. It