qadevOOo/tests/java/ifc/util/_XSortable.java

   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 package ifc.util;
  28
  29 import java.io.PrintWriter;
  30
  31 import lib.MultiMethodTest;
  32 import lib.Status;
  33 import lib.StatusException;
  34
  35 import com.sun.star.beans.PropertyValue;
  36 import com.sun.star.table.TableSortField;
  37 import com.sun.star.util.XSortable;
  38
  39
  40 /**
  41  * Testing <code>com.sun.star.util.XSortable</code>
  42  * interface methods :
  43  * <ul>
  44  *  <li><code> createSortDescriptor()</code></li>
  45  *  <li><code> sort()</code></li>
  46  * </ul> <p>
  47  * This test needs the following object relations :
  48  * <ul>
  49  *  <li> <code>'SORTCHECKER'</code> : <code>
  50 *    _XSortable.XSortChecker</code> interface implementation
  51  *  </li>
  52  * <ul><p>
  53  * Test is <b> NOT </b> multithread compilant. <p>
  54  * @see com.sun.star.util.XSortable
  55  */
  56 public class _XSortable extends MultiMethodTest {
  57     // oObj filled by MultiMethodTest
  58     public XSortable oObj = null;
  59     XSortChecker checker = null;
  60     PropertyValue[] oPV = null;
  61
  62     protected void before() {
  63         checker = (XSortChecker) tEnv.getObjRelation("SORTCHECKER");
  64
  65         if (checker == null) {
  66             throw new StatusException(Status.failed(
  67                                               "Couldn't get relation 'SORTCHECKER'"));
  68         }
  69
  70         checker.setPrintWriter(log);
  71     }
  72
  73     /**
  74      * Test calls the method. <p>
  75      * Has <b> OK </b> status if the length of the returned array
  76      * is greater than zero. <p>
  77      */
  78     public void _createSortDescriptor() {
  79         boolean bResult = false;
  80
  81         log.println("test for createSortDescriptor() ");
  82         oPV = oObj.createSortDescriptor();
  83
  84         if (oPV.length > 0) {
  85             bResult = true;
  86
  87             for (int k = 0; k < oPV.length; k++) {
  88                 log.println("DescriptorProperty " + k + ": Name=" +
  89                             oPV[k].Name + "; Value=" + oPV[k].Value);
  90
  91                 if (oPV[k].Name.equals("SortFields")) {
  92                     TableSortField[] tsf = (TableSortField[]) oPV[k].Value;
  93
  94                     for (int l = 0; l < tsf.length; l++) {
  95                         log.println("\t isAscending:  " +
  96                                     tsf[l].IsAscending);
  97                         log.println("\t IsCaseSensitive:  " +
  98                                     tsf[l].IsCaseSensitive);
  99                         log.println("\t CollatorAlgorithm:  " +
 100                                     tsf[l].CollatorAlgorithm);
 101                     }
 102                 }
 103             }
 104         }
 105
 106         log.println("Found " + oPV.length + " PropertyValues");
 107         tRes.tested("createSortDescriptor()", bResult);
 108     }
 109
 110     /**
 111      * Test calls the method using descriptor created before as
 112      * parameter. <p>
 113      * Has <b> OK </b> status if the method successfully returns
 114      * and no exceptions were thrown. <p>
 115      * The following method tests are to be completed successfully before :
 116      * <ul>
 117      *  <li> <code> createSortDescriptor() </code> : to have a descriptor
 118      *  for sort. </li>
 119      * </ul>
 120      */
 121     public void _sort() {
 122
 123         checker.prepareToSort();
 124
 125         log.println(
 126                 "############## Sort algorithm: Alphanumeric Order: Ascending");
 127         modifyDescriptor(false, true);
 128         oObj.sort(oPV);
 129
 130         boolean res = checker.checkSort(false, true);
 131         log.println(
 132                 "############################################################");
 133
 134         log.println(
 135                 "############# Sort algorithm: Alphanumeric Order: Descending");
 136         modifyDescriptor(false, false);
 137         oObj.sort(oPV);
 138         res = checker.checkSort(false, false);
 139         log.println(
 140                 "############################################################");
 141
 142         log.println(
 143                 "################# Sort algorithm: Numeric Order: Ascending");
 144         modifyDescriptor(true, true);
 145         oObj.sort(oPV);
 146         res = checker.checkSort(true, true);
 147         log.println(
 148                 "############################################################");
 149
 150         log.println(
 151                 "################## Sort algorithm: Numeric Order: Descending");
 152         modifyDescriptor(true, false);
 153         oObj.sort(oPV);
 154         res = checker.checkSort(true, false);
 155         log.println(
 156                 "############################################################");
 157
 158         tRes.tested("sort()", res);
 159     }
 160
 161     protected void modifyDescriptor(boolean isSortNumeric,
 162                                     boolean isSortAscending) {
 163         for (int i = 0; i < oPV.length; i++) {
 164             if (oPV[i].Name.equals("SortFields")) {
 165                 TableSortField[] TableFields = (TableSortField[]) oPV[i].Value;
 166
 167                 if (TableFields.length == 0) {
 168                     TableFields = new TableSortField[1];
 169                     TableFields[0] = new TableSortField();
 170                 }
 171
 172                 for (int k = 0; k < TableFields.length; k++) {
 173                     TableFields[k].IsAscending = isSortAscending;
 174
 175                     if (isSortNumeric) {
 176                         TableFields[k].FieldType = com.sun.star.table.TableSortFieldType.NUMERIC;
 177                         TableFields[k].CollatorAlgorithm = "numeric";
 178                     } else {
 179                         TableFields[k].FieldType = com.sun.star.table.TableSortFieldType.ALPHANUMERIC;
 180                         TableFields[k].CollatorAlgorithm = "alphanumeric";
 181                     }
 182                 }
 183
 184                 oPV[i].Value = TableFields;
 185             }
 186
 187             if (oPV[i].Name.equals("isSortInTable")) {
 188                 oPV[i].Value = new Boolean(true);
 189             }
 190
 191             if (oPV[i].Name.equals("IsSortColumns")) {
 192                 oPV[i].Value = new Boolean(false);
 193             }
 194         }
 195
 196         log.println("Modified sort descriptor: ");
 197
 198         if (oPV.length > 0) {
 199             for (int k = 0; k < oPV.length; k++) {
 200                 log.println("DescriptorProperty " + k + ": Name=" +
 201                             oPV[k].Name + "; Value=" + oPV[k].Value);
 202
 203                 if (oPV[k].Name.equals("SortFields")) {
 204                     TableSortField[] tsf = (TableSortField[]) oPV[k].Value;
 205
 206                     for (int l = 0; l < tsf.length; l++) {
 207                         log.println("\t isAscending:  " +
 208                                     tsf[l].IsAscending);
 209                         log.println("\t IsCaseSensitive:  " +
 210                                     tsf[l].IsCaseSensitive);
 211                         log.println("\t CollatorAlgorithm:  " +
 212                                     tsf[l].CollatorAlgorithm);
 213                     }
 214                 }
 215             }
 216         }
 217     }
 218
 219     /**
 220     * The interface for sort checking.
 221     */
 222     public static interface XSortChecker {
 223         public void prepareToSort();
 224
 225         public boolean checkSort(boolean isSortNumbering,
 226                                  boolean isSortAscending);
 227
 228         public void setPrintWriter(PrintWriter log);
 229     }
 230
 231     /**
 232     * Forces environment recreation.
 233     */
 234     protected void after() {
 235         disposeEnvironment();
 236     }
 237
 238 } // finish class _XSortable