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