1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 package mod._sc; 29 30 import java.io.PrintWriter; 31 32 import lib.StatusException; 33 import lib.TestCase; 34 import lib.TestEnvironment; 35 import lib.TestParameters; 36 import util.SOfficeFactory; 37 import util.XMLTools; 38 39 import com.sun.star.beans.XPropertySet; 40 import com.sun.star.document.XDocumentInfoSupplier; 41 import com.sun.star.document.XExporter; 42 import com.sun.star.lang.XComponent; 43 import com.sun.star.lang.XMultiServiceFactory; 44 import com.sun.star.uno.Any; 45 import com.sun.star.uno.Type; 46 import com.sun.star.uno.UnoRuntime; 47 import com.sun.star.uno.XInterface; 48 import com.sun.star.xml.sax.XDocumentHandler; 49 50 51 /** 52 * Test for object which is represented by service 53 * <code>com.sun.star.comp.Calc.XMLMetaExporter</code>. <p> 54 * Object implements the following interfaces : 55 * <ul> 56 * <li><code>com::sun::star::lang::XInitialization</code></li> 57 * <li><code>com::sun::star::document::ExportFilter</code></li> 58 * <li><code>com::sun::star::document::XFilter</code></li> 59 * <li><code>com::sun::star::document::XExporter</code></li> 60 * <li><code>com::sun::star::beans::XPropertySet</code></li> 61 * </ul> 62 * @see com.sun.star.lang.XInitialization 63 * @see com.sun.star.document.ExportFilter 64 * @see com.sun.star.document.XFilter 65 * @see com.sun.star.document.XExporter 66 * @see com.sun.star.beans.XPropertySet 67 * @see ifc.lang._XInitialization 68 * @see ifc.document._ExportFilter 69 * @see ifc.document._XFilter 70 * @see ifc.document._XExporter 71 * @see ifc.beans._XPropertySet 72 */ 73 public class XMLMetaExporter extends TestCase { 74 75 static XComponent xSheetDoc; 76 77 /** 78 * New spreadsheet 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 calc document" ); 85 xSheetDoc = SOF.openDoc("scalc","_blank"); 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 * Spreadsheet document disposed 95 */ 96 protected void cleanup( TestParameters tParam, PrintWriter log ) { 97 log.println( " disposing xCalcDoc " ); 98 util.DesktopTools.closeDoc(xSheetDoc); 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.Calc.XMLMetaExporter</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 calc document is set as a source document for exporter 109 * created. A meta property 'Title' is set to some value. This made 110 * for checking if this value is successfully exported within 111 * the document meta information. 112 * Object relations created : 113 * <ul> 114 * <li> <code>'MediaDescriptor'</code> for 115 * {@link ifc.document._XFilter} interface </li> 116 * <li> <code>'XFilter.Checker'</code> for 117 * {@link ifc.document._XFilter} interface </li> 118 * <li> <code>'SourceDocument'</code> for 119 * {@link ifc.document._XExporter} interface </li> 120 * </ul> 121 */ 122 public synchronized TestEnvironment createTestEnvironment( TestParameters tParam, 123 PrintWriter log ) 124 throws StatusException { 125 126 XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ; 127 XInterface oObj = null; 128 FilterChecker filter = new FilterChecker(log); 129 Any arg = new Any(new Type(XDocumentHandler.class),filter); 130 131 // Checking tags existance and changed property value 132 filter.addTag(new XMLTools.Tag ("office:document-meta")); 133 filter.addTag(new XMLTools.Tag ("office:meta")); 134 filter.addCharactersEnclosed("TestDocument", 135 new XMLTools.Tag ("dc:title")); 136 137 try { 138 oObj = (XInterface) xMSF.createInstanceWithArguments( 139 "com.sun.star.comp.Calc.XMLMetaExporter", new Object[] {arg}); 140 XExporter xEx = (XExporter) UnoRuntime.queryInterface 141 (XExporter.class,oObj); 142 xEx.setSourceDocument(xSheetDoc); 143 144 // Obtaining and changing property values 145 XDocumentInfoSupplier infoSup = (XDocumentInfoSupplier) 146 UnoRuntime.queryInterface (XDocumentInfoSupplier.class, 147 xSheetDoc) ; 148 XPropertySet docInfo = (XPropertySet) UnoRuntime.queryInterface 149 (XPropertySet.class, infoSup.getDocumentInfo()) ; 150 docInfo.setPropertyValue("Title", "TestDocument"); 151 152 log.println("fill sheet 1 with contnet..."); 153 util.CalcTools.fillCalcSheetWithContent(xSheetDoc,1, 3, 3, 50, 50); 154 155 } catch (com.sun.star.uno.Exception e) { 156 e.printStackTrace(log) ; 157 throw new StatusException("Can't create environment.", e) ; 158 } catch (java.lang.Exception e) { 159 e.printStackTrace(log); 160 throw new StatusException("Can't create environment.", e); 161 } 162 163 // create testobject here 164 log.println( "creating a new environment" ); 165 TestEnvironment tEnv = new TestEnvironment( oObj ); 166 167 tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor( 168 new String[] {"FilterName"}, 169 new Object[] {"scalc: StarOffice XML (Calc)"})); 170 tEnv.addObjRelation("SourceDocument",xSheetDoc); 171 tEnv.addObjRelation("XFilter.Checker", filter) ; 172 return tEnv; 173 174 } 175 176 /** 177 * This class checks the XML for tags and data required and returns 178 * checking result to <code>XFilter</code> interface test. All 179 * the information about errors occured in XML data is written 180 * to log specified. 181 * @see ifc.document._XFilter 182 */ 183 protected class FilterChecker extends XMLTools.XMLChecker 184 implements ifc.document._XFilter.FilterChecker { 185 186 /** 187 * Creates a class which will write information 188 * into log specified. 189 */ 190 public FilterChecker(PrintWriter log) { 191 super(log,false) ; 192 } 193 /** 194 * <code>_XFilter.FilterChecker</code> interface method 195 * which returns the result of XML checking. 196 * @return <code>true</code> if the XML data exported was 197 * valid (i.e. all necessary tags and character data exists), 198 * <code>false</code> if some errors occured. 199 */ 200 public boolean checkFilter() { 201 return check(); 202 } 203 } 204 } 205 206