qadevOOo/tests/java/ifc/util/_XSearchable.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: _XSearchable.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.util;
  32
  33 import lib.MultiMethodTest;
  34
  35 import com.sun.star.container.XIndexAccess;
  36 import com.sun.star.table.XCell;
  37 import com.sun.star.util.XSearchDescriptor;
  38 import com.sun.star.util.XSearchable;
  39
  40 /**
  41  * Testing <code>com.sun.star.util.XSearchable</code>
  42  * interface methods :
  43  * <ul>
  44  *  <li><code> createSearchDescriptor()</code></li>
  45  *  <li><code> findAll()</code></li>
  46  *  <li><code> findFirst()</code></li>
  47  *  <li><code> findNext()</code></li>
  48  * </ul> <p>
  49  *
  50  * The requipment for the tested object is that it
  51  * <b>must containt</b> string 'xTextDoc'. Only
  52  * in that case this interface is tested correctly. <p>
  53  *
  54  * Test is <b> NOT </b> multithread compilant. <p>
  55  * @see com.sun.star.util.XSearchable
  56  */
  57 public class _XSearchable extends MultiMethodTest {
  58
  59     public XSearchable oObj = null;                // oObj filled by MultiMethodTest
  60     public XSearchDescriptor Sdesc = null;
  61     public Object start = null;
  62     private String mSearchString = "xTextDoc";
  63     private boolean mDispose = false;
  64     private boolean mExcludeFindNext = false;
  65
  66     /**
  67      * Creates an entry to search for, if the current object does not provide
  68      * one. In this case, the environment is disposed after the test, since
  69      * the inserted object may influence following tests.
  70      *
  71      */
  72     protected void before() {
  73         Object o = tEnv.getObjRelation("SEARCHSTRING");
  74         if (o != null) {
  75             mSearchString = (String)o;
  76         }
  77         o = tEnv.getObjRelation("XSearchable.MAKEENTRYINCELL");
  78         if (o != null) {
  79             XCell[] cells = new XCell[0];
  80             if (o instanceof XCell) {
  81                 cells = new XCell[]{(XCell)o};
  82             }
  83             else if (o instanceof XCell[]) {
  84                 cells = (XCell[])o;
  85             }
  86             else {
  87                 log.println("Needed object relation 'XSearchable.MAKEENTRYINCELL' is there, but is of type '"
  88                             + o.getClass().getName() + "'. Should be 'XCell' or 'XCell[]' instead.");
  89             }
  90             for (int i=0; i<cells.length; i++) {
  91                 cells[i].setFormula(mSearchString);
  92             }
  93             mDispose = true;
  94         }
  95         mExcludeFindNext = (tEnv.getObjRelation("EXCLUDEFINDNEXT")==null)?false:true;
  96     }
  97
  98     /**
  99      * Creates the search descriptor which searches for
 100      * 'xTextDoc' string. <p>
 101      * Has <b> OK </b> status if the method returns not
 102      * <code>null</code> value.
 103      */
 104     public void _createSearchDescriptor() {
 105
 106         log.println("testing createSearchDescriptor() ... ");
 107
 108         Sdesc = oObj.createSearchDescriptor();
 109         Sdesc.setSearchString(mSearchString);
 110         tRes.tested("createSearchDescriptor()", Sdesc != null);
 111
 112     }
 113
 114     /**
 115      * Performs search using descriptor created before. <p>
 116      * Has <b> OK </b> status if the method not <code>null</code>
 117      * collections. <p>
 118      * The following method tests are to be completed successfully before :
 119      * <ul>
 120      *  <li> <code> createSearchDescriptor() </code> : creates the descriptor
 121      *  required for search. </li>
 122      * </ul>
 123      */
 124     public void _findAll() {
 125
 126         requiredMethod("createSearchDescriptor()");
 127         log.println("testing findAll()");
 128
 129         XIndexAccess IA = oObj.findAll(Sdesc);
 130         tRes.tested("findAll()", IA != null);
 131     }
 132
 133     /**
 134      * Performs search using descriptor created before. Storing the
 135      * first occurence result. <p>
 136      * Has <b> OK </b> status if the method not <code>null</code>
 137      * value. <p>
 138      * The following method tests are to be completed successfully before :
 139      * <ul>
 140      *  <li> <code> createSearchDescriptor() </code> : creates the descriptor
 141      *  required for search. </li>
 142      * </ul>
 143      */
 144     public void _findFirst() {
 145
 146         requiredMethod("createSearchDescriptor()");
 147         log.println("testing findFirst()");
 148         start = oObj.findFirst(Sdesc);
 149         tRes.tested("findFirst()", start != null);
 150     }
 151
 152     /**
 153      * Performs search using descriptor and first search result
 154      * created before. <p>
 155      * Has <b> OK </b> status if the method not <code>null</code>
 156      * value. <p>
 157      * The following method tests are to be completed successfully before :
 158      * <ul>
 159      *  <li> <code> findFirst() </code> : to have first search result. </li>
 160      * </ul>
 161      */
 162     public void _findNext() {
 163         if (mExcludeFindNext) {
 164             log.println("Testing findNext() excluded, because only one" +
 165                         " search result is available.");
 166             tRes.tested("findNext()", true);
 167         }
 168         else{
 169             requiredMethod("findFirst()");
 170
 171             log.println("testing findNext()");
 172             Object xI = oObj.findNext(start,Sdesc);
 173             tRes.tested("findNext()", xI != null);
 174         }
 175     }
 176
 177     /**
 178      * In case the interface itself made the entry to search for, the environment
 179      * must be disposed
 180      */
 181     protected void after() {
 182         if(mDispose) {
 183             disposeEnvironment();
 184         }
 185     }
 186 }
 187
 188