org.vedantatree.expressionoasis.extensions

Class DefaultVariableProvider

java.lang.Object

org.vedantatree.expressionoasis.extensions.DefaultVariableProvider

All Implemented Interfaces:

VariableProvider

public class DefaultVariableProvider
extends Object
implements VariableProvider

This is the default implementation of the variable provider.

Version:

1.0 Modified to use HashMap rather than Hashtable for performance reasons. I think this is safe to do, but may need to reverse if thread-safety issues are encountered., 1.1

Author:

Parmod Kamboj, Mohit Gupta, Kris Marwood

Constructor Summary

Constructors

Constructor and Description
DefaultVariableProvider()

Method Summary

Modifier and Type	Method and Description
void	addVariable(String variableName, ValueObject valueObject) Add a new variable value to Variable Provider Cache
void	clear() Clears the variable names.
Type	getVariableType(String variableName) Gets the type of variable.
ValueObject	getVariableValue(String variableName) Gets the value of variable.
void	initialize(ExpressionContext expressionContext) It initialize the Function provider with expression context and also gives a chance to pre-initialize any internal states for operations
void	removeVariable(String variableName) Removes the variable from Variable Provider Cache by given name
boolean	supportsVariable(String variableName) Checks whether the specified variable is supported by this variable provider or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVariableProvider

public DefaultVariableProvider()

Method Detail

initialize

public void initialize(ExpressionContext expressionContext)
                throws ExpressionEngineException

It initialize the Function provider with expression context and also gives a chance to pre-initialize any internal states for operations

Specified by:

initialize in interface VariableProvider

Parameters:

expressionContext - Context of current expression evaluation process

Throws:

ExpressionEngineException

addVariable

public void addVariable(String variableName,
                        ValueObject valueObject)

Add a new variable value to Variable Provider Cache

Parameters:

variableName - name of the variable to add

valueObject - value of the variable

removeVariable

public void removeVariable(String variableName)

Removes the variable from Variable Provider Cache by given name

Parameters:

variableName - name of the the variable to remove

clear

public void clear()

Clears the variable names.

getVariableType

public Type getVariableType(String variableName)
                     throws ExpressionEngineException

Description copied from interface: VariableProvider

Gets the type of variable.

Specified by:

getVariableType in interface VariableProvider

Parameters:

variableName - name of the variable

Returns:

type of the variable

Throws:

ExpressionEngineException - if anything goes wrong

See Also:

VariableProvider.getVariableType(java.lang.String)

getVariableValue

public ValueObject getVariableValue(String variableName)
                             throws ExpressionEngineException

Description copied from interface: VariableProvider

Gets the value of variable.

Specified by:

getVariableValue in interface VariableProvider

Parameters:

variableName - name of the variable.

Returns:

value of variable wrapped in ValueObject

Throws:

ExpressionEngineException - if anything goes wrong

See Also:

VariableProvider.getVariableValue(java.lang.String)

supportsVariable

public boolean supportsVariable(String variableName)
                         throws ExpressionEngineException

Description copied from interface: VariableProvider

Checks whether the specified variable is supported by this variable provider or not.

Specified by:

supportsVariable in interface VariableProvider

Parameters:

variableName - name of the variable

Returns:

true if the variable is supported by this provider false otherwise

Throws:

ExpressionEngineException - if anything goes wrong

See Also:

VariableProvider.supportsVariable(java.lang.String)