ComparisonFunction (WSO2 Balana Core 1.1.12 API)

java.lang.Object
- org.wso2.balana.cond.FunctionBase
- - org.wso2.balana.cond.ComparisonFunction

All Implemented Interfaces:

Expression, Function
```
public class ComparisonFunction
extends FunctionBase
```
A class that implements all of the standard comparison functions.

Since:

1.0

Author:

Steve Hanna, Seth Proctor

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`NAME_DATE_GREATER_THAN` Standard identifier for the date-greater-than function.
`static String`	`NAME_DATE_GREATER_THAN_OR_EQUAL` Standard identifier for the date-greater-than-or-equal function.
`static String`	`NAME_DATE_LESS_THAN` Standard identifier for the date-less-than function.
`static String`	`NAME_DATE_LESS_THAN_OR_EQUAL` Standard identifier for the date-less-than-or-equal function.
`static String`	`NAME_DATETIME_GREATER_THAN` Standard identifier for the dateTime-greater-than function.
`static String`	`NAME_DATETIME_GREATER_THAN_OR_EQUAL` Standard identifier for the dateTime-greater-than-or-equal function.
`static String`	`NAME_DATETIME_LESS_THAN` Standard identifier for the dateTime-less-than function.
`static String`	`NAME_DATETIME_LESS_THAN_OR_EQUAL` Standard identifier for the dateTime-less-than-or-equal function.
`static String`	`NAME_DOUBLE_GREATER_THAN` Standard identifier for the double-greater-than function.
`static String`	`NAME_DOUBLE_GREATER_THAN_OR_EQUAL` Standard identifier for the double-greater-than-or-equal function.
`static String`	`NAME_DOUBLE_LESS_THAN` Standard identifier for the double-less-than function.
`static String`	`NAME_DOUBLE_LESS_THAN_OR_EQUAL` Standard identifier for the double-less-than-or-equal function.
`static String`	`NAME_INTEGER_GREATER_THAN` Standard identifier for the integer-greater-than function.
`static String`	`NAME_INTEGER_GREATER_THAN_OR_EQUAL` Standard identifier for the integer-greater-than-or-equal function.
`static String`	`NAME_INTEGER_LESS_THAN` Standard identifier for the integer-less-than function.
`static String`	`NAME_INTEGER_LESS_THAN_OR_EQUAL` Standard identifier for the integer-less-than-or-equal function.
`static String`	`NAME_STRING_GREATER_THAN` Standard identifier for the string-greater-than function.
`static String`	`NAME_STRING_GREATER_THAN_OR_EQUAL` Standard identifier for the string-greater-than-or-equal function.
`static String`	`NAME_STRING_LESS_THAN` Standard identifier for the string-less-than function.
`static String`	`NAME_STRING_LESS_THAN_OR_EQUAL` Standard identifier for the string-less-than-or-equal function.
`static String`	`NAME_TIME_GREATER_THAN` Standard identifier for the time-greater-than function.
`static String`	`NAME_TIME_GREATER_THAN_OR_EQUAL` Standard identifier for the time-greater-than-or-equal function.
`static String`	`NAME_TIME_LESS_THAN` Standard identifier for the time-less-than function.
`static String`	`NAME_TIME_LESS_THAN_OR_EQUAL` Standard identifier for the time-less-than-or-equal function.

Fields inherited from class org.wso2.balana.cond.FunctionBase
FUNCTION_NS, FUNCTION_NS_2, FUNCTION_NS_3

Constructor Summary

Constructors
Constructor and Description

ComparisonFunction(String functionName)
Creates a new ComparisonFunction object.

Constructors
Constructor and Description
`ComparisonFunction(String functionName)` Creates a new `ComparisonFunction` object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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_INTEGER_GREATER_THAN
```
public static final String NAME_INTEGER_GREATER_THAN
```
    Standard identifier for the integer-greater-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_INTEGER_GREATER_THAN_OR_EQUAL
```
public static final String NAME_INTEGER_GREATER_THAN_OR_EQUAL
```
    Standard identifier for the integer-greater-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_INTEGER_LESS_THAN
```
public static final String NAME_INTEGER_LESS_THAN
```
    Standard identifier for the integer-less-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_INTEGER_LESS_THAN_OR_EQUAL
```
public static final String NAME_INTEGER_LESS_THAN_OR_EQUAL
```
    Standard identifier for the integer-less-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_DOUBLE_GREATER_THAN
```
public static final String NAME_DOUBLE_GREATER_THAN
```
    Standard identifier for the double-greater-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_DOUBLE_GREATER_THAN_OR_EQUAL
```
public static final String NAME_DOUBLE_GREATER_THAN_OR_EQUAL
```
    Standard identifier for the double-greater-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_DOUBLE_LESS_THAN
