/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* Copyright (c) 2008 - 2009 Pentaho Corporation, . All rights reserved.
*/
package org.pentaho.jfreereport.legacy;
import java.math.BigDecimal;
import org.pentaho.reporting.engine.classic.core.function.ColumnAggregationExpression;
/**
* @deprecated These functions are no longer supported.
*/
public class ColumnAverageExpression extends ColumnAggregationExpression
{
private static final int DEFAULT_SCALE = 14;
private boolean onlyValidFields;
public ColumnAverageExpression()
{
}
public boolean isOnlyValidFields()
{
return onlyValidFields;
}
public void setOnlyValidFields(final boolean onlyValidFields)
{
this.onlyValidFields = onlyValidFields;
}
/**
* Return the current expression value. <P> The value depends (obviously) on
* the expression implementation.
*
* @return the value of the function.
*/
public Object getValue()
{
Object[] values = getFieldValues();
BigDecimal computedResult = new BigDecimal("0");
int count = 0;
for (int i = 0; i < values.length; i++)
{
Object value = values[i];
if (value instanceof Number)
{
Number n = (Number) value;
//noinspection ObjectToString
computedResult = computedResult.add(new BigDecimal(n.toString()));
count++;
}
}
if (onlyValidFields)
{
return computedResult.divide(new BigDecimal(count), DEFAULT_SCALE, BigDecimal.ROUND_HALF_UP).stripTrailingZeros();
}
if (values.length > 0)
{
return computedResult.divide(new BigDecimal(values.length), DEFAULT_SCALE, BigDecimal.ROUND_HALF_UP).stripTrailingZeros();
}
else
{
return BigDecimal.ZERO;
}
}
}