1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 package mod._xmloff.Chart;
29 
30 import java.io.PrintWriter;
31 
32 import lib.StatusException;
33 import lib.TestCase;
34 import lib.TestEnvironment;
35 import lib.TestParameters;
36 import util.SOfficeFactory;
37 import util.XMLTools;
38 
39 import com.sun.star.chart.XChartDocument;
40 import com.sun.star.document.XExporter;
41 import com.sun.star.lang.XMultiServiceFactory;
42 import com.sun.star.uno.Any;
43 import com.sun.star.uno.Exception;
44 import com.sun.star.uno.Type;
45 import com.sun.star.uno.UnoRuntime;
46 import com.sun.star.uno.XInterface;
47 import com.sun.star.xml.sax.XDocumentHandler;
48 
49 /**
50  * Test for object which is represented by service
51  * <code>com.sun.star.comp.Chart.XMLStylesExporter</code>. <p>
52  * Object implements the following interfaces :
53  * <ul>
54  *  <li><code>com::sun::star::lang::XInitialization</code></li>
55  *  <li><code>com::sun::star::document::ExportFilter</code></li>
56  *  <li><code>com::sun::star::document::XFilter</code></li>
57  *  <li><code>com::sun::star::document::XExporter</code></li>
58  *  <li><code>com::sun::star::beans::XPropertySet</code></li>
59  * </ul>
60  * @see com.sun.star.lang.XInitialization
61  * @see com.sun.star.document.ExportFilter
62  * @see com.sun.star.document.XFilter
63  * @see com.sun.star.document.XExporter
64  * @see com.sun.star.beans.XPropertySet
65  * @see ifc.lang._XInitialization
66  * @see ifc.document._ExportFilter
67  * @see ifc.document._XFilter
68  * @see ifc.document._XExporter
69  * @see ifc.beans._XPropertySet
70  */
71 public class XMLStylesExporter extends TestCase {
72     XChartDocument xChartDoc = null;
73 
74     /**
75      * New text document created.
76      */
77     protected void initialize( TestParameters tParam, PrintWriter log ) {
78 
79         // get a soffice factory object
80         SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF());
81 
82         try {
83             log.println( "creating a chartdocument" );
84             xChartDoc = SOF.createChartDoc(null);;
85         } catch ( Exception e ) {
86             // Some exception occures.FAILED
87             e.printStackTrace( log );
88             throw new StatusException( "Couldn't create document", e );
89         }
90     }
91 
92     /**
93      * Close document
94      */
95     protected void cleanup( TestParameters tParam, PrintWriter log ) {
96         if( xChartDoc!=null ) {
97             log.println( "    closing xChartDoc" );
98             util.DesktopTools.closeDoc(xChartDoc);
99             xChartDoc = null;
100         }
101     }
102 
103     /**
104     * Creating a Testenvironment for the interfaces to be tested.
105     * Creates an instance of the service
106     * <code>com.sun.star.comp.Chart.XMLStylesExporter</code> with
107     * argument which is an implementation of <code>XDocumentHandler</code>
108     * and which can check if required tags and character data is
109     * exported. <p>
110     *   Existing of some tags checked in XML data exported.
111     *     Object relations created :
112     * <ul>
113     *  <li> <code>'MediaDescriptor'</code> for
114     *      {@link ifc.document._XFilter} interface </li>
115     *  <li> <code>'XFilter.Checker'</code> for
116     *      {@link ifc.document._XFilter} interface </li>
117     *  <li> <code>'SourceDocument'</code> for
118     *      {@link ifc.document._XExporter} interface </li>
119     * </ul>
120     */
121     public synchronized TestEnvironment createTestEnvironment
122             (TestParameters tParam, PrintWriter log) {
123 
124         XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ;
125         XInterface oObj = null;
126 
127         FilterChecker filter = new FilterChecker(log);
128         Any arg = new Any(new Type(XDocumentHandler.class),filter);
129 
130         try {
131             oObj = (XInterface) xMSF.createInstanceWithArguments(
132                 "com.sun.star.comp.Chart.XMLStylesExporter",
133                 new Object[] {arg});
134             XExporter xEx = (XExporter)
135                 UnoRuntime.queryInterface(XExporter.class,oObj);
136             xEx.setSourceDocument(xChartDoc);
137 
138         } catch (com.sun.star.uno.Exception e) {
139             e.printStackTrace(log) ;
140             throw new StatusException("Can't create component.", e) ;
141         }
142 
143 
144         filter.addTag(new XMLTools.Tag("office:document-styles")) ;
145         filter.addTagEnclosed(new XMLTools.Tag("office:styles"),
146             new XMLTools.Tag("office:document-styles"));
147 
148         // create testobject here
149         log.println( "creating a new environment" );
150         TestEnvironment tEnv = new TestEnvironment( oObj );
151 
152         tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor(
153             new String[] {"FilterName"},
154             new Object[] {"schart: StarOffice XML (Chart)"}));
155         tEnv.addObjRelation("SourceDocument",xChartDoc);
156         tEnv.addObjRelation("XFilter.Checker", filter) ;
157         log.println("Implementation Name: "+util.utils.getImplName(oObj));
158 
159         return tEnv;
160 
161     }
162 
163     /**
164      * This class checks the XML for tags and data required and returns
165      * checking result to <code>XFilter</code> interface test. All
166      * the information about errors occured in XML data is written
167      * to log specified.
168      * @see ifc.document._XFilter
169      */
170     protected class FilterChecker extends XMLTools.XMLChecker
171         implements ifc.document._XFilter.FilterChecker {
172 
173         /**
174          * Creates a class which will write information
175          * into log specified.
176          */
177         public FilterChecker(PrintWriter log) {
178             super(log, true) ;
179         }
180         /**
181          * <code>_XFilter.FilterChecker</code> interface method
182          * which returns the result of XML checking.
183          * @return <code>true</code> if the XML data exported was
184          * valid (i.e. all necessary tags and character data exists),
185          * <code>false</code> if some errors occured.
186          */
187         public boolean checkFilter() {
188             return check() ;
189         }
190     }
191 }
192