qadevOOo/tests/java/mod/_sw/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._sw;
  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.document.XDocumentPropertiesSupplier;
  31 import com.sun.star.document.XDocumentProperties;
  32 import com.sun.star.document.XExporter;
  33 import com.sun.star.lang.XMultiServiceFactory;
  34 import com.sun.star.text.XTextDocument;
  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.Calc.XMLMetaExporter</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
  65     XTextDocument xTextDoc;
  66     MetaFilterChecker Filter;
  67
  68     /**
  69      * New text document created.
  70      */
  71     @Override
  72     protected void initialize( TestParameters tParam, PrintWriter log ) {
  73         SOfficeFactory SOF = SOfficeFactory.getFactory( tParam.getMSF() );
  74         try {
  75             log.println( "creating a textdocument" );
  76             xTextDoc = SOF.createTextDoc( null );
  77
  78         } catch ( com.sun.star.uno.Exception e ) {
  79         // Some exception occurs.FAILED
  80             e.printStackTrace( log );
  81             throw new StatusException( "Couldn't create document", e );
  82         }
  83     }
  84
  85     /**
  86      * Document disposed here.
  87      */
  88     @Override
  89     protected void cleanup( TestParameters tParam, PrintWriter log ) {
  90       log.println( "    disposing xTextDoc " );
  91       util.DesktopTools.closeDoc(xTextDoc);
  92     }
  93
  94     /**
  95     * Creating a Testenvironment for the interfaces to be tested.
  96     * Creates an instance of the service
  97     * <code>com.sun.star.comp.Calc.XMLMetaExporter</code> with
  98     * argument which is an implementation of <code>XDocumentHandler</code>
  99     * and which can check if required tags and character data is
 100     * exported. <p>
 101     * The text document is set as a source document for exporter
 102     * created. The 'Title' metadata property is set to a value. This made
 103     * for checking if this property is successfully exported within
 104     * the document metadata.
 105     *     Object relations created :
 106     * <ul>
 107     *  <li> <code>'MediaDescriptor'</code> for
 108     *      {@link ifc.document._XFilter} interface </li>
 109     *  <li> <code>'XFilter.Checker'</code> for
 110     *      {@link ifc.document._XFilter} interface </li>
 111     *  <li> <code>'SourceDocument'</code> for
 112     *      {@link ifc.document._XExporter} interface </li>
 113     * </ul>
 114     */
 115     @Override
 116     public synchronized TestEnvironment createTestEnvironment
 117             ( TestParameters tParam, PrintWriter log ) throws StatusException {
 118         final String TITLE = "Title for testing of XMLMetaExporter";
 119
 120         XMultiServiceFactory xMSF = tParam.getMSF() ;
 121         XInterface oObj = null;
 122
 123         Filter = new MetaFilterChecker(log);
 124         Any arg = new Any(new Type(XDocumentHandler.class), Filter);
 125
 126         try {
 127             oObj = (XInterface) xMSF.createInstanceWithArguments(
 128                 "com.sun.star.comp.Writer.XMLMetaExporter",
 129                 new Object[] {arg});
 130             XExporter xEx = UnoRuntime.queryInterface
 131                 (XExporter.class,oObj);
 132             xEx.setSourceDocument(xTextDoc);
 133
 134             //set some meta data
 135             XDocumentPropertiesSupplier xPropSup = UnoRuntime.queryInterface
 136                 (XDocumentPropertiesSupplier.class, xTextDoc);
 137             final XDocumentProperties xDocProps = xPropSup.getDocumentProperties();
 138             xDocProps.setTitle(TITLE);
 139         } catch (com.sun.star.uno.Exception e) {
 140             e.printStackTrace(log) ;
 141             throw new StatusException("Can't create component.", e) ;
 142         }
 143
 144         // adding tags which must be contained in XML output
 145         Filter.addTag("office:document-meta");
 146         Filter.addTagEnclosed("office:meta", "office:document-meta");
 147         Filter.addCharactersEnclosed(TITLE, "dc:title");
 148
 149         // create testobject here
 150         log.println( "creating a new environment" );
 151         TestEnvironment tEnv = new TestEnvironment( oObj );
 152
 153         tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor(
 154             new String[] {"FilterName"},
 155             new Object[] {"swriter: StarOffice XML (Writer)"}));
 156         tEnv.addObjRelation("SourceDocument", xTextDoc);
 157         tEnv.addObjRelation("XFilter.Checker", Filter);
 158         return tEnv;
 159     }
 160
 161     /**
 162      * This class checks the XML for tags and data required and returns
 163      * checking result to <code>XFilter</code> interface test. All
 164      * the information about errors occurred in XML data is written
 165      * to log specified.
 166      * @see ifc.document._XFilter
 167      */
 168     private class MetaFilterChecker extends XMLTools.XMLTagsChecker
 169       implements ifc.document._XFilter.FilterChecker {
 170
 171         /**
 172          * Creates a class which will write information
 173          * into log specified.
 174          */
 175         private MetaFilterChecker(PrintWriter log) {
 176             super(log) ;
 177         }
 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 checkTags();
 188         }
 189     }
 190 }
 191