com.sun.xacml.cond
Class BagFunction

java.lang.Object
  com.sun.xacml.cond.FunctionBase
      com.sun.xacml.cond.BagFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

ConditionBagFunction, GeneralBagFunction

public abstract class BagFunction

extends FunctionBase

Represents all of the Bag functions, though the actual implementations are in two sub-classes specific to the condition and general bag functions.

Since:

1.0

Field Summary

protected static String[]	baseTypes A complete list of all the XACML datatypes supported by the Bag functions
static String	NAME_BASE_BAG Base name for the type-bag funtions.
static String	NAME_BASE_BAG_SIZE Base name for the type-bag-size funtions.
static String	NAME_BASE_IS_IN Base name for the type-is-in.
static String	NAME_BASE_ONE_AND_ONLY Base name for the type-one-and-only funtions.
protected static String[]	simpleTypes A complete list of all the XACML datatypes supported by the Bag functions, using the "simple" form of the names (eg, string instead of http://www.w3.org/2001/XMLSchema#string)

Fields inherited from class com.sun.xacml.cond.FunctionBase

FUNCTION_NS

Constructor Summary

protected	BagFunction(String functionName, int functionId, String[] paramTypes) Protected constuctor used by the general and condition subclasses to create a boolean function with parameters of different datatypes.
protected	BagFunction(String functionName, int functionId, String paramType, boolean paramIsBag, int numParams, String returnType, boolean returnsBag) Protected constuctor used by the general and condition subclasses to create a non-boolean function with parameters of the same datatype.

Method Summary

static BagFunction	getBagInstance(String functionName, String argumentType) Returns a new BagFunction that provides the type-bag functionality over the given attribute type.
static BagFunction	getBagSizeInstance(String functionName, String argumentType) Returns a new BagFunction that provides the type-bag-size functionality over the given attribute type.
static BagFunction	getIsInInstance(String functionName, String argumentType) Returns a new BagFunction that provides the type-is-in functionality over the given attribute type.
static BagFunction	getOneAndOnlyInstance(String functionName, String argumentType) Returns a new BagFunction that provides the type-one-and-only functionality over the given attribute type.
static Set	getSupportedIdentifiers() Returns a Set containing all the function identifiers supported by this class.

Methods inherited from class com.sun.xacml.cond.FunctionBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.xacml.cond.Function

evaluate

Field Detail

NAME_BASE_ONE_AND_ONLY

public static final String NAME_BASE_ONE_AND_ONLY

Base name for the type-one-and-only funtions. To get the standard identifier for a given type, use FunctionBase.FUNCTION_NS + the datatype's base name (e.g., string) + NAME_BASE_ONE_AND_ONLY.

See Also:

Constant Field Values

NAME_BASE_BAG_SIZE

public static final String NAME_BASE_BAG_SIZE

Base name for the type-bag-size funtions. To get the standard identifier for a given type, use FunctionBase.FUNCTION_NS + the datatype's base name (e.g., string) + NAME_BASE_BAG_SIZE.

See Also:

Constant Field Values

NAME_BASE_IS_IN

public static final String NAME_BASE_IS_IN

Base name for the type-is-in. To get the standard identifier for a given type, use FunctionBase.FUNCTION_NS + the datatype's base name (e.g., string) + NAME_BASE_IS_IN.

See Also:

Constant Field Values

NAME_BASE_BAG

public static final String NAME_BASE_BAG

Base name for the type-bag funtions. To get the standard identifier for a given type, use FunctionBase.FUNCTION_NS + the datatype's base name (e.g., string) + NAME_BASE_BAG.

See Also:

Constant Field Values

baseTypes

protected static String[] baseTypes

A complete list of all the XACML datatypes supported by the Bag functions

simpleTypes

protected static String[] simpleTypes

A complete list of all the XACML datatypes supported by the Bag functions, using the "simple" form of the names (eg, string instead of http://www.w3.org/2001/XMLSchema#string)

Constructor Detail

BagFunction

protected BagFunction(String functionName,
                      int functionId,
                      String paramType,
                      boolean paramIsBag,
                      int numParams,
                      String returnType,
                      boolean returnsBag)

Protected constuctor used by the general and condition subclasses to create a non-boolean function with parameters of the same datatype. If you need to create a new BagFunction instance you should either use one of the getInstance methods or construct one of the sub-classes directly.

Parameters:

functionName - the identitifer for the function

functionId - an optional, internal numeric identifier

paramType - the datatype this function accepts

paramIsBag - whether the parameters are bags

numParams - number of parameters allowed or -1 for any number

returnType - the datatype this function returns

returnsBag - whether this function returns bags

BagFunction

protected BagFunction(String functionName,
                      int functionId,
                      String[] paramTypes)

Protected constuctor used by the general and condition subclasses to create a boolean function with parameters of different datatypes. If you need to create a new BagFunction instance you should either use one of the getInstance methods or construct one of the sub-classes directly.

Parameters:

functionName - the identitifer for the function

functionId - an optional, internal numeric identifier

paramTypes - the datatype of each parameter

Method Detail

getOneAndOnlyInstance

public static BagFunction getOneAndOnlyInstance(String functionName,
                                                String argumentType)

Returns a new BagFunction that provides the type-one-and-only functionality over the given attribute type. This should be used to create new function instances for any new attribute types, and the resulting object should be put into the FunctionFactory (instances already exist in the factory for the standard attribute types).

Parameters:

functionName - the name to use for the function

argumentType - the type to operate on

Returns:

a new BagFunction

getBagSizeInstance

public static BagFunction getBagSizeInstance(String functionName,
                                             String argumentType)

Returns a new BagFunction that provides the type-bag-size functionality over the given attribute type. This should be used to create new function instances for any new attribute types, and the resulting object should be put into the FunctionFactory (instances already exist in the factory for the standard attribute types).

Parameters:

functionName - the name to use for the function

argumentType - the type to operate on

Returns:

a new BagFunction

getIsInInstance

public static BagFunction getIsInInstance(String functionName,
                                          String argumentType)

Returns a new BagFunction that provides the type-is-in functionality over the given attribute type. This should be used to create new function instances for any new attribute types, and the resulting object should be put into the FunctionFactory (instances already exist in the factory for the standard attribute types).

Parameters:

functionName - the name to use for the function

argumentType - the type to operate on

Returns:

a new BagFunction

getBagInstance

public static BagFunction getBagInstance(String functionName,
                                         String argumentType)

Returns a new BagFunction that provides the type-bag functionality over the given attribute type. This should be used to create new function instances for any new attribute types, and the resulting object should be put into the FunctionFactory (instances already exist in the factory for the standard attribute types).

Parameters:

functionName - the name to use for the function

argumentType - the type to operate on

Returns:

a new BagFunction

getSupportedIdentifiers

public static Set getSupportedIdentifiers()

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

Returns:

a Set of Strings