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 package mod._sc;
24cdf0e10cSrcweir 
25cdf0e10cSrcweir import java.io.PrintWriter;
26cdf0e10cSrcweir 
27cdf0e10cSrcweir import lib.StatusException;
28cdf0e10cSrcweir import lib.TestCase;
29cdf0e10cSrcweir import lib.TestEnvironment;
30cdf0e10cSrcweir import lib.TestParameters;
31cdf0e10cSrcweir import util.SOfficeFactory;
32cdf0e10cSrcweir 
33cdf0e10cSrcweir import com.sun.star.beans.XPropertySet;
34cdf0e10cSrcweir import com.sun.star.container.XIndexAccess;
35cdf0e10cSrcweir import com.sun.star.container.XNameAccess;
36cdf0e10cSrcweir import com.sun.star.lang.XComponent;
37cdf0e10cSrcweir import com.sun.star.lang.XMultiServiceFactory;
38cdf0e10cSrcweir import com.sun.star.sheet.XSpreadsheet;
39cdf0e10cSrcweir import com.sun.star.sheet.XSpreadsheetDocument;
40cdf0e10cSrcweir import com.sun.star.sheet.XSpreadsheets;
41cdf0e10cSrcweir import com.sun.star.uno.AnyConverter;
42cdf0e10cSrcweir import com.sun.star.uno.Type;
43cdf0e10cSrcweir import com.sun.star.uno.UnoRuntime;
44cdf0e10cSrcweir import com.sun.star.uno.XInterface;
45cdf0e10cSrcweir 
46cdf0e10cSrcweir /**
47cdf0e10cSrcweir * Test for object which is represented by service
48cdf0e10cSrcweir * <code>com.sun.star.sheet.DDELink</code>. <p>
49cdf0e10cSrcweir * Object implements the following interfaces :
50cdf0e10cSrcweir * <ul>
51cdf0e10cSrcweir *  <li> <code>com::sun::star::container::XNamed</code></li>
52cdf0e10cSrcweir *  <li> <code>com::sun::star::util::XRefreshable</code></li>
53cdf0e10cSrcweir *  <li> <code>com::sun::star::sheet::XDDELink</code></li>
54cdf0e10cSrcweir * </ul>
55cdf0e10cSrcweir * The following files used by this test :
56cdf0e10cSrcweir * <ul>
57cdf0e10cSrcweir *  <li><b> ScDDELinksObj.sdc </b> : the predefined testdocument </li>
58cdf0e10cSrcweir * </ul> <p>
59cdf0e10cSrcweir * @see com.sun.star.sheet.DDELink
60cdf0e10cSrcweir * @see com.sun.star.container.XNamed
61cdf0e10cSrcweir * @see com.sun.star.util.XRefreshable
62cdf0e10cSrcweir * @see com.sun.star.sheet.XDDELink
63cdf0e10cSrcweir * @see ifc.container._XNamed
64cdf0e10cSrcweir * @see ifc.util._XRefreshable
65cdf0e10cSrcweir * @see ifc.sheet._XDDELink
66cdf0e10cSrcweir */
67cdf0e10cSrcweir public class ScDDELinkObj extends TestCase {
68cdf0e10cSrcweir     static XSpreadsheetDocument xSheetDoc = null;
69cdf0e10cSrcweir     static XComponent oDoc = null;
70cdf0e10cSrcweir 
71cdf0e10cSrcweir     /**
72cdf0e10cSrcweir     * Creates Spreadsheet document.
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 Spreadsheet document" );
79cdf0e10cSrcweir             xSheetDoc = SOF.createCalcDoc(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     /**
89cdf0e10cSrcweir     * Disposes Spreadsheet document and testdocument if it was loaded already.
90cdf0e10cSrcweir     */
cleanup( TestParameters tParam, PrintWriter log )91cdf0e10cSrcweir     protected void cleanup( TestParameters tParam, PrintWriter log ) {
92cdf0e10cSrcweir         log.println( "    disposing xSheetDoc " );
93cdf0e10cSrcweir         XComponent oComp = (XComponent)
94cdf0e10cSrcweir             UnoRuntime.queryInterface(XComponent.class, xSheetDoc) ;
95cdf0e10cSrcweir         util.DesktopTools.closeDoc(oComp);
96cdf0e10cSrcweir         if (oDoc != null) {
97cdf0e10cSrcweir             util.DesktopTools.closeDoc(oDoc);
98cdf0e10cSrcweir         }
99cdf0e10cSrcweir     }
100cdf0e10cSrcweir 
101cdf0e10cSrcweir     /**
102cdf0e10cSrcweir     * Creating a Testenvironment for the interfaces to be tested.
103cdf0e10cSrcweir     * Disposes the testdocument if it was loaded already.
104cdf0e10cSrcweir     * Creates an instance of the <code>com.sun.star.frame.Desktop</code>
105cdf0e10cSrcweir     * and loads the predefined testdocument. Retrieves a collection of
106cdf0e10cSrcweir     * spreadsheets from a document and takes one of them. Sets specific formula
107cdf0e10cSrcweir     * to some cells in the spreadsheet(the formula specify DDE links to the
108cdf0e10cSrcweir     * testdocument). Retrieves the collection of DDE links in the document and
109cdf0e10cSrcweir     * retrives first DDE link from the collection.
110cdf0e10cSrcweir     * The retrived DDE link is the instance of the service
111cdf0e10cSrcweir     * <code>com.sun.star.sheet.DDELink</code>.
112cdf0e10cSrcweir     * Object relations created :
113cdf0e10cSrcweir     * <ul>
114cdf0e10cSrcweir     *  <li> <code>'setName'</code> for
115cdf0e10cSrcweir     *      {@link ifc.container._XNamed}(specify that the method
116cdf0e10cSrcweir     *      <code>setName</code> must not be tested)</li>
117cdf0e10cSrcweir     *  <li> <code>'APPLICATION'</code> for
118cdf0e10cSrcweir     *      {@link ifc.sheet._XDDELink}(the name of the current application)</li>
119cdf0e10cSrcweir     *  <li> <code>'ITEM'</code> for
120cdf0e10cSrcweir     *      {@link ifc.sheet._XDDELink}(the DDE item that was set in the formula)</li>
121cdf0e10cSrcweir     *  <li> <code>'TOPIC'</code> for
122cdf0e10cSrcweir     *      {@link ifc.sheet._XDDELink}(the full testdocument name)</li>
123cdf0e10cSrcweir     * </ul>
124cdf0e10cSrcweir     * @see com.sun.star.frame.Desktop
125cdf0e10cSrcweir     * @see com.sun.star.sheet.DDELink
126cdf0e10cSrcweir     */
createTestEnvironment(TestParameters Param, PrintWriter log)127cdf0e10cSrcweir     protected synchronized TestEnvironment createTestEnvironment(TestParameters Param, PrintWriter log) {
128cdf0e10cSrcweir 
129cdf0e10cSrcweir         XInterface oObj = null;
130cdf0e10cSrcweir 
131cdf0e10cSrcweir         if (oDoc != null) {
132cdf0e10cSrcweir             util.DesktopTools.closeDoc(oDoc);
133cdf0e10cSrcweir         }
134cdf0e10cSrcweir 
135cdf0e10cSrcweir         // creation of testobject here
136cdf0e10cSrcweir         // first we write what we are intend to do to log file
137cdf0e10cSrcweir         log.println( "Creating a test environment" );
138cdf0e10cSrcweir 
139cdf0e10cSrcweir         // create testobject here
140cdf0e10cSrcweir 
141cdf0e10cSrcweir         XMultiServiceFactory oMSF = (XMultiServiceFactory)Param.getMSF();
142cdf0e10cSrcweir 
143cdf0e10cSrcweir         // load the predefined testdocument
144cdf0e10cSrcweir         String testdoc = util.utils.getFullTestURL("ScDDELinksObj.sdc");
145cdf0e10cSrcweir         try {
146cdf0e10cSrcweir             oDoc = SOfficeFactory.getFactory(oMSF).loadDocument(testdoc);
147cdf0e10cSrcweir         } catch (com.sun.star.lang.IllegalArgumentException e) {
148cdf0e10cSrcweir             e.printStackTrace(log);
149cdf0e10cSrcweir             throw new StatusException("Can't load test document", e);
150cdf0e10cSrcweir         } catch (com.sun.star.io.IOException e) {
151cdf0e10cSrcweir             e.printStackTrace(log);
152cdf0e10cSrcweir             throw new StatusException("Can't load test document", e);
153cdf0e10cSrcweir         } catch (com.sun.star.uno.Exception e) {
154cdf0e10cSrcweir             e.printStackTrace(log);
155cdf0e10cSrcweir             throw new StatusException("Can't load test document", e);
156cdf0e10cSrcweir         }
157cdf0e10cSrcweir 
158cdf0e10cSrcweir         log.println("getting sheets");
159cdf0e10cSrcweir         XSpreadsheets xSpreadsheets = (XSpreadsheets)xSheetDoc.getSheets();
160cdf0e10cSrcweir 
161cdf0e10cSrcweir         log.println("getting a sheet");
162cdf0e10cSrcweir         XSpreadsheet oSheet = null;
163cdf0e10cSrcweir         XIndexAccess oIndexAccess = (XIndexAccess)
164cdf0e10cSrcweir             UnoRuntime.queryInterface(XIndexAccess.class, xSpreadsheets);
165cdf0e10cSrcweir         try {
166cdf0e10cSrcweir             oSheet = (XSpreadsheet) AnyConverter.toObject(
167cdf0e10cSrcweir                     new Type(XSpreadsheet.class),oIndexAccess.getByIndex(0));
168cdf0e10cSrcweir         } catch (com.sun.star.lang.WrappedTargetException e) {
169cdf0e10cSrcweir             e.printStackTrace(log);
170cdf0e10cSrcweir             throw new StatusException("Couldn't get a spreadsheet", e);
171cdf0e10cSrcweir         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
172cdf0e10cSrcweir             e.printStackTrace(log);
173cdf0e10cSrcweir             throw new StatusException("Couldn't get a spreadsheet", e);
174cdf0e10cSrcweir         } catch (com.sun.star.lang.IllegalArgumentException e) {
175cdf0e10cSrcweir             e.printStackTrace(log);
176cdf0e10cSrcweir             throw new StatusException("Couldn't get a spreadsheet", e);
177cdf0e10cSrcweir         }
178cdf0e10cSrcweir 
179cdf0e10cSrcweir         log.println("filling some cells");
180cdf0e10cSrcweir         String sAppl = "soffice";
181cdf0e10cSrcweir         String sItem = "Sheet1.A1";
182cdf0e10cSrcweir         testdoc = util.utils.getFullTestDocName("ScDDELinksObj.sdc");
183cdf0e10cSrcweir         try {
184cdf0e10cSrcweir             oSheet.getCellByPosition(5, 5).setFormula(
185cdf0e10cSrcweir                 "=DDE(\""+ sAppl +"\";\""+testdoc+"\";\""+ sItem +"\"");
186cdf0e10cSrcweir             oSheet.getCellByPosition(1, 4).setFormula(
187cdf0e10cSrcweir                 "=DDE(\""+ sAppl +"\";\""+testdoc+"\";\""+ sItem +"\"");
188cdf0e10cSrcweir         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
189cdf0e10cSrcweir             e.printStackTrace(log);
190cdf0e10cSrcweir             throw new StatusException(
191cdf0e10cSrcweir                 "Exception occurred while filling cells", e);
192cdf0e10cSrcweir         }
193cdf0e10cSrcweir 
194cdf0e10cSrcweir         try {
195cdf0e10cSrcweir             log.println("Getting test object ") ;
196cdf0e10cSrcweir 
197cdf0e10cSrcweir             // Getting named ranges.
198cdf0e10cSrcweir             XPropertySet docProps = (XPropertySet)
199cdf0e10cSrcweir                 UnoRuntime.queryInterface(XPropertySet.class, xSheetDoc);
200cdf0e10cSrcweir             XNameAccess links = (XNameAccess) AnyConverter.toObject(
201cdf0e10cSrcweir                 new Type(XNameAccess.class), UnoRuntime.queryInterface(
202cdf0e10cSrcweir                     XNameAccess.class, docProps.getPropertyValue("DDELinks")));
203cdf0e10cSrcweir 
204cdf0e10cSrcweir             String[] linkNames = links.getElementNames();
205cdf0e10cSrcweir 
206cdf0e10cSrcweir             oObj = (XInterface) AnyConverter.toObject(
207cdf0e10cSrcweir                 new Type(XInterface.class),links.getByName(linkNames[0]));
208cdf0e10cSrcweir             log.println("Creating object - " +
209cdf0e10cSrcweir                                         ((oObj == null) ? "FAILED" : "OK"));
210cdf0e10cSrcweir         } catch (com.sun.star.lang.WrappedTargetException e) {
211cdf0e10cSrcweir             e.printStackTrace(log) ;
212cdf0e10cSrcweir             throw new StatusException(
213cdf0e10cSrcweir                 "Error getting test object from spreadsheet document", e) ;
214cdf0e10cSrcweir         } catch (com.sun.star.beans.UnknownPropertyException e) {
215cdf0e10cSrcweir             e.printStackTrace(log) ;
216cdf0e10cSrcweir             throw new StatusException(
217cdf0e10cSrcweir                 "Error getting test object from spreadsheet document", e) ;
218cdf0e10cSrcweir         } catch (com.sun.star.container.NoSuchElementException e) {
219cdf0e10cSrcweir             e.printStackTrace(log) ;
220cdf0e10cSrcweir             throw new StatusException(
221cdf0e10cSrcweir                 "Error getting test object from spreadsheet document", e) ;
222cdf0e10cSrcweir         } catch (com.sun.star.lang.IllegalArgumentException e) {
223cdf0e10cSrcweir             e.printStackTrace(log) ;
224cdf0e10cSrcweir             throw new StatusException(
225cdf0e10cSrcweir                 "Error getting test object from spreadsheet document", e) ;
226cdf0e10cSrcweir         }
227cdf0e10cSrcweir 
228cdf0e10cSrcweir         TestEnvironment tEnv = new TestEnvironment( oObj );
229cdf0e10cSrcweir 
230cdf0e10cSrcweir         // Other parameters required for interface tests
231cdf0e10cSrcweir         tEnv.addObjRelation("APPLICATION", sAppl);
232cdf0e10cSrcweir         tEnv.addObjRelation("ITEM", sItem);
233cdf0e10cSrcweir         tEnv.addObjRelation("TOPIC", testdoc);
234cdf0e10cSrcweir         tEnv.addObjRelation("setName", new Boolean(true));
235cdf0e10cSrcweir 
236cdf0e10cSrcweir         return tEnv;
237cdf0e10cSrcweir     }
238cdf0e10cSrcweir 
239cdf0e10cSrcweir }
240cdf0e10cSrcweir 
241cdf0e10cSrcweir 
242