qadevOOo/tests/java/mod/_sc/ScDataPilotItemObj.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 package mod._sc;
  19
  20 import com.sun.star.beans.XPropertySet;
  21 import com.sun.star.container.XIndexAccess;
  22 import com.sun.star.container.XNamed;
  23 import com.sun.star.lang.XComponent;
  24 import com.sun.star.lang.XMultiServiceFactory;
  25 import com.sun.star.sheet.DataPilotFieldOrientation;
  26 import com.sun.star.sheet.XDataPilotDescriptor;
  27 import com.sun.star.sheet.XDataPilotField;
  28 import com.sun.star.sheet.XDataPilotTables;
  29 import com.sun.star.sheet.XDataPilotTablesSupplier;
  30 import com.sun.star.sheet.XSpreadsheet;
  31 import com.sun.star.sheet.XSpreadsheetDocument;
  32 import com.sun.star.sheet.XSpreadsheets;
  33 import com.sun.star.table.CellAddress;
  34 import com.sun.star.table.CellRangeAddress;
  35 import com.sun.star.uno.AnyConverter;
  36 import com.sun.star.uno.Type;
  37 import com.sun.star.uno.UnoRuntime;
  38 import com.sun.star.uno.XInterface;
  39
  40 import java.io.PrintWriter;
  41
  42 import lib.StatusException;
  43 import lib.TestCase;
  44 import lib.TestEnvironment;
  45 import lib.TestParameters;
  46
  47 import util.SOfficeFactory;
  48
  49
  50 /**
  51 * Test for object which is represented by service
  52 * <code>com.sun.star.sheet.DataPilotField</code>. <p>
  53 * Object implements the following interfaces :
  54 * <ul>
  55 *  <li> <code>com::sun::star::container::XNamed</code></li>
  56 *  <li> <code>com::sun::star::sheet::DataPilotField</code></li>
  57 *  <li> <code>com::sun::star::beans::XPropertySet</code></li>
  58 * </ul>
  59 * @see com.sun.star.sheet.DataPilotField
  60 * @see com.sun.star.container.XNamed
  61 * @see com.sun.star.sheet.DataPilotField
  62 * @see com.sun.star.beans.XPropertySet
  63 * @see ifc.container._XNamed
  64 * @see ifc.sheet._DataPilotField
  65 * @see ifc.beans._XPropertySet
  66 */
  67 public class ScDataPilotItemObj extends TestCase {
  68     private XSpreadsheetDocument xSheetDoc = null;
  69
  70     /**
  71      * A field is filled some values. This integer determines the size of the
  72      * field in x and y direction.
  73      */
  74     private int mMaxFieldIndex = 6;
  75
  76     /**
  77     * Creates Spreadsheet document.
  78     */
  79     protected void initialize(TestParameters tParam, PrintWriter log) {
  80         SOfficeFactory SOF = SOfficeFactory.getFactory(
  81                                      (XMultiServiceFactory) tParam.getMSF());
  82
  83         try {
  84             log.println("creating a Spreadsheet document");
  85             xSheetDoc = SOF.createCalcDoc(null);
  86         } catch (com.sun.star.uno.Exception e) {
  87             // Some exception occurs.FAILED
  88             e.printStackTrace(log);
  89             throw new StatusException("Couldn't create document", e);
  90         }
  91     }
  92
  93     /**
  94     * Disposes Spreadsheet document.
  95     */
  96     protected void cleanup(TestParameters tParam, PrintWriter log) {
  97         log.println("    disposing xSheetDoc ");
  98
  99         XComponent oComp = UnoRuntime.queryInterface(
 100                                    XComponent.class, xSheetDoc);
 101         util.DesktopTools.closeDoc(oComp);
 102     }
 103
 104     /**
 105     * Creating a Testenvironment for the interfaces to be tested.
 106     * Retrieves a collection of spreadsheets from a document
 107     * and takes one of them. Fills some table in the spreadsheet.
 108     * Obtains the collection of data pilot tables using the interface
 109     * <code>XDataPilotTablesSupplier</code>. Creates a data pilot descriptor
 110     * for the filled table and inserts new data pilot table with this descriptor
 111     * to the collection. Obtains the collection of all the data pilot fields
 112     * using the interface <code>XDataPilotDescriptor</code>. Retrieves from
 113     * the collection the data pilot field with index 0. This data pilot field
 114     * is the instance of the service <code>com.sun.star.sheet.DataPilotField</code>.
 115     * @see com.sun.star.sheet.DataPilotField
 116     * @see com.sun.star.sheet.XDataPilotTablesSupplier
 117     * @see com.sun.star.sheet.XDataPilotDescriptor
 118     */
 119     protected synchronized TestEnvironment createTestEnvironment(TestParameters Param,
 120                                                                  PrintWriter log) {
 121         XInterface oObj = null;
 122
 123
 124         // creation of testobject here
 125         // first we write what we are intend to do to log file
 126         log.println("Creating a test environment");
 127
 128         // the cell range
 129         CellRangeAddress sCellRangeAdress = new CellRangeAddress();
 130         sCellRangeAdress.Sheet = 0;
 131         sCellRangeAdress.StartColumn = 1;
 132         sCellRangeAdress.StartRow = 0;
 133         sCellRangeAdress.EndColumn = mMaxFieldIndex - 1;
 134         sCellRangeAdress.EndRow = mMaxFieldIndex - 1;
 135
 136         // position of the data pilot table
 137         CellAddress sCellAdress = new CellAddress();
 138         sCellAdress.Sheet = 0;
 139         sCellAdress.Column = 7;
 140         sCellAdress.Row = 8;
 141
 142         log.println("Getting a sheet");
 143
 144         XSpreadsheets xSpreadsheets = xSheetDoc.getSheets();
 145         XSpreadsheet oSheet = null;
 146         XSpreadsheet oSheet2 = null;
 147         XIndexAccess oIndexAccess = UnoRuntime.queryInterface(
 148                                             XIndexAccess.class, xSpreadsheets);
 149         // Make sure there are at least two sheets
 150         xSpreadsheets.insertNewByName("Some Sheet", (short)0);
 151
 152         try {
 153             oSheet = (XSpreadsheet) AnyConverter.toObject(
 154                              new Type(XSpreadsheet.class),
 155                              oIndexAccess.getByIndex(0));
 156             oSheet2 = (XSpreadsheet) AnyConverter.toObject(
 157                               new Type(XSpreadsheet.class),
 158                               oIndexAccess.getByIndex(1));
 159         } catch (com.sun.star.lang.WrappedTargetException e) {
 160             e.printStackTrace();
 161             throw new StatusException("Couldn't get a spreadsheet", e);
 162         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 163             e.printStackTrace();
 164             throw new StatusException("Couldn't get a spreadsheet", e);
 165         } catch (com.sun.star.lang.IllegalArgumentException e) {
 166             e.printStackTrace();
 167             throw new StatusException("Couldn't get a spreadsheet", e);
 168         }
 169
 170         try {
 171             log.println("Filling a table");
 172
 173             for (int i = 1; i < mMaxFieldIndex; i++) {
 174                 oSheet.getCellByPosition(i, 0).setFormula("Col" + i);
 175                 oSheet.getCellByPosition(0, i).setFormula("Row" + i);
 176                 oSheet2.getCellByPosition(i, 0).setFormula("Col" + i);
 177                 oSheet2.getCellByPosition(0, i).setFormula("Row" + i);
 178             }
 179
 180             for (int i = 1; i < mMaxFieldIndex; i++)
 181                 for (int j = 1; j < mMaxFieldIndex; j++) {
 182                     oSheet.getCellByPosition(i, j).setValue(i * (j + 1));
 183                     oSheet2.getCellByPosition(i, j).setValue(i * (j + 2));
 184                 }
 185         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 186             e.printStackTrace();
 187             throw new StatusException("Couldn't fill some cells", e);
 188         }
 189
 190         try {
 191             oSheet.getCellByPosition(1, 5);
 192
 193             int x = sCellAdress.Column;
 194             int y = sCellAdress.Row + 3;
 195
 196
 197             oSheet.getCellByPosition(x, y);
 198             new Integer(27);
 199         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 200             e.printStackTrace();
 201             throw new StatusException("Couldn't get cells for changing.", e);
 202         }
 203
 204
 205         // create the test objects
 206         log.println("Getting test objects");
 207
 208         XDataPilotTablesSupplier DPTS = UnoRuntime.queryInterface(
 209                                                 XDataPilotTablesSupplier.class,
 210                                                 oSheet);
 211         XDataPilotTables DPT = DPTS.getDataPilotTables();
 212         XDataPilotDescriptor DPDsc = DPT.createDataPilotDescriptor();
 213         DPDsc.setSourceRange(sCellRangeAdress);
 214
 215         XPropertySet fieldPropSet = null;
 216
 217         try {
 218             Object oDataPilotField = DPDsc.getDataPilotFields().getByIndex(0);
 219             fieldPropSet = UnoRuntime.queryInterface(
 220                                    XPropertySet.class, oDataPilotField);
 221         } catch (com.sun.star.lang.WrappedTargetException e) {
 222             e.printStackTrace();
 223             throw new StatusException("Couldn't create a test environment", e);
 224         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 225             e.printStackTrace();
 226             throw new StatusException("Couldn't create a test environment", e);
 227         }
 228
 229         try {
 230             fieldPropSet.setPropertyValue("Function",
 231                                           com.sun.star.sheet.GeneralFunction.SUM);
 232             fieldPropSet.setPropertyValue("Orientation",
 233                                           com.sun.star.sheet.DataPilotFieldOrientation.DATA);
 234         } catch (com.sun.star.lang.WrappedTargetException e) {
 235             e.printStackTrace();
 236             throw new StatusException("Couldn't create a test environment", e);
 237         } catch (com.sun.star.lang.IllegalArgumentException e) {
 238             e.printStackTrace();
 239             throw new StatusException("Couldn't create a test environment", e);
 240         } catch (com.sun.star.beans.PropertyVetoException e) {
 241             e.printStackTrace();
 242             throw new StatusException("Couldn't create a test environment", e);
 243         } catch (com.sun.star.beans.UnknownPropertyException e) {
 244             e.printStackTrace();
 245             throw new StatusException("Couldn't create a test environment", e);
 246         }
 247
 248         log.println("Insert the DataPilotTable");
 249
 250         if (DPT.hasByName("DataPilotTable")) {
 251             DPT.removeByName("DataPilotTable");
 252         }
 253
 254         XIndexAccess IA = DPDsc.getDataPilotFields();
 255         getSRange(IA);
 256
 257         DPT.insertNewByName("DataPilotTable", sCellAdress, DPDsc);
 258
 259         try {
 260             oObj = (XInterface) AnyConverter.toObject(
 261                            new Type(XInterface.class), IA.getByIndex(0));
 262         } catch (com.sun.star.lang.WrappedTargetException e) {
 263             e.printStackTrace();
 264             throw new StatusException("Couldn't get data pilot field", e);
 265         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 266             e.printStackTrace();
 267             throw new StatusException("Couldn't get data pilot field", e);
 268         } catch (com.sun.star.lang.IllegalArgumentException e) {
 269             e.printStackTrace();
 270             throw new StatusException("Couldn't get data pilot field", e);
 271         }
 272
 273         log.println("Creating object - " +
 274                     ((oObj == null) ? "FAILED" : "OK"));
 275
 276         XDataPilotField xDataPilotField = UnoRuntime.queryInterface(
 277                                                   XDataPilotField.class, oObj);
 278
 279         XIndexAccess xIA = xDataPilotField.getItems();
 280
 281         try {
 282             oObj = UnoRuntime.queryInterface(XInterface.class,
 283                                                           xIA.getByIndex(0));
 284         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 285             log.println("Couldn't get DataPilotItemObj");
 286             e.printStackTrace(log);
 287         } catch (com.sun.star.lang.WrappedTargetException e) {
 288             log.println("Couldn't get DataPilotItemObj");
 289             e.printStackTrace(log);
 290         }
 291
 292         TestEnvironment tEnv = new TestEnvironment(oObj);
 293
 294         log.println("Implementationname: " + util.utils.getImplName(oObj));
 295
 296         // Other parameters required for interface tests
 297         tEnv.addObjRelation("NoSetName",  "ScDataPilotItemObj");
 298         return tEnv;
 299     }
 300
 301     private void getSRange(XIndexAccess IA) {
 302         int fieldsAmount = IA.getCount() + 1;
 303
 304         String[] fieldsNames = new String[fieldsAmount];
 305
 306         int i = -1;
 307         int cnt = 0;
 308
 309         while ((++i) < fieldsAmount) {
 310             Object field;
 311
 312             try {
 313                 field = IA.getByIndex(i);
 314             } catch (com.sun.star.lang.WrappedTargetException e) {
 315                 e.printStackTrace(log);
 316
 317                 return;
 318             } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 319                 e.printStackTrace(log);
 320
 321                 return;
 322             }
 323
 324             XNamed named = UnoRuntime.queryInterface(XNamed.class,
 325                                                               field);
 326             String name = named.getName();
 327
 328             log.println("**Field : '" + name + "' ... ");
 329
 330             if (!name.equals("Data")) {
 331                 fieldsNames[cnt] = name;
 332
 333                 XPropertySet props = UnoRuntime.queryInterface(
 334                                              XPropertySet.class, field);
 335
 336                 try {
 337                     switch (cnt % 5) {
 338                     case 0:
 339                         props.setPropertyValue("Orientation",
 340                                                DataPilotFieldOrientation.COLUMN);
 341                         log.println("  Column");
 342
 343                         break;
 344
 345                     case 1:
 346                         props.setPropertyValue("Orientation",
 347                                                DataPilotFieldOrientation.ROW);
 348                         log.println("  Row");
 349
 350                         break;
 351
 352                     case 2:
 353                         props.setPropertyValue("Orientation",
 354                                                DataPilotFieldOrientation.DATA);
 355                         log.println("  Data");
 356
 357                         break;
 358
 359                     case 3:
 360                         props.setPropertyValue("Orientation",
 361                                                DataPilotFieldOrientation.HIDDEN);
 362                         log.println("  Hidden");
 363
 364                         break;
 365
 366                     case 4:
 367                         props.setPropertyValue("Orientation",
 368                                                DataPilotFieldOrientation.PAGE);
 369                         log.println("  Page");
 370
 371                         break;
 372                     }
 373                 } catch (com.sun.star.lang.WrappedTargetException e) {
 374                     e.printStackTrace(log);
 375
 376                     return;
 377                 } catch (com.sun.star.lang.IllegalArgumentException e) {
 378                     e.printStackTrace(log);
 379
 380                     return;
 381                 } catch (com.sun.star.beans.PropertyVetoException e) {
 382                     e.printStackTrace(log);
 383
 384                     return;
 385                 } catch (com.sun.star.beans.UnknownPropertyException e) {
 386                     e.printStackTrace(log);
 387
 388                     return;
 389                 }
 390
 391                 if ((++cnt) > 4) {
 392                     break;
 393                 }
 394             } else {
 395                 return;
 396             }
 397         }
 398     }
 399 }