org.jfree.formula.function.datetime

Class WeekDayFunction

Implemented Interfaces:
Function, Serializable

public class WeekDayFunction
extends java.lang.Object
implements Function

This function extracts the day of week from a date.

The returned value depends of the Type passed as second argument using the following table:

Day of WeekType=1 ResultType=2 ResultType=3 Result
Sunday 1 7 6
Monday 2 1 0
Tuesday 3 2 1
Wednesday 4 3 2
Thursday 5 4 3
Friday 6 5 4
Saturday 7 6 5
Author:
Cedric Pronzato

Constructor Summary

WeekDayFunction()

Method Summary

int
convertType(int currentDayOfWeek, int type)
TypeValuePair
evaluate(FormulaContext context, ParameterCallback parameters)
String
getCanonicalName()

Constructor Details

WeekDayFunction

public WeekDayFunction()

Method Details

convertType

public int convertType(int currentDayOfWeek,
                       int type)

evaluate

public TypeValuePair evaluate(FormulaContext context,
                              ParameterCallback parameters)
            throws EvaluationException
Specified by:
evaluate in interface Function

getCanonicalName

public String getCanonicalName()
Specified by:
getCanonicalName in interface Function