/libformula-1.1.3/source/org/pentaho/reporting/libraries/formula/function/datetime/WeekDayFunction.java
Java | 166 lines | 79 code | 13 blank | 74 comment | 16 complexity | 0f7d0115fcce45f5af4b302f5d9330b0 MD5 | raw file
Possible License(s): LGPL-2.1
- /*
- * 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) 2006 - 2009 Pentaho Corporation and Contributors. All rights reserved.
- */
- package org.pentaho.reporting.libraries.formula.function.datetime;
- import java.util.Calendar;
- import java.util.Date;
- import java.math.BigDecimal;
- import org.pentaho.reporting.libraries.formula.EvaluationException;
- import org.pentaho.reporting.libraries.formula.FormulaContext;
- import org.pentaho.reporting.libraries.formula.LibFormulaErrorValue;
- import org.pentaho.reporting.libraries.formula.function.Function;
- import org.pentaho.reporting.libraries.formula.function.ParameterCallback;
- import org.pentaho.reporting.libraries.formula.lvalues.TypeValuePair;
- import org.pentaho.reporting.libraries.formula.typing.TypeRegistry;
- import org.pentaho.reporting.libraries.formula.typing.coretypes.NumberType;
- import org.pentaho.reporting.libraries.formula.util.DateUtil;
- /**
- * This function extracts the day of week from a date. <p/> The returned value
- * depends of the Type passed as second argument using the following table:<br/>
- * <TABLE>
- * <TR>
- * <TH>Day of Week</TH>
- * <TH>Type=1 Result</TH>
- * <TH>Type=2 Result</TH>
- * <TH>Type=3 Result</TH>
- * </TR>
- * <TR>
- * <TD>Sunday</TD>
- * <TD> 1</TD>
- * <TD> 7</TD>
- * <TD> 6</TD>
- * </TR>
- * <TR>
- * <TD>Monday</TD>
- * <TD> 2</TD>
- * <TD> 1</TD>
- * <TD> 0</TD>
- * </TR>
- * <TR>
- * <TD>Tuesday</TD>
- * <TD> 3</TD>
- * <TD> 2</TD>
- * <TD> 1</TD>
- * </TR>
- * <TR>
- * <TD>Wednesday</TD>
- * <TD> 4</TD>
- * <TD> 3</TD>
- * <TD> 2</TD>
- * </TR>
- * <TR>
- * <TD>Thursday</TD>
- * <TD> 5</TD>
- * <TD> 4</TD>
- * <TD> 3</TD>
- * </TR>
- * <TR>
- * <TD>Friday</TD>
- * <TD> 6</TD>
- * <TD> 5</TD>
- * <TD> 4</TD>
- * </TR>
- * <TR>
- * <TD>Saturday</TD>
- * <TD> 7</TD>
- * <TD> 6</TD>
- * <TD> 5</TD>
- * </TR>
- * </TABLE>
- *
- * @author Cedric Pronzato
- */
- public class WeekDayFunction implements Function
- {
- private static final long serialVersionUID = -825027235225096201L;
- public WeekDayFunction()
- {
- }
- public String getCanonicalName()
- {
- return "WEEKDAY";
- }
- public TypeValuePair evaluate(final FormulaContext context,
- final ParameterCallback parameters) throws EvaluationException
- {
- if (parameters.getParameterCount() > 2)
- {
- throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_ARGUMENTS_VALUE);
- }
- final TypeRegistry typeRegistry = context.getTypeRegistry();
- final Date d = typeRegistry.convertToDate(parameters.getType(0), parameters.getValue(0));
- int type = 1; // default is Type 1
- if (parameters.getParameterCount() == 2)
- {
- final Number n = typeRegistry.convertToNumber(parameters.getType(1), parameters.getValue(1));
- if (n == null)
- {
- throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_INVALID_ARGUMENT_VALUE);
- }
- type = n.intValue();
- if (type < 1 || type > 3)
- {
- throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_INVALID_ARGUMENT_VALUE);
- }
- }
- if (d == null)
- {
- throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_INVALID_ARGUMENT_VALUE);
- }
- final Calendar gc = DateUtil.createCalendar(d, context.getLocalizationContext());
- final int dayOfWeek = gc.get(Calendar.DAY_OF_WEEK);
- // in java Sunday = 1 (= Type 1 of openformula)
- final int result = convertType(dayOfWeek, type);
- //noinspection UnpredictableBigDecimalConstructorCall
- return new TypeValuePair(NumberType.GENERIC_NUMBER, new BigDecimal((double)result));
- }
- public int convertType(final int currentDayOfWeek, final int type)
- {
- if (type == 1)
- {
- return currentDayOfWeek;
- }
- else if (type == 2)
- {
- final int i = ((currentDayOfWeek + 6) % 8);
- if(i == 7)
- {
- return i;
- }
- else
- {
- return i + 1;
- }
- }
- else
- {
- return (currentDayOfWeek + 5) % 7;
- }
- }
- }