Bugzilla 46523 - added implementation for SUMIF

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@734252 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-beta5" date="2008-??-??">
+           <action dev="POI-DEVELOPERS" type="add">46523 - added implementation for SUMIF function</action>
            <action dev="POI-DEVELOPERS" type="add">Support for reading HSSF column styles</action>
            <action dev="POI-DEVELOPERS" type="fix">Hook up POIXMLTextExtractor.getMetadataTextExtractor() to the already written POIXMLPropertiesTextExtractor</action>
            <action dev="POI-DEVELOPERS" type="fix">46472 - Avoid NPE in HPSFPropertiesExtractor when no properties exist</action>

src/documentation/content/xdocs/status.xml

@@ -34,6 +34,7 @@
 	<!-- Don't forget to update changes.xml too! -->
     <changes>
         <release version="3.5-beta5" date="2008-??-??">
+           <action dev="POI-DEVELOPERS" type="add">46523 - added implementation for SUMIF function</action>
            <action dev="POI-DEVELOPERS" type="add">Support for reading HSSF column styles</action>
            <action dev="POI-DEVELOPERS" type="fix">Hook up POIXMLTextExtractor.getMetadataTextExtractor() to the already written POIXMLPropertiesTextExtractor</action>
            <action dev="POI-DEVELOPERS" type="fix">46472 - Avoid NPE in HPSFPropertiesExtractor when no properties exist</action>

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

@@ -1,25 +1,123 @@
-/*
+/* ====================================================================
-* 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 Sumif extends NotImplementedFunction {
+import org.apache.poi.hssf.record.formula.eval.AreaEval;
+import org.apache.poi.hssf.record.formula.eval.ErrorEval;
+import org.apache.poi.hssf.record.formula.eval.Eval;
+import org.apache.poi.hssf.record.formula.eval.EvaluationException;
+import org.apache.poi.hssf.record.formula.eval.NumberEval;
+import org.apache.poi.hssf.record.formula.eval.RefEval;
+import org.apache.poi.hssf.record.formula.eval.ValueEval;
+import org.apache.poi.hssf.record.formula.functions.CountUtils.I_MatchPredicate;
+
+/**
+ * Implementation for the Excel function SUMIF<p>
+ * 
+ * Syntax : <br/>
+ *  SUMIF ( <b>range</b>, <b>criteria</b>, sum_range ) <br/>
+ *    <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
+ *      <tr><th>range</th><td>The range over which criteria is applied.  Also used for addend values when the third parameter is not present</td></tr>
+ *      <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
+ *      <tr><th>sum_range</th><td>Locates the top-left corner of the corresponding range of addends - values to be added (after being selected by the criteria)</td></tr>
+ *    </table><br/>
+ * </p>
+ * @author Josh Micich
+ */
+public final class Sumif implements Function {
+
+	public Eval evaluate(Eval[] args, int srcRowIndex, short srcColumnIndex) {
+		if (args.length < 2) {
+			return ErrorEval.VALUE_INVALID;
+		}
+		
+		AreaEval aeRange;
+		AreaEval aeSum;
+		try {
+			aeRange = convertRangeArg(args[0]);
+			
+			switch (args.length) {
+				case 2:
+					aeSum = aeRange;
+					break;
+				case 3:
+					aeSum = createSumRange(args[2], aeRange);
+					break;
+				default:
+					return ErrorEval.VALUE_INVALID;
+			}
+		} catch (EvaluationException e) {
+			return e.getErrorEval();
+		}
+		I_MatchPredicate mp = Countif.createCriteriaPredicate(args[1], srcRowIndex, srcRowIndex);
+		double result = sumMatchingCells(aeRange, mp, aeSum);
+		return new NumberEval(result);
+	}
+
+	private static double sumMatchingCells(AreaEval aeRange, I_MatchPredicate mp, AreaEval aeSum) {
+		int height=aeRange.getHeight();
+		int width= aeRange.getWidth();
+		
+		double result = 0.0;
+		for (int r=0; r<height; r++) {
+			for (int c=0; c<width; c++) {
+				result += accumulate(aeRange, mp, aeSum, r, c);
+			}
+		}
+		return result;
+	}
+
+	private static double accumulate(AreaEval aeRange, I_MatchPredicate mp, AreaEval aeSum, int relRowIndex,
+			int relColIndex) {
+		
+		if (!mp.matches(aeRange.getRelativeValue(relRowIndex, relColIndex))) {
+			return 0.0;
+		}
+		ValueEval addend = aeSum.getRelativeValue(relRowIndex, relColIndex);
+		if (addend instanceof NumberEval) {
+			return ((NumberEval)addend).getNumberValue();
+		}
+		// everything else (including string and boolean values) counts as zero
+		return 0.0;
+	}
+
+	/**
+	 * @return a range of the same dimensions as aeRange using eval to define the top left corner.
+	 * @throws EvaluationException if eval is not a reference
+	 */
+	private static AreaEval createSumRange(Eval eval, AreaEval aeRange) throws EvaluationException {
+		if (eval instanceof AreaEval) {
+			return ((AreaEval) eval).offset(0, aeRange.getHeight()-1, 0, aeRange.getWidth()-1);
+		}
+		if (eval instanceof RefEval) {
+			return ((RefEval)eval).offset(0, aeRange.getHeight()-1, 0, aeRange.getWidth()-1);
+		}
+		throw new EvaluationException(ErrorEval.VALUE_INVALID);
+	}
+
+	private static AreaEval convertRangeArg(Eval eval) throws EvaluationException {
+		if (eval instanceof AreaEval) {
+			return (AreaEval) eval;
+		}
+		if (eval instanceof RefEval) {
+			return ((RefEval)eval).offset(0, 0, 0, 0);
+		}
+		throw new EvaluationException(ErrorEval.VALUE_INVALID);
+	}
 
 }