1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski package fvt.uno.sc.data;
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski import static org.junit.Assert.*;
24*b1cdbd2cSJim Jagielski 
25*b1cdbd2cSJim Jagielski import java.util.Arrays;
26*b1cdbd2cSJim Jagielski import java.util.Collection;
27*b1cdbd2cSJim Jagielski 
28*b1cdbd2cSJim Jagielski import org.junit.After;
29*b1cdbd2cSJim Jagielski import org.junit.AfterClass;
30*b1cdbd2cSJim Jagielski import org.junit.Before;
31*b1cdbd2cSJim Jagielski import org.junit.BeforeClass;
32*b1cdbd2cSJim Jagielski import org.junit.Test;
33*b1cdbd2cSJim Jagielski import org.junit.runner.RunWith;
34*b1cdbd2cSJim Jagielski import org.junit.runners.Parameterized;
35*b1cdbd2cSJim Jagielski import org.junit.runners.Parameterized.Parameters;
36*b1cdbd2cSJim Jagielski import org.openoffice.test.uno.UnoApp;
37*b1cdbd2cSJim Jagielski import testlib.uno.SCUtil;
38*b1cdbd2cSJim Jagielski import com.sun.star.lang.XComponent;
39*b1cdbd2cSJim Jagielski import com.sun.star.sheet.GeneralFunction;
40*b1cdbd2cSJim Jagielski import com.sun.star.sheet.SubTotalColumn;
41*b1cdbd2cSJim Jagielski import com.sun.star.sheet.XCellRangeData;
42*b1cdbd2cSJim Jagielski import com.sun.star.sheet.XSpreadsheet;
43*b1cdbd2cSJim Jagielski import com.sun.star.sheet.XSpreadsheetDocument;
44*b1cdbd2cSJim Jagielski import com.sun.star.sheet.XSubTotalCalculatable;
45*b1cdbd2cSJim Jagielski import com.sun.star.sheet.XSubTotalDescriptor;
46*b1cdbd2cSJim Jagielski import com.sun.star.table.XCellRange;
47*b1cdbd2cSJim Jagielski import com.sun.star.uno.Enum;
48*b1cdbd2cSJim Jagielski import com.sun.star.uno.UnoRuntime;
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski @RunWith(value = Parameterized.class)
51*b1cdbd2cSJim Jagielski public class SubTotalsFunction {
52*b1cdbd2cSJim Jagielski 	private static final UnoApp app = new UnoApp();
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski 	UnoApp unoApp = new UnoApp();
55*b1cdbd2cSJim Jagielski 	XSpreadsheetDocument scDocument = null;
56*b1cdbd2cSJim Jagielski 	XComponent scComponent = null;
57*b1cdbd2cSJim Jagielski 
58*b1cdbd2cSJim Jagielski 	private GeneralFunction operator;
59*b1cdbd2cSJim Jagielski 
60*b1cdbd2cSJim Jagielski 	private String operatorString;
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski 	private int operatorvalue;
63*b1cdbd2cSJim Jagielski 
64*b1cdbd2cSJim Jagielski 	private double bssubtotalresult;
65*b1cdbd2cSJim Jagielski 
66*b1cdbd2cSJim Jagielski 	private double cssubtotalresult;
67*b1cdbd2cSJim Jagielski 
68*b1cdbd2cSJim Jagielski 	private double mssubtotalresult;
69*b1cdbd2cSJim Jagielski 
70*b1cdbd2cSJim Jagielski 	private double grandtotal;
71*b1cdbd2cSJim Jagielski 
72*b1cdbd2cSJim Jagielski 	@Parameters
data()73*b1cdbd2cSJim Jagielski 	public static Collection<Object[]> data() throws Exception {
74*b1cdbd2cSJim Jagielski 		// Remove GeneralFunction.Auto,GeneralFunction.NONE
75*b1cdbd2cSJim Jagielski 		return Arrays.asList(new Object[][] {
76*b1cdbd2cSJim Jagielski 				{ GeneralFunction.SUM, "Sum", 9, 12, 12, 4, 28 },
77*b1cdbd2cSJim Jagielski 				{ GeneralFunction.AVERAGE, "Average", 1, 4, 6, 2, 4 },
78*b1cdbd2cSJim Jagielski 				{ GeneralFunction.COUNT, "Count", 3, 3, 2, 2, 7 },
79*b1cdbd2cSJim Jagielski 				{ GeneralFunction.COUNTNUMS, "Count", 2, 3, 2, 2, 7 },
80*b1cdbd2cSJim Jagielski 				{ GeneralFunction.MAX, "Max", 4, 6, 7, 3, 7 },
81*b1cdbd2cSJim Jagielski 				{ GeneralFunction.MIN, "Min", 5, 2, 5, 1, 1 },
82*b1cdbd2cSJim Jagielski 				{ GeneralFunction.VAR, "Var", 10, 4, 2, 2, 4.666666667 },
83*b1cdbd2cSJim Jagielski 				{ GeneralFunction.PRODUCT, "Product", 6, 48, 35, 3, 5040 },
84*b1cdbd2cSJim Jagielski 				{ GeneralFunction.STDEVP, "StDev", 8, 1.6329931619, 1, 1, 2 },
85*b1cdbd2cSJim Jagielski 				{ GeneralFunction.STDEV, "StDev", 7, 2, 1.4142135624,
86*b1cdbd2cSJim Jagielski 						1.4142135624, 2.1602468995 },
87*b1cdbd2cSJim Jagielski 				{ GeneralFunction.VARP, "Var", 11, 2.6666666667, 1, 1, 4 }, });
88*b1cdbd2cSJim Jagielski 	}
89*b1cdbd2cSJim Jagielski 
90*b1cdbd2cSJim Jagielski 	@Before
setUpDocument()91*b1cdbd2cSJim Jagielski 	public void setUpDocument() throws Exception {
92*b1cdbd2cSJim Jagielski 		unoApp.start();
93*b1cdbd2cSJim Jagielski 	}
94*b1cdbd2cSJim Jagielski 
95*b1cdbd2cSJim Jagielski 	@After
tearDownDocument()96*b1cdbd2cSJim Jagielski 	public void tearDownDocument() {
97*b1cdbd2cSJim Jagielski 		 unoApp.close();
98*b1cdbd2cSJim Jagielski 		 unoApp.closeDocument(scComponent);
99*b1cdbd2cSJim Jagielski 
100*b1cdbd2cSJim Jagielski 	}
101*b1cdbd2cSJim Jagielski 
102*b1cdbd2cSJim Jagielski 	@BeforeClass
setUpConnection()103*b1cdbd2cSJim Jagielski 	public static void setUpConnection() throws Exception {
104*b1cdbd2cSJim Jagielski 
105*b1cdbd2cSJim Jagielski 	}
106*b1cdbd2cSJim Jagielski 
107*b1cdbd2cSJim Jagielski 	@AfterClass
tearDownConnection()108*b1cdbd2cSJim Jagielski 	public static void tearDownConnection() throws InterruptedException,
109*b1cdbd2cSJim Jagielski 			Exception {
110*b1cdbd2cSJim Jagielski 
111*b1cdbd2cSJim Jagielski 	}
112*b1cdbd2cSJim Jagielski 
SubTotalsFunction(Enum operator, String operatorString, int operatorvalue, double bssubtotalresult, double cssubtotalresult, double mssubtotalresult, double grandtotal)113*b1cdbd2cSJim Jagielski 	public SubTotalsFunction(Enum operator, String operatorString,
114*b1cdbd2cSJim Jagielski 			int operatorvalue, double bssubtotalresult,
115*b1cdbd2cSJim Jagielski 			double cssubtotalresult, double mssubtotalresult, double grandtotal) {
116*b1cdbd2cSJim Jagielski 		this.operator = (GeneralFunction) operator;
117*b1cdbd2cSJim Jagielski 		this.operatorString = operatorString;
118*b1cdbd2cSJim Jagielski 		this.operatorvalue = operatorvalue;
119*b1cdbd2cSJim Jagielski 		this.bssubtotalresult = bssubtotalresult;
120*b1cdbd2cSJim Jagielski 		this.cssubtotalresult = cssubtotalresult;
121*b1cdbd2cSJim Jagielski 		this.mssubtotalresult = mssubtotalresult;
122*b1cdbd2cSJim Jagielski 		this.grandtotal = grandtotal;
123*b1cdbd2cSJim Jagielski 	}
124*b1cdbd2cSJim Jagielski 
125*b1cdbd2cSJim Jagielski 	@Test
test()126*b1cdbd2cSJim Jagielski 	public void test() throws Exception {
127*b1cdbd2cSJim Jagielski 		// New document and input data in document
128*b1cdbd2cSJim Jagielski 		scComponent = unoApp.newDocument("scalc");
129*b1cdbd2cSJim Jagielski 		scDocument = SCUtil.getSCDocument(scComponent);
130*b1cdbd2cSJim Jagielski 		XSpreadsheet currentsheet = SCUtil.getCurrentSheet(scDocument);
131*b1cdbd2cSJim Jagielski 		XCellRange xdataRange = (XCellRange) UnoRuntime.queryInterface(
132*b1cdbd2cSJim Jagielski 				XCellRange.class, currentsheet);
133*b1cdbd2cSJim Jagielski 		XCellRange sourceRange = currentsheet.getCellRangeByName("A1:E8");
134*b1cdbd2cSJim Jagielski 		XCellRangeData sourceData = (XCellRangeData) UnoRuntime.queryInterface(
135*b1cdbd2cSJim Jagielski 				XCellRangeData.class, sourceRange);
136*b1cdbd2cSJim Jagielski 		Object[][] Source = { { "Level", "Code", "No.", "Team", "Name" },
137*b1cdbd2cSJim Jagielski 				{ "BS", 20, 4, "B", "Elle" }, { "BS", 20, 6, "C", "Sweet" },
138*b1cdbd2cSJim Jagielski 				{ "BS", 20, 2, "A", "Chcomic" }, { "CS", 30, 5, "A", "Ally" },
139*b1cdbd2cSJim Jagielski 				{ "MS", 10, 1, "A", "Joker" }, { "MS", 10, 3, "B", "Kevin" },
140*b1cdbd2cSJim Jagielski 				{ "CS", 30, 7, "C", "Tom" } };
141*b1cdbd2cSJim Jagielski 		sourceData.setDataArray(Source);
142*b1cdbd2cSJim Jagielski 
143*b1cdbd2cSJim Jagielski 		// Create SubTotals
144*b1cdbd2cSJim Jagielski 		XSubTotalCalculatable xSub = (XSubTotalCalculatable) UnoRuntime
145*b1cdbd2cSJim Jagielski 				.queryInterface(XSubTotalCalculatable.class, sourceRange);
146*b1cdbd2cSJim Jagielski 		XSubTotalDescriptor xSubDesc = xSub.createSubTotalDescriptor(true);
147*b1cdbd2cSJim Jagielski 		SubTotalColumn[] aColumns = new SubTotalColumn[1];
148*b1cdbd2cSJim Jagielski 		// calculate sum of third column
149*b1cdbd2cSJim Jagielski 		aColumns[0] = new SubTotalColumn();
150*b1cdbd2cSJim Jagielski 		aColumns[0].Column = 2;
151*b1cdbd2cSJim Jagielski 		aColumns[0].Function = operator;
152*b1cdbd2cSJim Jagielski 		// group by first column
153*b1cdbd2cSJim Jagielski 		xSubDesc.addNew(aColumns, 0);
154*b1cdbd2cSJim Jagielski 		xSub.applySubTotals(xSubDesc, true);
155*b1cdbd2cSJim Jagielski 
156*b1cdbd2cSJim Jagielski 		// Verify BS SubTotals result
157*b1cdbd2cSJim Jagielski 		String BSsubtotals = "=SUBTOTAL(" + operatorvalue + ";$C$2:$C$4)";
158*b1cdbd2cSJim Jagielski 		String BSsubtotalsString = "BS " + operatorString;
159*b1cdbd2cSJim Jagielski 
160*b1cdbd2cSJim Jagielski 		assertEquals(bssubtotalresult,
161*b1cdbd2cSJim Jagielski 				SCUtil.getValueFromCell(currentsheet, 2, 4), 0.000000001);
162*b1cdbd2cSJim Jagielski 		assertEquals(BSsubtotals, SCUtil.getFormulaFromCell(currentsheet, 2, 4));
163*b1cdbd2cSJim Jagielski 		assertEquals(BSsubtotalsString,
164*b1cdbd2cSJim Jagielski 				SCUtil.getTextFromCell(currentsheet, 0, 4));
165*b1cdbd2cSJim Jagielski 
166*b1cdbd2cSJim Jagielski 		// Verify CS SubTotals result
167*b1cdbd2cSJim Jagielski 		String CSsubtotals = "=SUBTOTAL(" + operatorvalue + ";$C$6:$C$7)";
168*b1cdbd2cSJim Jagielski 		String CSsubtotalsString = "CS " + operatorString;
169*b1cdbd2cSJim Jagielski 
170*b1cdbd2cSJim Jagielski 		assertEquals(cssubtotalresult,
171*b1cdbd2cSJim Jagielski 				SCUtil.getValueFromCell(currentsheet, 2, 7), 0.000000001);
172*b1cdbd2cSJim Jagielski 		assertEquals(CSsubtotals, SCUtil.getFormulaFromCell(currentsheet, 2, 7));
173*b1cdbd2cSJim Jagielski 		assertEquals(CSsubtotalsString,
174*b1cdbd2cSJim Jagielski 				SCUtil.getTextFromCell(currentsheet, 0, 7));
175*b1cdbd2cSJim Jagielski 
176*b1cdbd2cSJim Jagielski 		// Verify MS SubTotals result
177*b1cdbd2cSJim Jagielski 		String MSsubtotals = "=SUBTOTAL(" + operatorvalue + ";$C$9:$C$10)";
178*b1cdbd2cSJim Jagielski 		String MSsubtotalsString = "MS " + operatorString;
179*b1cdbd2cSJim Jagielski 
180*b1cdbd2cSJim Jagielski 		assertEquals(mssubtotalresult,
181*b1cdbd2cSJim Jagielski 				SCUtil.getValueFromCell(currentsheet, 2, 10), 0.000000001);
182*b1cdbd2cSJim Jagielski 		assertEquals(MSsubtotals,
183*b1cdbd2cSJim Jagielski 				SCUtil.getFormulaFromCell(currentsheet, 2, 10));
184*b1cdbd2cSJim Jagielski 		assertEquals(MSsubtotalsString,
185*b1cdbd2cSJim Jagielski 				SCUtil.getTextFromCell(currentsheet, 0, 10));
186*b1cdbd2cSJim Jagielski 
187*b1cdbd2cSJim Jagielski 		// Verify GrandTotal result
188*b1cdbd2cSJim Jagielski 		String GTsubtotals = "=SUBTOTAL(" + operatorvalue + ";$C$2:$C$11)";
189*b1cdbd2cSJim Jagielski 		String GTsubtotalsString = "Grand Total";
190*b1cdbd2cSJim Jagielski 
191*b1cdbd2cSJim Jagielski 		assertEquals(grandtotal, SCUtil.getValueFromCell(currentsheet, 2, 11),
192*b1cdbd2cSJim Jagielski 				0.000000001);
193*b1cdbd2cSJim Jagielski 		assertEquals(GTsubtotals,
194*b1cdbd2cSJim Jagielski 				SCUtil.getFormulaFromCell(currentsheet, 2, 11));
195*b1cdbd2cSJim Jagielski 		assertEquals(GTsubtotalsString,
196*b1cdbd2cSJim Jagielski 				SCUtil.getTextFromCell(currentsheet, 0, 11));
197*b1cdbd2cSJim Jagielski 
198*b1cdbd2cSJim Jagielski 		// Save the file and reload it
199*b1cdbd2cSJim Jagielski 		SCUtil.saveFileAs(scComponent, "Subtotals", "ods");
200*b1cdbd2cSJim Jagielski 		XSpreadsheetDocument scDocumentTemp = SCUtil.reloadFile(unoApp,
201*b1cdbd2cSJim Jagielski 				scDocument, "Subtotals.ods");
202*b1cdbd2cSJim Jagielski 		scDocument = scDocumentTemp;
203*b1cdbd2cSJim Jagielski 		currentsheet = SCUtil.getCurrentSheet(scDocument);
204*b1cdbd2cSJim Jagielski 
205*b1cdbd2cSJim Jagielski 		// verify it again
206*b1cdbd2cSJim Jagielski 		// Verify BS SubTotals result
207*b1cdbd2cSJim Jagielski 		BSsubtotals = "=SUBTOTAL(" + operatorvalue + ";$C$2:$C$4)";
208*b1cdbd2cSJim Jagielski 		BSsubtotalsString = "BS " + operatorString;
209*b1cdbd2cSJim Jagielski 
210*b1cdbd2cSJim Jagielski 		assertEquals(bssubtotalresult,
211*b1cdbd2cSJim Jagielski 				SCUtil.getValueFromCell(currentsheet, 2, 4), 0.000000001);
212*b1cdbd2cSJim Jagielski 		assertEquals(BSsubtotals, SCUtil.getFormulaFromCell(currentsheet, 2, 4));
213*b1cdbd2cSJim Jagielski 		assertEquals(BSsubtotalsString,
214*b1cdbd2cSJim Jagielski 				SCUtil.getTextFromCell(currentsheet, 0, 4));
215*b1cdbd2cSJim Jagielski 
216*b1cdbd2cSJim Jagielski 		// Verify CS SubTotals result
217*b1cdbd2cSJim Jagielski 		CSsubtotals = "=SUBTOTAL(" + operatorvalue + ";$C$6:$C$7)";
218*b1cdbd2cSJim Jagielski 		CSsubtotalsString = "CS " + operatorString;
219*b1cdbd2cSJim Jagielski 
220*b1cdbd2cSJim Jagielski 		assertEquals(cssubtotalresult,
221*b1cdbd2cSJim Jagielski 				SCUtil.getValueFromCell(currentsheet, 2, 7), 0.000000001);
222*b1cdbd2cSJim Jagielski 		assertEquals(CSsubtotals, SCUtil.getFormulaFromCell(currentsheet, 2, 7));
223*b1cdbd2cSJim Jagielski 		assertEquals(CSsubtotalsString,
224*b1cdbd2cSJim Jagielski 				SCUtil.getTextFromCell(currentsheet, 0, 7));
225*b1cdbd2cSJim Jagielski 
226*b1cdbd2cSJim Jagielski 		// Verify MS SubTotals result
227*b1cdbd2cSJim Jagielski 		MSsubtotals = "=SUBTOTAL(" + operatorvalue + ";$C$9:$C$10)";
228*b1cdbd2cSJim Jagielski 		MSsubtotalsString = "MS " + operatorString;
229*b1cdbd2cSJim Jagielski 
230*b1cdbd2cSJim Jagielski 		assertEquals(mssubtotalresult,
231*b1cdbd2cSJim Jagielski 				SCUtil.getValueFromCell(currentsheet, 2, 10), 0.000000001);
232*b1cdbd2cSJim Jagielski 		assertEquals(MSsubtotals,
233*b1cdbd2cSJim Jagielski 				SCUtil.getFormulaFromCell(currentsheet, 2, 10));
234*b1cdbd2cSJim Jagielski 		assertEquals(MSsubtotalsString,
235*b1cdbd2cSJim Jagielski 				SCUtil.getTextFromCell(currentsheet, 0, 10));
236*b1cdbd2cSJim Jagielski 
237*b1cdbd2cSJim Jagielski 		// Verify GrandTotal result
238*b1cdbd2cSJim Jagielski 		GTsubtotals = "=SUBTOTAL(" + operatorvalue + ";$C$2:$C$11)";
239*b1cdbd2cSJim Jagielski 		GTsubtotalsString = "Grand Total";
240*b1cdbd2cSJim Jagielski 
241*b1cdbd2cSJim Jagielski 		assertEquals(grandtotal, SCUtil.getValueFromCell(currentsheet, 2, 11),
242*b1cdbd2cSJim Jagielski 				0.000000001);
243*b1cdbd2cSJim Jagielski 		assertEquals(GTsubtotals,
244*b1cdbd2cSJim Jagielski 				SCUtil.getFormulaFromCell(currentsheet, 2, 11));
245*b1cdbd2cSJim Jagielski 		assertEquals(GTsubtotalsString,
246*b1cdbd2cSJim Jagielski 				SCUtil.getTextFromCell(currentsheet, 0, 11));
247*b1cdbd2cSJim Jagielski 	}
248*b1cdbd2cSJim Jagielski }
249