reportbuilder/java/org/libreoffice/report/pentaho/output/StylesWriter.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 package org.libreoffice.report.pentaho.output;
  19
  20 import org.libreoffice.report.pentaho.OfficeNamespaces;
  21 import org.libreoffice.report.pentaho.model.DataStyle;
  22 import org.libreoffice.report.pentaho.model.FontFaceDeclsSection;
  23 import org.libreoffice.report.pentaho.model.FontFaceElement;
  24 import org.libreoffice.report.pentaho.model.OfficeMasterPage;
  25 import org.libreoffice.report.pentaho.model.OfficeMasterStyles;
  26 import org.libreoffice.report.pentaho.model.OfficeStyle;
  27 import org.libreoffice.report.pentaho.model.OfficeStyles;
  28 import org.libreoffice.report.pentaho.model.OfficeStylesCollection;
  29 import org.libreoffice.report.pentaho.model.PageLayout;
  30 import org.libreoffice.report.pentaho.model.RawText;
  31
  32 import java.io.IOException;
  33 import java.io.Writer;
  34
  35 import java.util.Iterator;
  36 import java.util.Map;
  37 import java.util.TreeMap;
  38
  39 import org.jfree.layouting.namespace.Namespaces;
  40 import org.jfree.layouting.util.AttributeMap;
  41 import org.jfree.report.JFreeReportBoot;
  42 import org.jfree.report.JFreeReportInfo;
  43 import org.jfree.report.structure.Element;
  44 import org.jfree.report.structure.Node;
  45 import org.jfree.report.structure.Section;
  46 import org.jfree.report.structure.StaticText;
  47
  48 import org.pentaho.reporting.libraries.xmlns.common.AttributeList;
  49 import org.pentaho.reporting.libraries.xmlns.writer.DefaultTagDescription;
  50 import org.pentaho.reporting.libraries.xmlns.writer.XmlWriter;
  51 import org.pentaho.reporting.libraries.xmlns.writer.XmlWriterSupport;
  52
  53
  54 /**
  55  * This class writes the style collection into a 'styles.xml' document.
  56  *
  57  * @since 09.03.2007
  58  */
  59 public class StylesWriter
  60 {
  61
  62     private final XmlWriter xmlWriter;
  63     private final boolean writeOpeningTag;
  64
  65     public StylesWriter(final Writer writer)
  66     {
  67         final DefaultTagDescription tagDescription = new DefaultTagDescription();
  68         tagDescription.configure(JFreeReportBoot.getInstance().getGlobalConfig(),
  69                 OfficeDocumentReportTarget.TAG_DEF_PREFIX);
  70
  71         this.xmlWriter = new XmlWriter(writer, tagDescription);
  72         this.xmlWriter.setAlwaysAddNamespace(true);
  73         this.writeOpeningTag = true;
  74     }
  75
  76     public StylesWriter(final XmlWriter xmlWriter)
  77     {
  78         this.xmlWriter = xmlWriter;
  79         this.writeOpeningTag = false;
  80     }
  81
  82     public void writeContentStyles(
  83             final OfficeStylesCollection globals)
  84             throws IOException
  85     {
  86         writeFontFaces(new OfficeStylesCollection[]
  87                 {
  88                     globals
  89                 });
  90         writeAutomaticStylesSection(new OfficeStylesCollection[]
  91                 {
  92                     globals
  93                 });
  94     }
  95
  96     public void writeGlobalStyles(
  97             final OfficeStylesCollection globals)
  98             throws IOException
  99     {
 100         if (writeOpeningTag)
 101         {
 102             performWriteRootTag();
 103         }
 104
 105         writeFontFaces(new OfficeStylesCollection[]
 106                 {
 107                     globals
 108                 });
 109         writeCommonStylesSection(new OfficeStylesCollection[]
 110                 {
 111                     globals
 112                 });
 113         writeAutomaticStylesSection(new OfficeStylesCollection[]
 114                 {
 115                     globals
 116                 });
 117         writeMasterStylesSection(new OfficeStylesCollection[]
 118                 {
 119                     globals
 120                 });
 121
 122         if (writeOpeningTag)
 123         {
 124             xmlWriter.writeCloseTag();
 125         }
 126     }
 127
 128     private void writeMasterStylesSection(final OfficeStylesCollection[] osc)
 129             throws IOException
 130     {
 131         xmlWriter.writeTag(OfficeNamespaces.OFFICE_NS, "master-styles", XmlWriterSupport.OPEN);
 132         for (int sci = 0; sci < osc.length; sci++)
 133         {
 134             final OfficeStylesCollection collection = osc[sci];
 135             final OfficeMasterStyles officeStyles = collection.getMasterStyles();
 136             final OfficeMasterPage[] officeMasterPages = officeStyles.getAllMasterPages();
 137             for (int i = 0; i < officeMasterPages.length; i++)
 138             {
 139                 final OfficeMasterPage masterPage = officeMasterPages[i];
 140                 writeSection(masterPage);
 141             }
 142
 143             writeSectionChildren(officeStyles.getOtherNodes().getNodeArray());
 144         }
 145
 146         xmlWriter.writeCloseTag();
 147     }
 148
 149     private void writeCommonStylesSection(final OfficeStylesCollection[] osc)
 150             throws IOException
 151     {
 152         xmlWriter.writeTag(OfficeNamespaces.OFFICE_NS, "styles", XmlWriterSupport.OPEN);
 153
 154         for (int sci = 0; sci < osc.length; sci++)
 155         {
 156             final OfficeStylesCollection collection = osc[sci];
 157             final OfficeStyles officeStyles = collection.getCommonStyles();
 158             writeStyles(officeStyles);
 159         }
 160
 161         xmlWriter.writeCloseTag();
 162     }
 163
 164     private void writeAutomaticStylesSection(final OfficeStylesCollection[] osc)
 165             throws IOException
 166     {
 167         xmlWriter.writeTag(OfficeNamespaces.OFFICE_NS, "automatic-styles", XmlWriterSupport.OPEN);
 168         for (int sci = 0; sci < osc.length; sci++)
 169         {
 170             final OfficeStylesCollection collection = osc[sci];
 171             final OfficeStyles officeStyles = collection.getAutomaticStyles();
 172             writeStyles(officeStyles);
 173         }
 174
 175         xmlWriter.writeCloseTag();
 176     }
 177
 178     private void writeFontFaces(final OfficeStylesCollection[] osc)
 179             throws IOException
 180     {
 181         xmlWriter.writeTag(OfficeNamespaces.OFFICE_NS, "font-face-decls", XmlWriterSupport.OPEN);
 182
 183         final TreeMap<String,FontFaceElement> fontFaces = new TreeMap<String,FontFaceElement>();
 184         for (int sci = 0; sci < osc.length; sci++)
 185         {
 186             final OfficeStylesCollection collection = osc[sci];
 187             final FontFaceDeclsSection fontFaceDecls = collection.getFontFaceDecls();
 188             final FontFaceElement[] fontFaceElements = fontFaceDecls.getAllFontFaces();
 189             for (int i = 0; i < fontFaceElements.length; i++)
 190             {
 191                 final FontFaceElement element = fontFaceElements[i];
 192                 fontFaces.put(element.getStyleName(), element);
 193             }
 194         }
 195
 196         final Iterator<FontFaceElement> values = fontFaces.values().iterator();
 197         while (values.hasNext())
 198         {
 199             final FontFaceElement element = values.next();
 200             writeElement(element);
 201         }
 202
 203         xmlWriter.writeCloseTag();
 204     }
 205
 206     private void writeStyles(final OfficeStyles styles)
 207             throws IOException
 208     {
 209         final OfficeStyle[] allStyles = styles.getAllStyles();
 210         for (int i = 0; i < allStyles.length; i++)
 211         {
 212             final OfficeStyle style = allStyles[i];
 213             writeSection(style);
 214         }
 215
 216         final DataStyle[] allDataStyles = styles.getAllDataStyles();
 217         for (int i = 0; i < allDataStyles.length; i++)
 218         {
 219             final DataStyle style = allDataStyles[i];
 220             writeSection(style);
 221         }
 222
 223         final PageLayout[] allPageStyles = styles.getAllPageStyles();
 224         for (int i = 0; i < allPageStyles.length; i++)
 225         {
 226             final PageLayout style = allPageStyles[i];
 227             writeSection(style);
 228         }
 229
 230         writeSectionChildren(styles.getOtherStyles());
 231     }
 232
 233     private void writeElement(final Element element)
 234             throws IOException
 235     {
 236         final String type = element.getType();
 237         final String namespace = element.getNamespace();
 238         final AttributeList attrList = buildAttributeList(element.getAttributeMap());
 239         xmlWriter.writeTag(namespace, type, attrList, XmlWriterSupport.CLOSE);
 240     }
 241
 242     private void writeSection(final Section section)
 243             throws IOException
 244     {
 245         final String type = section.getType();
 246         final String namespace = section.getNamespace();
 247         final AttributeList attrList = buildAttributeList(section.getAttributeMap());
 248         if (section.getNodeCount() == 0)
 249         {
 250             xmlWriter.writeTag(namespace, type, attrList, XmlWriterSupport.CLOSE);
 251             return;
 252         }
 253
 254         xmlWriter.writeTag(namespace, type, attrList, XmlWriterSupport.OPEN);
 255         writeSectionChildren(section.getNodeArray());
 256
 257         xmlWriter.writeCloseTag();
 258     }
 259
 260     private void writeSectionChildren(final Node[] nodes)
 261             throws IOException
 262     {
 263         for (int i = 0; i < nodes.length; i++)
 264         {
 265             final Node node = nodes[i];
 266             if (node instanceof Section)
 267             {
 268                 writeSection((Section) node);
 269             }
 270             else if (node instanceof Element)
 271             {
 272                 writeElement((Element) node);
 273             }
 274             else if (node instanceof RawText)
 275             {
 276                 final RawText text = (RawText) node;
 277                 xmlWriter.writeText(text.getText());
 278             }
 279             else if (node instanceof StaticText)
 280             {
 281                 final StaticText text = (StaticText) node;
 282                 xmlWriter.writeTextNormalized(text.getText(), false);
 283             }
 284         }
 285     }
 286
 287     private AttributeList buildAttributeList(final AttributeMap attrs)
 288     {
 289         final AttributeList attrList = new AttributeList();
 290         final String[] namespaces = attrs.getNameSpaces();
 291         for (int i = 0; i < namespaces.length; i++)
 292         {
 293             final String attrNamespace = namespaces[i];
 294             if (isFilteredNamespace(attrNamespace))
 295             {
 296                 continue;
 297             }
 298
 299             final Map localAttributes = attrs.getAttributes(attrNamespace);
 300             final Iterator entries = localAttributes.entrySet().iterator();
 301             while (entries.hasNext())
 302             {
 303                 final Map.Entry entry = (Map.Entry) entries.next();
 304                 final String key = String.valueOf(entry.getKey());
 305                 attrList.setAttribute(attrNamespace, key, String.valueOf(entry.getValue()));
 306             }
 307         }
 308         return attrList;
 309     }
 310
 311     private boolean isFilteredNamespace(final String namespace)
 312     {
 313         if (Namespaces.LIBLAYOUT_NAMESPACE.equals(namespace))
 314         {
 315             return true;
 316         }
 317         if (JFreeReportInfo.REPORT_NAMESPACE.equals(namespace))
 318         {
 319             return true;
 320         }
 321         if (JFreeReportInfo.COMPATIBILITY_NAMESPACE.equals(namespace))
 322         {
 323             return true;
 324         }
 325         if (OfficeNamespaces.OOREPORT_NS.equals(namespace))
 326         {
 327             return true;
 328         }
 329         return false;
 330     }
 331
 332     private void performWriteRootTag()
 333             throws IOException
 334     {
 335         final AttributeList rootAttributes = new AttributeList();
 336         rootAttributes.addNamespaceDeclaration("office",
 337                 OfficeNamespaces.OFFICE_NS);
 338         rootAttributes.addNamespaceDeclaration("style", OfficeNamespaces.STYLE_NS);
 339         rootAttributes.addNamespaceDeclaration("text", OfficeNamespaces.TEXT_NS);
 340         rootAttributes.addNamespaceDeclaration("table", OfficeNamespaces.TABLE_NS);
 341         rootAttributes.addNamespaceDeclaration("draw", OfficeNamespaces.DRAWING_NS);
 342         rootAttributes.addNamespaceDeclaration("fo", OfficeNamespaces.FO_NS);
 343         rootAttributes.addNamespaceDeclaration("xlink", OfficeNamespaces.XLINK_NS);
 344         rootAttributes.addNamespaceDeclaration("dc", OfficeNamespaces.PURL_NS);
 345         rootAttributes.addNamespaceDeclaration("meta", OfficeNamespaces.META_NS);
 346         rootAttributes.addNamespaceDeclaration("number",
 347                 OfficeNamespaces.DATASTYLE_NS);
 348         rootAttributes.addNamespaceDeclaration("svg", OfficeNamespaces.SVG_NS);
 349         rootAttributes.addNamespaceDeclaration("chart", OfficeNamespaces.CHART_NS);
 350         rootAttributes.addNamespaceDeclaration("chartooo", OfficeNamespaces.CHARTOOO_NS);
 351         rootAttributes.addNamespaceDeclaration("dr3d", OfficeNamespaces.DR3D_NS);
 352         rootAttributes.addNamespaceDeclaration("math", OfficeNamespaces.MATHML_NS);
 353         rootAttributes.addNamespaceDeclaration("form", OfficeNamespaces.FORM_NS);
 354         rootAttributes.addNamespaceDeclaration("script",
 355                 OfficeNamespaces.SCRIPT_NS);
 356         rootAttributes.addNamespaceDeclaration("ooo", OfficeNamespaces.OO2004_NS);
 357         rootAttributes.addNamespaceDeclaration("ooow", OfficeNamespaces.OOW2004_NS);
 358         rootAttributes.addNamespaceDeclaration("oooc", OfficeNamespaces.OOC2004_NS);
 359         rootAttributes.addNamespaceDeclaration("dom",
 360                 OfficeNamespaces.XML_EVENT_NS);
 361         rootAttributes.addNamespaceDeclaration("xforms",
 362                 OfficeNamespaces.XFORMS_NS);
 363         rootAttributes.addNamespaceDeclaration("xsd", OfficeNamespaces.XSD_NS);
 364         rootAttributes.addNamespaceDeclaration("xsi", OfficeNamespaces.XSI_NS);
 365         rootAttributes.addNamespaceDeclaration("grddl", OfficeNamespaces.GRDDL_NS);
 366         rootAttributes.setAttribute(OfficeNamespaces.OFFICE_NS, "version",
 367                 OfficeDocumentReportTarget.ODF_VERSION);
 368
 369         this.xmlWriter.writeXmlDeclaration("UTF-8");
 370         this.xmlWriter.writeTag(OfficeNamespaces.OFFICE_NS,
 371                 "document-styles", rootAttributes, XmlWriterSupport.OPEN);
 372     }
 373
 374     public void close()
 375             throws IOException
 376     {
 377         xmlWriter.close();
 378     }
 379 }