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._sm; 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.document.XDocumentInfo; 36cdf0e10cSrcweir import com.sun.star.document.XDocumentInfoSupplier; 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.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.xml.sax.XDocumentHandler; 45cdf0e10cSrcweir 46cdf0e10cSrcweir /** 47cdf0e10cSrcweir * Test for object which is represented by service 48cdf0e10cSrcweir * <code>com.sun.star.comp.Math.XMLExporter</code>. <p> 49cdf0e10cSrcweir * Object implements the following interfaces : 50cdf0e10cSrcweir * <ul> 51cdf0e10cSrcweir * <li><code>com::sun::star::lang::XInitialization</code></li> 52cdf0e10cSrcweir * <li><code>com::sun::star::document::ExportFilter</code></li> 53cdf0e10cSrcweir * <li><code>com::sun::star::document::XFilter</code></li> 54cdf0e10cSrcweir * <li><code>com::sun::star::document::XExporter</code></li> 55cdf0e10cSrcweir * <li><code>com::sun::star::beans::XPropertySet</code></li> 56cdf0e10cSrcweir * </ul> 57cdf0e10cSrcweir * @see com.sun.star.lang.XInitialization 58cdf0e10cSrcweir * @see com.sun.star.document.ExportFilter 59cdf0e10cSrcweir * @see com.sun.star.document.XFilter 60cdf0e10cSrcweir * @see com.sun.star.document.XExporter 61cdf0e10cSrcweir * @see com.sun.star.beans.XPropertySet 62cdf0e10cSrcweir * @see ifc.lang._XInitialization 63cdf0e10cSrcweir * @see ifc.document._ExportFilter 64cdf0e10cSrcweir * @see ifc.document._XFilter 65cdf0e10cSrcweir * @see ifc.document._XExporter 66cdf0e10cSrcweir * @see ifc.beans._XPropertySet 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir public class XMLMetaExporter extends TestCase { 69cdf0e10cSrcweir XComponent xMathDoc; 70cdf0e10cSrcweir 71cdf0e10cSrcweir /** 72cdf0e10cSrcweir * New math document created. 73cdf0e10cSrcweir */ initialize( TestParameters tParam, PrintWriter log )74cdf0e10cSrcweir protected void initialize( TestParameters tParam, PrintWriter log ) { 75cdf0e10cSrcweir SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() ); 76cdf0e10cSrcweir 77cdf0e10cSrcweir try { 78cdf0e10cSrcweir log.println( "creating a math document" ); 79cdf0e10cSrcweir xMathDoc = SOF.createMathDoc(null); 80cdf0e10cSrcweir } catch ( com.sun.star.uno.Exception e ) { 81cdf0e10cSrcweir // Some exception occures.FAILED 82cdf0e10cSrcweir e.printStackTrace( log ); 83cdf0e10cSrcweir throw new StatusException( "Couldn't create document", e ); 84cdf0e10cSrcweir } 85cdf0e10cSrcweir } 86cdf0e10cSrcweir 87cdf0e10cSrcweir /** 88cdf0e10cSrcweir * Document disposed here. 89cdf0e10cSrcweir */ cleanup( TestParameters tParam, PrintWriter log )90cdf0e10cSrcweir protected void cleanup( TestParameters tParam, PrintWriter log ) { 91cdf0e10cSrcweir log.println( " disposing xMathDoc " ); 92cdf0e10cSrcweir xMathDoc.dispose(); 93cdf0e10cSrcweir } 94cdf0e10cSrcweir 95cdf0e10cSrcweir /** 96cdf0e10cSrcweir * Creating a Testenvironment for the interfaces to be tested. 97cdf0e10cSrcweir * Creates an instance of the service 98cdf0e10cSrcweir * <code>com.sun.star.comp.Math.XMLExporter</code> with 99cdf0e10cSrcweir * argument which is an implementation of <code>XDocumentHandler</code> 100cdf0e10cSrcweir * and which can check if required tags and character data is 101cdf0e10cSrcweir * exported. <p> 102cdf0e10cSrcweir * The math document is set as a source document for exporter 103cdf0e10cSrcweir * created. A new user info field inserted into document. This made 104cdf0e10cSrcweir * for checking if this info field is successfully exported within 105cdf0e10cSrcweir * the document content. 106cdf0e10cSrcweir * Object relations created : 107cdf0e10cSrcweir * <ul> 108cdf0e10cSrcweir * <li> <code>'MediaDescriptor'</code> for 109cdf0e10cSrcweir * {@link ifc.document._XFilter} interface </li> 110cdf0e10cSrcweir * <li> <code>'XFilter.Checker'</code> for 111cdf0e10cSrcweir * {@link ifc.document._XFilter} interface </li> 112cdf0e10cSrcweir * <li> <code>'SourceDocument'</code> for 113cdf0e10cSrcweir * {@link ifc.document._XExporter} interface </li> 114cdf0e10cSrcweir * </ul> 115cdf0e10cSrcweir */ createTestEnvironment(TestParameters tParam, PrintWriter log)116cdf0e10cSrcweir protected TestEnvironment createTestEnvironment 117cdf0e10cSrcweir (TestParameters tParam, PrintWriter log) { 118cdf0e10cSrcweir XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ; 119cdf0e10cSrcweir XInterface oObj = null; 120cdf0e10cSrcweir final String expName = "XMLMetaExporterName" ; 121cdf0e10cSrcweir final String expValue = "XMLMetaExporterValue" ; 122cdf0e10cSrcweir 123cdf0e10cSrcweir FilterChecker filter = new FilterChecker(log); 124cdf0e10cSrcweir Any arg = new Any(new Type(XDocumentHandler.class), filter); 125cdf0e10cSrcweir 126cdf0e10cSrcweir try { 127cdf0e10cSrcweir oObj = (XInterface) xMSF.createInstanceWithArguments( 128cdf0e10cSrcweir "com.sun.star.comp.Math.XMLMetaExporter", new Object[] {arg}); 129cdf0e10cSrcweir XExporter xEx = (XExporter) UnoRuntime.queryInterface 130cdf0e10cSrcweir (XExporter.class,oObj); 131cdf0e10cSrcweir xEx.setSourceDocument(xMathDoc); 132cdf0e10cSrcweir 133cdf0e10cSrcweir // setting a new name and value for user info field 134cdf0e10cSrcweir XDocumentInfoSupplier xDocInfoSup = (XDocumentInfoSupplier) 135cdf0e10cSrcweir UnoRuntime.queryInterface(XDocumentInfoSupplier.class, xMathDoc) ; 136cdf0e10cSrcweir XDocumentInfo xDocInfo = xDocInfoSup.getDocumentInfo() ; 137cdf0e10cSrcweir xDocInfo.setUserFieldName((short) 0, expName) ; 138cdf0e10cSrcweir xDocInfo.setUserFieldValue((short) 0, expValue) ; 139cdf0e10cSrcweir } catch (com.sun.star.uno.Exception e) { 140cdf0e10cSrcweir e.printStackTrace(log) ; 141cdf0e10cSrcweir throw new StatusException("Can't create component.", e) ; 142cdf0e10cSrcweir } 143cdf0e10cSrcweir 144cdf0e10cSrcweir // checking tags required 145cdf0e10cSrcweir filter.addTag(new XMLTools.Tag("office:document-meta")) ; 146cdf0e10cSrcweir filter.addCharactersEnclosed(expValue, 147cdf0e10cSrcweir new XMLTools.Tag("meta:user-defined", "meta:name", expName)) ; 148cdf0e10cSrcweir 149cdf0e10cSrcweir // create testobject here 150cdf0e10cSrcweir log.println( "creating a new environment" ); 151cdf0e10cSrcweir TestEnvironment tEnv = new TestEnvironment( oObj ); 152cdf0e10cSrcweir 153cdf0e10cSrcweir 154cdf0e10cSrcweir tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor( 155cdf0e10cSrcweir new String[] {"FilterName"}, 156cdf0e10cSrcweir new Object[] {"smath: StarOffice XML (Math)"})); 157cdf0e10cSrcweir tEnv.addObjRelation("SourceDocument",xMathDoc); 158cdf0e10cSrcweir tEnv.addObjRelation("XFilter.Checker", filter) ; 159cdf0e10cSrcweir 160cdf0e10cSrcweir log.println("Implementation Name: "+util.utils.getImplName(oObj)); 161cdf0e10cSrcweir 162cdf0e10cSrcweir return tEnv; 163cdf0e10cSrcweir } 164cdf0e10cSrcweir 165cdf0e10cSrcweir /** 166cdf0e10cSrcweir * This class checks the XML for tags and data required and returns 167cdf0e10cSrcweir * checking result to <code>XFilter</code> interface test. All 168cdf0e10cSrcweir * the information about errors occured in XML data is written 169cdf0e10cSrcweir * to log specified. 170cdf0e10cSrcweir * @see ifc.document._XFilter 171cdf0e10cSrcweir */ 172cdf0e10cSrcweir protected class FilterChecker extends XMLTools.XMLChecker 173cdf0e10cSrcweir implements ifc.document._XFilter.FilterChecker { 174cdf0e10cSrcweir 175cdf0e10cSrcweir /** 176cdf0e10cSrcweir * Creates a class which will write information 177cdf0e10cSrcweir * into log specified. 178cdf0e10cSrcweir */ FilterChecker(PrintWriter log)179cdf0e10cSrcweir public FilterChecker(PrintWriter log) { 180cdf0e10cSrcweir super(log, true) ; 181cdf0e10cSrcweir } 182cdf0e10cSrcweir /** 183cdf0e10cSrcweir * <code>_XFilter.FilterChecker</code> interface method 184cdf0e10cSrcweir * which returns the result of XML checking. 185cdf0e10cSrcweir * @return <code>true</code> if the XML data exported was 186cdf0e10cSrcweir * valid (i.e. all necessary tags and character data exists), 187cdf0e10cSrcweir * <code>false</code> if some errors occured. 188cdf0e10cSrcweir */ checkFilter()189cdf0e10cSrcweir public boolean checkFilter() { 190cdf0e10cSrcweir return check(); 191cdf0e10cSrcweir } 192cdf0e10cSrcweir } 193cdf0e10cSrcweir } // finish class TestCase 194cdf0e10cSrcweir 195