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._xmloff.Impress; 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.Exception; 46 import com.sun.star.uno.Type; 47 import com.sun.star.uno.UnoRuntime; 48 import com.sun.star.uno.XInterface; 49 import com.sun.star.xml.sax.XDocumentHandler; 50 51 /** 52 * Test for object which is represented by service 53 * <code>com.sun.star.comp.Impress.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 XComponent xImpressDoc = null; 75 76 /** 77 * New impress document created. 78 */ 79 protected void initialize( TestParameters tParam, PrintWriter log ) { 80 81 // get a soffice factory object 82 SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF()); 83 84 try { 85 log.println( "creating an impress document" ); 86 xImpressDoc = SOF.createImpressDoc(null);; 87 } catch ( Exception e ) { 88 // Some exception occures.FAILED 89 e.printStackTrace( log ); 90 throw new StatusException( "Couldn't create document", e ); 91 } 92 } 93 94 /** 95 * Impress document disposed 96 */ 97 protected void cleanup( TestParameters tParam, PrintWriter log ) { 98 log.println( "disposing xImpressDoc " ); 99 xImpressDoc.dispose(); 100 } 101 102 /** 103 * Creating a Testenvironment for the interfaces to be tested. 104 * Creates an instance of the service 105 * <code>com.sun.star.comp.Impress.XMLMetaExporter</code> with 106 * argument which is an implementation of <code>XDocumentHandler</code> 107 * and which can check if required tags and character data is 108 * exported. <p> 109 * The impress document is set as a source document for exporter 110 * created. A meta property 'Title' is set to specific value. This made 111 * for checking if this value is successfully exported within 112 * the document meta information. 113 * Object relations created : 114 * <ul> 115 * <li> <code>'MediaDescriptor'</code> for 116 * {@link ifc.document._XFilter} interface </li> 117 * <li> <code>'XFilter.Checker'</code> for 118 * {@link ifc.document._XFilter} interface </li> 119 * <li> <code>'SourceDocument'</code> for 120 * {@link ifc.document._XExporter} interface </li> 121 * </ul> 122 */ 123 public synchronized TestEnvironment createTestEnvironment 124 (TestParameters tParam, PrintWriter log) throws StatusException { 125 126 XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ; 127 XInterface oObj = null; 128 129 FilterChecker filter = new FilterChecker(log); 130 Any arg = new Any(new Type(XDocumentHandler.class), filter); 131 final String NAME = "XMLMetaExporter"; 132 133 try { 134 oObj = (XInterface) xMSF.createInstanceWithArguments( 135 "com.sun.star.comp.Impress.XMLMetaExporter", 136 new Object[]{arg}); 137 XExporter xEx = (XExporter) 138 UnoRuntime.queryInterface(XExporter.class,oObj); 139 xEx.setSourceDocument(xImpressDoc); 140 141 //change title name 142 XDocumentInfoSupplier infoSup = (XDocumentInfoSupplier) 143 UnoRuntime.queryInterface 144 (XDocumentInfoSupplier.class, xImpressDoc) ; 145 XPropertySet docInfo = (XPropertySet) UnoRuntime.queryInterface 146 (XPropertySet.class, infoSup.getDocumentInfo()) ; 147 docInfo.setPropertyValue("Title", NAME); 148 149 } catch (com.sun.star.uno.Exception e) { 150 e.printStackTrace(log) ; 151 throw new StatusException("Can't create component.", e) ; 152 } 153 154 // Checking tags existance and changed property value 155 filter.addTag(new XMLTools.Tag ("office:document-meta")); 156 filter.addTagEnclosed( 157 new XMLTools.Tag("office:meta"), 158 new XMLTools.Tag("office:document-meta") ); 159 filter.addTagEnclosed( 160 new XMLTools.Tag("dc:title"), 161 new XMLTools.Tag("office:meta") ); 162 filter.addCharactersEnclosed( 163 NAME, 164 new XMLTools.Tag ("dc:title") ); 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[] {"simpress: StarOffice XML (Impress)"})); 173 tEnv.addObjRelation("SourceDocument", xImpressDoc); 174 tEnv.addObjRelation("XFilter.Checker", filter) ; 175 return tEnv; 176 } 177 178 /** 179 * This class checks the XML for tags and data required and returns 180 * checking result to <code>XFilter</code> interface test. All 181 * the information about errors occured in XML data is written 182 * to log specified. 183 * @see ifc.document._XFilter 184 */ 185 protected class FilterChecker extends XMLTools.XMLChecker 186 implements ifc.document._XFilter.FilterChecker { 187 188 /** 189 * Creates a class which will write information 190 * into log specified. 191 */ 192 public FilterChecker(PrintWriter log) { 193 super(log, true); 194 } 195 /** 196 * <code>_XFilter.FilterChecker</code> interface method 197 * which returns the result of XML checking. 198 * @return <code>true</code> if the XML data exported was 199 * valid (i.e. all necessary tags and character data exists), 200 * <code>false</code> if some errors occured. 201 */ 202 public boolean checkFilter() { 203 return check(); 204 } 205 } 206 } 207