Package com.jedox.etl.components.scriptapi

Class ExecutionAPI

java.lang.Object

com.jedox.etl.core.scriptapi.ScriptAPI

com.jedox.etl.components.scriptapi.BaseAPI

com.jedox.etl.components.scriptapi.ExecutionAPI

All Implemented Interfaces:

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

Direct Known Subclasses:

FunctionAPI, JobAPI

public abstract class ExecutionAPI
extends BaseAPI

Common methods available for jobs and functions.

Constructor Summary

Constructors

Constructor	Description
ExecutionAPI()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all processors created with initSource(String) or initSource(String, String, int)
Object	getMailer()	Deprecated, for removal: This API element is subject to removal in a future version. This method is deprecated and will be removed, use JobAPI.getMailer() instead.
Source	getSource(String name)	Deprecated, for removal: This API element is subject to removal in a future version. This method is deprecated and will be removed, use initSource(String) instead.
State	getState()	Gets the State of the current execution including start date, first error message (if one exists) and status.
Source	initSource(String name)	Initializes a Source for a given name (extract or transform) with no tree format and processes all rows.
Source	initSource(String name, String format, int size)	Initializes a Source for a given name (extract or transform).
boolean	isNumeric(String inputData)	Tests if a given string is numeric.

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, isUsable, setAPIDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

ExecutionAPI

public ExecutionAPI()

Method Details

isNumeric

public boolean isNumeric(String inputData)

Tests if a given string is numeric. Uses Integrator's internal number convertion. It is similar to Groovy's isNumber() method for CharSequence, but also supports Boolean values.

Parameters:

inputData - string to test

Returns:

true if numeric, false otherwise

initSource

public Source initSource(String name,
 String format,
 int size)

Initializes a Source for a given name (extract or transform). The number of rows to process can be configured. For tree based sources a tree format can be set.

Parameters:

name - name of the source (extract or transform)

format - the tree format, can be null

size - number of rows to process, 0 processes all rows

Returns:

the initialized Source or null if in case of an error

initSource

public Source initSource(String name)

Initializes a Source for a given name (extract or transform) with no tree format and processes all rows.

Parameters:

name - name of the source (extract or transform)

Returns:

the initialized Source or null if in case of an error

getSource

@Deprecated(forRemoval=true)
public Source getSource(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

This method is deprecated and will be removed, use initSource(String) instead.

Gets an existing Source for a given name. If the source isn't available yet, it is initialized with no tree format and all rows are processed.

Parameters:

name - name of the source (extract or transform)

Returns:

the requested Source or null if the initialization fails

getState

public State getState()

Gets the State of the current execution including start date, first error message (if one exists) and status.

Returns:

the State of the current execution

close

public void close()

Closes all processors created with initSource(String) or initSource(String, String, int)

Specified by:

close in interface com.jedox.etl.core.scriptapi.IScriptAPI

Overrides:

close in class com.jedox.etl.core.scriptapi.ScriptAPI

getMailer

@Deprecated(forRemoval=true)
public Object getMailer()

Deprecated, for removal: This API element is subject to removal in a future version.

This method is deprecated and will be removed, use JobAPI.getMailer() instead.

Returns null if not called from a job.

Returns:

null if not called from a job