com.toolsverse.etl.common

Class FunctionContext

Object

com.toolsverse.etl.common.FunctionContext

Direct Known Subclasses:

LoadFunctionContext

public class FunctionContext
extends Object

The is a parameter passed to the function. Includes information such as current record, current value, etc.

Since:

1.0

Version:

2.0

See Also:

Function, Variable

Constructor Summary

Constructors

Constructor and Description
FunctionContext() Instantiates a new FunctionContext.

Method Summary

Modifier and Type	Method and Description
Object	execute(Variable var) Executes function associated with the variable for the current execution scope.
DataSetRecord	getCurrentRecord() Gets the current record of the data set.
Object	getCurrentValue() Gets the value of the current field of the current record of the data set.
long	getRow() Gets the current row.
int	getScope() Gets the execution scope.
Variable	getVariable() Gets the variable associated with the execution context.
boolean	isDoNotEncode() Checks if "do not encode" flag is set.
boolean	isFromCursor() Checks if "from cursor" flag is set.
void	setCurrentRecord(DataSetRecord value) Sets the current record of the data set.
void	setCurrentValue(Object value) Sets the value of the current field of the current record of the data set.
void	setDoNotEncode(boolean value) Sets the "do not encode" flag.
void	setFromCursor(boolean value) Sets the flag "from cursor".
void	setRow(long value) Sets the row.
void	setScope(int value) Sets the execution scope.
void	setVariable(Variable var) Sets the variable.

Methods inherited from class Object

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

Constructor Detail

FunctionContext

public FunctionContext()

Instantiates a new FunctionContext.

Method Detail

execute

public Object execute(Variable var)
               throws Exception

Executes function associated with the variable for the current execution scope.

Parameters:

var - the variable

Returns:

the string the result of the function, converted to the String

Throws:

Exception - in case of any error

getCurrentRecord

public DataSetRecord getCurrentRecord()

Gets the current record of the data set.

Returns:

the current record

getCurrentValue

public Object getCurrentValue()

Gets the value of the current field of the current record of the data set.

Returns:

the current value

getRow

public long getRow()

Gets the current row.

Returns:

the current row

getScope

public int getScope()

Gets the execution scope. The function can be executed BEFORE, AFTER and at RUNTIME (any combination of these).

Returns:

the execution scope

getVariable

public Variable getVariable()

Gets the variable associated with the execution context.

Returns:

the variable

isFromCursor

public boolean isFromCursor()

Checks if "from cursor" flag is set. There are two ways to iterate through the data set row by row: a)store everything in the memory and just have a loop or b)use a cursor if database supports it.

Returns:

true, if "from cursor" property is set

setCurrentRecord

public void setCurrentRecord(DataSetRecord value)

Sets the current record of the data set.

Parameters:

value - the new current record

setCurrentValue

public void setCurrentValue(Object value)

Sets the value of the current field of the current record of the data set.

Parameters:

value - The new current value

setFromCursor

public void setFromCursor(boolean value)

Sets the flag "from cursor". There are two ways to iterate through the data set row by row: a)store everything in the memory and just have a loop or b)use a cursor if database supports it.

Parameters:

value - the new checks if is from table

setDoNotEncode

public void setDoNotEncode(boolean value)

Sets the "do not encode" flag. If value is true the system will not use driver specific encoding and will simply return value.toString() when calculating function

Parameters:

value - the new vaue of the do not encode flag

isDoNotEncode

public boolean isDoNotEncode()

Checks if "do not encode" flag is set. If value is true the system will not use driver specific encoding and will simply return value.toString() when calculating function

Returns:

true, "if do not encode" flag is set

setRow

public void setRow(long value)

Sets the row.

Parameters:

value - the new row

setScope

public void setScope(int value)

Sets the execution scope. The function can be executed before, after and at runtime (any combination of these).

Parameters:

value - the new scope

setVariable

public void setVariable(Variable var)

Sets the variable.

Parameters:

var - the new variable