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._sw; 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.lang.XMultiServiceFactory; 39cdf0e10cSrcweir import com.sun.star.text.XTextDocument; 40cdf0e10cSrcweir import com.sun.star.uno.Any; 41cdf0e10cSrcweir import com.sun.star.uno.Type; 42cdf0e10cSrcweir import com.sun.star.uno.UnoRuntime; 43cdf0e10cSrcweir import com.sun.star.uno.XInterface; 44cdf0e10cSrcweir import com.sun.star.view.XViewSettingsSupplier; 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 XTextDocument xTextDoc; 72cdf0e10cSrcweir SettingsFilterChecker Filter; 73cdf0e10cSrcweir 74cdf0e10cSrcweir /** 75cdf0e10cSrcweir * New text document created. 76cdf0e10cSrcweir */ initialize( TestParameters tParam, PrintWriter log )77cdf0e10cSrcweir protected void initialize( TestParameters tParam, PrintWriter log ) { 78cdf0e10cSrcweir SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() ); 79cdf0e10cSrcweir 80cdf0e10cSrcweir try { 81cdf0e10cSrcweir log.println( "creating a textdocument" ); 82cdf0e10cSrcweir xTextDoc = SOF.createTextDoc( null ); 83cdf0e10cSrcweir 84cdf0e10cSrcweir } catch ( com.sun.star.uno.Exception e ) { 85cdf0e10cSrcweir // Some exception occures.FAILED 86cdf0e10cSrcweir e.printStackTrace( log ); 87cdf0e10cSrcweir throw new StatusException( "Couldn't create document", e ); 88cdf0e10cSrcweir } 89cdf0e10cSrcweir 90cdf0e10cSrcweir } 91cdf0e10cSrcweir 92cdf0e10cSrcweir /** 93cdf0e10cSrcweir * Document disposed here. 94cdf0e10cSrcweir */ cleanup( TestParameters tParam, PrintWriter log )95cdf0e10cSrcweir protected void cleanup( TestParameters tParam, PrintWriter log ) { 96cdf0e10cSrcweir log.println( " disposing xTextDoc " ); 97cdf0e10cSrcweir util.DesktopTools.closeDoc(xTextDoc); 98cdf0e10cSrcweir } 99cdf0e10cSrcweir 100cdf0e10cSrcweir /** 101cdf0e10cSrcweir * Creating a Testenvironment for the interfaces to be tested. 102cdf0e10cSrcweir * Creates an instance of the service 103cdf0e10cSrcweir * <code>com.sun.star.comp.Calc.XMLSettingsExporter</code> with 104cdf0e10cSrcweir * argument which is an implementation of <code>XDocumentHandler</code> 105cdf0e10cSrcweir * and which can check if required tags and character data is 106cdf0e10cSrcweir * exported. <p> 107cdf0e10cSrcweir * The text document is set as a source document for exporter 108cdf0e10cSrcweir * created. New document zoom is set as one of the 'View' settings. This made 109cdf0e10cSrcweir * for checking if this setting is successfully exported within 110cdf0e10cSrcweir * the document settings. 111cdf0e10cSrcweir * Object relations created : 112cdf0e10cSrcweir * <ul> 113cdf0e10cSrcweir * <li> <code>'MediaDescriptor'</code> for 114cdf0e10cSrcweir * {@link ifc.document._XFilter} interface </li> 115cdf0e10cSrcweir * <li> <code>'XFilter.Checker'</code> for 116cdf0e10cSrcweir * {@link ifc.document._XFilter} interface </li> 117cdf0e10cSrcweir * <li> <code>'SourceDocument'</code> for 118cdf0e10cSrcweir * {@link ifc.document._XExporter} interface </li> 119cdf0e10cSrcweir * </ul> 120cdf0e10cSrcweir */ createTestEnvironment(TestParameters tParam, PrintWriter log)121cdf0e10cSrcweir public synchronized TestEnvironment createTestEnvironment 122cdf0e10cSrcweir (TestParameters tParam, PrintWriter log) { 123cdf0e10cSrcweir 124cdf0e10cSrcweir final short ZOOM = 50; 125cdf0e10cSrcweir 126cdf0e10cSrcweir XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ; 127cdf0e10cSrcweir XInterface oObj = null; 128cdf0e10cSrcweir 129cdf0e10cSrcweir Filter = new SettingsFilterChecker(log); 130cdf0e10cSrcweir Any arg = new Any(new Type(XDocumentHandler.class), Filter); 131cdf0e10cSrcweir try { 132cdf0e10cSrcweir oObj = (XInterface) xMSF.createInstanceWithArguments( 133cdf0e10cSrcweir "com.sun.star.comp.Writer.XMLSettingsExporter", 134cdf0e10cSrcweir new Object[] {arg}); 135cdf0e10cSrcweir XExporter xEx = (XExporter) UnoRuntime.queryInterface 136cdf0e10cSrcweir (XExporter.class,oObj); 137cdf0e10cSrcweir xEx.setSourceDocument(xTextDoc); 138cdf0e10cSrcweir 139cdf0e10cSrcweir //set some settings 140cdf0e10cSrcweir XController xController = xTextDoc.getCurrentController(); 141cdf0e10cSrcweir XViewSettingsSupplier xViewSetSup = (XViewSettingsSupplier) 142cdf0e10cSrcweir UnoRuntime.queryInterface(XViewSettingsSupplier.class, 143cdf0e10cSrcweir xController); 144cdf0e10cSrcweir XPropertySet xPropSet = xViewSetSup.getViewSettings(); 145cdf0e10cSrcweir xPropSet.setPropertyValue("ZoomValue", new Short(ZOOM)); 146cdf0e10cSrcweir 147cdf0e10cSrcweir } catch (com.sun.star.uno.Exception e) { 148cdf0e10cSrcweir e.printStackTrace(log) ; 149cdf0e10cSrcweir throw new StatusException("Can't create component.", e) ; 150cdf0e10cSrcweir } 151cdf0e10cSrcweir 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 String.valueOf(ZOOM), 159cdf0e10cSrcweir new XMLTools.Tag("config:config-item", 160cdf0e10cSrcweir "config:name", "ZoomFactor") ); 161cdf0e10cSrcweir 162cdf0e10cSrcweir // create testobject here 163cdf0e10cSrcweir log.println( "creating a new environment" ); 164cdf0e10cSrcweir TestEnvironment tEnv = new TestEnvironment( oObj ); 165cdf0e10cSrcweir 166cdf0e10cSrcweir tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor( 167cdf0e10cSrcweir new String[] {"FilterName"}, 168cdf0e10cSrcweir new Object[] {"swriter: StarOffice XML (Writer)"})); 169cdf0e10cSrcweir tEnv.addObjRelation("SourceDocument",xTextDoc); 170cdf0e10cSrcweir tEnv.addObjRelation("XFilter.Checker", Filter); 171cdf0e10cSrcweir return tEnv; 172cdf0e10cSrcweir 173cdf0e10cSrcweir } 174cdf0e10cSrcweir 175cdf0e10cSrcweir /** 176cdf0e10cSrcweir * This class checks the XML for tags and data required and returns 177cdf0e10cSrcweir * checking result to <code>XFilter</code> interface test. All 178cdf0e10cSrcweir * the information about errors occured in XML data is written 179cdf0e10cSrcweir * to log specified. 180cdf0e10cSrcweir * @see ifc.document._XFilter 181cdf0e10cSrcweir */ 182cdf0e10cSrcweir protected class SettingsFilterChecker extends XMLTools.XMLChecker 183cdf0e10cSrcweir implements ifc.document._XFilter.FilterChecker { 184cdf0e10cSrcweir 185cdf0e10cSrcweir /** 186cdf0e10cSrcweir * Creates a class which will write information 187cdf0e10cSrcweir * into log specified. 188cdf0e10cSrcweir */ SettingsFilterChecker(PrintWriter log)189cdf0e10cSrcweir public SettingsFilterChecker(PrintWriter log) { 190cdf0e10cSrcweir super(log, false) ; 191cdf0e10cSrcweir } 192cdf0e10cSrcweir 193cdf0e10cSrcweir /** 194cdf0e10cSrcweir * <code>_XFilter.FilterChecker</code> interface method 195cdf0e10cSrcweir * which returns the result of XML checking. 196cdf0e10cSrcweir * @return <code>true</code> if the XML data exported was 197cdf0e10cSrcweir * valid (i.e. all necessary tags and character data exists), 198cdf0e10cSrcweir * <code>false</code> if some errors occured. 199cdf0e10cSrcweir */ checkFilter()200cdf0e10cSrcweir public boolean checkFilter() { 201cdf0e10cSrcweir return check(); 202cdf0e10cSrcweir } 203cdf0e10cSrcweir } 204cdf0e10cSrcweir } 205cdf0e10cSrcweir 206