qadevOOo/tests/java/ifc/sheet/_XRecentFunctions.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: _XRecentFunctions.java,v $
  10  * $Revision: 1.4 $
  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.sheet;
  32
  33 import java.util.Random;
  34
  35 import lib.MultiMethodTest;
  36 import lib.Status;
  37 import lib.StatusException;
  38
  39 import com.sun.star.beans.PropertyValue;
  40 import com.sun.star.container.XNameAccess;
  41 import com.sun.star.sheet.XRecentFunctions;
  42
  43 /**
  44 * Testing <code>com.sun.star.sheet.XRecentFunctions</code>
  45 * interface methods :
  46 * <ul>
  47 *  <li><code> getRecentFunctionIds()</code></li>
  48 *  <li><code> setRecentFunctionIds()</code></li>
  49 *  <li><code> getMaxRecentFunctions()</code></li>
  50 * </ul> <p>
  51 * This test needs the following object relations :
  52 * <ul>
  53 *  <li> <code>'FUNCTIONLIST'</code> (of type <code>XNameAccess</code>):
  54 *   to have the set of available functions </li>
  55 * <ul> <p>
  56 * @see com.sun.star.sheet.XRecentFunctions
  57 */
  58 public class _XRecentFunctions extends MultiMethodTest {
  59
  60     public XRecentFunctions oObj = null;
  61     int iMaxNumber = 0;
  62
  63     /**
  64     * Test calls the method, checks returned value and stores it. <p>
  65     * Has <b> OK </b> status if returned value isn't equal to zero. <p>
  66     */
  67     public void _getMaxRecentFunctions() {
  68
  69         iMaxNumber = oObj.getMaxRecentFunctions();
  70         log.println("Maximum recent functions : " + iMaxNumber);
  71
  72         tRes.tested("getMaxRecentFunctions()", iMaxNumber != 0);
  73     }
  74
  75     /**
  76     * Test calls the method and checks returned value. <p>
  77     * Has <b> OK </b> status if returned value isn't null, if length of returned
  78     * array is equal or less to the maximum number of functions and obtained
  79     * array doesn't contain equal functions. <p>
  80     * The following method tests are to be completed successfully before :
  81     * <ul>
  82     *  <li> <code> getMaxRecentFunctions() </code> : to have the maximum number
  83     *  of recent functions </li>
  84     * </ul>
  85     */
  86     public void _getRecentFunctionIds() {
  87         requiredMethod("getMaxRecentFunctions()");
  88
  89         boolean bResult = true;
  90         int[] IDs = null;
  91         int iNumber = 0;
  92
  93         IDs = oObj.getRecentFunctionIds();
  94         iNumber = IDs.length;
  95         bResult &= (iNumber <= iMaxNumber);
  96         log.println("Now there are " + iNumber + " recent functions");
  97         bResult &= (IDs != null);
  98         if (bResult) {
  99             for (int i = 0; i < iNumber - 1; i++)
 100                 for (int j = i + 1; j < iNumber; j++) {
 101                     bResult &= (IDs[i] != IDs[j]);
 102                 }
 103         }
 104
 105         tRes.tested("getRecentFunctionIds()", bResult);
 106     }
 107
 108     /**
 109     * Test gets the set of available functions, sets empty list of recent
 110     * functions, sets list of maximum size. <p>
 111     * Has <b> OK </b> status if length of recent function list is equal to zero
 112     * after list was set to empty, if length of list is equal to maximum size
 113     * after list was set to it's maximum size and no exception were thrown. <p>
 114     * The following method tests are to be completed successfully before :
 115     * <ul>
 116     *  <li> <code> getMaxRecentFunctions() </code> : to have the maximum number
 117     *  of recent functions </li>
 118     * </ul>
 119     */
 120     public void _setRecentFunctionIds() {
 121         requiredMethod("getMaxRecentFunctions()");
 122
 123         boolean bResult = true;
 124         int[] IDs = new int[0];
 125         XNameAccess functionList = null;
 126
 127         log.println("First, get the set of available functions.");
 128         functionList = (XNameAccess)tEnv.getObjRelation("FUNCTIONLIST");
 129         if (functionList == null) throw new StatusException(Status.failed
 130             ("Relation 'FUNCTIONLIST' not found"));
 131
 132         log.println("Now trying to set empty list.");
 133         oObj.setRecentFunctionIds(IDs);
 134         bResult &= (oObj.getRecentFunctionIds().length == 0);
 135
 136         log.println("Now trying to set list of maximum size.");
 137         String[] names = functionList.getElementNames();
 138         Random rnd = new Random();
 139
 140         IDs = new int[iMaxNumber];
 141         int startIdx = rnd.nextInt(names.length - iMaxNumber - 1) + 1;
 142
 143         try {
 144             for (int i = startIdx; i < startIdx + iMaxNumber; i++) {
 145                 PropertyValue[] propVals = (PropertyValue[])
 146                     functionList.getByName(names[i]);
 147                 for (int j = 0; j < propVals.length; j++) {
 148                     String propName = (String)propVals[j].Name;
 149                     if (propName.equals("Id")) {
 150                         IDs[i - startIdx] =
 151                             ((Integer)propVals[j].Value).intValue();
 152                         break;
 153                     }
 154                 }
 155             }
 156         } catch(com.sun.star.lang.WrappedTargetException e) {
 157             e.printStackTrace(log);
 158             bResult = false;
 159         } catch(com.sun.star.container.NoSuchElementException e) {
 160             e.printStackTrace(log);
 161             bResult = false;
 162         }
 163
 164         oObj.setRecentFunctionIds(IDs);
 165         bResult &= (oObj.getRecentFunctionIds().length == iMaxNumber);
 166
 167         tRes.tested("setRecentFunctionIds()", bResult);
 168     }
 169
 170 }
 171