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