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.Chart; 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.DesktopTools; 37 import util.SOfficeFactory; 38 import util.XMLTools; 39 40 import com.sun.star.beans.XPropertySet; 41 import com.sun.star.chart.XChartDocument; 42 import com.sun.star.document.XExporter; 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.Chart.XMLExporter</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 XMLExporter extends TestCase { 74 XChartDocument xChartDoc = null; 75 76 /** 77 * New text 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 a chartdocument" ); 86 xChartDoc = SOF.createChartDoc(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 * Close document 96 */ 97 protected void cleanup( TestParameters tParam, PrintWriter log ) { 98 if( xChartDoc!=null ) { 99 log.println( " closing xChartDoc" ); 100 util.DesktopTools.closeDoc(xChartDoc); 101 xChartDoc = null; 102 } 103 } 104 105 /** 106 * Creating a Testenvironment for the interfaces to be tested. 107 * Creates an instance of the service 108 * <code>com.sun.star.comp.Chart.XMLExporter</code> with 109 * argument which is an implementation of <code>XDocumentHandler</code> 110 * and which can check if required tags and character data is 111 * exported. <p> 112 * The chart document is set as a source document for exporter 113 * created. A new 'main title' is set for chart. This made 114 * for checking if this title is successfully exported within 115 * the document content. 116 * Object relations created : 117 * <ul> 118 * <li> <code>'MediaDescriptor'</code> for 119 * {@link ifc.document._XFilter} interface </li> 120 * <li> <code>'XFilter.Checker'</code> for 121 * {@link ifc.document._XFilter} interface </li> 122 * <li> <code>'SourceDocument'</code> for 123 * {@link ifc.document._XExporter} interface </li> 124 * </ul> 125 */ 126 public synchronized TestEnvironment createTestEnvironment 127 (TestParameters tParam, PrintWriter log ) { 128 129 XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ; 130 XInterface oObj = null; 131 final String exportStr = "XMLExporter test." ; 132 133 FilterChecker filter = new FilterChecker(log); 134 Any arg = new Any(new Type(XDocumentHandler.class),filter); 135 136 try { 137 oObj = (XInterface) xMSF.createInstanceWithArguments( 138 "com.sun.star.comp.Chart.XMLExporter", new Object[] {arg}); 139 XExporter xEx = (XExporter) 140 UnoRuntime.queryInterface(XExporter.class,oObj); 141 xEx.setSourceDocument(xChartDoc); 142 143 Object oTitle = xChartDoc.getTitle() ; 144 XPropertySet xTitleProp = (XPropertySet) UnoRuntime.queryInterface 145 (XPropertySet.class, oTitle) ; 146 xTitleProp.setPropertyValue("String", exportStr) ; 147 } catch (com.sun.star.uno.Exception e) { 148 e.printStackTrace(log) ; 149 throw new StatusException("Can't create component.", e) ; 150 } 151 152 filter.addTag(new XMLTools.Tag("office:document")) ; 153 filter.addTagEnclosed(new XMLTools.Tag("office:meta"), 154 new XMLTools.Tag("office:document")); 155 filter.addTagEnclosed(new XMLTools.Tag("office:body"), 156 new XMLTools.Tag("office:document")); 157 filter.addCharactersEnclosed(exportStr, 158 new XMLTools.Tag("chart:title")) ; 159 160 161 // create testobject here 162 log.println( "creating a new environment" ); 163 TestEnvironment tEnv = new TestEnvironment( oObj ); 164 165 tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor( 166 new String[] {"FilterName"}, 167 new Object[] {"schart: StarOffice XML (Chart)"})); 168 tEnv.addObjRelation("SourceDocument",xChartDoc); 169 tEnv.addObjRelation("XFilter.Checker", filter) ; 170 log.println("Implementation Name: "+util.utils.getImplName(oObj)); 171 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, true) ; 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