```
public static final String NAME_DOUBLE_LESS_THAN
```
    Standard identifier for the double-less-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_DOUBLE_LESS_THAN_OR_EQUAL
```
public static final String NAME_DOUBLE_LESS_THAN_OR_EQUAL
```
    Standard identifier for the double-less-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_STRING_GREATER_THAN
```
public static final String NAME_STRING_GREATER_THAN
```
    Standard identifier for the string-greater-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_STRING_GREATER_THAN_OR_EQUAL
```
public static final String NAME_STRING_GREATER_THAN_OR_EQUAL
```
    Standard identifier for the string-greater-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_STRING_LESS_THAN
```
public static final String NAME_STRING_LESS_THAN
```
    Standard identifier for the string-less-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_STRING_LESS_THAN_OR_EQUAL
```
public static final String NAME_STRING_LESS_THAN_OR_EQUAL
```
    Standard identifier for the string-less-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_TIME_GREATER_THAN
```
public static final String NAME_TIME_GREATER_THAN
```
    Standard identifier for the time-greater-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_TIME_GREATER_THAN_OR_EQUAL
```
public static final String NAME_TIME_GREATER_THAN_OR_EQUAL
```
    Standard identifier for the time-greater-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_TIME_LESS_THAN
```
public static final String NAME_TIME_LESS_THAN
```
    Standard identifier for the time-less-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_TIME_LESS_THAN_OR_EQUAL
```
public static final String NAME_TIME_LESS_THAN_OR_EQUAL
```
    Standard identifier for the time-less-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_DATETIME_GREATER_THAN
```
public static final String NAME_DATETIME_GREATER_THAN
```
    Standard identifier for the dateTime-greater-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_DATETIME_GREATER_THAN_OR_EQUAL
```
public static final String NAME_DATETIME_GREATER_THAN_OR_EQUAL
```
    Standard identifier for the dateTime-greater-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_DATETIME_LESS_THAN
```
public static final String NAME_DATETIME_LESS_THAN
```
    Standard identifier for the dateTime-less-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_DATETIME_LESS_THAN_OR_EQUAL
```
public static final String NAME_DATETIME_LESS_THAN_OR_EQUAL
```
    Standard identifier for the dateTime-less-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_DATE_GREATER_THAN
```
public static final String NAME_DATE_GREATER_THAN
```
    Standard identifier for the date-greater-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_DATE_GREATER_THAN_OR_EQUAL
```
public static final String NAME_DATE_GREATER_THAN_OR_EQUAL
```
    Standard identifier for the date-greater-than-or-equal function.
    
    See Also:
    
    Constant Field Values
  - NAME_DATE_LESS_THAN
```
public static final String NAME_DATE_LESS_THAN
```
    Standard identifier for the date-less-than function.
    
    See Also:
    
    Constant Field Values
  - NAME_DATE_LESS_THAN_OR_EQUAL
```
public static final String NAME_DATE_LESS_THAN_OR_EQUAL
```
    Standard identifier for the date-less-than-or-equal function.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ComparisonFunction
```
public ComparisonFunction(String functionName)
```
    Creates a new ComparisonFunction 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 isn't known
- 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

Class ComparisonFunction

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

NAME_INTEGER_GREATER_THAN

NAME_INTEGER_GREATER_THAN_OR_EQUAL

NAME_INTEGER_LESS_THAN

NAME_INTEGER_LESS_THAN_OR_EQUAL

NAME_DOUBLE_GREATER_THAN

NAME_DOUBLE_GREATER_THAN_OR_EQUAL

NAME_DOUBLE_LESS_THAN

NAME_DOUBLE_LESS_THAN_OR_EQUAL

NAME_STRING_GREATER_THAN

NAME_STRING_GREATER_THAN_OR_EQUAL

NAME_STRING_LESS_THAN

NAME_STRING_LESS_THAN_OR_EQUAL

NAME_TIME_GREATER_THAN

NAME_TIME_GREATER_THAN_OR_EQUAL

NAME_TIME_LESS_THAN

NAME_TIME_LESS_THAN_OR_EQUAL

NAME_DATETIME_GREATER_THAN

NAME_DATETIME_GREATER_THAN_OR_EQUAL

NAME_DATETIME_LESS_THAN

NAME_DATETIME_LESS_THAN_OR_EQUAL

NAME_DATE_GREATER_THAN

NAME_DATE_GREATER_THAN_OR_EQUAL

NAME_DATE_LESS_THAN

NAME_DATE_LESS_THAN_OR_EQUAL

Constructor Detail

ComparisonFunction

Method Detail

getSupportedIdentifiers

evaluate