Bugzilla 45966 - added implementation for FIND function (patch from Torstein Tauno Svendsen).

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@707953 13f79535-47bb-0310-9956-ffa450edef68

src/documentation/content/xdocs/changes.xml

@@ -37,6 +37,7 @@
 
 		<!-- Don't forget to update status.xml too! -->
         <release version="3.5-beta4" date="2008-??-??">
+           <action dev="POI-DEVELOPERS" type="add">45966 - added implementation for FIND function</action>
            <action dev="POI-DEVELOPERS" type="fix">45778 - fixed ObjRecord to read ftLbsData properly</action>
            <action dev="POI-DEVELOPERS" type="fix">46053 - fixed evaluation cache dependency analysis when changing blank cells</action>
         </release>

src/documentation/content/xdocs/status.xml

@@ -34,6 +34,7 @@
 	<!-- Don't forget to update changes.xml too! -->
     <changes>
         <release version="3.5-beta4" date="2008-??-??">
+           <action dev="POI-DEVELOPERS" type="add">45966 - added implementation for FIND function</action>
            <action dev="POI-DEVELOPERS" type="fix">45778 - fixed ObjRecord to read ftLbsData properly</action>
            <action dev="POI-DEVELOPERS" type="fix">46053 - fixed evaluation cache dependency analysis when changing blank cells</action>
         </release>

src/java/org/apache/poi/hssf/record/formula/functions/Find.java

@@ -1,25 +1,65 @@
-/*
+/* ====================================================================
-* Licensed to the Apache Software Foundation (ASF) under one or more
+   Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements.  See the NOTICE file distributed with
+   contributor license agreements.  See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
+   this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
+   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 not use this file except in compliance with
-* the License.  You may obtain a copy of the License at
+   the License.  You may obtain a copy of the License at
-*
+
-*     http://www.apache.org/licenses/LICENSE-2.0
+       http://www.apache.org/licenses/LICENSE-2.0
-*
+
-* Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
+   distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
+   See the License for the specific language governing permissions and
-* limitations under the License.
+   limitations under the License.
-*/
+==================================================================== */
-/*
+
- * Created on May 15, 2005
- *
- */
 package org.apache.poi.hssf.record.formula.functions;
 
