mirror of
https://github.com/apache/poi.git
synced 2026-02-27 20:40:08 +08:00
[github-803] Add support for SHEET function. Thanks to Richard V. This closes #803
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1925484 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning
parent
9fafa45bac
commit
9f43059a37
@ -191,7 +191,7 @@ public final class AnalysisToolPak implements UDFFinder {
|
||||
r(m, "RECEIVED", null);
|
||||
r(m, "RTD", null);
|
||||
r(m, "SERIESSUM", null);
|
||||
r(m, "SHEET", null);
|
||||
r(m, "SHEET", Sheet.instance);
|
||||
r(m, "SINGLE", Single.instance);
|
||||
r(m, "SQRTPI", Sqrtpi.instance);
|
||||
r(m, "STDEV.S", Stdevs.instance);
|
||||
|
||||
@ -0,0 +1,89 @@
|
||||
/* ====================================================================
|
||||
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 org.apache.poi.ss.formula.functions;
|
||||
|
||||
import org.apache.poi.ss.formula.EvaluationWorkbook;
|
||||
import org.apache.poi.ss.formula.OperationEvaluationContext;
|
||||
import org.apache.poi.ss.formula.eval.*;
|
||||
|
||||
/**
|
||||
* Implementation for Excel SHEET() function.
|
||||
* <p>
|
||||
* <b>Syntax</b>:<br> <b>SHEET</b>([value])<br>
|
||||
* </p>
|
||||
* <p>
|
||||
* Returns the sheet number of the referenced sheet or the current sheet if no argument is provided.
|
||||
* </p>
|
||||
* <p>
|
||||
* Examples:
|
||||
* <ul>
|
||||
* <li><code>=SHEET()</code> → returns the current sheet number (1-based)</li>
|
||||
* <li><code>=SHEET(A1)</code> → returns the sheet number of the reference A1</li>
|
||||
* <li><code>=SHEET(A1:B5)</code> → returns the sheet number of the range A1:B5</li>
|
||||
* <li><code>=SHEET("Sheet3")</code> → returns the sheet number of the sheet named "Sheet3"</li>
|
||||
* </ul>
|
||||
* </p>
|
||||
* <p>
|
||||
* See <a href="https://support.microsoft.com/en-us/office/sheet-function-44718b6f-8b87-47a1-a9d6-b701c06cff24">Microsoft Documentation</a>
|
||||
* </p>
|
||||
*/
|
||||
public class Sheet implements FreeRefFunction {
|
||||
|
||||
public static final Sheet instance = new Sheet();
|
||||
|
||||
@Override
|
||||
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
|
||||
try {
|
||||
if (args.length == 0) {
|
||||
// No argument provided → return the current sheet index +1 (Excel uses 1-based index)
|
||||
return new NumberEval((double) ec.getSheetIndex() + 1);
|
||||
} else {
|
||||
ValueEval arg = args[0];
|
||||
|
||||
if (arg instanceof RefEval) {
|
||||
// Argument is a single cell reference → return the sheet index of that reference +1
|
||||
RefEval ref = (RefEval) arg;
|
||||
int sheetIndex = ref.getFirstSheetIndex();
|
||||
return new NumberEval((double) sheetIndex + 1);
|
||||
} else if (arg instanceof AreaEval) {
|
||||
// Argument is a cell range → return the sheet index of that area +1
|
||||
AreaEval area = (AreaEval) arg;
|
||||
int sheetIndex = area.getFirstSheetIndex();
|
||||
return new NumberEval((double) sheetIndex + 1);
|
||||
} else if (arg instanceof StringEval) {
|
||||
// Argument is a string (sheet name, e.g., "Sheet3") → look up the sheet index by name
|
||||
String sheetName = ((StringEval) arg).getStringValue();
|
||||
EvaluationWorkbook wb = ec.getWorkbook();
|
||||
int sheetIndex = wb.getSheetIndex(sheetName);
|
||||
if (sheetIndex >= 0) {
|
||||
return new NumberEval((double) sheetIndex + 1);
|
||||
} else {
|
||||
// Sheet name not found → return #N/A error
|
||||
return ErrorEval.NA;
|
||||
}
|
||||
} else {
|
||||
// Unsupported argument type → return #N/A error
|
||||
return ErrorEval.NA;
|
||||
}
|
||||
}
|
||||
} catch (Exception e) {
|
||||
// Any unexpected exception (e.g., null pointers) → return #VALUE! error
|
||||
return ErrorEval.VALUE_INVALID;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,89 @@
|
||||
/* ====================================================================
|
||||
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 org.apache.poi.ss.formula.functions;
|
||||
|
||||
import org.apache.poi.hssf.usermodel.*;
|
||||
import org.apache.poi.ss.formula.OperationEvaluationContext;
|
||||
import org.apache.poi.ss.usermodel.CellType;
|
||||
import org.apache.poi.ss.usermodel.FormulaError;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
|
||||
final class TestSheet {
|
||||
|
||||
private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 2, 0, 2, null);
|
||||
|
||||
@Test
|
||||
void testSheetFunctionWithRealWorkbook() throws IOException {
|
||||
try (HSSFWorkbook wb = new HSSFWorkbook()) {
|
||||
// Add three sheets: Sheet1, Sheet2, Sheet3
|
||||
HSSFSheet sheet1 = wb.createSheet("Sheet1");
|
||||
HSSFSheet sheet2 = wb.createSheet("Sheet2");
|
||||
HSSFSheet sheet3 = wb.createSheet("Sheet3");
|
||||
|
||||
// Add data
|
||||
sheet1.createRow(0).createCell(0).setCellValue(123); // A1 in Sheet1
|
||||
sheet2.createRow(1).createCell(0).setCellValue(456); // A2 in Sheet2
|
||||
|
||||
HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
|
||||
|
||||
// Define formulas and expected results
|
||||
String[] formulas = {
|
||||
"SHEET()",
|
||||
"SHEET(A1)",
|
||||
"SHEET(A1:B5)",
|
||||
"SHEET(Sheet2!A2)",
|
||||
"SHEET(\"Sheet3\")",
|
||||
"SHEET(\"invalid\")"
|
||||
};
|
||||
|
||||
Object[] expected = {
|
||||
1.0, // current sheet
|
||||
1.0, // A1 in same sheet
|
||||
1.0, // A1:B5 in same sheet
|
||||
2.0, // Sheet2!A2
|
||||
3.0, // Sheet3
|
||||
FormulaError.NA.getCode() // unknown sheet → #N/A
|
||||
};
|
||||
|
||||
// Write formulas to separate cells and evaluate
|
||||
HSSFRow formulaRow = sheet1.createRow(1);
|
||||
for (int i = 0; i < formulas.length; i++) {
|
||||
String formula = formulas[i];
|
||||
HSSFCell cell = formulaRow.createCell(i);
|
||||
cell.setCellFormula(formula);
|
||||
CellType resultType = fe.evaluateFormulaCell(cell);
|
||||
|
||||
if (expected[i] instanceof Double) {
|
||||
assertEquals(CellType.NUMERIC, resultType,
|
||||
"Unexpected cell type for formula: " + formula);
|
||||
assertEquals((Double) expected[i], cell.getNumericCellValue(),
|
||||
"Unexpected numeric result for formula: " + formula);
|
||||
} else if (expected[i] instanceof Byte) {
|
||||
assertEquals(CellType.ERROR, resultType,
|
||||
"Unexpected cell type for formula: " + formula);
|
||||
assertEquals((byte) expected[i], cell.getErrorCellValue(),
|
||||
"Unexpected error code for formula: " + formula);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user