Package com.jedox.etl.components.scriptapi

Class FunctionAPI

java.lang.Object

com.jedox.etl.core.scriptapi.ScriptAPI

com.jedox.etl.components.scriptapi.BaseAPI

com.jedox.etl.components.scriptapi.ExecutionAPI

com.jedox.etl.components.scriptapi.FunctionAPI

All Implemented Interfaces:

com.jedox.etl.core.scriptapi.IPropertiesAware, com.jedox.etl.core.scriptapi.IScriptAPI

public class FunctionAPI
extends ExecutionAPI

Use with binding API, only available in functions of Integrator transforms.

Constructor Summary

Constructors

Constructor	Description
FunctionAPI()

Method Summary

Modifier and Type	Method	Description
int	getCalculationCount()	Gets the number of times a function has been calculated in the source.
Element	getTreeElement()	Gets the currently processed element of a tree (only for functions inside of TreeElement transforms)

Methods inherited from class com.jedox.etl.components.scriptapi.ExecutionAPI

getMailer, getSource, getState, initSource, initSource, isNumeric

Methods inherited from class com.jedox.etl.components.scriptapi.BaseAPI

clearProperties, getComponentName, getConfigSetting, getConfigSetting, getGlobalConnections, getLocalFilesDir, getProjectName, getProperty, setProperty

Methods inherited from class com.jedox.etl.core.scriptapi.ScriptAPI

getDefaultImports, getExtensionPoint, getParameters, setAPIDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionAPI

public FunctionAPI()

Method Details

getCalculationCount

public int getCalculationCount()

Gets the number of times a function has been calculated in the source. A function is only calculated once for identical input values.

Returns:

number of calculations

getTreeElement

public Element getTreeElement()
                       throws com.jedox.etl.core.component.ETLRuntimeException

Gets the currently processed element of a tree (only for functions inside of TreeElement transforms)

Returns:

the tree element which holds children, parents, weight, and attributes

Throws:

com.jedox.etl.core.component.ETLRuntimeException - if the source is not a tree