org.wso2.balana.cond

Class DateMathFunction

java.lang.Object

org.wso2.balana.cond.FunctionBase

org.wso2.balana.cond.DateMathFunction

All Implemented Interfaces:

Expression, Function

public class DateMathFunction
extends FunctionBase

A class that implements several of the date math functions. They all take two arguments. The first is a DateTimeAttribute or a DateAttribute (as the case may be) and the second is a DayTimeDurationAttribute or a YearMonthDurationAttribute (as the case may be). The function adds or subtracts the second argument to/from the first and returns a value of the same type as the first argument. If either of the arguments evaluates to indeterminate, an indeterminate result is returned.

Since:

1.0

Author:

Steve Hanna, Seth Proctor

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_DATE_ADD_YEARMONTHDURATION Standard identifier for the date-add-yearMonthDuration function.
static String	NAME_DATE_SUBTRACT_YEARMONTHDURATION Standard identifier for the date-subtract-yearMonthDuration function.
static String	NAME_DATETIME_ADD_DAYTIMEDURATION Standard identifier for the dateTime-add-dayTimeDuration function.
static String	NAME_DATETIME_ADD_YEARMONTHDURATION Standard identifier for the dateTime-add-yearMonthDuration function.
static String	NAME_DATETIME_SUBTRACT_DAYTIMEDURATION Standard identifier for the dateTime-subtract-dayTimeDuration function.
static String	NAME_DATETIME_SUBTRACT_YEARMONTHDURATION Standard identifier for the dateTime-subtract-yearMonthDuration function.

Fields inherited from class org.wso2.balana.cond.FunctionBase

FUNCTION_NS, FUNCTION_NS_2, FUNCTION_NS_3

Constructor Summary

Constructors

Constructor and Description
DateMathFunction(String functionName) Creates a new DateMathFunction object.

Method Summary

Modifier and Type	Method and Description
EvaluationResult	evaluate(List inputs, EvaluationCtx context) Evaluate the function, using the specified parameters.
static Set	getSupportedIdentifiers() Returns a Set containing all the function identifiers supported by this class.

Methods inherited from class org.wso2.balana.cond.FunctionBase

checkInputs, checkInputsNoBag, encode, encode, evalArgs, getFunctionId, getFunctionName, getIdentifier, getReturnType, getReturnTypeAsString, getType, makeProcessingError, returnsBag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME_DATETIME_ADD_DAYTIMEDURATION

public static final String NAME_DATETIME_ADD_DAYTIMEDURATION

Standard identifier for the dateTime-add-dayTimeDuration function.

See Also:

Constant Field Values

NAME_DATETIME_SUBTRACT_DAYTIMEDURATION

public static final String NAME_DATETIME_SUBTRACT_DAYTIMEDURATION

Standard identifier for the dateTime-subtract-dayTimeDuration function.

See Also:

Constant Field Values

NAME_DATETIME_ADD_YEARMONTHDURATION

public static final String NAME_DATETIME_ADD_YEARMONTHDURATION

Standard identifier for the dateTime-add-yearMonthDuration function.

See Also:

Constant Field Values

NAME_DATETIME_SUBTRACT_YEARMONTHDURATION

public static final String NAME_DATETIME_SUBTRACT_YEARMONTHDURATION

Standard identifier for the dateTime-subtract-yearMonthDuration function.

See Also:

Constant Field Values

NAME_DATE_ADD_YEARMONTHDURATION

public static final String NAME_DATE_ADD_YEARMONTHDURATION

Standard identifier for the date-add-yearMonthDuration function.

See Also:

Constant Field Values

NAME_DATE_SUBTRACT_YEARMONTHDURATION

public static final String NAME_DATE_SUBTRACT_YEARMONTHDURATION

Standard identifier for the date-subtract-yearMonthDuration function.

See Also:

Constant Field Values

Constructor Detail

DateMathFunction

public DateMathFunction(String functionName)

Creates a new DateMathFunction object.

Parameters:

functionName - the standard XACML name of the function to be handled by this object, including the full namespace

Throws:

IllegalArgumentException - if the function is unknown

Method Detail

getSupportedIdentifiers

public static Set getSupportedIdentifiers()

Returns a Set containing all the function identifiers supported by this class.

Returns:

a Set of Strings

evaluate

public EvaluationResult evaluate(List inputs,
                                 EvaluationCtx context)

Evaluate the function, using the specified parameters.

Parameters:

inputs - a List of Evaluatable objects representing the arguments passed to the function

context - an EvaluationCtx so that the Evaluatable objects can be evaluated

Returns:

an EvaluationResult representing the function's result