qadevOOo/tests/java/ifc/frame/_XDispatchProvider.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: _XDispatchProvider.java,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package ifc.frame;
  32
  33 import lib.MultiMethodTest;
  34 import util.utils;
  35
  36 import com.sun.star.frame.DispatchDescriptor;
  37 import com.sun.star.frame.FrameSearchFlag;
  38 import com.sun.star.frame.XDispatch;
  39 import com.sun.star.frame.XDispatchProvider;
  40 import com.sun.star.lang.XMultiServiceFactory;
  41 import com.sun.star.uno.UnoRuntime;
  42 import com.sun.star.util.URL;
  43 import com.sun.star.util.XURLTransformer;
  44
  45 /**
  46 * Testing <code>com.sun.star.frame.XDispatchProvider</code>
  47 * interface methods:
  48 * <ul>
  49 *  <li><code> queryDispatch() </code></li>
  50 *  <li><code> queryDispatches() </code></li>
  51 * </ul><p>
  52 * This test needs the following object relations :
  53 * <ul>
  54 *  <li> <code>'XDispatchProvider.URL'</code> (of type <code>String</code>):
  55 *  used to obtain unparsed url of DispatchProvider </li>
  56 * </ul> <p>
  57 * Test is <b> NOT </b> multithread compilant. <p>
  58 * @see com.sun.star.frame.XDispatchProvider
  59 */
  60 public class _XDispatchProvider extends MultiMethodTest {
  61     public static XDispatchProvider oObj = null;
  62     private String dispatchUrl = null ;
  63
  64     /**
  65     * Retrieves object relation.
  66     */
  67     public void before() {
  68         dispatchUrl = (String) tEnv.getObjRelation("XDispatchProvider.URL") ;
  69         if (dispatchUrl == null) {
  70             dispatchUrl = utils.getFullTestDocName("index.html");
  71         }
  72         log.println("Using URL: '" + dispatchUrl + "'");
  73     }
  74
  75     /**
  76     * Test calls the method. <p>
  77     * Has <b> OK </b> status if the method does not return null.
  78     */
  79     public void _queryDispatch() {
  80         URL url = new URL();
  81         String frameName = "_top";
  82
  83         url.Complete = dispatchUrl;
  84         try {
  85             XURLTransformer xParser=(XURLTransformer)
  86                 UnoRuntime.queryInterface(XURLTransformer.class,
  87                     ((XMultiServiceFactory)tParam.getMSF()).createInstance
  88                         ("com.sun.star.util.URLTransformer"));
  89             // Because it's an in/out parameter we must use an array of
  90             // URL objects.
  91             URL[] aParseURL = new URL[1];
  92             aParseURL[0] = new URL();
  93             aParseURL[0].Complete = dispatchUrl;
  94             xParser.parseStrict(aParseURL);
  95             url = aParseURL[0];
  96         } catch (com.sun.star.uno.Exception e) {
  97             log.println("Couldn't parse URL");
  98         }
  99         XDispatch xDispatch = oObj.queryDispatch(url,
 100                 frameName, FrameSearchFlag.ALL);
 101         tRes.tested("queryDispatch()", xDispatch != null);
 102     }
 103
 104     /**
 105     * Before test calls the method, DispatchDescriptor sequence is defined.<p>
 106     * Has <b> OK </b> status if the method does not return null, returned
 107     * sequence length is equal to a number of DispatchDescriptors
 108     * and returned sequence consists of non-null elements.
 109     */
 110     public void _queryDispatches() {
 111         String name1 = "_self";
 112         String name2 = "_top";
 113         URL url1 = new URL();
 114         URL url2 = new URL();
 115
 116         url1.Complete = dispatchUrl;
 117         url2.Complete = dispatchUrl;
 118         try {
 119             log.println("Parsing URL");
 120             XURLTransformer xParser = (XURLTransformer)
 121                 UnoRuntime.queryInterface(XURLTransformer.class,
 122                     ((XMultiServiceFactory)tParam.getMSF()).createInstance
 123                         ("com.sun.star.util.URLTransformer"));
 124             // Because it's an in/out parameter we must use an array of
 125             // URL objects.
 126             URL[] aParseURL = new URL[1];
 127             aParseURL[0] = new URL();
 128             aParseURL[0].Complete = dispatchUrl;
 129             xParser.parseStrict(aParseURL);
 130             url1 = aParseURL[0];
 131             url2 = aParseURL[0];
 132         } catch (com.sun.star.uno.Exception e) {
 133             log.println("Couldn't parse URL");
 134         }
 135         DispatchDescriptor descs[] = new DispatchDescriptor[] {
 136             new DispatchDescriptor(url1, name1, FrameSearchFlag.ALL),
 137             new DispatchDescriptor(url2, name2, FrameSearchFlag.ALL)
 138         };
 139         XDispatch[] xDispatches = oObj.queryDispatches(descs);
 140
 141         if (xDispatches == null) {
 142             log.println("queryDispatches() returned null");
 143             tRes.tested("queryDispatches()", false);
 144             return;
 145         }
 146
 147         if (xDispatches.length != descs.length) {
 148             log.println("queryDispatches() returned "
 149                     + xDispatches.length
 150                     + " amount of XDispatch instead of "
 151                     + descs.length);
 152             tRes.tested("queryDispatches()", false);
 153             return;
 154         }
 155
 156         for (int i = 0; i < xDispatches.length; i++) {
 157             if (xDispatches[i] == null) {
 158                 log.println("queryDispatches() result contains"
 159                         + " null object");
 160                 tRes.tested("queryDispatches()", false);
 161                 return;
 162             }
 163         }
 164
 165         tRes.tested("queryDispatches()", true);
 166         return;
 167     }
 168
 169 }
 170