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.container.XIndexAccess; 36cdf0e10cSrcweir import com.sun.star.container.XNamed; 37cdf0e10cSrcweir import com.sun.star.document.XExporter; 38cdf0e10cSrcweir import com.sun.star.lang.XComponent; 39cdf0e10cSrcweir import com.sun.star.lang.XMultiServiceFactory; 40cdf0e10cSrcweir import com.sun.star.sheet.XSpreadsheet; 41cdf0e10cSrcweir import com.sun.star.sheet.XSpreadsheetDocument; 42cdf0e10cSrcweir import com.sun.star.sheet.XSpreadsheets; 43cdf0e10cSrcweir import com.sun.star.uno.Any; 44cdf0e10cSrcweir import com.sun.star.uno.AnyConverter; 45cdf0e10cSrcweir import com.sun.star.uno.Type; 46cdf0e10cSrcweir import com.sun.star.uno.UnoRuntime; 47cdf0e10cSrcweir import com.sun.star.uno.XInterface; 48cdf0e10cSrcweir import com.sun.star.xml.sax.XDocumentHandler; 49cdf0e10cSrcweir 50cdf0e10cSrcweir /** 51cdf0e10cSrcweir * Test for object which is represented by service 52cdf0e10cSrcweir * <code>com.sun.star.comp.Calc.XMLExporter</code>. <p> 53cdf0e10cSrcweir * Object implements the following interfaces : 54cdf0e10cSrcweir * <ul> 55cdf0e10cSrcweir * <li><code>com::sun::star::lang::XInitialization</code></li> 56cdf0e10cSrcweir * <li><code>com::sun::star::document::ExportFilter</code></li> 57cdf0e10cSrcweir * <li><code>com::sun::star::document::XFilter</code></li> 58cdf0e10cSrcweir * <li><code>com::sun::star::document::XExporter</code></li> 59cdf0e10cSrcweir * <li><code>com::sun::star::beans::XPropertySet</code></li> 60cdf0e10cSrcweir * </ul> 61cdf0e10cSrcweir * @see com.sun.star.lang.XInitialization 62cdf0e10cSrcweir * @see com.sun.star.document.ExportFilter 63cdf0e10cSrcweir * @see com.sun.star.document.XFilter 64cdf0e10cSrcweir * @see com.sun.star.document.XExporter 65cdf0e10cSrcweir * @see com.sun.star.beans.XPropertySet 66cdf0e10cSrcweir * @see ifc.lang._XInitialization 67cdf0e10cSrcweir * @see ifc.document._ExportFilter 68cdf0e10cSrcweir * @see ifc.document._XFilter 69cdf0e10cSrcweir * @see ifc.document._XExporter 70cdf0e10cSrcweir * @see ifc.beans._XPropertySet 71cdf0e10cSrcweir */ 72cdf0e10cSrcweir public class XMLExporter extends TestCase { 73cdf0e10cSrcweir static XComponent xSheetDoc; 74cdf0e10cSrcweir 75cdf0e10cSrcweir /** 76cdf0e10cSrcweir * New spreadsheet document created. 77cdf0e10cSrcweir */ initialize( TestParameters tParam, PrintWriter log )78cdf0e10cSrcweir protected void initialize( TestParameters tParam, PrintWriter log ) { 79cdf0e10cSrcweir SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() ); 80cdf0e10cSrcweir try { 81cdf0e10cSrcweir log.println( "creating a calc document" ); 82cdf0e10cSrcweir xSheetDoc = SOF.openDoc("scalc","_blank"); 83cdf0e10cSrcweir } catch ( com.sun.star.uno.Exception e ) { 84cdf0e10cSrcweir // Some exception occures.FAILED 85cdf0e10cSrcweir e.printStackTrace( log ); 86cdf0e10cSrcweir throw new StatusException( "Couldn't create document", e ); 87cdf0e10cSrcweir } 88cdf0e10cSrcweir } 89cdf0e10cSrcweir 90cdf0e10cSrcweir /** 91cdf0e10cSrcweir * Spreadsheet document disposed 92cdf0e10cSrcweir */ cleanup( TestParameters tParam, PrintWriter log )93cdf0e10cSrcweir protected void cleanup( TestParameters tParam, PrintWriter log ) { 94cdf0e10cSrcweir log.println( " disposing xCalcDoc " ); 95cdf0e10cSrcweir util.DesktopTools.closeDoc(xSheetDoc); 96cdf0e10cSrcweir } 97cdf0e10cSrcweir 98cdf0e10cSrcweir /** 99cdf0e10cSrcweir * Creating a Testenvironment for the interfaces to be tested. 100cdf0e10cSrcweir * Creates an instance of the service 101cdf0e10cSrcweir * <code>com.sun.star.comp.Calc.XMLExporter</code> with 102cdf0e10cSrcweir * argument which is an implementation of <code>XDocumentHandler</code> 103cdf0e10cSrcweir * and which can check if required tags and character data is 104cdf0e10cSrcweir * exported. <p> 105cdf0e10cSrcweir * The calc document is set as a source document for exporter 106cdf0e10cSrcweir * created. Checking whether tags for table corresponding to some sheet 107cdf0e10cSrcweir * is exported.<p> 108cdf0e10cSrcweir * Object relations created : 109cdf0e10cSrcweir * <ul> 110cdf0e10cSrcweir * <li> <code>'MediaDescriptor'</code> for 111cdf0e10cSrcweir * {@link ifc.document._XFilter} interface </li> 112cdf0e10cSrcweir * <li> <code>'XFilter.Checker'</code> for 113cdf0e10cSrcweir * {@link ifc.document._XFilter} interface </li> 114cdf0e10cSrcweir * <li> <code>'SourceDocument'</code> for 115cdf0e10cSrcweir * {@link ifc.document._XExporter} interface </li> 116cdf0e10cSrcweir * </ul> 117cdf0e10cSrcweir */ createTestEnvironment(TestParameters tParam, PrintWriter log)118cdf0e10cSrcweir protected synchronized TestEnvironment createTestEnvironment(TestParameters tParam, PrintWriter log) { 119cdf0e10cSrcweir 120cdf0e10cSrcweir XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ; 121cdf0e10cSrcweir XInterface oObj = null; 122cdf0e10cSrcweir FilterChecker Filter = new FilterChecker(log); 123cdf0e10cSrcweir Any arg = new Any(new Type(XDocumentHandler.class), Filter); 124cdf0e10cSrcweir final String SHEET_NAME = "XMLExporter_SheetTestName"; 125cdf0e10cSrcweir 126cdf0e10cSrcweir try { 127cdf0e10cSrcweir oObj = (XInterface) xMSF.createInstanceWithArguments( 128cdf0e10cSrcweir "com.sun.star.comp.Calc.XMLExporter", new Object[] {arg} ); 129cdf0e10cSrcweir XExporter xEx = (XExporter) UnoRuntime.queryInterface 130cdf0e10cSrcweir (XExporter.class,oObj); 131cdf0e10cSrcweir xEx.setSourceDocument(xSheetDoc); 132cdf0e10cSrcweir 133cdf0e10cSrcweir //set name of sheet 134cdf0e10cSrcweir XSpreadsheetDocument xSpreadsheetDoc = (XSpreadsheetDocument) 135cdf0e10cSrcweir UnoRuntime.queryInterface(XSpreadsheetDocument.class, xSheetDoc); 136cdf0e10cSrcweir XSpreadsheets xSpreadsheets = xSpreadsheetDoc.getSheets(); 137cdf0e10cSrcweir XIndexAccess xSheetsIndexArray = (XIndexAccess) 138cdf0e10cSrcweir UnoRuntime.queryInterface(XIndexAccess.class, xSpreadsheets); 139cdf0e10cSrcweir XSpreadsheet xSheet = (XSpreadsheet) AnyConverter.toObject( 140cdf0e10cSrcweir new Type(XSpreadsheet.class),xSheetsIndexArray.getByIndex(0)); 141cdf0e10cSrcweir XNamed xSheetNamed = (XNamed) 142cdf0e10cSrcweir UnoRuntime.queryInterface(XNamed.class, xSheet); 143cdf0e10cSrcweir xSheetNamed.setName(SHEET_NAME); 144cdf0e10cSrcweir 145cdf0e10cSrcweir log.println("fill sheet with contnet..."); 146cdf0e10cSrcweir util.CalcTools.fillCalcSheetWithContent(xSheet, 3, 3, 50, 50); 147cdf0e10cSrcweir 148cdf0e10cSrcweir } catch (com.sun.star.uno.Exception e) { 149cdf0e10cSrcweir e.printStackTrace(log) ; 150cdf0e10cSrcweir throw new StatusException("Can't create component.", e) ; 151cdf0e10cSrcweir } catch (java.lang.Exception e) { 152cdf0e10cSrcweir e.printStackTrace(log); 153cdf0e10cSrcweir throw new StatusException("Can't create environment.", e); 154cdf0e10cSrcweir } 155cdf0e10cSrcweir 156cdf0e10cSrcweir // adding tags which must be contained in XML output 157cdf0e10cSrcweir Filter.addTag( new XMLTools.Tag("office:document") ); 158cdf0e10cSrcweir Filter.addTagEnclosed( 159cdf0e10cSrcweir new XMLTools.Tag("office:meta"), 160cdf0e10cSrcweir new XMLTools.Tag("office:document") ); 161cdf0e10cSrcweir Filter.addTagEnclosed( 162cdf0e10cSrcweir new XMLTools.Tag("office:settings"), 163cdf0e10cSrcweir new XMLTools.Tag("office:document") ); 164cdf0e10cSrcweir Filter.addTagEnclosed( 165cdf0e10cSrcweir new XMLTools.Tag("office:script"), 166cdf0e10cSrcweir new XMLTools.Tag("office:document") ); 167cdf0e10cSrcweir Filter.addTagEnclosed( 168cdf0e10cSrcweir new XMLTools.Tag("office:styles"), 169cdf0e10cSrcweir new XMLTools.Tag("office:document") ); 170cdf0e10cSrcweir Filter.addTagEnclosed( 171cdf0e10cSrcweir new XMLTools.Tag("office:body"), 172cdf0e10cSrcweir new XMLTools.Tag("office:document") ); 173cdf0e10cSrcweir Filter.addTagEnclosed( 174cdf0e10cSrcweir new XMLTools.Tag("table:table"), 175cdf0e10cSrcweir new XMLTools.Tag("office:body") ); 176cdf0e10cSrcweir Filter.addTag( 177cdf0e10cSrcweir new XMLTools.Tag("table:table", "table:name", SHEET_NAME) ); 178cdf0e10cSrcweir 179cdf0e10cSrcweir // create testobject here 180cdf0e10cSrcweir log.println( "creating a new environment" ); 181cdf0e10cSrcweir TestEnvironment tEnv = new TestEnvironment( oObj ); 182cdf0e10cSrcweir 183cdf0e10cSrcweir tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor( 184cdf0e10cSrcweir new String[] {"FilterName"}, 185cdf0e10cSrcweir new Object[] {"scalc: StarOffice XML (Calc)"})); 186cdf0e10cSrcweir tEnv.addObjRelation("SourceDocument",xSheetDoc); 187cdf0e10cSrcweir tEnv.addObjRelation("XFilter.Checker", Filter) ; 188cdf0e10cSrcweir return tEnv; 189cdf0e10cSrcweir } 190cdf0e10cSrcweir 191cdf0e10cSrcweir /** 192cdf0e10cSrcweir * This class checks the XML for tags and data required and returns 193cdf0e10cSrcweir * checking result to <code>XFilter</code> interface test. All 194cdf0e10cSrcweir * the information about errors occured in XML data is written 195cdf0e10cSrcweir * to log specified. 196cdf0e10cSrcweir * @see ifc.document._XFilter 197cdf0e10cSrcweir */ 198cdf0e10cSrcweir protected class FilterChecker extends XMLTools.XMLChecker 199cdf0e10cSrcweir implements ifc.document._XFilter.FilterChecker { 200cdf0e10cSrcweir 201cdf0e10cSrcweir /** 202cdf0e10cSrcweir * Creates a class which will write information 203cdf0e10cSrcweir * into log specified. 204cdf0e10cSrcweir */ FilterChecker(PrintWriter log)205cdf0e10cSrcweir public FilterChecker(PrintWriter log) { 206cdf0e10cSrcweir super(log, false) ; 207cdf0e10cSrcweir } 208cdf0e10cSrcweir /** 209cdf0e10cSrcweir * <code>_XFilter.FilterChecker</code> interface method 210cdf0e10cSrcweir * which returns the result of XML checking. 211cdf0e10cSrcweir * @return <code>true</code> if the XML data exported was 212cdf0e10cSrcweir * valid (i.e. all necessary tags and character data exists), 213cdf0e10cSrcweir * <code>false</code> if some errors occured. 214cdf0e10cSrcweir */ checkFilter()215cdf0e10cSrcweir public boolean checkFilter() { 216cdf0e10cSrcweir return check(); 217cdf0e10cSrcweir } 218cdf0e10cSrcweir } 219cdf0e10cSrcweir } 220cdf0e10cSrcweir 221