qadevOOo/tests/java/mod/_sw/XMLStylesExporter.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XMLStylesExporter.java,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package mod._sw;
  32
  33 import java.io.PrintWriter;
  34
  35 import lib.StatusException;
  36 import lib.TestCase;
  37 import lib.TestEnvironment;
  38 import lib.TestParameters;
  39 import util.SOfficeFactory;
  40 import util.XMLTools;
  41
  42 import com.sun.star.beans.XPropertySet;
  43 import com.sun.star.document.XExporter;
  44 import com.sun.star.lang.XMultiServiceFactory;
  45 import com.sun.star.text.XFootnotesSupplier;
  46 import com.sun.star.text.XTextDocument;
  47 import com.sun.star.uno.Any;
  48 import com.sun.star.uno.Type;
  49 import com.sun.star.uno.UnoRuntime;
  50 import com.sun.star.uno.XInterface;
  51 import com.sun.star.xml.sax.XDocumentHandler;
  52
  53 /**
  54  * Test for object which is represented by service
  55  * <code>com.sun.star.comp.Calc.XMLStylesExporter</code>. <p>
  56  * Object implements the following interfaces :
  57  * <ul>
  58  *  <li><code>com::sun::star::lang::XInitialization</code></li>
  59  *  <li><code>com::sun::star::document::ExportFilter</code></li>
  60  *  <li><code>com::sun::star::document::XFilter</code></li>
  61  *  <li><code>com::sun::star::document::XExporter</code></li>
  62  *  <li><code>com::sun::star::beans::XPropertySet</code></li>
  63  * </ul>
  64  * @see com.sun.star.lang.XInitialization
  65  * @see com.sun.star.document.ExportFilter
  66  * @see com.sun.star.document.XFilter
  67  * @see com.sun.star.document.XExporter
  68  * @see com.sun.star.beans.XPropertySet
  69  * @see ifc.lang._XInitialization
  70  * @see ifc.document._ExportFilter
  71  * @see ifc.document._XFilter
  72  * @see ifc.document._XExporter
  73  * @see ifc.beans._XPropertySet
  74  */
  75 public class XMLStylesExporter extends TestCase {
  76
  77     XTextDocument xTextDoc;
  78
  79     /**
  80      * New text document created.
  81      */
  82     protected void initialize( TestParameters tParam, PrintWriter log ) {
  83         SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() );
  84
  85         try {
  86             log.println( "creating a textdocument" );
  87             xTextDoc = SOF.createTextDoc( null );
  88         } catch ( com.sun.star.uno.Exception e ) {
  89             // Some exception occures.FAILED
  90             e.printStackTrace( log );
  91             throw new StatusException( "Couldn't create document", e );
  92         }
  93     }
  94
  95     /**
  96      * Document disposed here.
  97      */
  98     protected void cleanup( TestParameters tParam, PrintWriter log ) {
  99         log.println( "    disposing xTextDoc " );
 100         util.DesktopTools.closeDoc(xTextDoc);
 101     }
 102
 103     /**
 104     * Creating a Testenvironment for the interfaces to be tested.
 105     * Creates an instance of the service
 106     * <code>com.sun.star.comp.Calc.XMLStylesExporter</code> with
 107     * argument which is an implementation of <code>XDocumentHandler</code>
 108     * and which can check if required tags and character data is
 109     * exported. <p>
 110     * The text document is set as a source document for exporter
 111     * created. Footnote property 'Prefix' is set to a new value. This made
 112     * for checking if this property value is successfully exported within
 113     * the document styles.
 114     *     Object relations created :
 115     * <ul>
 116     *  <li> <code>'MediaDescriptor'</code> for
 117     *      {@link ifc.document._XFilter} interface </li>
 118     *  <li> <code>'XFilter.Checker'</code> for
 119     *      {@link ifc.document._XFilter} interface </li>
 120     *  <li> <code>'SourceDocument'</code> for
 121     *      {@link ifc.document._XExporter} interface </li>
 122     * </ul>
 123     */
 124     public synchronized TestEnvironment createTestEnvironment
 125             ( TestParameters tParam, PrintWriter log ) {
 126
 127         XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ;
 128         XInterface oObj = null;
 129         FilterChecker filter = new FilterChecker(log) ;
 130         Any arg = new Any(new Type(XDocumentHandler.class),filter);
 131
 132         try {
 133             oObj = (XInterface) xMSF.createInstanceWithArguments(
 134                 "com.sun.star.comp.Writer.XMLStylesExporter",
 135                 new Object[] {arg});
 136             XExporter xEx = (XExporter) UnoRuntime.queryInterface
 137                 (XExporter.class,oObj);
 138             xEx.setSourceDocument(xTextDoc);
 139         } catch (com.sun.star.uno.Exception e) {
 140             e.printStackTrace(log) ;
 141             throw new StatusException("Can't create component.", e) ;
 142         }
 143
 144         // Cheching Head Tag existance and that property has changed
 145         filter.addTag(new XMLTools.Tag ("office:document-styles"));
 146         filter.addTag(new XMLTools.Tag ("text:footnotes-configuration",
 147             "style:num-prefix","New Property")) ;
 148
 149         // create testobject here
 150         log.println( "creating a new environment" );
 151         TestEnvironment tEnv = new TestEnvironment( oObj );
 152
 153         // Obtain Footnotes properties
 154         XFootnotesSupplier supp = (XFootnotesSupplier) UnoRuntime.queryInterface
 155             (XFootnotesSupplier.class, xTextDoc);
 156         XPropertySet set = supp.getFootnoteSettings();
 157
 158         // Change property "Prefix"
 159         try {
 160             set.setPropertyValue("Prefix","New Property");
 161         } catch (com.sun.star.uno.Exception e) {
 162             e.printStackTrace( log );
 163             throw new StatusException( "Couldn't change property value", e );
 164         }
 165
 166         tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor(
 167             new String[] {"FilterName"},
 168             new Object[] {"swriter: StarOffice XML (Writer)"}));
 169         tEnv.addObjRelation("SourceDocument",xTextDoc);
 170         tEnv.addObjRelation("XFilter.Checker", filter) ;
 171         return tEnv;
 172
 173     }
 174
 175     /**
 176      * This class checks the XML for tags and data required and returns
 177      * checking result to <code>XFilter</code> interface test. All
 178      * the information about errors occured in XML data is written
 179      * to log specified.
 180      * @see ifc.document._XFilter
 181      */
 182     protected class FilterChecker extends XMLTools.XMLChecker
 183         implements ifc.document._XFilter.FilterChecker {
 184
 185         /**
 186          * Creates a class which will write information
 187          * into log specified.
 188          */
 189         public FilterChecker(PrintWriter log) {
 190             super(log,false) ;
 191         }
 192
 193         /**
 194          * <code>_XFilter.FilterChecker</code> interface method
 195          * which returns the result of XML checking.
 196          * @return <code>true</code> if the XML data exported was
 197          * valid (i.e. all necessary tags and character data exists),
 198          * <code>false</code> if some errors occured.
 199          */
 200         public boolean checkFilter() {
 201             return check();
 202         }
 203     }
 204
 205 }
 206