/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
package mod._sc;
import java.io.PrintWriter;
import lib.StatusException;
import lib.TestCase;
import lib.TestEnvironment;
import lib.TestParameters;
import util.SOfficeFactory;
import util.ValueComparer;
import com.sun.star.beans.XPropertySet;
import com.sun.star.container.XNameAccess;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.sheet.XSpreadsheet;
import com.sun.star.sheet.XSpreadsheetDocument;
import com.sun.star.sheet.XSpreadsheets;
import com.sun.star.table.XCell;
import com.sun.star.table.XCellRange;
import com.sun.star.uno.AnyConverter;
import com.sun.star.uno.Type;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XInterface;
import ifc.sheet._XCellRangesQuery;
/**
* Test for object which is represented by service
* com.sun.star.sheet.SheetCellRange
.
* Object implements the following interfaces :
*
* -
com::sun::star::table::CellProperties
* -
com::sun::star::util::XMergeable
* -
com::sun::star::sheet::XCellRangeAddressable
* -
com::sun::star::sheet::XArrayFormulaRange
* -
com::sun::star::chart::XChartData
* -
com::sun::star::table::XColumnRowRange
* -
com::sun::star::beans::XPropertySet
* -
com::sun::star::style::CharacterProperties
* -
com::sun::star::sheet::XSheetOperation
* -
com::sun::star::table::XCellRange
* -
com::sun::star::style::ParagraphProperties
* -
com::sun::star::sheet::SheetCellRange
*
* @see com.sun.star.sheet.SheetCellRange
* @see com.sun.star.table.CellProperties
* @see com.sun.star.util.XMergeable
* @see com.sun.star.sheet.XCellRangeAddressable
* @see com.sun.star.sheet.XArrayFormulaRange
* @see com.sun.star.chart.XChartData
* @see com.sun.star.table.XColumnRowRange
* @see com.sun.star.beans.XPropertySet
* @see com.sun.star.style.CharacterProperties
* @see com.sun.star.sheet.XSheetOperation
* @see com.sun.star.table.XCellRange
* @see com.sun.star.style.ParagraphProperties
* @see com.sun.star.sheet.SheetCellRange
* @see ifc.table._CellProperties
* @see ifc.util._XMergeable
* @see ifc.sheet._XCellRangeAddressable
* @see ifc.sheet._XArrayFormulaRange
* @see ifc.chart._XChartData
* @see ifc.table._XColumnRowRange
* @see ifc.beans._XPropertySet
* @see ifc.style._CharacterProperties
* @see ifc.sheet._XSheetOperation
* @see ifc.table._XCellRange
* @see ifc.style._ParagraphProperties
* @see ifc.sheet._SheetCellRange
*/
public class ScCellRangeObj extends TestCase {
XSpreadsheetDocument xSheetDoc = null;
/**
* Creates Spreadsheet document.
*/
protected void initialize(TestParameters tParam, PrintWriter log) {
SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory) tParam.getMSF());
try {
log.println("creating a Spreadsheet document");
xSheetDoc = SOF.createCalcDoc(null);
} catch (com.sun.star.uno.Exception e) {
// Some exception occured.FAILED
e.printStackTrace(log);
throw new StatusException("Couldn't create document", e);
}
}
/**
* Disposes Spreadsheet document.
*/
protected void cleanup(TestParameters tParam, PrintWriter log) {
log.println(" disposing xSheetDoc ");
XComponent oComp = (XComponent) UnoRuntime.queryInterface(
XComponent.class, xSheetDoc);
util.DesktopTools.closeDoc(oComp);
}
/**
* Creating a Testenvironment for the interfaces to be tested.
* Retrieves a collection of spreadsheets from a document,
* and takes one of them. Retrieves some cell range from the spreadsheet.
* The retrieved cell range is instance of the service
* com.sun.star.sheet.SheetCellRange
.
* Object relations created :
*
* -
'SHEET'
for
* {@link ifc.sheet._XArrayFormulaRange} (the spreadsheet which the cell
* range was retrieved from)
*
* @see com.sun.star.sheet.XSpreadsheet
*/
protected TestEnvironment createTestEnvironment(TestParameters Param,
PrintWriter log) {
XInterface oObj = null;
XCellRange testRange;
// creation of testobject here
// first we write what we are intend to do to log file
log.println("Creating a test environment");
XSpreadsheets oSpreadsheets = ((XSpreadsheetDocument) UnoRuntime.queryInterface(
XSpreadsheetDocument.class,
xSheetDoc)).getSheets();
XNameAccess oNames = (XNameAccess) UnoRuntime.queryInterface(
XNameAccess.class, oSpreadsheets);
XSpreadsheet oSheet = null;
try {
oSheet = (XSpreadsheet) AnyConverter.toObject(
new Type(XSpreadsheet.class),
oNames.getByName(oNames.getElementNames()[0]));
oObj = oSheet.getCellRangeByPosition(0, 0, 3, 4);
testRange = (XCellRange) UnoRuntime.queryInterface(
XCellRange.class, oObj);
} catch (com.sun.star.lang.WrappedTargetException e) {
e.printStackTrace(log);
throw new StatusException(
"Error getting cell object from spreadsheet document", e);
} catch (com.sun.star.lang.IndexOutOfBoundsException e) {
e.printStackTrace(log);
throw new StatusException(
"Error getting cell object from spreadsheet document", e);
} catch (com.sun.star.container.NoSuchElementException e) {
e.printStackTrace(log);
throw new StatusException(
"Error getting cell object from spreadsheet document", e);
} catch (com.sun.star.lang.IllegalArgumentException e) {
e.printStackTrace(log);
throw new StatusException(
"Error getting cell object from spreadsheet document", e);
}
TestEnvironment tEnv = new TestEnvironment(oObj);
tEnv.addObjRelation("SHEET", oSheet);
// add expected results for the XCellRangesQuery interface test
String[]expectedResults = new String[7];
expectedResults[_XCellRangesQuery.QUERYCOLUMNDIFFERENCES] = "Sheet1.B1:C1;Sheet1.B3";
expectedResults[_XCellRangesQuery.QUERYCONTENTCELLS] = "Sheet1.B2:B3";
expectedResults[_XCellRangesQuery.QUERYEMPTYCELLS] = "Sheet1.A1 ... Sheet1.B1 ... Sheet1.B5 ... Sheet1.C3 ... Sheet1.D1";
expectedResults[_XCellRangesQuery.QUERYFORMULACELLS] = "Sheet1.C2";
expectedResults[_XCellRangesQuery.QUERYINTERSECTION] = "Sheet1.D4";
expectedResults[_XCellRangesQuery.QUERYROWDIFFERENCES] = "Sheet1.A2:A4;Sheet1.C2:D4";
expectedResults[_XCellRangesQuery.QUERYVISIBLECELLS] = "Sheet1.A2";
tEnv.addObjRelation("XCellRangesQuery.EXPECTEDRESULTS", expectedResults);
tEnv.addObjRelation("XCellRangesQuery.CREATEENTRIES", Boolean.TRUE);
XPropertySet PropSet = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, oObj);
tEnv.addObjRelation("PropSet", PropSet);
// XSearchable: Add a cell to make a seacrchable entry
try {
tEnv.addObjRelation("XSearchable.MAKEENTRYINCELL", new XCell[] {
testRange.getCellByPosition(0,0), testRange.getCellByPosition(0,1)});
}
catch(com.sun.star.lang.IndexOutOfBoundsException e){
e.printStackTrace((PrintWriter)log);
log.println("Cannot make required object relation 'XSearchable.MAKEENTRYINCELL'.");
}
// XCellRangeData
/* Object[][] newData = new Object[5][4];
for (int i=0; i