1*ef39d40dSAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*ef39d40dSAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*ef39d40dSAndrew Rist * or more contributor license agreements. See the NOTICE file 5*ef39d40dSAndrew Rist * distributed with this work for additional information 6*ef39d40dSAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*ef39d40dSAndrew Rist * to you under the Apache License, Version 2.0 (the 8*ef39d40dSAndrew Rist * "License"); you may not use this file except in compliance 9*ef39d40dSAndrew Rist * with the License. You may obtain a copy of the License at 10*ef39d40dSAndrew Rist * 11*ef39d40dSAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*ef39d40dSAndrew Rist * 13*ef39d40dSAndrew Rist * Unless required by applicable law or agreed to in writing, 14*ef39d40dSAndrew Rist * software distributed under the License is distributed on an 15*ef39d40dSAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*ef39d40dSAndrew Rist * KIND, either express or implied. See the License for the 17*ef39d40dSAndrew Rist * specific language governing permissions and limitations 18*ef39d40dSAndrew Rist * under the License. 19*ef39d40dSAndrew Rist * 20*ef39d40dSAndrew Rist *************************************************************/ 21*ef39d40dSAndrew Rist 22*ef39d40dSAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir package mod._sc; 25cdf0e10cSrcweir 26cdf0e10cSrcweir import java.io.PrintWriter; 27cdf0e10cSrcweir 28cdf0e10cSrcweir import lib.StatusException; 29cdf0e10cSrcweir import lib.TestCase; 30cdf0e10cSrcweir import lib.TestEnvironment; 31cdf0e10cSrcweir import lib.TestParameters; 32cdf0e10cSrcweir import util.SOfficeFactory; 33cdf0e10cSrcweir import util.XMLTools; 34cdf0e10cSrcweir 35cdf0e10cSrcweir import com.sun.star.beans.XPropertySet; 36cdf0e10cSrcweir import com.sun.star.document.XExporter; 37cdf0e10cSrcweir import com.sun.star.frame.XController; 38cdf0e10cSrcweir import com.sun.star.frame.XModel; 39cdf0e10cSrcweir import com.sun.star.lang.XComponent; 40cdf0e10cSrcweir import com.sun.star.lang.XMultiServiceFactory; 41cdf0e10cSrcweir import com.sun.star.uno.Any; 42cdf0e10cSrcweir import com.sun.star.uno.Type; 43cdf0e10cSrcweir import com.sun.star.uno.UnoRuntime; 44cdf0e10cSrcweir import com.sun.star.uno.XInterface; 45cdf0e10cSrcweir import com.sun.star.xml.sax.XDocumentHandler; 46cdf0e10cSrcweir 47cdf0e10cSrcweir /** 48cdf0e10cSrcweir * Test for object which is represented by service 49cdf0e10cSrcweir * <code>com.sun.star.comp.Calc.XMLSettingsExporter</code>. <p> 50cdf0e10cSrcweir * Object implements the following interfaces : 51cdf0e10cSrcweir * <ul> 52cdf0e10cSrcweir * <li><code>com::sun::star::lang::XInitialization</code></li> 53cdf0e10cSrcweir * <li><code>com::sun::star::document::ExportFilter</code></li> 54cdf0e10cSrcweir * <li><code>com::sun::star::document::XFilter</code></li> 55cdf0e10cSrcweir * <li><code>com::sun::star::document::XExporter</code></li> 56cdf0e10cSrcweir * <li><code>com::sun::star::beans::XPropertySet</code></li> 57cdf0e10cSrcweir * </ul> 58cdf0e10cSrcweir * @see com.sun.star.lang.XInitialization 59cdf0e10cSrcweir * @see com.sun.star.document.ExportFilter 60cdf0e10cSrcweir * @see com.sun.star.document.XFilter 61cdf0e10cSrcweir * @see com.sun.star.document.XExporter 62cdf0e10cSrcweir * @see com.sun.star.beans.XPropertySet 63cdf0e10cSrcweir * @see ifc.lang._XInitialization 64cdf0e10cSrcweir * @see ifc.document._ExportFilter 65cdf0e10cSrcweir * @see ifc.document._XFilter 66cdf0e10cSrcweir * @see ifc.document._XExporter 67cdf0e10cSrcweir * @see ifc.beans._XPropertySet 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir public class XMLSettingsExporter extends TestCase { 70cdf0e10cSrcweir 71cdf0e10cSrcweir static XComponent xSheetDoc; 72cdf0e10cSrcweir 73cdf0e10cSrcweir /** 74cdf0e10cSrcweir * New spreadsheet document created. 75cdf0e10cSrcweir */ initialize( TestParameters tParam, PrintWriter log )76cdf0e10cSrcweir protected void initialize( TestParameters tParam, PrintWriter log ) { 77cdf0e10cSrcweir SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() ); 78cdf0e10cSrcweir 79cdf0e10cSrcweir try { 80cdf0e10cSrcweir log.println( "creating a calc document" ); 81cdf0e10cSrcweir xSheetDoc = SOF.openDoc("scalc","_blank"); 82cdf0e10cSrcweir } catch ( com.sun.star.uno.Exception e ) { 83cdf0e10cSrcweir // Some exception occures.FAILED 84cdf0e10cSrcweir e.printStackTrace( log ); 85cdf0e10cSrcweir throw new StatusException( "Couldn't create document", e ); 86cdf0e10cSrcweir } 87cdf0e10cSrcweir } 88cdf0e10cSrcweir 89cdf0e10cSrcweir /** 90cdf0e10cSrcweir * Spreadsheet document disposed 91cdf0e10cSrcweir */ cleanup( TestParameters tParam, PrintWriter log )92cdf0e10cSrcweir protected void cleanup( TestParameters tParam, PrintWriter log ) { 93cdf0e10cSrcweir log.println( " disposing xCalcDoc " ); 94cdf0e10cSrcweir util.DesktopTools.closeDoc(xSheetDoc); 95cdf0e10cSrcweir } 96cdf0e10cSrcweir 97cdf0e10cSrcweir /** 98cdf0e10cSrcweir * Creating a Testenvironment for the interfaces to be tested. 99cdf0e10cSrcweir * Creates an instance of the service 100cdf0e10cSrcweir * <code>com.sun.star.comp.Calc.XMLSettingsExporter</code> with 101cdf0e10cSrcweir * argument which is an implementation of <code>XDocumentHandler</code> 102cdf0e10cSrcweir * and which can check if required tags and character data is 103cdf0e10cSrcweir * exported. <p> 104cdf0e10cSrcweir * The calc document is set as a source document for exporter 105cdf0e10cSrcweir * created. Sets settings' property 'ShowGrid' to 'false', then checks 106cdf0e10cSrcweir * it in the exported xml document.<p> 107cdf0e10cSrcweir * Object relations created : 108cdf0e10cSrcweir * <ul> 109cdf0e10cSrcweir * <li> <code>'MediaDescriptor'</code> for 110cdf0e10cSrcweir * {@link ifc.document._XFilter} interface </li> 111cdf0e10cSrcweir * <li> <code>'XFilter.Checker'</code> for 112cdf0e10cSrcweir * {@link ifc.document._XFilter} interface </li> 113cdf0e10cSrcweir * <li> <code>'SourceDocument'</code> for 114cdf0e10cSrcweir * {@link ifc.document._XExporter} interface </li> 115cdf0e10cSrcweir * </ul> 116cdf0e10cSrcweir */ createTestEnvironment( TestParameters tParam, PrintWriter log )117cdf0e10cSrcweir public synchronized TestEnvironment createTestEnvironment( TestParameters tParam, 118cdf0e10cSrcweir PrintWriter log ) 119cdf0e10cSrcweir throws StatusException { 120cdf0e10cSrcweir 121cdf0e10cSrcweir XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ; 122cdf0e10cSrcweir XInterface oObj = null; 123cdf0e10cSrcweir SettingsFilterChecker filter = new SettingsFilterChecker(log); 124cdf0e10cSrcweir Any arg = new Any(new Type(XDocumentHandler.class), filter); 125cdf0e10cSrcweir try { 126cdf0e10cSrcweir oObj = (XInterface) xMSF.createInstanceWithArguments( 127cdf0e10cSrcweir "com.sun.star.comp.Calc.XMLSettingsExporter", 128cdf0e10cSrcweir new Object[] {arg} ); 129cdf0e10cSrcweir XExporter xEx = (XExporter) UnoRuntime.queryInterface 130cdf0e10cSrcweir (XExporter.class,oObj); 131cdf0e10cSrcweir xEx.setSourceDocument(xSheetDoc); 132cdf0e10cSrcweir 133cdf0e10cSrcweir //set some settings 134cdf0e10cSrcweir XModel xSheetModel = (XModel) 135cdf0e10cSrcweir UnoRuntime.queryInterface(XModel.class, xSheetDoc); 136cdf0e10cSrcweir XController xController = xSheetModel.getCurrentController(); 137cdf0e10cSrcweir XPropertySet xPropSet = (XPropertySet) 138cdf0e10cSrcweir UnoRuntime.queryInterface(XPropertySet.class, xController); 139cdf0e10cSrcweir xPropSet.setPropertyValue("ShowGrid", "false"); 140cdf0e10cSrcweir 141cdf0e10cSrcweir util.CalcTools.fillCalcSheetWithContent(xSheetDoc,1, 3, 3, 50, 50); 142cdf0e10cSrcweir 143cdf0e10cSrcweir } catch (com.sun.star.uno.Exception e) { 144cdf0e10cSrcweir e.printStackTrace(log) ; 145cdf0e10cSrcweir throw new StatusException("Can't create component.", e) ; 146cdf0e10cSrcweir } catch (java.lang.Exception e) { 147cdf0e10cSrcweir e.printStackTrace(log); 148cdf0e10cSrcweir throw new StatusException("Can't create environment.", e); 149cdf0e10cSrcweir } 150cdf0e10cSrcweir 151cdf0e10cSrcweir //Create and prepare filter 152cdf0e10cSrcweir // adding tags which must be contained in XML output 153cdf0e10cSrcweir filter.addTag(new XMLTools.Tag("office:document-settings") ); 154cdf0e10cSrcweir filter.addTagEnclosed( 155cdf0e10cSrcweir new XMLTools.Tag("office:settings"), 156cdf0e10cSrcweir new XMLTools.Tag("office:document-settings") ); 157cdf0e10cSrcweir filter.addCharactersEnclosed( 158cdf0e10cSrcweir "false", 159cdf0e10cSrcweir new XMLTools.Tag("config:config-item", "config:name", "ShowGrid") ); 160cdf0e10cSrcweir 161cdf0e10cSrcweir // create testobject here 162cdf0e10cSrcweir log.println( "creating a new environment" ); 163cdf0e10cSrcweir TestEnvironment tEnv = new TestEnvironment( oObj ); 164cdf0e10cSrcweir 165cdf0e10cSrcweir tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor( 166cdf0e10cSrcweir new String[] {"FilterName"}, 167cdf0e10cSrcweir new Object[] {"scalc: StarOffice XML (Calc)"})); 168cdf0e10cSrcweir tEnv.addObjRelation("SourceDocument",xSheetDoc); 169cdf0e10cSrcweir tEnv.addObjRelation("XFilter.Checker", filter) ; 170cdf0e10cSrcweir return tEnv; 171cdf0e10cSrcweir } 172cdf0e10cSrcweir 173cdf0e10cSrcweir /** 174cdf0e10cSrcweir * This class checks the XML for tags and data required and returns 175cdf0e10cSrcweir * checking result to <code>XFilter</code> interface test. All 176cdf0e10cSrcweir * the information about errors occured in XML data is written 177cdf0e10cSrcweir * to log specified. 178cdf0e10cSrcweir * @see ifc.document._XFilter 179cdf0e10cSrcweir */ 180cdf0e10cSrcweir protected class SettingsFilterChecker extends XMLTools.XMLChecker 181cdf0e10cSrcweir implements ifc.document._XFilter.FilterChecker { 182cdf0e10cSrcweir 183cdf0e10cSrcweir /** 184cdf0e10cSrcweir * Creates a class which will write information 185cdf0e10cSrcweir * into log specified. 186cdf0e10cSrcweir */ SettingsFilterChecker(PrintWriter log)187cdf0e10cSrcweir public SettingsFilterChecker(PrintWriter log) { 188cdf0e10cSrcweir super(log, false) ; 189cdf0e10cSrcweir } 190cdf0e10cSrcweir /** 191cdf0e10cSrcweir * <code>_XFilter.FilterChecker</code> interface method 192cdf0e10cSrcweir * which returns the result of XML checking. 193cdf0e10cSrcweir * @return <code>true</code> if the XML data exported was 194cdf0e10cSrcweir * valid (i.e. all necessary tags and character data exists), 195cdf0e10cSrcweir * <code>false</code> if some errors occured. 196cdf0e10cSrcweir */ checkFilter()197cdf0e10cSrcweir public boolean checkFilter() { 198cdf0e10cSrcweir return check(); 199cdf0e10cSrcweir } 200cdf0e10cSrcweir } 201cdf0e10cSrcweir } 202cdf0e10cSrcweir 203