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