-public class Find extends NotImplementedFunction {
+import org.apache.poi.hssf.record.formula.eval.Eval;
+import org.apache.poi.hssf.record.formula.eval.ErrorEval;
+import org.apache.poi.hssf.record.formula.eval.ValueEval;
+import org.apache.poi.hssf.record.formula.eval.NumberEval;
+import org.apache.poi.hssf.record.formula.eval.EvaluationException;
 
+/**
+ * Implementation of the FIND() function.<p/>
+ *
+ * <b>Syntax</b>:<br/>
+ * <b>FIND</b>(<b>find_text</b>, <b>within_text</b>, start_num)<p/>
+ *
+ * FIND returns the character position of the first occurrence of <tt>find_text</tt> inside 
+ * <tt>within_text</tt>.  The third parameter, <tt>start_num</tt>, is optional (default=1)
+ * and specifies where to start searching from.  Character positions are 1-based.<p/>
+ *
+ * @author Torstein Tauno Svendsen (torstei@officenet.no)
+ */
+public class Find extends TextFunction {
+
+	protected ValueEval evaluateFunc(Eval[] args, int srcCellRow, short srcCellCol)
+			throws EvaluationException {
+
+		int nArgs = args.length;
+		if (nArgs < 2 || nArgs > 3) {
+			return ErrorEval.VALUE_INVALID;
+		}
+		String needle = evaluateStringArg(args[0], srcCellRow, srcCellCol);
+		String haystack = evaluateStringArg(args[1], srcCellRow, srcCellCol);
+		int startpos;
+		if (nArgs == 3) {
+			startpos = evaluateIntArg(args[2], srcCellRow, srcCellCol);
+			if (startpos <= 0) {
+				return ErrorEval.VALUE_INVALID;
+			}
+			startpos--; // convert 1-based to zero based
+		} else {
+			startpos = 0;
+		}
+		int result = haystack.indexOf(needle, startpos);
+		if (result == -1) {
+			return ErrorEval.VALUE_INVALID;
+		}
+		return new NumberEval(result + 1);
+	}
 }

src/testcases/org/apache/poi/hssf/record/formula/functions/AllIndividualFunctionEvaluationTests.java

@@ -32,6 +32,7 @@ public final class AllIndividualFunctionEvaluationTests {
 		result.addTestSuite(TestAverage.class);
 		result.addTestSuite(TestCountFuncs.class);
 		result.addTestSuite(TestDate.class);
+		result.addTestSuite(TestFind.class);
 		result.addTestSuite(TestFinanceLib.class);
 		result.addTestSuite(TestIndex.class);
 		result.addTestSuite(TestIndexFunctionFromSpreadsheet.class);

src/testcases/org/apache/poi/hssf/record/formula/functions/TestFind.java

@@ -0,0 +1,76 @@
+/* ====================================================================
+   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.hssf.record.formula.functions;
+
+import junit.framework.TestCase;
+
+import org.apache.poi.hssf.usermodel.HSSFCell;
+import org.apache.poi.hssf.usermodel.HSSFErrorConstants;
+import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator;
+import org.apache.poi.hssf.usermodel.HSSFWorkbook;
+import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator.CellValue;
+
+/**
+ * Tests for {@link Find}
+ * 
+ * @author Torstein Svendsen (torstei@officenet.no)
+ */
+public final class TestFind extends TestCase {
+
+	public void testFind() {
+		HSSFWorkbook wb = new HSSFWorkbook();
+		HSSFCell cell = wb.createSheet().createRow(0).createCell(0);
+
+		HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
+
+		confirmResult(fe, cell, "find(\"h\", \"haystack\")", 1);
+		confirmResult(fe, cell, "find(\"a\", \"haystack\",2)", 2);
+		confirmResult(fe, cell, "find(\"a\", \"haystack\",3)", 6);
+
+		// number args converted to text
+		confirmResult(fe, cell, "find(7, 32768)", 3);
+		confirmResult(fe, cell, "find(\"34\", 1341235233412, 3)", 10);
+		confirmResult(fe, cell, "find(5, 87654)", 4);
+
+		// Errors
+		confirmError(fe, cell, "find(\"n\", \"haystack\")", HSSFErrorConstants.ERROR_VALUE);
+		confirmError(fe, cell, "find(\"k\", \"haystack\",9)", HSSFErrorConstants.ERROR_VALUE);
+		confirmError(fe, cell, "find(\"k\", \"haystack\",#REF!)", HSSFErrorConstants.ERROR_REF);
+		confirmError(fe, cell, "find(\"k\", \"haystack\",0)", HSSFErrorConstants.ERROR_VALUE);
+		confirmError(fe, cell, "find(#DIV/0!, #N/A, #REF!)", HSSFErrorConstants.ERROR_DIV_0);
+		confirmError(fe, cell, "find(2, #N/A, #REF!)", HSSFErrorConstants.ERROR_NA);
+	}
+
+	private static void confirmResult(HSSFFormulaEvaluator fe, HSSFCell cell, String formulaText,
+			int expectedResult) {
+		cell.setCellFormula(formulaText);
+		fe.notifyUpdateCell(cell);
+		CellValue result = fe.evaluate(cell);
+		assertEquals(result.getCellType(), HSSFCell.CELL_TYPE_NUMERIC);
+		assertEquals(expectedResult, result.getNumberValue(), 0.0);
+	}
+
+	private static void confirmError(HSSFFormulaEvaluator fe, HSSFCell cell, String formulaText,
+			int expectedErrorCode) {
+		cell.setCellFormula(formulaText);
+		fe.notifyUpdateCell(cell);
+		CellValue result = fe.evaluate(cell);
+		assertEquals(result.getCellType(), HSSFCell.CELL_TYPE_ERROR);
+		assertEquals(expectedErrorCode, result.getErrorValue());
+	}
+}