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