oracle.odi.sdk.opentools

Interface IOpenTool

All Known Subinterfaces:

IOpenToolStoppable

All Known Implementing Classes:

OpenToolAbstract, OpenToolStoppableAbstract

public interface IOpenTool

The IOpenTool interface must be implemented by an Open Tool class for use in Data Integrator packages. It provides methods to get the description, icon, provider, syntax and version of the Open Tool, as well as the list of parameters it takes. It must also provide the execute() method, which is called to carry out the main functionality of the Open Tool. The name of the Open Tool is the first word of the Syntax.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BIG_ICON A constant used to refer to the large icon type, as passed to the function getIcon().
static int	SMALL_ICON A constant used to refer to the small icon type, as passed to the function getIcon().

Method Summary

Modifier and Type	Method and Description
void	execute() Called to carry out the main functionality of the Open Tool.
java.lang.String	getDescription() Returns a description of this Open Tool.
java.lang.String	getIcon(int pIconType) Returns a path to the .gif file within the Open Tool's .jar package for the icon of a certain type.
IOpenToolParameter[]	getParameters() Returns an array of IOpenToolParameter objects that can be used to configure the behavior of this Open Tool when it is executed.
java.lang.String	getProvider() Returns the name of the provider of this Open Tool.
java.lang.String	getSyntax() Returns the syntax of the Open Tool which is used to initialize the Command and General tabs of the tool in the package window.
java.lang.String	getVersion() Returns the version number of this Open Tool.

Field Detail

SMALL_ICON

static final int SMALL_ICON

A constant used to refer to the small icon type, as passed to the function getIcon().

See Also:

Constant Field Values

BIG_ICON

static final int BIG_ICON

A constant used to refer to the large icon type, as passed to the function getIcon().

See Also:

Constant Field Values

Method Detail

execute

void execute()
      throws OpenToolExecutionException

Called to carry out the main functionality of the Open Tool. This method is called when this step of a package is called.

Throws:

OpenToolExecutionException - excepton during execution

getSyntax

java.lang.String getSyntax()

Returns the syntax of the Open Tool which is used to initialize the Command and General tabs of the tool in the package window. The syntax should always contain the name of the command, followed by any parameters that should be given values by default. Normal Data Integrator tool syntax is used: toolname -PARAM1=value -PARAM2=value. Note that the first word of the syntax is used as the name of the Open Tool.

Returns:

A string representing the syntax.

getDescription

java.lang.String getDescription()

Returns a description of this Open Tool. This information is displayed in the Designer GUI when this Open Tool is selected.

Returns:

A string containing the description.

getVersion

java.lang.String getVersion()

Returns the version number of this Open Tool. This information is displayed in the Designer GUI when this Open Tool is selected.

Returns:

A string containing the version number.

getProvider

java.lang.String getProvider()

Returns the name of the provider of this Open Tool. This information is displayed in the Designer GUI when this Open Tool is selected.

Returns:

A string containing the name of the provider

getIcon

java.lang.String getIcon(int pIconType)

Returns a path to the .gif file within the Open Tool's .jar package for the icon of a certain type. If SMALL_ICON is specified, the icon file should be a 16x16 icon to be displayed in the toolbar for this Open Tool. If BIG_ICON is specifed, the icon file should be a 32x32 icon suitable for displaying in the package diagram, to represent this Open Tool. A blank string may be returned, in which case a default icon will be used.

Parameters:

pIconType - icon type

Returns:

The absolute path and filename of the required .gif file within the .jar package.

getParameters

IOpenToolParameter[] getParameters()

Returns an array of IOpenToolParameter objects that can be used to configure the behavior of this Open Tool when it is executed.

Returns:

An array of IOpenToolParameter