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._xmloff.Chart;
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.DesktopTools;
33 import util.SOfficeFactory;
34 import util.XMLTools;
35 
36 import com.sun.star.beans.XPropertySet;
37 import com.sun.star.chart.XChartDocument;
38 import com.sun.star.document.XExporter;
39 import com.sun.star.lang.XMultiServiceFactory;
40 import com.sun.star.uno.Any;
41 import com.sun.star.uno.Exception;
42 import com.sun.star.uno.Type;
43 import com.sun.star.uno.UnoRuntime;
44 import com.sun.star.uno.XInterface;
45 import com.sun.star.xml.sax.XDocumentHandler;
46 
47 /**
48  * Test for object which is represented by service
49  * <code>com.sun.star.comp.Chart.XMLExporter</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 XMLExporter extends TestCase {
70     XChartDocument xChartDoc = null;
71 
72     /**
73      * New text document created.
74      */
initialize( TestParameters tParam, PrintWriter log )75     protected void initialize( TestParameters tParam, PrintWriter log ) {
76 
77         // get a soffice factory object
78         SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF());
79 
80         try {
81             log.println( "creating a chartdocument" );
82             xChartDoc = SOF.createChartDoc(null);
83         } catch ( Exception e ) {
84             // Some exception occured.FAILED
85             e.printStackTrace( log );
86             throw new StatusException( "Couldn't create document", e );
87         }
88     }
89 
90     /**
91      * Close document
92      */
cleanup( TestParameters tParam, PrintWriter log )93     protected void cleanup( TestParameters tParam, PrintWriter log ) {
94         if( xChartDoc!=null ) {
95             log.println( "    closing xChartDoc" );
96             util.DesktopTools.closeDoc(xChartDoc);
97             xChartDoc = null;
98         }
99     }
100 
101     /**
102     * Creating a Testenvironment for the interfaces to be tested.
103     * Creates an instance of the service
104     * <code>com.sun.star.comp.Chart.XMLExporter</code> with
105     * argument which is an implementation of <code>XDocumentHandler</code>
106     * and which can check if required tags and character data is
107     * exported. <p>
108     * The chart document is set as a source document for exporter
109     * created. A new 'main title' is set for chart. This made
110     * for checking if this title is successfully exported within
111     * the document content.
112     *     Object relations created :
113     * <ul>
114     *  <li> <code>'MediaDescriptor'</code> for
115     *      {@link ifc.document._XFilter} interface </li>
116     *  <li> <code>'XFilter.Checker'</code> for
117     *      {@link ifc.document._XFilter} interface </li>
118     *  <li> <code>'SourceDocument'</code> for
119     *      {@link ifc.document._XExporter} interface </li>
120     * </ul>
121     */
createTestEnvironment(TestParameters tParam, PrintWriter log )122     public synchronized TestEnvironment createTestEnvironment
123             (TestParameters tParam, PrintWriter log ) {
124 
125         XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ;
126         XInterface oObj = null;
127         final String exportStr = "XMLExporter test." ;
128 
129         FilterChecker filter = new FilterChecker(log);
130         Any arg = new Any(new Type(XDocumentHandler.class),filter);
131 
132         try {
133             oObj = (XInterface) xMSF.createInstanceWithArguments(
134                 "com.sun.star.comp.Chart.XMLExporter", new Object[] {arg});
135             XExporter xEx = (XExporter)
136                 UnoRuntime.queryInterface(XExporter.class,oObj);
137             xEx.setSourceDocument(xChartDoc);
138 
139             Object oTitle = xChartDoc.getTitle() ;
140             XPropertySet xTitleProp = (XPropertySet) UnoRuntime.queryInterface
141                 (XPropertySet.class, oTitle) ;
142             xTitleProp.setPropertyValue("String", exportStr) ;
143         } catch (com.sun.star.uno.Exception e) {
144             e.printStackTrace(log) ;
145             throw new StatusException("Can't create component.", e) ;
146         }
147 
148         filter.addTag(new XMLTools.Tag("office:document")) ;
149         filter.addTagEnclosed(new XMLTools.Tag("office:meta"),
150             new XMLTools.Tag("office:document"));
151         filter.addTagEnclosed(new XMLTools.Tag("office:body"),
152             new XMLTools.Tag("office:document"));
153         filter.addCharactersEnclosed(exportStr,
154             new XMLTools.Tag("chart:title")) ;
155 
156 
157         // create testobject here
158         log.println( "creating a new environment" );
159         TestEnvironment tEnv = new TestEnvironment( oObj );
160 
161         tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor(
162             new String[] {"FilterName"},
163             new Object[] {"schart: StarOffice XML (Chart)"}));
164         tEnv.addObjRelation("SourceDocument",xChartDoc);
165         tEnv.addObjRelation("XFilter.Checker", filter) ;
166         log.println("Implementation Name: "+util.utils.getImplName(oObj));
167 
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 occurred 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, true) ;
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 occurred.
195          */
checkFilter()196         public boolean checkFilter() {
197             return check() ;
198         }
199     }
200 }
201