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