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