qadevOOo/tests/java/mod/_sw/XMLStylesImporter.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
  29 import com.sun.star.beans.XPropertySet;
  30 import com.sun.star.lang.XMultiServiceFactory;
  31 import com.sun.star.text.XFootnotesSupplier;
  32 import com.sun.star.text.XTextDocument;
  33 import com.sun.star.uno.UnoRuntime;
  34 import com.sun.star.uno.XInterface;
  35
  36 /**
  37  * Test for object which is represented by service
  38  * <code>com.sun.star.comp.Writer.XMLStylesImporter</code>. <p>
  39  * Object implements the following interfaces :
  40  * <ul>
  41  *  <li><code>com::sun::star::lang::XInitialization</code></li>
  42  *  <li><code>com::sun::star::document::XImporter</code></li>
  43  *  <li><code>com::sun::star::document::XFilter</code></li>
  44  *  <li><code>com::sun::star::document::ImportFilter</code></li>
  45  *  <li><code>com::sun::star::beans::XPropertySet</code></li>
  46  *  <li><code>com::sun::star::xml::sax::XDocumentHandler</code></li>
  47
  48  * </ul>
  49  * @see com.sun.star.lang.XInitialization
  50  * @see com.sun.star.document.XImporter
  51  * @see com.sun.star.document.XFilter
  52  * @see com.sun.star.document.ImportFilter
  53  * @see com.sun.star.beans.XPropertySet
  54  * @see com.sun.star.xml.sax.XDocumentHandler
  55  * @see ifc.lang._XInitialization
  56  * @see ifc.document._XImporter
  57  * @see ifc.document._XFilter
  58  * @see ifc.document._XExporter
  59  * @see ifc.beans._XPropertySet
  60  * @see ifc.xml.sax._XDocumentHandler
  61  */
  62 public class XMLStylesImporter extends TestCase {
  63     XTextDocument xTextDoc;
  64
  65     /**
  66     * New text 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 textdocument" );
  74             xTextDoc = SOF.createTextDoc( 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     * Text document destroyed.
  84     */
  85     @Override
  86     protected void cleanup( TestParameters tParam, PrintWriter log ) {
  87         log.println( "    disposing xTextDoc " );
  88         util.DesktopTools.closeDoc(xTextDoc);
  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.Writer.XMLStylesImporter</code><p>
  95     *
  96     * The text document is set as a target document for importer.
  97     * Imported XML-data contains only style tags including
  98     * title tag with test prefix.
  99     * After import prefixes getting from target document is checked.
 100     *     Object relations created :
 101     * <ul>
 102     *  <li> <code>'XDocumentHandler.XMLData'</code> for
 103     *      {@link ifc.xml.sax._XDocumentHandler} interface </li>
 104     *  <li> <code>'XDocumentHandler.ImportChecker'</code> for
 105     *      {@link ifc.xml.sax._XDocumentHandler} interface </li>
 106     *  <li> <code>'TargetDocument'</code> for
 107     *      {@link ifc.document._XImporter} interface </li>
 108     * </ul>
 109     */
 110     @Override
 111     public synchronized TestEnvironment createTestEnvironment( TestParameters tParam,
 112                                                   PrintWriter log )
 113                                                     throws StatusException {
 114
 115         XInterface oObj = null;
 116         Object oInt = null ;
 117         final String impPrefix = "Prefix" ;
 118
 119         // creation of testobject here
 120         // first we write what we are intend to do to log file
 121         log.println( "creating a test environment" );
 122
 123         XMultiServiceFactory xMSF = tParam.getMSF() ;
 124
 125         try {
 126             oInt = xMSF.createInstance
 127                 ("com.sun.star.comp.Writer.XMLStylesImporter") ;
 128
 129         } catch (com.sun.star.uno.Exception e) {
 130             e.printStackTrace(log) ;
 131             throw new StatusException("Can't create component.", e) ;
 132         }
 133
 134         oObj = (XInterface) oInt ;
 135
 136         // create testobject here
 137         log.println( "creating a new environment for Paragraph object" );
 138         TestEnvironment tEnv = new TestEnvironment( oObj );
 139
 140         // adding relation
 141         tEnv.addObjRelation("TargetDocument", xTextDoc) ;
 142
 143         // adding relation for XDocumentHandler
 144         String[][] xml = new String[][] {
 145             {"start", "office:document-styles",
 146                 "xmlns:office", "CDATA", "http://openoffice.org/2000/office",
 147                 "xmlns:style", "CDATA", "http://openoffice.org/2000/style",
 148                 "xmlns:text", "CDATA", "http://openoffice.org/2000/text"
 149                 },
 150             {"start", "office:styles"},
 151             {"start", "text:footnotes-configuration",
 152                 "style:num-prefix", "CDATA", impPrefix},
 153             {"end", "text:footnotes-configuration"},
 154             {"end", "office:styles"},
 155             {"end", "office:document-styles"}} ;
 156
 157         tEnv.addObjRelation("XDocumentHandler.XMLData", xml) ;
 158
 159         XFootnotesSupplier supp = UnoRuntime.queryInterface
 160             (XFootnotesSupplier.class, xTextDoc);
 161         final XPropertySet set = supp.getFootnoteSettings();
 162         final PrintWriter logF = log ;
 163
 164         tEnv.addObjRelation("XDocumentHandler.ImportChecker",
 165             new ifc.xml.sax._XDocumentHandler.ImportChecker() {
 166                 public boolean checkImport() {
 167                     try {
 168                         String prefix = (String) set.getPropertyValue("Prefix");
 169                         logF.println("Prefix returned = '" + prefix + "'") ;
 170                         return impPrefix.equals(prefix) ;
 171                     } catch (com.sun.star.uno.Exception e) {
 172                         logF.println("Exception occurred while checking filter :") ;
 173                         e.printStackTrace(logF) ;
 174                         return false ;
 175                     }
 176                 }
 177             }) ;
 178
 179         return tEnv;
 180     } // finish method getTestEnvironment
 181 }
 182