qadevOOo/tests/java/mod/_sm/XMLSettingsExporter.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
  19 package mod._sm;
  20
  21 import java.io.PrintWriter;
  22
  23 import lib.StatusException;
  24 import lib.TestCase;
  25 import lib.TestEnvironment;
  26 import lib.TestParameters;
  27 import util.SOfficeFactory;
  28 import util.XMLTools;
  29
  30 import com.sun.star.beans.XPropertySet;
  31 import com.sun.star.document.XExporter;
  32 import com.sun.star.lang.XComponent;
  33 import com.sun.star.lang.XMultiServiceFactory;
  34 import com.sun.star.uno.Any;
  35 import com.sun.star.uno.Type;
  36 import com.sun.star.uno.UnoRuntime;
  37 import com.sun.star.uno.XInterface;
  38 import com.sun.star.xml.sax.XDocumentHandler;
  39
  40 /**
  41  * Test for object which is represented by service
  42  * <code>com.sun.star.comp.Math.XMLSettingsExporter</code>. <p>
  43  * Object implements the following interfaces :
  44  * <ul>
  45  *  <li><code>com::sun::star::lang::XInitialization</code></li>
  46  *  <li><code>com::sun::star::document::ExportFilter</code></li>
  47  *  <li><code>com::sun::star::document::XFilter</code></li>
  48  *  <li><code>com::sun::star::document::XExporter</code></li>
  49  *  <li><code>com::sun::star::beans::XPropertySet</code></li>
  50  * </ul>
  51  * @see com.sun.star.lang.XInitialization
  52  * @see com.sun.star.document.ExportFilter
  53  * @see com.sun.star.document.XFilter
  54  * @see com.sun.star.document.XExporter
  55  * @see com.sun.star.beans.XPropertySet
  56  * @see ifc.lang._XInitialization
  57  * @see ifc.document._ExportFilter
  58  * @see ifc.document._XFilter
  59  * @see ifc.document._XExporter
  60  * @see ifc.beans._XPropertySet
  61  */
  62 public class XMLSettingsExporter extends TestCase {
  63     XComponent xMathDoc;
  64
  65     /**
  66      * New math document created.
  67      */
  68     @Override
  69     protected void initialize( TestParameters tParam, PrintWriter log ) {
  70         SOfficeFactory SOF = SOfficeFactory.getFactory( tParam.getMSF() );
  71
  72         try {
  73             log.println( "creating a math document" );
  74             xMathDoc = SOF.createMathDoc(null);
  75         } catch ( com.sun.star.uno.Exception e ) {
  76             // Some exception occurs.FAILED
  77             e.printStackTrace( log );
  78             throw new StatusException( "Couldn't create document", e );
  79         }
  80     }
  81
  82     /**
  83      * Document disposed here.
  84      */
  85     @Override
  86     protected void cleanup( TestParameters tParam, PrintWriter log ) {
  87         log.println( "    disposing xMathDoc " );
  88         xMathDoc.dispose();
  89     }
  90
  91     /**
  92     * Creating a Testenvironment for the interfaces to be tested.
  93     * Creates an instance of the service
  94     * <code>com.sun.star.comp.Math.XMLSettingsExporter</code> with
  95     * argument which is an implementation of <code>XDocumentHandler</code>
  96     * and which can check if required tags and character data is
  97     * exported. <p>
  98     * The math document is set as a source document for exporter
  99     * created. A new value for TopMargin property is set for document.
 100     * This made
 101     * for checking if this property is successfully exported within
 102     * the document settings.
 103     *     Object relations created :
 104     * <ul>
 105     *  <li> <code>'MediaDescriptor'</code> for
 106     *      {@link ifc.document._XFilter} interface </li>
 107     *  <li> <code>'XFilter.Checker'</code> for
 108     *      {@link ifc.document._XFilter} interface </li>
 109     *  <li> <code>'SourceDocument'</code> for
 110     *      {@link ifc.document._XExporter} interface </li>
 111     * </ul>
 112     */
 113     @Override
 114     protected TestEnvironment createTestEnvironment
 115             (TestParameters tParam, PrintWriter log) {
 116         XMultiServiceFactory xMSF = tParam.getMSF() ;
 117         XInterface oObj = null;
 118         final short expMargin = 67 ;
 119
 120         FilterChecker filter = new FilterChecker(log);
 121         Any arg = new Any(new Type(XDocumentHandler.class), filter);
 122
 123         try {
 124             oObj = (XInterface) xMSF.createInstanceWithArguments(
 125                 "com.sun.star.comp.Math.XMLSettingsExporter",
 126                 new Object[] {arg});
 127             XExporter xEx = UnoRuntime.queryInterface
 128                 (XExporter.class,oObj);
 129             xEx.setSourceDocument(xMathDoc);
 130
 131             // setting a formula in document
 132             XPropertySet xPS = UnoRuntime.queryInterface
 133                 (XPropertySet.class, xMathDoc) ;
 134
 135             xPS.setPropertyValue("TopMargin", Short.valueOf(expMargin)) ;
 136         } catch (com.sun.star.uno.Exception e) {
 137             e.printStackTrace(log) ;
 138             throw new StatusException("Can't create component.", e) ;
 139         }
 140
 141         // checking tags required
 142
 143         filter.addTag(new XMLTools.Tag("office:document-settings")) ;
 144         filter.addCharactersEnclosed(String.valueOf(expMargin),
 145             new XMLTools.Tag("config:config-item", "config:name", "TopMargin")) ;
 146
 147         // create testobject here
 148         log.println( "creating a new environment" );
 149         TestEnvironment tEnv = new TestEnvironment( oObj );
 150
 151         tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor(
 152             new String[] {"FilterName"},
 153             new Object[] {"smath: StarOffice XML (Math)"}));
 154         tEnv.addObjRelation("SourceDocument",xMathDoc);
 155         tEnv.addObjRelation("XFilter.Checker", filter) ;
 156
 157         log.println("Implementation Name: "+util.utils.getImplName(oObj));
 158
 159         return tEnv;
 160     }
 161
 162     /**
 163      * This class checks the XML for tags and data required and returns
 164      * checking result to <code>XFilter</code> interface test. All
 165      * the information about errors occurred in XML data is written
 166      * to log specified.
 167      * @see ifc.document._XFilter
 168      */
 169     private class FilterChecker extends XMLTools.XMLChecker
 170         implements ifc.document._XFilter.FilterChecker {
 171
 172         /**
 173          * Creates a class which will write information
 174          * into log specified.
 175          */
 176         private FilterChecker(PrintWriter log) {
 177             super(log, true) ;
 178         }
 179         /**
 180          * <code>_XFilter.FilterChecker</code> interface method
 181          * which returns the result of XML checking.
 182          * @return <code>true</code> if the XML data exported was
 183          * valid (i.e. all necessary tags and character data exists),
 184          * <code>false</code> if some errors occurred.
 185          */
 186         public boolean checkFilter() {
 187             return check();
 188         }
 189     }
 190
 191 }    // finish class TestCase
 192